Xero Accounting Endpoint: PrepaymentsExpanded: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 146: | Line 146: | ||
:[[Xero Accounting Endpoint: Accounts|Accounts]] | :[[Xero Accounting Endpoint: Accounts|Accounts]] | ||
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]] | |||
:[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]] | |||
:[[Xero Accounting Endpoint: Contacts|Contacts]] | :[[Xero Accounting Endpoint: Contacts|Contacts]] | ||
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | :[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | ||
Revision as of 00:01, 21 September 2021
Overview
The Xero PrepaymentsExpanded endpoint provides the list of prepayments transactions recorded within Xero.
This endpoints provides access to all fields and details. It is also optimised for larger data files.
In most situations, it is recommended to use this endpoint instead of the Prepayments endpoint.
Fields
The following fields are available for the BatchPayments 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 amount allocated to the invoice.
- See Allocations Fields for more information.
- LineAmountTypes
- A text field that indicates the type of values on the lines.
- Possible values are:
- Exclusive: Indicates that line items are exclusive of tax.
- Inclusive: Indicates that line items are inclusive tax.
- NoTax: Indicates that line items have no tax.
- LineItems
- A table field that provides the invoice-like lines entered against the prepayment.
- See LineItems Fields for more information.
- 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.
Allocations Fields
The Allocations Fields include the following sub fields.
- Amount
- A decimal value 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.
LineItems Fields
The LineItems Fields include the following sub fields.
- LineItemID
- A text field that provides the internal id of the line.
- Description
- A text field that provides the description of the line.
- Quantity
- A decimal value that provides the quantity entered on the line.
- UnitAmount
- A decimal value that provides the unit amount of the line.
- LineAmount
- A decimal value that provides the amount of the line.
- TaxAmount
- A decimal value that provides the tax amount of the line.
- AccountID
- A text field that provides the account id of the line.
- AccountCode
- A text field that provides the account code of the line.
- TaxType
- A text field that provides the tax type of the line.
- Tracking
- A table field that provides the tracking category options assigned to the line.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields