Refund Object

Refund Object Fields

paymentActivityIdIntegerThe Fusebill generated ID of the associated payment activity for this refund.

[Read Only]
referenceStringA reference string intended to be the explanation of why this refund was issued. [Max Length: 500 characters]
effectiveTimestampTimestampThe effective timestamp of this refund
descriptionStringA description of the refund e.g. "Refund of payment 218921 "
customerIdIntegerThe Fusebill generated ID of the customer who is receiving the refund

[Read Only]
originalPaymentActivityIdIntegerThe Fusebill generated ID of the payment activity for the original payment
[Read Only]
amountDecimalThe total amount of the refund
currency3 character ISO currency codeThe currency the amount is measured in
invoiceAllocationsList of Objects. Defined belowIf the original payment was allocated across invoices this specifies how to allocate this refund across those invoices.
gatewayFeeDecimalThe fee charged by the gateway
settlementObject. Defined belowContains settlement details for the refund. Can be null
idIntegerThe Fusebill generated ID that uniquely identifies this refund
[Read Only]
uriStringThe full string path to this resource
[Read Only]

Invoice Allocation Fields

invoiceIdIntegerThe Fusebill generated ID that uniquely identifies this invoice
[Read Only]
invoiceNumberIntegerThe invoice number
[Read Only]
amountDecimalThe amount of the payment that was allocated to this invoice
outstandingBalanceDecimalThe current outstanding balance of the invoice. Not the amount that was outstanding at the time of payment
invoiceTotalDecimalThe total of the invoice
netsuiteIdStringThe ID of this invoice in Netsuite
quickBooksIdNumberThe ID of this invoice in QuickBooks
uriStringThe full string path to the invoice
[Read Only]

Settlement Object

statusEnum: {Unknown, Pending, Successful, Failed}The status of the settlement
modifiedTimestampTimestampThe last modified timestamp
lastCheckedTimestampTimestampThe last settlement check timestamp
nextCheckTimestampTimestampThe next settlement check timestamp
messageStringThe settlement status message