Xero Accounting Endpoint: PrepaymentsExpanded: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (13 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
The Xero '''PrepaymentsExpanded''' [[Endpoints|endpoint]] provides the list of prepayments transactions recorded within Xero. | The Xero '''PrepaymentsExpanded''' [[Xero Accounting Endpoints|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. | This endpoints provides access to all fields and details. It is also optimised for larger data files. | ||
| Line 10: | Line 10: | ||
== Fields == | == Fields == | ||
The following fields are available for the | The following fields are available for the PrepaymentsExpanded endpoint. | ||
;PrepaymentID | ;PrepaymentID | ||
| Line 16: | Line 16: | ||
;Type | ;Type | ||
:A [[Field Type: Text|text field]] that indicates the type of | :A [[Field Type: Text|text field]] that indicates the type of prepayment. | ||
:Possible values are: | :Possible values are: | ||
:* '''RECEIVE-PREPAYMENT''': Indicates the prepayment is for accounts receivable / customer side. | :* '''RECEIVE-PREPAYMENT''': Indicates the prepayment is for accounts receivable / customer side. | ||
| Line 30: | Line 30: | ||
:A [[Field Type: Text|text field]] that indicates the status of the prepayment. | :A [[Field Type: Text|text field]] that indicates the status of the prepayment. | ||
:Possible values are: | :Possible values are: | ||
:* '''AUTHORISED''': Indicates the transaction is authorised | :* '''AUTHORISED''': Indicates the transaction is authorised. | ||
:* ''' | :* '''PAID''': Indicates the transaction has been processed and paid. | ||
:* '''VOIDED''': Indicates the transaction has been deleted. | |||
;Contact | ;Contact | ||
| Line 37: | Line 38: | ||
;Payments | ;Payments | ||
:A [[Field Type: Table|table field]] that provides the | :A [[Field Type: Table|table field]] that provides the payments information. | ||
:See [[#Payments Fields|Payments Fields]] for more information. | |||
;Allocations | ;Allocations | ||
:A [[Field Type: Table|table field]] that provides the [[ | :A [[Field Type: Table|table field]] that provides the amount allocated to the invoice. | ||
:See [[#Allocations Fields|Allocations Fields]] for more information. | |||
;LineAmountTypes | ;LineAmountTypes | ||
| Line 54: | Line 57: | ||
;Subtotal | ;Subtotal | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax exclusive amount of the transaction. | ||
;TotalTax | ;TotalTax | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax amount of the transaction. | ||
;Total | ;Total | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the total amount of the transaction. | ||
;RemainingCredit | ;RemainingCredit | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the remaining credit that can be applied to other invoices. | ||
;CurrencyCode | ;CurrencyCode | ||
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the | :A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the transaction. | ||
;CurrencyRate | ;CurrencyRate | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the exchange rate applied to the transaction. | ||
;HasAttachments | ;HasAttachments | ||
| Line 75: | Line 78: | ||
;UpdatedDateUTC | ;UpdatedDateUTC | ||
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this | :A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this prepayment was created and/or updated. | ||
== Payments Fields == | |||
The [[#Fields|Payments Fields]] include the following sub fields. | |||
;PaymentID | |||
:A [[Field Type: GUID|GUID field]] representing the internal id of a payment. | |||
:This field can be linked to the [[Xero Accounting Endpoint: Payments|Payments]] endpoint. | |||
;BatchPaymentID | |||
:A [[Field Type: GUID|GUID field]] representing the internal id of a batch payment. | |||
:This field can be linked to the [[Xero Accounting Endpoint: BatchPayments|BatchPayments]] endpoint. | |||
;Date | |||
:A [[Field Type: Date|date field]] that provides the date on which the link occurred. | |||
;Amount | |||
:A [[Field Type: Decimal|decimal field]] that provides the amount associated with the payment. | |||
;CurrencyRate | |||
:A [[Field Type: Decimal|decimal field]] that provides the exchange rate applicable. | |||
;Reference | |||
:A [[Field Type: Text|text field]] that provides the reference. | |||
== Allocations Fields == | |||
The [[#Fields|Allocations Fields]] include the following sub fields. | |||
;Amount | |||
:A [[Field Type: Decimal|decimal field]] that provides the amount allocated to an invoice. | |||
;Date | |||
:A [[Field Type: Date|date field]] that provides the date on which the amount was allocated to an invcoice. | |||
;Invoice | |||
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Invoices|invoice]] details. | |||
| Line 90: | Line 131: | ||
;Quantity | ;Quantity | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the quantity entered on the line. | ||
;UnitAmount | ;UnitAmount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the unit amount of the line. | ||
;LineAmount | ;LineAmount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount of the line. | ||
;TaxAmount | ;TaxAmount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the tax amount of the line. | ||
;AccountID | ;AccountID | ||
| Line 124: | Line 165: | ||
:[[Xero Accounting Field: Contacts|Contacts]] | :[[Xero Accounting Field: Contacts|Contacts]] | ||
:[[Xero Accounting Field: Invoices|Invoices]] | :[[Xero Accounting Field: Invoices|Invoices]] | ||
:[[Xero Accounting Field: TaxTypes|TaxTypes]] | :[[Xero Accounting Field: TaxTypes|TaxTypes]] | ||
:[[Xero Accounting Field: TrackingCategories|TrackingCategories]] | :[[Xero Accounting Field: TrackingCategories|TrackingCategories]] | ||
| Line 132: | Line 172: | ||
:[[Xero Accounting Endpoint: Accounts|Accounts]] | :[[Xero Accounting Endpoint: Accounts|Accounts]] | ||
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]] | |||
:[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]] | |||
:[[Xero Accounting Endpoint: BatchPayments|BatchPayments]] | |||
:[[Xero Accounting Endpoint: Contacts|Contacts]] | :[[Xero Accounting Endpoint: Contacts|Contacts]] | ||
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | :[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]] | ||
| Line 141: | Line 184: | ||
:[[Xero Accounting Endpoint: TaxRates|TaxRates]] | :[[Xero Accounting Endpoint: TaxRates|TaxRates]] | ||
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] | :[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]] | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||
Latest revision as of 00:20, 22 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 PrepaymentsExpanded 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.
- 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 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.
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 field that provides the quantity entered on the line.
- UnitAmount
- A decimal field that provides the unit amount of the line.
- LineAmount
- A decimal field that provides the amount of the line.
- TaxAmount
- A decimal field 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
Related Endpoints
- Accounts
- BankTransactions
- BankTransactionsExpanded
- BatchPayments
- Contacts
- ContactsExpanded
- Currencies
- Invoices
- InvoicesExpanded
- Payments
- Prepayments
- TaxRates
- TrackingCategories