Xero Accounting Endpoint: Prepayments: Difference between revisions

(10 intermediate revisions by the same user not shown)

Line 1:

== Overview ==

The Xero '''Prepayments''' [[Endpoints|endpoint]] provides the list of prepayments transactions recorded within Xero.

The Xero '''Prepayments''' [[Xero Accounting Endpoints|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~~.

This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many prepayments.

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.

Line 17:

;Type

:A [[Field Type: Text|text field]] that indicates the type of ~~batch payment~~.

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

Line 31:

:A [[Field Type: Text|text field]] that indicates the status of the prepayment.

: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

Line 38:

Line 39:

;Payments

:A [[Field Type: Table|table field]] that provides the ~~detailed~~ [[~~Xero Accounting Field:~~ Payments|~~payments~~]] ~~associated with this prepayment~~.

: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 [[~~Xero Accounting Field: Invoices~~|~~invoices~~]] ~~on which the prepayment was applied~~.

:A [[Field Type: Table|table field]] that provides the amount allocated to the invoice.

:See [[#Allocations Fields|Allocations Fields]] for more information.

;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

: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

: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

: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

: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

: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

Line 65:

Line 68:

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

== 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 78:

Line 120:

:[[Xero Accounting Field: Contacts|Contacts]]

:[[Xero Accounting Field: Invoices|Invoices]]

~~:[[Xero Accounting Field: Payments|Payments]]~~

Line 84:

Line 125:

:[[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]]

Line 91:

Line 135:

:[[Xero Accounting Endpoint: Payments|Payments]]

:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The Xero '''Prepayments''' [[Endpoints|endpoint]] provides the list of prepayments transactions recorded within Xero.
+The Xero '''Prepayments''' [[Xero Accounting Endpoints|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.
+This endpoint does not provide access to all fields and details. It is optimised for small data files that do not have many prepayments.
 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.
@@ Line 17: / Line 17: @@
 ;Type
-:A [[Field Type: Text|text field]] that indicates the type of batch payment.
+: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.
@@ Line 31: / Line 31: @@
 :A [[Field Type: Text|text field]] that indicates the status of the prepayment.
 :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
@@ Line 38: / Line 39: @@
 ;Payments
-:A [[Field Type: Table|table field]] that provides the detailed [[Xero Accounting Field: Payments|payments]] associated with this prepayment.
+: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 [[Xero Accounting Field: Invoices|invoices]] on which the prepayment was applied.
+:A [[Field Type: Table|table field]] that provides the amount allocated to the invoice.
+:See [[#Allocations Fields|Allocations Fields]] for more information.
 ;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
-: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
-: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
-: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
-: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
-: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
@@ Line 65: / Line 68: @@
 ;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.
+== 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 78: / Line 120: @@
 :[[Xero Accounting Field: Contacts|Contacts]]
 :[[Xero Accounting Field: Invoices|Invoices]]
-:[[Xero Accounting Field: Payments|Payments]]
@@ Line 84: / Line 125: @@
 :[[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]]
@@ Line 91: / Line 135: @@
 :[[Xero Accounting Endpoint: Payments|Payments]]
 :[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]