The Invoice Payments object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Invoice Payments endpoint, you can retrieve a list of all invoice payments for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the invoice payment, unique for the business in the accounting service. |
| customerRef | Reference Types | Reference to the customer against which the payment is created. |
| accountRef | Reference Types | Reference to the account or bank account the invoice payment is linked to. Pushing data requires a valid bank account reference. Query Accounts and use the id parameter of an account with isBankAccount=true as a value. For Xero, use nomincalCode parameter. |
| totalAmount sortable, filterable | decimal | Amount of the invoice payment. |
| currency | string | ISO-4217 currency code of the invoice payment. |
| currencyRate | decimal | Rate to convert the total amount of the transaction into the base currency for the business at the time of the transaction. |
| date sortable, filterable | string See Date | Date the invoice payment was recorded in the accounting service. |
| paymentMethod sortable, filterable | string | Payment method used. |
| memo | string | Any additional information or business notes about the invoice payment. |
| lines | array | An array of invoice payment lines. |
| sourceModifiedDate sortable, filterable | string See Date | Date the record was last changed in the accounting service provider. |
Lines
| Field | Type | Descirption |
|---|---|---|
| amount sortable, filterable | decimal | Any additional information or business notes about the invoice payment. |
| links | object | Invoice payment linked transactions. |
| allocatedOnDate sortable, filterable | string See Date | Date the payment line was allocated on. |
Links
| Field | Type | Description |
|---|---|---|
| type sortable, filterable | string | Types of links to invoice payment lines. Valid values:invoicepaymentpaymentOnAccountcreditNoterefund |
| id sortable, filterable | string | Unique identifier of the transaction represented by the link. |