Xero Accounting Endpoint: CreditNotes: Difference between revisions

(6 intermediate revisions by the same user not shown)

Line 1:

== Overview ==

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

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

In most situations, it is recommended to use the [[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]. It provides many additional fields and is also optimised for larger data files.

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

;DataFile

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

;CreditNoteID

Line 50:

Line 55:

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

;BrandingThemeID

:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: BrandingThemes|branding theme]] of the ~~bank~~ transaction.

:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: BrandingThemes|branding theme]] of the transaction.

;HasAttachments

Line 85:

Line 90:

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

Line 116:

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

:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]

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

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

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

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

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

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

== Related Topics ==

:[[Xero Accounting Models]]

:[[Xero Accounting Endpoints]]

@@ Line 1: / Line 1: @@
 == Overview ==
-The Xero '''CreditNotes''' [[Endpoints|endpoint]] provides the list of credit notes recorded within Xero.
+The Xero '''CreditNotes''' [[Xero Accounting Endpoints|endpoint]] provides the list of credit notes 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 credit notes.
 In most situations, it is recommended to use the [[Xero  Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]. It provides many additional fields and is also optimised for larger data files.
+Note that an alternate endpoint named [[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]] 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 CreditNotes endpoint.
+;DataFile
+:A [[Field Type: Record|record field]] that identifies the [[Field: DataFiles|source data file]] for this record.
 ;CreditNoteID
@@ Line 50: / Line 55: @@
 ;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.
 ;BrandingThemeID
-:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: BrandingThemes|branding theme]] of the bank transaction.
+:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: BrandingThemes|branding theme]] of the transaction.
 ;HasAttachments
@@ Line 85: / Line 90: @@
 ;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 111: / Line 116: @@
 :[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
 :[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]
+:[[Xero Accounting Endpoint: CreditNotesExpandedTable|CreditNotesExpandedTable]]
+:[[Xero Accounting Endpoint: CreditNotesTable|CreditNotesTable]]
 :[[Xero Accounting Endpoint: Currencies|Currencies]]
 :[[Xero Accounting Endpoint: Invoices|Invoices]]
 :[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
+:[[Xero Projects Endpoint: Projects|Projects]]
+== Related Topics ==
+:[[Xero Accounting Models]]
+:[[Xero Accounting Endpoints]]