Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...


Name

Type

Description

id

String

The ID of the retrieved payment

number

String

The number of the retrieved payment

reference_numberStringThe reference number of the retrieved payment
life_cycle_stateString

The state of the retrieved payment which can be one of the following:

DRAFT, REJECTED, POSTED, CANCELLED

payment_amountNumberThe amount of the payment
issued_onDateThe date that the payment was issued
posted_onDateThe date that the payment was posted
received_onDateThe date that the payment was received
notesStringShared notes for the payment
processed_by_payment_gatewayString

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_numberString

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_codeString

The back office code of the retrieved payment

Tip

Available from CRM.COM R9.1.0


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_receivableAccounts Receivable Object

The related accounts receivable

Tip

For releases prior CRM.COM R14.0.0, the related Accounts Receivable Object is retrieved always

From CRM.COM R14.0.0 and onwards, Accounts Receivable Object will be retrieved only if the payment was posted against it


voucherVoucher Object

The related voucher

Tip

Available from CRM.COM R14.0.0


typeFinancial transaction type objectThe financial transaction type of the payment
categoryFinancial transaction category objectThe category of the payment
payment_methodPayment method objectThe payment method of that payment
.
received_by_userUser objectThe user who actually received the payment
received_by_unitUnit object

The unit who actually received the payment

Tip

Deprecated from CRM.COM R18.0.0


received_by_business_unitBusiness Unit object

The business unit who actually received the payment

Tip

Available from CRM.COM R18.0.0


rejection_reasonFinancial transaction rejection reason objectThe reason that the payment was rejected
cardPayment 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_preferenceAccounts 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

Tip

Available from CRM.COM R11.0.0


accounting_period_informationAccounting 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.

Tip
Available from CRM.COM R10.0.0


currency_rate_periodCurrency Rate Period object

The currency rate period based on which the payment's amounts were calculated

Tip

Available from CRM.COM R10.0.0


invoices_to_pay_setSet of invoice objectsThe invoices that were intended to be paid
bills_to_pay_setSet of bill objectsThe bills that were intended to be paid
products_to_pay_setSet of products

The products that were intended to be paid

Tip

Available from CRM.COM R12.0.0


bills_paidSet of bill objects

The bill(s) actually paid through the payment

Tip

Available from CRM.COM R14.28.0


payment_cancellationPayment Cancellation Object

The payment cancellation related with the retrieved payment, if it was cancelled

Tip

Available from CRM.COM R14.5.0


log_information

Log Information Object

The log information related with the retrieved payment

Anchor
payments referred objects
payments referred objects
Referred Objects Response Data

...

Include Page
unit_short
unit_short

Include Page
business_unit_short
business_unit_short

Include Page
financial_transaction_rejection_reason_short
financial_transaction_rejection_reason_short

...

Include Page
bill_short
bill_short

Include Page
bill_paid_short
bill_paid_short

Include Page
product_short
product_short

Include Page
payment_cancellation_short
payment_cancellation_short

Include Page
log_information_short
log_information_short