Xero Accounting Endpoint: Prepayments: 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 '''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 | 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. | 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 | ;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 31: | Line 31: | ||
: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 46: | Line 47: | ||
;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 67: | Line 68: | ||
;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. | ||
| Line 86: | Line 87: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount associated with the payment. | ||
;CurrencyRate | ;CurrencyRate | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the exchange rate applicable. | ||
;Reference | ;Reference | ||
| Line 100: | Line 101: | ||
;Amount | ;Amount | ||
:A [[Field Type: Decimal|decimal | :A [[Field Type: Decimal|decimal field]] that provides the amount allocated to an invoice. | ||
;Date | ;Date | ||
| Line 106: | Line 107: | ||
;Invoice | ;Invoice | ||
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting | :A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Invoices|invoice]] details. | ||
| Line 126: | Line 127: | ||
:[[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 133: | Line 135: | ||
:[[Xero Accounting Endpoint: Payments|Payments]] | :[[Xero Accounting Endpoint: Payments|Payments]] | ||
:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] | :[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] | ||
== Related Topics == | |||
:[[Xero Accounting Models]] | |||
:[[Xero Accounting Endpoints]] | |||