Name | Type | Description | ||
---|---|---|---|---|
id | String | The ID of the retrieved payment | ||
number | String | The number of the retrieved payment | ||
reference_number | String | The reference number of the retrieved payment | ||
life_cycle_state | String | The state of the retrieved payment which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED | ||
payment_amount | Number | The amount of the payment | ||
issued_on | Date | The date that the payment was issued | ||
posted_on | Date | The date that the payment was posted | ||
received_on | Date | The date that the payment was received | ||
notes | String | Shared notes for the payment | ||
processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed | ||
payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed | ||
back_office_code | String | The back office code of the retrieved payment
| ||
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
| ||
type | Financial transaction type object | The financial transaction type of the payment | ||
category | Financial transaction category object | The category of the payment | ||
payment_method | Payment method object | The payment method of that payment | ||
received_by_user | User object | The user who actually received the payment | ||
received_by_unit | Unit object | The unit who actually received the payment
| ||
received_by_business_unit | Business Unit object | The business unit who actually received the payment
| ||
rejection_reason | Financial transaction rejection reason object | The reason that the payment was rejected | ||
card | Payment Gateway Card Object | The card that was charged by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed | ||
payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference that were used by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed
| ||
accounting_period_information | Accounting Period Information object | The accounting period information of the retrieved payment. This is applicable only if the payment was processed within an Accounting Period Closing process run.
| ||
currency_rate_period | Currency Rate Period object | The currency rate period based on which the payment's amounts were calculated
| ||
invoices_to_pay_set | Set of invoice objects | The invoices that were intended to be paid | ||
bills_to_pay_set | Set of bill objects | The bills that were intended to be paid | ||
products_to_pay_set | Set of products | The products that were intended to be paid
| ||
bills_paid | Set of bill objects | The bill(s) actually paid through the payment
| ||
payment_cancellation | Payment Cancellation Object | The payment cancellation related with the retrieved payment, if it was cancelled
| ||
Log Information Object | The log information related with the retrieved payment |
...
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
...