Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the retrieved refund

number

String

The number of the retrieved refund

reference_numberStringThe reference number of the retrieved refund
life_cycle_stateString

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

DRAFT, REJECTED, POSTED, CANCELLED,PENDING_VERIFICATION

refund_amountNumberThe total refund amount
issued_onDateThe date that the refund was issued
posted_onDateThe date that the refund was posted
notesStringShared notes for the refund
processed_by_payment_gatewayString

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

Tip

Available from CRM.COM R13.0.0

payment_gateway_reference_numberString

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

Tip

Available from CRM.COM R13.0.0

back_office_codeString

The back office code of the retrieved refund

Tip

Available from CRM.COM R9.1.0

issue_reasonStringA 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_receivableAccounts receivable objectReceivable ObjectThe related accounts receivable
voucherVoucher Object

The related voucher

Tip

Available from CRM.COM R14.0.0

typeFinancial transaction type objectThe financial transaction type of this refund
categoryFinancial transaction category objectThe category of the refund
refund_methodRefund method object

The refund method of the refund

Tip

Available from CRM.COM R13.0.0

rejection_reasonFinancial transaction rejection reason objectThe reason that the refund was rejected
payment_preferenceAccounts 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

Tip

Available from CRM.COM R13.0.0

accounting_period_informationAccounting Period Information object

The refund's accounting period information

Tip

Available from CRM.COM R10.0.0

currency_rate_periodCurrency Rate Period object

The refund's currency rate period

Tip

Available from CRM.COM R10.0.0

log_information

Log Information Object

The log information related with the retrieved refund

...

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
voucher_short
voucher_short

Include Page
financial_transaction_type_short
financial_transaction_type_short

Include Page
financial_transaction_category_short
financial_transaction_category_short

Include Page
refund_method_short
refund_method_short

Include Page
financial_transaction_rejection_reason_short
financial_transaction_rejection_reason_short

Include Page
accounts_receivable_payment_preference_short
accounts_receivable_payment_preference_short

Include Page
accounting_period_information_short
accounting_period_information_short

Include Page
currency_rate_period_short
currency_rate_period_short

Include Page
log_information_short
log_information_short