View source for Xero Accounting Endpoint: PrepaymentsExpanded

== Overview ==

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.

In most situations, it is recommended to use this endpoint instead of the [[Xero  Accounting Endpoint: Prepayments|Prepayments]] endpoint.


== Fields ==

The following fields are available for the PrepaymentsExpanded endpoint.

;PrepaymentID
:A [[Field Type: GUID|guid field]] that provides the id of the prepayment.

;Type
:A [[Field Type: Text|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 [[Field Type: Text|text field]] that provides the reference of the prepayment.

;Date
:A [[Field Type: Date|date field]] that provides the date on which the prepayment occurred.

;Status
:A [[Field Type: Text|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 [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Contacts|Contacts]] associated with the prepayment.

;Payments
:A [[Field Type: Table|table field]] that provides the payments information.
:See [[#Payments Fields|Payments Fields]] for more information.

;Allocations
:A [[Field Type: Table|table field]] that provides the amount allocated to the invoice.
:See [[#Allocations Fields|Allocations Fields]] for more information.

;LineAmountTypes
:A [[Field Type: Text|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 [[Field Type: Table|table field]] that provides the invoice-like lines entered against the prepayment.
:See [[#LineItems Fields|LineItems Fields]] for more information.

;Subtotal
:A [[Field Type: Decimal|decimal field]] that provides the tax exclusive amount of the transaction.

;TotalTax
:A [[Field Type: Decimal|decimal field]] that provides the tax amount of the transaction.

;Total
:A [[Field Type: Decimal|decimal field]] that provides the total amount of the transaction.

;RemainingCredit
:A [[Field Type: Decimal|decimal field]] that provides the remaining credit that can be applied to other invoices.

;CurrencyCode
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the transaction.

;CurrencyRate
:A [[Field Type: Decimal|decimal field]] that provides the exchange rate applied to the transaction.

;HasAttachments
:A [[Field Type: Boolean|true/false field]] that indicates if attachments were uploaded against the transaction.

;UpdatedDateUTC
: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.


== LineItems Fields ==

The [[#Fields|LineItems Fields]] include the following sub fields.

;LineItemID
:A [[Field Type: Text|text field]] that provides the internal id of the line.

;Description
:A [[Field Type: Text|text field]] that provides the description of the line.

;Quantity
:A [[Field Type: Decimal|decimal field]] that provides the quantity entered on the line.

;UnitAmount
:A [[Field Type: Decimal|decimal field]] that provides the unit amount of the line.

;LineAmount
:A [[Field Type: Decimal|decimal field]] that provides the amount of the line.

;TaxAmount
:A [[Field Type: Decimal|decimal field]] that provides the tax amount of the line.

;AccountID
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account id]] of the line.

;AccountCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line.

;TaxType
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Field: TaxTypes|tax type]] of the line.

;Tracking
:A [[Field Type: Table|table field]] that provides the [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] assigned to the line.


== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/prepayments Xero API].


== Related Fields ==

:[[Xero Accounting Field: Accounts|Accounts]]
:[[Xero Accounting Field: Contacts|Contacts]]
:[[Xero Accounting Field: Invoices|Invoices]]
:[[Xero Accounting Field: TaxTypes|TaxTypes]]
:[[Xero Accounting Field: TrackingCategories|TrackingCategories]]


== Related Endpoints ==

:[[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: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
:[[Xero Accounting Endpoint: Payments|Payments]]
:[[Xero Accounting Endpoint: Prepayments|Prepayments]]
:[[Xero Accounting Endpoint: TaxRates|TaxRates]]
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]


== Related Topics ==

:[[Xero Accounting Models]]
:[[Xero Accounting Endpoints]]