GET refunds/show
This method returns information related with a refund. A single refund is returned by each call
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
| refund_identifier (mandatory) | Refund identifier | The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:
| |||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved refund |
| number | String | The number of the retrieved refund |
| reference_number | String | The reference number of the retrieved refund |
| life_cycle_state | String | The state of the retrieved refund which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED,PENDING_VERIFICATION |
| refund_amount | Number | The total refund amount |
| issued_on | Date | The date that the refund was issued |
| posted_on | Date | The date that the refund was posted |
| notes | String | Shared notes for the refund |
| processed_by_payment_gateway | String | The payment gateway that processed the refund. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| payment_gateway_reference_number | String | A reference to the number of the refund that was created on the payment gateway. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| back_office_code | String | The back office code of the retrieved refund |
| issue_reason | String | A description of the reason that the refund is issued |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| accounts_receivable | Accounts Receivable Object | The related accounts receivable |
| voucher | Voucher Object | The related voucher Available from CRM.COM R14.0.0 |
| type | Financial transaction type object | The financial transaction type of this refund |
| category | Financial transaction category object | The category of the refund |
| refund_method | Refund method object | The refund method of the refund |
| rejection_reason | Financial transaction rejection reason object | The reason that the refund was rejected |
| payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference that were used by the payment gateway that processed the refund. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| accounting_period_information | Accounting Period Information object | The refund's accounting period information |
| currency_rate_period | Currency Rate Period object | The refund's currency rate period |
Log Information Object | The log information related with the retrieved refund |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"udf_float_1": null,
"udf_float_2": null,
"udf_float_3": null,
"number": "17",
"udf_float_4": null,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"accounts_receivable":
{
"account_owner":
{
"last_name": "Johnson",
"middle_name": null,
"company_profile": null,
"type": "PERSON",
"first_name": "Peter",
"name": null,
"id": "C73D1572FEA76C37A08945ECE4DECC98",
"company_name": null,
"demographics":
{
"gender": "MALE",
"passport_issued_by_country": null,
"passport_number": "7839023",
"social_security_number": "98374",
"date_of_birth":
{
"month": 4,
"day": 6,
"year": 1985
},
"name_day":
{
"month": 6,
"day": 29
},
"id_number": "984783",
"industry": null
}
},
"life_cycle_state": "ACTIVE",
"number": "192",
"name": "Peter Johnson Premium",
"id": "2C5FC6F615FA9E798487AC0C293ECCE6"
},
"id": "C32C494AD42A5B1AFE3B205BF9D37CBA",
"posted_on": "2014-07-15T15:44:50",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"log_information":
{
"updated_date": "2014-07-15T15:44:50",
"created_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_date": "2014-07-15T15:44:19",
"updated_by_unit":
{
"community_name": "Main Community",
"group_name": "Main Group",
"name": "Admin Unit",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"description": "r1",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "JackH",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
},
"updated_by_user":
{
"person_name": "JackH",
"username": "JackH",
"id": "B8650C555C4EA8C741103961276E7773",
"email": "j_hadjicosti@crm.com"
}
},
"issued_on": "2014-07-15T15:44:19",
"life_cycle_state": "POSTED",
"back_office_code": null,
"issued_reasonon": "Item was broken",
"rejection_reason": null,
"type":
{
"classification": "REFUND",
"name": "Broken Item Refund",
"id": "09A6B916D5B222FEB54DEEC12F2A6FE9",
"description": null,
"alternative_code": "BRITREF"
},
"reference_number": "25",
"category":
{
"name": "Broken Item Refund",
"id": "3D5A60B6CB4E8B4316686A2FFB859FFF",
"description": "Broken Item Refund",
"code": "RC3"
},
"refund_amount": 80
}
}
HTTP Method: GET
Request:
Response:
{
"data": {
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-06-30T13:03:18",
"updated_date": "2016-06-30T13:03:56",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"currency_rate_period": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"udf_date_2": null,
"type": {
"alternative_code": "R",
"name": "Refund",
"description": null,
"id": "REFUND",
"classification": "REFUND"
},
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": null,
"udf_float_3": null,
"udf_float_4": null,
"refund_amount": 2,
"rejection_reason": null,
"issued_reason": null,
"id": "41B681512D5A438289287DE82CCEA5E7",
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"udf_string_3": null,
"accounting_period_information": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"accounts_receivable": {
"number": "ACR0000000264",
"name": "ACR0000000264 Alternative Currency",
"id": "4820A781EFF243DF96DD44487EBA5C74",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Currency",
"id": "E6E1240F3C8C48CE83159DB9AF89284B",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Alternative",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"life_cycle_state": "DRAFT",
"reference_number": "6",
"posted_on": null,
"issued_on": "2016-06-30T13:03:18",
"udf_string_6": null,
"category": null,
"udf_string_7": null,
"udf_string_8": null,
"back_office_code": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
GET refunds/list
This method returns information related with refunds. Multiple refunds are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the refund that should be returned as a result should be allocated. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the refund that should be returned as a result. The allowed financial transaction type identifier field are the following:
| ||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the refund that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved refund |
| number | String | The number of the retrieved refund |
| reference_number | String | The reference number of the retrieved refund |
| life_cycle_state | String | The state of the retrieved refund which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED,PENDING_VERIFICATION |
| refund_amount | Number | The total refund amount |
| issued_on | Date | The date that the refund was issued |
| posted_on | Date | The date that the refund was posted |
| notes | String | Shared notes for the refund |
| processed_by_payment_gateway | String | The payment gateway that processed the refund. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| payment_gateway_reference_number | String | A reference to the number of the refund that was created on the payment gateway. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| back_office_code | String | The back office code of the retrieved refund |
| issue_reason | String | A description of the reason that the refund is issued |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| accounts_receivable | Accounts Receivable Object | The related accounts receivable |
| voucher | Voucher Object | The related voucher Available from CRM.COM R14.0.0 |
| type | Financial transaction type object | The financial transaction type of this refund |
| category | Financial transaction category object | The category of the refund |
| refund_method | Refund method object | The refund method of the refund |
| rejection_reason | Financial transaction rejection reason object | The reason that the refund was rejected |
| payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference that were used by the payment gateway that processed the refund. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| accounting_period_information | Accounting Period Information object | The refund's accounting period information |
| currency_rate_period | Currency Rate Period object | The refund's currency rate period |
Log Information Object | The log information related with the retrieved refund |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
[
{
"life_cycle_state": "POSTED",
"id": "C32C494AD42A5B1AFE3B205BF9D37CBA",
"reference_number": "25"
},
{
"life_cycle_state": "POSTED",
"id": "52A51D5B6C3090EE083690C9C799842E",
"reference_number": "26"
}
]
}
HTTP Method: GET
Request:
Response:
{
"data": [
{
"currency_rate_period": null,
"id": "47F1172E05CC4F958CE6A22C8C9B9B72",
"reference_number": "12"
},
{
"currency_rate_period": null,
"id": "2E61CBC9AA2B4C8B890C9FBCC1C5326A",
"reference_number": "11"
},
{
"currency_rate_period": null,
"id": "311FFC68C373426D87F337DB790216D5",
"reference_number": "10"
},
{
"currency_rate_period": null,
"id": "5B49BC96217F4231A5A3B064C9A1D2E8",
"reference_number": "9"
},
{
"currency_rate_period": {
"from_date": "C7D7ED57F21B47028144967E015DCBE5",
"to_date": 2.3,
"rate": 2.3,
"inverse_rate": 0.23000000417232513,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9"
},
"id": "C7D7ED57F21B47028144967E015DCBE5"
},
"id": "0436CD88F42643159493577C6F51A8CF",
"reference_number": "8"
},
{
"currency_rate_period": null,
"id": "8B244D9D5857407EA4193C18B137959C",
"reference_number": "7"
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
POST refunds/create
This method is creating a new refund either in Draft or Posted state
Resource URL
Parameters
Name | Type | Description | |||||||||||||||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||||||||||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the refund should be allocated to. The allowed accounts receivable identifier fields are the following:
| |||||||||||||||||||||||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the refund . The allowed financial transaction type identifier field are the following:
| |||||||||||||||||||||||||||
life_cycle_state (mandatory) | String | The state of the retrieved refund which can be one of the following: DRAFT, POSTED | |||||||||||||||||||||||||||
refund_method_identifier (optional) | Refund method identifier | The refund method of the refund. If not specified then the refund method which is specified as the default on the selected refund type is applied. The allowed refund method identifier fields are the following:
| |||||||||||||||||||||||||||
refund_amount (mandatory) | Number | The amount of the refund | |||||||||||||||||||||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the refund. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| |||||||||||||||||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the refund that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| |||||||||||||||||||||||||||
accounts_receivable_payment_preference_identifier (mandatory on conditions) | Accounts Receivable Payment Preference Identifier | The accounts receivable payment preferences that will be used by generic payment gateways to process the refund. The specified accounts receivable payment preferences should belong to the specified accounts receivable. This information is applicable and mandatory only if the refund will be processed by a generic payment gateway, as denoted by the selected refund method. The allowed accounts receivable payment preference identifier fields are the following:
| |||||||||||||||||||||||||||
notes (optional) | String | Shared notes for the refund | |||||||||||||||||||||||||||
back_office_code (optional) | String | A back office code for the refund. If specified then it should be unique | |||||||||||||||||||||||||||
issue_on (optional) | Date | The date on which the refund is issued | |||||||||||||||||||||||||||
issue_reason (optional) | String | A description of the reason that the refund is issued | |||||||||||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | |||||||||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | |||||||||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | |||||||||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | |||||||||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | |||||||||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | |||||||||||||||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"accounts_receivable_identifier":{"number":"192"},
"type_identifier":{"name":"Broken Item Refund"},
"life_cycle_state":"POSTED",
"refund_amount":"150",
"category_identifier":{"name":"Broken Item Refund"},
"issue_reason":"Item was broken.",
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2014-07-15T15:59:18",
"life_cycle_state": "POSTED",
"number": "19",
"id": "308883971F72E715FC64D005FF0C9B1F",
"reference_number": "27",
"posted_on": "2014-07-15T15:59:18",
"refund_amount": 150
}
}
POST refunds/post
This method is used to post a refund which is in draft state.
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
| refund_identifier (mandatory) | Refund identifier | The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:
| |||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"refund_identifier":{"reference_number":"54"},
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2015-02-02T12:40:14",
"life_cycle_state": "POSTED",
"number": "24",
"id": "85EEB0CD1DB6A8CF299A035079576A94",
"reference_number": "54",
"posted_on": "2015-02-02T12:42:11",
"refund_amount": 20
}
}
POST refunds/reject
This method is used to reject a refund which is in draft state.
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
| refund_identifier (mandatory) | Refund identifier | The identifier of the refund that should be returned as a result. The allowed refund identifier fields are the following:
| |||||||||||||||
| rejection_reason_identifier | Rejection reason identifier | The reason that the refund is rejected. The allowed rejection reason identifier fields are the following:
| |||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token": "E78968BE92E02C3FCCD2D671B9772EF9",
"refund_identifier":{"reference_number":"29"},
"rejection_reason_identifier":{"name":"Reject Due to Business Request"},
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"issued_on": "2014-07-15T16:01:24",
"life_cycle_state": "REJECTED",
"number": null,
"id": "0FAE4317E8E46BC90490E7A031CE723A",
"reference_number": "29",
"posted_on": null,
"refund_amount": 150
}
}
POST refunds/update
Available from CRM.COM R9.1.0
This method is updating a single Refund but only as long as it is in Draft life cycle state
Resource URL
Parameters
Name | Type | Description | |||||||||||||||
token | String | The token retrieved from the login method | |||||||||||||||
refund_identifier (mandatory) | Refund identifier | The identifier of the refund that should be updated. Only refunds in draft state can be specified.The allowed refund identifier fields are the following:
| |||||||||||||||
| accounts_receivable_identifier (optional) | Accounts receivable identifier | The identifier of the updated accounts receivable to which the refund should be allocated to. The allowed accounts receivable identifier fields are the following:
| |||||||||||||||
type_identifier (optional) | Financial transaction type identifier | The financial transaction type of the refund. Only financial transaction types with classification Refund can be specified. The allowed financial transaction type identifier field are the following:
| |||||||||||||||
refund_amount (optional) | Number | The amount of the refund | |||||||||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the refund. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an error is throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| |||||||||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the refund that should be updated. The allowed financial transaction category identifier fields are the following:
| |||||||||||||||
notes (optional) | String | Shared notes for the refund | |||||||||||||||
back_office_code (optional) | String | A back office code for the refund. If specified then it should be unique
| |||||||||||||||
issued_on (optional) | Date | The date on which the refund was issued | |||||||||||||||
issue_reason (optional) | String | A description of the reason that the refund is issued | |||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | |||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | |||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | |||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | |||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | |||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | |||||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved refund |
| number | String | The number of the retrieved refund |
| reference_number | String | The reference number of the retrieved refund |
| life_cycle_state | String | The state of the retrieved refund which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED,PENDING_VERIFICATION |
| refund_amount | Number | The total refund amount |
| issued_on | Date | The date that the refund was issued |
| posted_on | Date | The date that the refund was posted |
| notes | String | Shared notes for the refund |
| processed_by_payment_gateway | String | The payment gateway that processed the refund. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| payment_gateway_reference_number | String | A reference to the number of the refund that was created on the payment gateway. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| back_office_code | String | The back office code of the retrieved refund |
| issue_reason | String | A description of the reason that the refund is issued |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| accounts_receivable | Accounts Receivable Object | The related accounts receivable |
| voucher | Voucher Object | The related voucher Available from CRM.COM R14.0.0 |
| type | Financial transaction type object | The financial transaction type of this refund |
| category | Financial transaction category object | The category of the refund |
| refund_method | Refund method object | The refund method of the refund |
| rejection_reason | Financial transaction rejection reason object | The reason that the refund was rejected |
| payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference that were used by the payment gateway that processed the refund. This information becomes available only if the selected refund method is included in the payment gateway provider as a linked refund method, or if the refund is already posted and the information was already completed |
| accounting_period_information | Accounting Period Information object | The refund's accounting period information |
| currency_rate_period | Currency Rate Period object | The refund's currency rate period |
Log Information Object | The log information related with the retrieved refund |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"134273A5D8B341BB82E8060C4E97CECB",
"refund_identifier":{"reference_number":"51"},
"accounts_receivable_identifier":{"name":"Jessie03 "},
"type_identifier":{"name":"Refund 2"},
"category_identifier":{"code":"RC"},
"refund_amount":20,
"back_office_code":"REF000001",
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"udf_string_3":"udf string 3",
"udf_string_4":"udf string 4",
"udf_string_5":"udf string 5",
"udf_string_6":"udf string 6",
"udf_string_7":"udf string 7",
"udf_string_8":"udf string 8",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59"
}
Response:
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": null,
"udf_float_1": 10,
"udf_float_2": 20,
"udf_float_3": 30,
"number": null,
"udf_float_4": 40,
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"accounts_receivable": {
"account_owner": {
"last_name": "Pickman",
"middle_name": "Li",
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": "Mr",
"first_name": "Jessie",
"type": "PERSON",
"id": "F9A629E466B1EF473CECD46F2A4D63F3",
"name": null,
"company_name": null,
"demographics": {
"gender": "MALE",
"passport_issued_by_country": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"social_security_number": "434567",
"passport_number": "54567432",
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": 4,
"day": 2
},
"date_of_birth": {
"month": 11,
"day": 1,
"year": 1988
},
"id_number": "983452",
"id_issued_by_country": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
}
}
},
"life_cycle_state": "ACTIVE",
"number": "173",
"id": "6991CE48FA587DF10ADCE6F436647749",
"name": "Jessie03"
},
"issued_reason": null,
"id": "573F6D322CEB439B8D642ECC9FB3B7C4",
"posted_on": null,
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"udf_date_4": "2014-08-05T15:49:59",
"log_information": {
"updated_date": "2016-05-04T12:13:28",
"created_date": "2015-04-08T08:53:58",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"issued_on": "2015-04-08T08:53:58",
"life_cycle_state": "DRAFT",
"back_office_code": "REF000001",
"rejection_reason": null,
"type": {
"classification": "REFUND",
"id": "B496E67C8C89CB35BF6C37EF78CD6BA0",
"name": "Refund 2",
"description": "Refund 2",
"alternative_code": "R2"
},
"reference_number": "51",
"category": {
"id": "945C6EEBC85130C0CC92B550D22946EC",
"name": "Refund Categories",
"description": "Refund Categories",
"code": "RC"
},
"refund_amount": 20
}
}