Xero Accounting Endpoint: CreditNotesExpanded: Difference between revisions

(9 intermediate revisions by the same user not shown)

Line 1:

== Overview ==

The Xero '''CreditNotesExpanded''' [[Endpoints|endpoint]] provides the list of credit notes recorded within Xero.

The Xero '''CreditNotesExpanded''' [[Xero Accounting Endpoints|endpoint]] provides the list of credit notes 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: CreditNotes|CreditNotes]] endpoint.

Note that an alternate endpoint named [[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]] 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 CreditNotesExpanded endpoint.

;DataFile

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

;CreditNoteID

Line 61:

Line 66:

;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

Line 76:

Line 81:

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

;BrandingThemeID

Line 96:

Line 101:

;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

Line 108:

Line 113:

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

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

Line 122:

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

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

Line 174:

:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]

:[[Xero Accounting Endpoint: CreditNotes|CreditNotes]]

:[[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]]

:[[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]]

:[[Xero Accounting Endpoint: Currencies|Currencies]]

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

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

:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]

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

:[[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 '''CreditNotesExpanded''' [[Endpoints|endpoint]] provides the list of credit notes  recorded within Xero.
+The Xero '''CreditNotesExpanded''' [[Xero Accounting Endpoints|endpoint]] provides the list of credit notes  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: CreditNotes|CreditNotes]] endpoint.
+Note that an alternate endpoint named [[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]] 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 CreditNotesExpanded endpoint.
+;DataFile
+:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record.
 ;CreditNoteID
@@ Line 61: / Line 66: @@
 ;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
@@ Line 76: / Line 81: @@
 ;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.
 ;BrandingThemeID
@@ Line 96: / Line 101: @@
 ;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
@@ Line 108: / Line 113: @@
 The [[#Fields|LineItems Fields]] include the following sub fields.
+;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 113: / Line 122: @@
 ;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.
+;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 158: / Line 174: @@
 :[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
 :[[Xero Accounting Endpoint: CreditNotes|CreditNotes]]
+:[[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]]
+:[[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]]
 :[[Xero Accounting Endpoint: Currencies|Currencies]]
 :[[Xero Accounting Endpoint: Items|Items]]
 :[[Xero Accounting Endpoint: Invoices|Invoices]]
 :[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
+:[[Xero Projects Endpoint: Projects|Projects]]
 :[[Xero Accounting Endpoint: TaxRates|TaxRates]]
 :[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]