Difference between revisions of "Xero Accounting Endpoint: Prepayments"
Jump to navigation
Jump to search
(Created page with "== Overview == The Xero '''Prepayments''' endpoint provides the list of prepayments transactions recorded within Xero. This endpoint does not provide access to...") |
|||
| Line 5: | Line 5: | ||
This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many bank transactions. | This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many bank transactions. | ||
In most situations, it is recommended to use the [[Xero Accounting Endpoint: | In most situations, it is recommended to use the [[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]. It provides many additional fields and is also optimised for larger data files. | ||
Revision as of 23:54, 20 September 2021
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 bank transactions.
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 batch payment.
- 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 and has been processed.
- DELETED: 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 detailed payments associated with this prepayment.
- Allocations
- A table field that provides the invoices on which the prepayment was applied.
- Subtotal
- A decimal value that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal value that provides the tax amount of the transaction.
- Total
- A decimal value that provides the total amount of the transaction.
- RemainingCredit
- A decimal value that provides the remaining credit that can be applied to other invoices.
- CurrencyCode
- A text field that indicates the currency of the bank transaction.
- CurrencyRate
- A decimal value 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 batch payment was created and/or updated.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields