Xero Accounting Endpoint: InvoicesExpanded: Difference between revisions

(9 intermediate revisions by the same user not shown)

Line 1:

== Overview ==

The Xero '''InvoicesExpanded''' [[Endpoints|endpoint]] provides the list of invoices (both sales and purchases) recorded within Xero.

The Xero '''InvoicesExpanded''' [[Xero Accounting Endpoints|endpoint]] provides the list of invoices (both sales and purchases) 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: Invoices|Invoices]] endpoint.

Note that an alternate endpoint named [[Xero Accounting Endpoint: InvoicesExpandedTable|InvoicesExpandedTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.

Line 11:

Line 13:

The following fields are available for the InvoicesExpanded endpoint.

;DataFile

:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record.

;InvoiceID

Line 85:

Line 90:

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

;AmountDue

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total amount due.

:A [[Field Type: Decimal|decimal field]] that provides the total amount due.

;AmountPaid

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total amount paid.

:A [[Field Type: Decimal|decimal field]] that provides the total amount paid.

;AmountCredited

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total amount credited.

:A [[Field Type: Decimal|decimal field]] that provides the total amount credited.

;CurrencyCode

Line 106:

Line 111:

;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 115:

Line 120:

;CISDeduction

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the CIS deduction amount (UK only).

:A [[Field Type: Decimal|decimal field]] that provides the CIS deduction amount (UK only).

;RepeatingInvoiceID

Line 137:

Line 142:

;LineItemID

:A [[Field Type: GUID|guid field]] that provides an ID for the line.

:This field can be linked with the [[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]] endpoint to determine how billable expenses on purchase invoices are applied to sales invoices.

;Description

Line 142:

Line 148:

;Quantity

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the quantity of the line.

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

;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

: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

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

;DiscountRate

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the discount rate applied to the line.

:A [[Field Type: Decimal|decimal field]] that provides the discount rate applied to the line.

;AccountID

:A [[Field Type: GUID|guid 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.

;Item

:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Endpoint: Items|item]] of the line.

;ItemCode

:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item code]] of the line.

:''This field is provided for backwards compatibility purposes only.''

;TaxType

Line 186:

Line 199:

;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

: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

Line 207:

Line 220:

;AppliedAmount

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the amount applied to the invoice.

:A [[Field Type: Decimal|decimal field]] that provides the amount applied to the invoice.

;Date

Line 213:

Line 226:

;Total

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total amount of the credit note.

:A [[Field Type: Decimal|decimal field]] that provides the total amount of the credit note.

Line 225:

Line 238:

;AppliedAmount

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the amount applied to the invoice.

:A [[Field Type: Decimal|decimal field]] that provides the amount applied to the invoice.

;Date

Line 231:

Line 244:

;Total

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total amount of the prepayment.

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

Line 243:

Line 256:

;AppliedAmount

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the amount applied to the invoice.

:A [[Field Type: Decimal|decimal field]] that provides the amount applied to the invoice.

;Date

Line 249:

Line 262:

;Total

:A [[Field Type: Decimal|decimal ~~value~~]] that provides the total amount of the overpayment.

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

Line 275:

Line 288:

:[[Xero Accounting Endpoint: Items|Items]]

:[[Xero Accounting Endpoint: Invoices|Invoices]]

:[[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]]

:[[Xero Accounting Endpoint: Overpayments|Overpayments]]

:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]

Line 280:

Line 294:

:[[Xero Accounting Endpoint: Prepayments|Prepayments]]

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

:[[Xero Projects Endpoint: Projects|Projects]]

:[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]]

:[[Xero Accounting Endpoint: Quotes|Quotes]]

:[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]]

:[[Xero Accounting Endpoint: TaxRates|TaxRates]]

:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The Xero '''InvoicesExpanded''' [[Endpoints|endpoint]] provides the list of invoices (both sales and purchases) recorded within Xero.
+The Xero '''InvoicesExpanded''' [[Xero Accounting Endpoints|endpoint]] provides the list of invoices (both sales and purchases) 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: Invoices|Invoices]] endpoint.
+Note that an alternate endpoint named [[Xero Accounting Endpoint: InvoicesExpandedTable|InvoicesExpandedTable]] is available which provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.
@@ Line 11: / Line 13: @@
 The following fields are available for the InvoicesExpanded endpoint.
+;DataFile
+:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record.
 ;InvoiceID
