The Refund object
From the Refunds endpoint, you can retrieve a list of all refunds for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the refund, unique for the business in the accounting service. |
| customerRef | Reference Types | Reference to the customer that was refunded. |
| bankAccountRef | Reference Types | Reference to the account from which payment money is refunded. Query the Chart of Accounts endpoint to determine the appropriate Account object for this reference, where isBankAccount is true. |
| postedDate sortable, filterable | string See Date | Date on which the refund was posted to the accounting service, and had an impact on the general ledger. This may be different from the creation date. |
| currency | string | ISO-4217 currency code of the refund. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| lines | array | An array of refund line items. |
| totalDiscount sortable, filterable | decimal | Total amount of discounts applied to the refund. |
| discountPercentage sortable, filterable | decimal | Discount percentage applied to the refund. |
| subTotal sortable, filterable | decimal | Amount of the refund, inclusive of discounts but exclusive of tax. |
| taxAmount sortable, filterable | decimal | Amount of tax on the refund. |
| totalAmount sortable, filterable | decimal | Total amount of the refund, inclusive of tax. |
| memo | string | Any additional information or business notes about the refund. |
| sourceModifiedDate sortable, filterable | string See Date | The date on which this record was last modified in the accounting service. |
Lines
| Field | Type | Description |
|---|---|---|
| description | string | Description of the line item. |
| unitAmount sortable, filterable | decimal | Line item unit amount. |
| quantity sortable, filterable | integer | Line item quantity. |
| discountAmount sortable, filterable | decimal | Line item discount amount. |
| discountPercentage sortable, filterable | decimal | Line item discount percentage. |
| taxAmount sortable, filterable | decimal | Line item tax amount. |
| amount sortable, filterable | decimal | Line item total amount, inclusive of discounts & tax. |
| links sortable, filterable | string | Refunds linked invoices. |
| accountRef | Reference Types | Reference to the account the line item is linked to. |
| taxRateRef | Reference Types | Reference to the tax rate the line item is linked to. |
| inventoryRef | Reference Types | Reference to the product or inventory the line item is linked to. |
| trackingCategoryRefs | Reference Types | Reference to the tracking categories associated with this line item, e.g. classes or departments. |
Links
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Unique identifier of the invoice represented by the link. |