Xero Accounting Endpoint: Prepayments
Overview
The Xero Prepayments endpoint provides the list of prepayments transactions recorded within Xero.
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many prepayments.
In most situations, it is recommended to use the PrepaymentsExpanded. It provides many additional fields and is also optimised for larger data files.
Fields
The following fields are available for the Prepayments endpoint.
- PrepaymentID
- A guid field that provides the id of the prepayment.
- Type
- A text field that indicates the type of prepayment.
- Possible values are:
- RECEIVE-PREPAYMENT: Indicates the prepayment is for accounts receivable / customer side.
- SPEND-PREPAYMENT: Indicates the prepayment is for accounts payable / supplier side.
- Reference
- A text field that provides the reference of the prepayment.
- Date
- A date field that provides the date on which the prepayment occurred.
- Status
- A text field that indicates the status of the prepayment.
- Possible values are:
- AUTHORISED: Indicates the transaction is authorised.
- PAID: Indicates the transaction has been processed and paid.
- VOIDED: Indicates the transaction has been deleted.
- Contact
- A record field that provides the Contacts associated with the prepayment.
- Payments
- A table field that provides the payments information.
- See Payments Fields for more information.
- Allocations
- A table field that provides the amount allocated to the invoice.
- See Allocations Fields for more information.
- Subtotal
- A decimal field that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal field that provides the tax amount of the transaction.
- Total
- A decimal field that provides the total amount of the transaction.
- RemainingCredit
- A decimal field that provides the remaining credit that can be applied to other invoices.
- CurrencyCode
- A text field that indicates the currency of the transaction.
- CurrencyRate
- A decimal field that provides the exchange rate applied to the transaction.
- HasAttachments
- A true/false field that indicates if attachments were uploaded against the transaction.
- UpdatedDateUTC
- A date time field that indicates the date and time this prepayment was created and/or updated.
Payments Fields
The Payments Fields include the following sub fields.
- PaymentID
- A GUID field representing the internal id of a payment.
- This field can be linked to the Payments endpoint.
- BatchPaymentID
- A GUID field representing the internal id of a batch payment.
- This field can be linked to the BatchPayments endpoint.
- Date
- A date field that provides the date on which the link occurred.
- Amount
- A decimal field that provides the amount associated with the payment.
- CurrencyRate
- A decimal field that provides the exchange rate applicable.
- Reference
- A text field that provides the reference.
Allocations Fields
The Allocations Fields include the following sub fields.
- Amount
- A decimal field that provides the amount allocated to an invoice.
- Date
- A date field that provides the date on which the amount was allocated to an invcoice.
- Invoice
- A record field that provides the invoice details.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- BankTransactions
- BankTransactionsExpanded
- BatchPayments
- Contacts
- ContactsExpanded
- Currencies
- Invoices
- InvoicesExpanded
- Payments
- PrepaymentsExpanded