Xero Accounting Endpoint: PrepaymentsExpanded: Difference between revisions

No edit summary
No edit summary
 
(7 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 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 and has been processed.
:* '''AUTHORISED''': Indicates the transaction is authorised.
:* '''DELETED''': Indicates the transaction has been deleted.
:* '''PAID''': Indicates the transaction has been processed and paid.
:* '''VOIDED''': Indicates the transaction has been deleted.


;Contact
;Contact
Line 56: Line 57:


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


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


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


;RemainingCredit
;RemainingCredit
:A [[Field Type: Decimal|decimal value]] that provides the remaining credit that can be applied to other invoices.
: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 bank transaction.
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the transaction.


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


;HasAttachments
;HasAttachments
Line 77: Line 78:


;UpdatedDateUTC
;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this batch payment was created and/or updated.
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this prepayment was created and/or updated.




Line 96: Line 97:


;Amount
;Amount
:A [[Field Type: Decimal|decimal value]] that provides the amount associated with the payment.
:A [[Field Type: Decimal|decimal field]] that provides the amount associated with the payment.


;CurrencyRate
;CurrencyRate
:A [[Field Type: Decimal|decimal value]] that provides the exchange rate applicable.
:A [[Field Type: Decimal|decimal field]] that provides the exchange rate applicable.


;Reference
;Reference
Line 110: Line 111:


;Amount
;Amount
:A [[Field Type: Decimal|decimal value]] that provides the amount allocated to an invoice.
:A [[Field Type: Decimal|decimal field]] that provides the amount allocated to an invoice.


;Date
;Date
Line 116: Line 117:


;Invoice
;Invoice
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Endpoint: Invoices|invoice]] details.
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Invoices|invoice]] details.




Line 130: Line 131:


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


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


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


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


;AccountID
;AccountID
Line 173: Line 174:
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]]
:[[Xero Accounting Endpoint: BankTransactions|BankTransactions]]
:[[Xero Accounting Endpoint: BankTransactionsExpanded|BankTransactionsExpanded]]
:[[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 182: 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]]