| Table of Contents | ||
|---|---|---|
|
...
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 |
...
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 |
...
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_amount (mandatory) | Number | The amount of the refund | ||||||
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:
| ||||||
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 |
...
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:
|
...
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:
|
...
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 | ||||||
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 |
...