CustomerRefund
Represents refund transactions issued to customers, including payment method, currency amounts, exchange rate details, and reconciliation information.
Columns
| Name | Type | ReadOnly | Description |
| auditCreatedDateTime | Datetime | True |
The date and time when the customer refund was created. |
| auditModifiedDateTime | Datetime | True |
The date and time when the customer refund was last modified. |
| bankReconciliationDate | Date | False |
The date on which this customer refund was reconciled with the bank. |
| bankReconciliationStatus | String | False |
The bank reconciliation status of this customer refund, such as cleared or uncleared. |
| baseCurrencyCurrency | String | False |
The base currency used for this customer refund. |
| baseCurrencyRefundAmount | Decimal | False |
The refund amount in the base currency. |
| baseCurrencyTotalDue | Decimal | True |
The total amount due in the base currency for this customer refund. |
| baseCurrencyTotalPaid | Decimal | True |
The total amount paid in the base currency for this customer refund. |
| baseCurrencyTotalSelected | Decimal | True |
The total amount selected for application in the base currency for this customer refund. |
| customer_Href | String | True |
The URL of the customer associated with this refund. |
| customer_Id | String | False |
The Id of the customer associated with this refund. |
| customer_Key | String | False |
The system-assigned key of the customer associated with this refund. |
| customer_Name | String | True |
The name of the customer associated with this refund. |
| description | String | False |
The description of the customer refund. |
| documentNumber | String | False |
The document number associated with this customer refund. |
| entity_Href | String | True |
The URL of the entity associated with this customer refund. |
| entity_Id | String | True |
The Id of the entity associated with this customer refund. |
| entity_Key | String | True |
The system-assigned key of the entity associated with this customer refund. |
| entity_Name | String | True |
The name of the entity associated with this customer refund. |
| exchangeRateDate | Date | True |
The date used to determine the exchange rate for this customer refund. |
| exchangeRateRate | Decimal | True |
The exchange rate applied to convert the transaction currency to the base currency. |
| exchangeRateTypeId | String | True |
The Id of the exchange rate type used for this customer refund. |
| financialEntity_Href | String | True |
The URL of the financial entity associated with this customer refund. |
| financialEntity_Id | String | False |
The Id of the financial entity associated with this customer refund. |
| financialEntity_Key | String | False |
The system-assigned key of the financial entity associated with this customer refund. |
| href | String | True |
The URL of the customer refund resource. |
| id | String | True |
The unique identifier of the customer refund. |
| key [KEY] | String | True |
The system-assigned key that uniquely identifies the customer refund record. |
| payToId | String | False |
The Id of the contact to whom the refund is paid. |
| payToKey | String | False |
The system-assigned key of the contact to whom the refund is paid. |
| paymentDate | Date | False |
The date on which the refund payment was issued. |
| paymentMethod | String | False |
The payment method used to issue this customer refund, such as check or ACH. |
| refundDate | Date | False |
The date of the customer refund. |
| refundSummary_Href | String | True |
The URL of the refund summary associated with this customer refund. |
| refundSummary_Id | String | False |
The Id of the refund summary associated with this customer refund. |
| refundSummary_Key | String | False |
The system-assigned key of the refund summary associated with this customer refund. |
| refundSummary_Name | String | False |
The name of the refund summary associated with this customer refund. |
| state | String | False |
The current state of this customer refund, such as draft, pending, or posted. |
| txnCurrencyCurrency | String | False |
The transaction currency used for this customer refund. |
| txnCurrencyRefundAmount | Decimal | False |
The refund amount in the transaction currency. |
| txnCurrencyTotalDue | Decimal | True |
The total amount due in the transaction currency for this customer refund. |
| txnCurrencyTotalPaid | Decimal | True |
The total amount paid in the transaction currency for this customer refund. |
| txnCurrencyTotalSelected | Decimal | True |
The total amount selected for application in the transaction currency for this customer refund. |
| ListAggregate_Lines | String | False |
The aggregate list of line items associated with this customer refund. |
| ListAggregate_RefundDetails | String | False |
The aggregate list of refund detail records associated with this customer refund. |