The Refund Object
From the Refunds endpoint, you can retrieve a list of all refunds for a specified business.
Field | Type | Description |
---|---|---|
id | string | Identifier for the refund, unique to the business in the accounting service provider. |
customerRef | Reference Types | Reference to the customer the refund has been issued to. |
accountRef | Reference Types | Reference to the account to which the refund is linked to. |
date sortable, filterable | string See Date | Date of the refund as recorded in the accounting service provider. |
currencyRef | Reference Types | Currency of the refund. Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency. |
currencyRate | decimal | Rate between the currency of the refund and the base currency of the business. Not applicable when multi-currency is not supported. |
lines | array | An array of refund lines. |
subTotal sortable, filterable | decimal | Value of the refund, including discounts and excluding tax. |
taxAmount sortable, filterable | decimal | Any tax applied to the refund amount. |
discountAmount | decimal | Numerical value of any discounts applied. |
discountPercentage | decimal | Percentage rate (from 0 to 100) of any discounts applied to the unit amount. |
totalAmount sortable, filterable | decimal | Amount of the refund, inclusive of tax. |
memo | string | User-friendly reference for the refund. |
shippingAddress | Reference Types | Delivery for any goods that have been ordered. |
sourceModifiedDate sortable, filterable | string See Date | Date the record was last changed in the accounting service provider. |
Lines
Field | Type | Description |
---|---|---|
description | string | Friendly name of the goods or services received. |
unitAmount | decimal | Price of each unit of goods or services. |
quantity | integer | Number of units of goods or services. |
discountAmount | decimal | Numerical value of any discounts applied. |
discountPercentage | decimal | Percentage rate (from 0 to 100) of any discounts applied to the unit amount. |
subTotal | decimal | Amount of the line, inclusive of discounts but exclusive of tax. |
taxAmount | decimal | Amount of tax for the line. |
totalAmount | decimal | Total amount of the line, inclusive of discounts and tax. |
accountRef | Reference Types | Reference to the account to which the line item is linked to. |
taxRateRef | Reference Types | Reference to the tax rate to which the line item is linked to. |
inventoryRef | Reference Types | Reference to the product or inventory item to which the line item is linked to. |
trackingCategoryRef | Reference Types | Reference to the tracking category to which the line item is linked to. |