| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment identifier | The identifier of the payment that should be returned as a result. The allowed payment 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 payments 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 payment 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 payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
payment_method_identifier (optional) | Payment method identifier | The payment method of the payment that should be returned as a result. The allowed payment method 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 payments 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 payment 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 payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||
payment_method_identifier (optional) | Payment method identifier | The payment method of the payment that should be returned as a result. The allowed payment method identifier fields are the following:
| ||||||
number (mandatory) | Number | The number of payments to be retrieved, starting from the latest one | ||||||
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 payment 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 payment. The allowed financial transaction type identifier field are the following:
| ||||||||
life_cycle_state (mandatory) | String | The state of the retrieved payment which can be one of the following: DRAFT, POSTED | ||||||||
payment_method_identifier (mandatory) | Payment method identifier | The payment method of the payment. The allowed payment method identifier fields are the following:
| ||||||||
payment_amount (mandatory) | Number | The amount of the payment | ||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||||
received_by_user_identifier (optional) | User identifier | The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
| ||||||||
received_by_unit_identifier (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| ||||||||
card_identifier (mandatory on conditions) | Payment Gateway Card Identifier | The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
| ||||||||
notes (optional) | String | Shared notes for the payment | ||||||||
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 | ||||||||
(optional) | Set of invoice objects | The invoices that are intended to be paid | ||||||||
(optional) | Set of bill objects | The bills that are intended to be paid |
...
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 payment 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 payment. The allowed financial transaction type identifier field are the following:
| ||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||
payment_method_identifier (mandatory) | Payment method identifier | The payment method of the payment. The allowed payment method identifier fields are the following:
| ||||||||
invoice_identifier (mandatory) | Invoice identifier | The invoice to be paid. The allowed invoice identifier fields are the following:
| ||||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||||
received_by_user_identifier (optional) | User identifier | The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
| ||||||||
received_by_unit_identifier (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| ||||||||
card_identifier (mandatory on conditions) | Payment Gateway Card Identifier | The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
| ||||||||
notes (optional) | String | Shared notes for the payment | ||||||||
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 | ||||||||
| accounts_receivable_identifier (mandatory) | Accounts receivable identifier | The identifier of the accounts receivable in which the payment 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 payment. The allowed financial transaction type identifier field are the following:
| ||||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment that should be returned as a result. The allowed financial transaction category identifier fields are the following:
| ||||||||
payment_method_identifier (mandatory) | Payment method identifier | The payment method of the payment. The allowed payment method identifier fields are the following:
| ||||||||
bill_identifier (mandatory) | Bill identifier | The invoice to be paid. The allowed invoice identifier fields are the following:
| ||||||||
received_on (optional) | Date | The date that the payment was received. It defaults to the issued date if not specified | ||||||||
received_by_user_identifier (optional) | User identifier | The user who actually received the payment. It defaults to the issued by user if not specified. The allowed user identifier fields are the following:
| ||||||||
received_by_unit_identifier (optional) | Unit identifier | The unit who actually received the payment. The allowed unit identifier fields are the following:
| ||||||||
card_identifier (mandatory on conditions) | Payment Gateway Card Identifier | The card that will be charged for the amount specified on the payment, by the related payment gateway provider. The allowed payment gateway card identifier fields are the following:
The card is applicable and mandatory if the specified payment method is linked with a payment gateway system. Note that the retrieved cards are filtered based on the cards owned by the specified accounts receivable owner
| ||||||||
notes (optional) | String | Shared notes for the payment | ||||||||
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 | ||||||
| payment_identifier (mandatory) | Payment identifier | The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment Identifier | The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
| ||||||
| rejection_reason_identifier | Rejection reason identifier | The reason that the payment is rejected. The allowed rejection reason identifier fields are the following:
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| payment_identifier (mandatory) | Payment Identifier | The identifier of the payment that should be posted. Only payments in draft state can be specified.The allowed payment identifier fields are the following:
| ||||||
type_identifier (mandatory) | Financial transaction type identifier | The financial transaction type of the payment cancellation. The allowed financial transaction type identifier field are the following:
| ||||||
category_identifier (optional) | Financial transaction category identifier | The financial transaction category of the payment cancellation. The allowed financial transaction category identifier fields are the following:
| ||||||
notes (optional) | String | Shared notes for the payment | ||||||
issue_reason (optional) | String | A description of the reason that the payment cancellation 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 |
...