Refunds

The Refund Object

From the Refunds endpoint, you can retrieve a list of all refunds for a specified business.

FieldTypeDescription
idstring Identifier for the refund, unique to the business in the accounting service provider.
customerRefReference TypesReference to the customer the refund has been issued to.
accountRefReference TypesReference 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 TypesCurrency 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 decimalRate between the currency of the refund and the base currency of the business. Not applicable when multi-currency is not supported.
lines arrayAn array of refund lines.
subTotal
sortable, filterable
decimalValue of the refund, including discounts and excluding tax.
taxAmount
sortable, filterable
decimalAny tax applied to the refund amount.
discountAmountdecimalNumerical value of any discounts applied.
discountPercentagedecimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
totalAmount
sortable, filterable
decimalAmount of the refund, inclusive of tax.
memo stringUser-friendly reference for the refund.
shippingAddressReference TypesDelivery 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

FieldTypeDescription
descriptionstringFriendly name of the goods or services received.
unitAmountdecimalPrice of each unit of goods or services.
quantityintegerNumber of units of goods or services.
discountAmountdecimalNumerical value of any discounts applied.
discountPercentagedecimalPercentage rate (from 0 to 100) of any discounts applied to the unit amount.
subTotaldecimalAmount of the line, inclusive of discounts but exclusive of tax.
taxAmountdecimalAmount of tax for the line.
totalAmountdecimalTotal amount of the line, inclusive of discounts and tax.
accountRefReference TypesReference to the account to which the line item is linked to.
taxRateRefReference TypesReference to the tax rate to which the line item is linked to.
inventoryRefReference TypesReference to the product or inventory item to which the line item is linked to.
trackingCategoryRefReference TypesReference to the tracking category to which the line item is linked to.