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:
| ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | ||||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 | ||||||||||||
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