Xero Accounting Endpoint: CreditNotes - Revision history

Nic at 01:17, 5 September 2025

2025-09-05T01:17:23Z

← Older revision		Revision as of 20:17, 4 September 2025
Line 116:		Line 116:
	:[[Xero Accounting Endpoint: ContactsExpanded\|ContactsExpanded]]		:[[Xero Accounting Endpoint: ContactsExpanded\|ContactsExpanded]]
	:[[Xero Accounting Endpoint: CreditNotesExpanded\|CreditNotesExpanded]]		:[[Xero Accounting Endpoint: CreditNotesExpanded\|CreditNotesExpanded]]
			:[[Xero Accounting Endpoint: CreditNotesExpandedTable\|CreditNotesExpandedTable]]
			:[[Xero Accounting Endpoint: CreditNotesTable\|CreditNotesTable]]
	:[[Xero Accounting Endpoint: Currencies\|Currencies]]		:[[Xero Accounting Endpoint: Currencies\|Currencies]]
	:[[Xero Accounting Endpoint: Invoices\|Invoices]]		:[[Xero Accounting Endpoint: Invoices\|Invoices]]

Nic at 01:07, 5 September 2025

2025-09-05T01:07:33Z

← Older revision		Revision as of 20:07, 4 September 2025
Line 13:		Line 13:

	The following fields are available for the CreditNotes endpoint.		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		;CreditNoteID

Nic at 01:06, 5 September 2025

2025-09-05T01:06:54Z

← Older revision		Revision as of 20:06, 4 September 2025
Line 6:		Line 6:

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

Nic at 05:16, 22 September 2021

2021-09-22T05:16:01Z

← Older revision		Revision as of 00:16, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== 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 credit notes.		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.
Line 115:		Line 115:
	:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]		:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]
	:[[Xero Projects Endpoint: Projects\|Projects]]		:[[Xero Projects Endpoint: Projects\|Projects]]


			== Related Topics ==

			:[[Xero Accounting Models]]
			:[[Xero Accounting Endpoints]]

Nic at 04:28, 22 September 2021

2021-09-22T04:28:23Z

← Older revision		Revision as of 23:28, 21 September 2021
Line 50:		Line 50:

	;Subtotal		;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		;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		;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		;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		;CurrencyCode
Line 65:		Line 65:

	;CurrencyRate		;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		;BrandingThemeID
Line 85:		Line 85:

	;Amount		;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		;Date

Nic at 03:54, 22 September 2021

2021-09-22T03:54:55Z

← Older revision		Revision as of 22:54, 21 September 2021
Line 114:		Line 114:
	:[[Xero Accounting Endpoint: Invoices\|Invoices]]		:[[Xero Accounting Endpoint: Invoices\|Invoices]]
	:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]		:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]
			:[[Xero Projects Endpoint: Projects\|Projects]]

Nic at 06:38, 21 September 2021

2021-09-21T06:38:19Z

← Older revision		Revision as of 01:38, 21 September 2021
Line 3:		Line 3:
	The Xero '''CreditNotes''' [[Endpoints\|endpoint]] provides the list of credit notes recorded within Xero.		The Xero '''CreditNotes''' [[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.		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.
Line 62:		Line 62:

	;CurrencyCode		;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		;CurrencyRate
Line 68:		Line 68:

	;BrandingThemeID		;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		;HasAttachments

Nic: Created page with "== Overview == The Xero '''CreditNotes''' endpoint provides the list of credit notes recorded within Xero. This endpoint does not provide access to all fields..."

2021-09-21T05:50:07Z

Created page with "== Overview == The Xero '''CreditNotes''' endpoint provides the list of credit notes recorded within Xero. This endpoint does not provide access to all fields..."

New page

== Overview ==

The Xero '''CreditNotes''' [[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.

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.

== Fields ==

The following fields are available for the CreditNotes endpoint.

;CreditNoteID
:A [[Field Type: GUID|guid field]] that provides the id of the credit note.

;Type
:A [[Field Type: Text|text field]] that indicates the type of credit note.
:Possible values are:
:* '''ACCPAYCREDIT''': Indicates the credit note is for accounts payable / supplier side.
:* '''ACCRECCREDIT''': Indicates the credit note is for accounts receivable / customer side.

;CreditNoteNumber
:A [[Field Type: Text|text field]] that provides the credit note number.

;Reference
:A [[Field Type: Text|text field]] that provides the reference of the credit note.

;Date
:A [[Field Type: Date|date field]] that provides the date on which the credit note occurred.

;DueDate
:A [[Field Type: Date|date field]] that provides the due date of the credit note.

;Status
:A [[Field Type: Text|text field]] that indicates the status of the credit note.
:Possible values are:
:* '''AUTHORISED''': Indicates the transaction is authorised and has been processed.
:* '''DELETED''': Indicates the transaction has been deleted.

;Contact
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Contacts|Contacts]] associated with the credit note.

;SentToContact
:A [[Field Type: Boolean|true/false field]] that indicates if the credit note has been sent to the contact.

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

;TotalTax
:A [[Field Type: Decimal|decimal value]] that provides the tax amount of the transaction.

;Total
:A [[Field Type: Decimal|decimal value]] 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.

;CurrencyCode
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the bank transaction.

;CurrencyRate
:A [[Field Type: Decimal|decimal value]] 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.

;HasAttachments
:A [[Field Type: Boolean|true/false field]] that indicates if attachments were uploaded against the transaction.

;FullyPaidOnDate
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time credit note was fully applied.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this credit note was created and/or updated.

== Allocations Fields ==

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

;Amount
:A [[Field Type: Decimal|decimal value]] 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 Endpoint: Invoices|invoice]] details.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/creditnotes Xero API].

== Related Fields ==

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

== Related Endpoints ==

:[[Xero Accounting Endpoint: BrandingThemes|BrandingThemes]]
:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]