@@ Line 85: / Line 90: @@
 ;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.
 ;AmountDue
-:A [[Field Type: Decimal|decimal value]] that provides the total amount due.
+:A [[Field Type: Decimal|decimal field]] that provides the total amount due.
 ;AmountPaid
-:A [[Field Type: Decimal|decimal value]] that provides the total amount paid.
+:A [[Field Type: Decimal|decimal field]] that provides the total amount paid.
 ;AmountCredited
-:A [[Field Type: Decimal|decimal value]] that provides the total amount credited.
+:A [[Field Type: Decimal|decimal field]] that provides the total amount credited.
 ;CurrencyCode
@@ Line 106: / Line 111: @@
 ;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 115: / Line 120: @@
 ;CISDeduction
-:A [[Field Type: Decimal|decimal value]] that provides the CIS deduction amount (UK only).
+:A [[Field Type: Decimal|decimal field]] that provides the CIS deduction amount (UK only).
 ;RepeatingInvoiceID
@@ Line 137: / Line 142: @@
 ;LineItemID
 :A [[Field Type: GUID|guid field]] that provides an ID for the line.
+:This field can be linked with the [[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]] endpoint to determine how billable expenses on purchase invoices are applied to sales invoices.
 ;Description
@@ Line 142: / Line 148: @@
 ;Quantity
-:A [[Field Type: Decimal|decimal value]] that provides the quantity of the line.
+:A [[Field Type: Decimal|decimal field]] that provides the quantity of the line.
 ;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
-: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
-: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.
 ;DiscountRate
-:A [[Field Type: Decimal|decimal value]] that provides the discount rate applied to the line.
+:A [[Field Type: Decimal|decimal field]] that provides the discount rate applied to the line.
+;AccountID
+:A [[Field Type: GUID|guid 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.
+;Item
+:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Endpoint: Items|item]] of the line.
 ;ItemCode
 :A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item code]] of the line.
+:''This field is provided for backwards compatibility purposes only.''
 ;TaxType
@@ Line 186: / Line 199: @@
 ;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
-: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
@@ Line 207: / Line 220: @@
 ;AppliedAmount
-:A [[Field Type: Decimal|decimal value]] that provides the amount applied to the invoice.
+:A [[Field Type: Decimal|decimal field]] that provides the amount applied to the invoice.
 ;Date
@@ Line 213: / Line 226: @@
 ;Total
-:A [[Field Type: Decimal|decimal value]] that provides the total amount of the credit note.
+:A [[Field Type: Decimal|decimal field]] that provides the total amount of the credit note.
@@ Line 225: / Line 238: @@
 ;AppliedAmount
-:A [[Field Type: Decimal|decimal value]] that provides the amount applied to the invoice.
+:A [[Field Type: Decimal|decimal field]] that provides the amount applied to the invoice.
 ;Date
@@ Line 231: / Line 244: @@
 ;Total
-:A [[Field Type: Decimal|decimal value]] that provides the total amount of the prepayment.
+:A [[Field Type: Decimal|decimal field]] that provides the total amount of the prepayment.
@@ Line 243: / Line 256: @@
 ;AppliedAmount
-:A [[Field Type: Decimal|decimal value]] that provides the amount applied to the invoice.
+:A [[Field Type: Decimal|decimal field]] that provides the amount applied to the invoice.
 ;Date
@@ Line 249: / Line 262: @@
 ;Total
-:A [[Field Type: Decimal|decimal value]] that provides the total amount of the overpayment.
+:A [[Field Type: Decimal|decimal field]] that provides the total amount of the overpayment.
@@ Line 275: / Line 288: @@
 :[[Xero Accounting Endpoint: Items|Items]]
 :[[Xero Accounting Endpoint: Invoices|Invoices]]
+:[[Xero Accounting Endpoint: LinkedTransactions|LinkedTransactions]]
 :[[Xero Accounting Endpoint: Overpayments|Overpayments]]
 :[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]
@@ Line 280: / Line 294: @@
 :[[Xero Accounting Endpoint: Prepayments|Prepayments]]
 :[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]
+:[[Xero Projects Endpoint: Projects|Projects]]
+:[[Xero Accounting Endpoint: PurchaseOrders|PurchaseOrders]]
+:[[Xero Accounting Endpoint: Quotes|Quotes]]
 :[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]]
 :[[Xero Accounting Endpoint: TaxRates|TaxRates]]
 :[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]