For AI agents: visit https://developer.staxbill.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
| Property | Type` | Description |
|---|
paymentActivityId | Integer | The Fusebill generated ID of the associated payment activity for this refund. |
reference | String | A reference string intended to be the explanation of why this refund was issued. |
effectiveTimestamp | Timestamp | The effective timestamp of this refund |
description | String | A description of the refund e.g. "Refund of payment 218921" |
customerId | Integer | The Fusebill generated ID of the customer who is receiving the refund |
originalPaymentActivityId | Integer | The Fusebill generated ID of the payment activity for the original payment |
amount | Decimal | The total amount of the refund |
currency | 3 character ISO currency code | The currency the amount is measured in |
invoiceAllocations | List of Objects. Defined below | If the original payment was allocated across invoices this specifies how to allocate this refund across those invoices. |
gatewayFee | Decimal | The fee charged by the gateway |
settlement | Object. Defined below | Contains settlement details for the refund. Can be null |
id | Integer | The Fusebill generated ID that uniquely identifies this refund. |
uri | String | The full string path to this resource. |
| Property | Type | Description |
|---|
invoiceId | Integer | The Fusebill generated ID that uniquely identifies this invoice. |
invoiceNumber | Integer | The invoice number
 "title": |
amount | Decimal | The amount of the payment that was allocated to this invoice |
outstandingBalance | Decimal | The current outstanding balance of the invoice. Not the amount that was outstanding at the time of payment |
invoiceTotal | Decimal | The total of the invoice |
netsuiteId | String | The ID of this invoice in Netsuite |
quickBooksId | Number | The ID of this invoice in QuickBooks |
uri | String | The full string path to the invoice. |
| Property | Type | Description |
|---|
status | Enum: {Unknown, Pending, Successful, Failed} | The status of the settlement |
modifiedTimestamp | Timestamp | The last modified timestamp |
lastCheckedTimestamp | Timestamp | The last settlement check timestamp |
nextCheckTimestamp | Timestamp | The next settlement check timestamp |
message | String | The settlement status message |
