Xero Accounting Endpoint: Invoices - Revision history

Nic at 05:19, 22 September 2021

2021-09-22T05:19:57Z

← Older revision		Revision as of 00:19, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''Invoices''' [[Endpoints\|endpoint]] provides the list of invoices (both sales and purchases) recorded within Xero.		The Xero '''Invoices''' [[Xero Accounting Endpoints\|endpoint]] provides the list of invoices (both sales and purchases) 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 bank transactions.
Line 230:		Line 230:
	:[[Xero Accounting Endpoint: Quotes\|Quotes]]		:[[Xero Accounting Endpoint: Quotes\|Quotes]]
	:[[Xero Accounting Endpoint: RepeatingInvoices\|RepeatingInvoices]]		:[[Xero Accounting Endpoint: RepeatingInvoices\|RepeatingInvoices]]


			== Related Topics ==

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

Nic at 04:27, 22 September 2021

2021-09-22T04:27:21Z

← Older revision		Revision as of 23:27, 21 September 2021
Line 74:		Line 74:

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

	;AmountDue		;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		;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		;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		;CurrencyCode
Line 95:		Line 95:

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

	;HasAttachments		;HasAttachments
Line 104:		Line 104:

	;CISDeduction		;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		;RepeatingInvoiceID
Line 135:		Line 135:

	;Amount		;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		;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		;Reference
Line 156:		Line 156:

	;AppliedAmount		;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		;Date
Line 162:		Line 162:

	;Total		;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 174:		Line 174:

	;AppliedAmount		;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		;Date
Line 180:		Line 180:

	;Total		;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 192:		Line 192:

	;AppliedAmount		;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		;Date
Line 198:		Line 198:

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

Nic at 03:55, 22 September 2021

2021-09-22T03:55:11Z

← Older revision		Revision as of 22:55, 21 September 2021
Line 226:		Line 226:
	:[[Xero Accounting Endpoint: Prepayments\|Prepayments]]		:[[Xero Accounting Endpoint: Prepayments\|Prepayments]]
	:[[Xero Accounting Endpoint: PrepaymentsExpanded\|PrepaymentsExpanded]]		:[[Xero Accounting Endpoint: PrepaymentsExpanded\|PrepaymentsExpanded]]
			:[[Xero Projects Endpoint: Projects\|Projects]]
	:[[Xero Accounting Endpoint: PurchaseOrders\|PurchaseOrders]]		:[[Xero Accounting Endpoint: PurchaseOrders\|PurchaseOrders]]
	:[[Xero Accounting Endpoint: Quotes\|Quotes]]		:[[Xero Accounting Endpoint: Quotes\|Quotes]]
	:[[Xero Accounting Endpoint: RepeatingInvoices\|RepeatingInvoices]]		:[[Xero Accounting Endpoint: RepeatingInvoices\|RepeatingInvoices]]

Nic at 01:43, 22 September 2021

2021-09-22T01:43:26Z

← Older revision		Revision as of 20:43, 21 September 2021
Line 226:		Line 226:
	:[[Xero Accounting Endpoint: Prepayments\|Prepayments]]		:[[Xero Accounting Endpoint: Prepayments\|Prepayments]]
	:[[Xero Accounting Endpoint: PrepaymentsExpanded\|PrepaymentsExpanded]]		:[[Xero Accounting Endpoint: PrepaymentsExpanded\|PrepaymentsExpanded]]
			:[[Xero Accounting Endpoint: PurchaseOrders\|PurchaseOrders]]
			:[[Xero Accounting Endpoint: Quotes\|Quotes]]
	:[[Xero Accounting Endpoint: RepeatingInvoices\|RepeatingInvoices]]		:[[Xero Accounting Endpoint: RepeatingInvoices\|RepeatingInvoices]]

Nic at 01:05, 22 September 2021

2021-09-22T01:05:28Z

← Older revision		Revision as of 20:05, 21 September 2021
Line 220:		Line 220:
	:[[Xero Accounting Endpoint: Currencies\|Currencies]]		:[[Xero Accounting Endpoint: Currencies\|Currencies]]
	:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]		:[[Xero Accounting Endpoint: InvoicesExpanded\|InvoicesExpanded]]
			:[[Xero Accounting Endpoint: LinkedTransactions\|LinkedTransactions]]
	:[[Xero Accounting Endpoint: Overpayments\|Overpayments]]		:[[Xero Accounting Endpoint: Overpayments\|Overpayments]]
	:[[Xero Accounting Endpoint: OverpaymentsExpanded\|OverpaymentsExpanded]]		:[[Xero Accounting Endpoint: OverpaymentsExpanded\|OverpaymentsExpanded]]

Nic at 00:57, 22 September 2021

2021-09-22T00:57:00Z

← Older revision		Revision as of 19:57, 21 September 2021
Line 116:		Line 116:

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

Nic: Created page with "== Overview == The Xero '''Invoices''' endpoint provides the list of invoices (both sales and purchases) recorded within Xero. This endpoint does not provide a..."

2021-09-21T06:33:02Z

Created page with "== Overview == The Xero '''Invoices''' endpoint provides the list of invoices (both sales and purchases) recorded within Xero. This endpoint does not provide a..."

New page

== Overview ==

The Xero '''Invoices''' [[Endpoints|endpoint]] provides the list of invoices (both sales and purchases) 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: InvoicesExpanded|InvoicesExpanded]]. It provides many additional fields and is also optimised for larger data files.

== Fields ==

The following fields are available for the Invoices endpoint.

;InvoiceID
:A [[Field Type: GUID|guid field]] that provides the id of the invoice.

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

;InvoiceNumber
:A [[Field Type: Text|text field]] that provides the invoice number.

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

;Status
:A [[Field Type: Text|text field]] that indicates the status of the invoice.
:Possible values are:
:* '''DRAFT''': Indicates the invoice is a draft.
:* '''SUBMITTED''': Indicates the invoice is awaiting approval.
:* '''AUTHORISED''': Indicates the invoice is approved and awaiting payment or partially paid.
:* '''PAID''': Indicates the invoice is completely paid.
:* '''VOIDED''': Indicates the invoice is voided.
:* '''DELETED''': Indicates the invoice is deleted.

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

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

;ExpectedPaymentDate
:A [[Field Type: Date|date field]] that provides the expected payment date of the invoice.
:Only applies to sales invoice.

;PlannedPaymentDate
:A [[Field Type: Date|date field]] that provides the planned payment date of the invoice.
:Only applies to bills invoice.

;FullyPaidOnDate
:A [[Field Type: Date|date field]] that provides the date the invoice was fully paid.

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

;Payments
:A [[Field Type: Table|table field]] that provides the list of payments applied to the invoice.
:See [[#Payments Fields|Payments Fields]] for more information.

;CreditNotes
:A [[Field Type: Table|table field]] that provides the list of credit notes applied to the invoice.
:See [[#CreditNotes Fields|CreditNotes Fields]] for more information.

;Prepayments
:A [[Field Type: Table|table field]] that provides the list of prepayments applied to the invoice.
:See [[#Prepayments Fields|Prepayments Fields]] for more information.

;Overpayments
:A [[Field Type: Table|table field]] that provides the list of Overpayments applied to the invoice.
:See [[#Overpayments Fields|Overpayments 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.

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

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

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

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

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

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

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

;RepeatingInvoiceID
:A [[Field Type: GUID|guid field]] that indicates the [[Xero Accounting Endpoint: RepeatingInvoices|repeating invoice id]] of the invoice.

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

;Url
:A [[Field Type: Text|text field]] that provides the url of the uploaded document.

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

== Payments Fields ==

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

;PaymentID
:A [[Field Type: GUID|GUID field]] representing the internal id of a payment.
:This field can be linked to the [[Xero Accounting Endpoint: Payments|Payments]] endpoint.

;BatchPaymentID
:A [[Field Type: GUID|GUID field]] representing the internal id of a batch payment.
:This field can be linked to the [[Xero Accounting Endpoint: BatchPayments|BatchPayments]] endpoint.

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

;Amount
:A [[Field Type: Decimal|decimal value]] that provides the amount associated with the payment.

;CurrencyRate
:A [[Field Type: Decimal|decimal value]] that provides the exchange rate applicable.

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

== CreditNotes Fields ==

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

;CreditNoteID
:A [[Field Type: GUID|GUID field]] representing the internal id of a credit note.
:This field can be linked to the [[Xero Accounting Endpoint: CreditNotes|CreditNotes]] and [[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]] endpoints.

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

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

;Date
:A [[Field Type: Date|date field]] that provides the date on which it was applied.

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

== Prepayments Fields ==

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

;PrepaymentID
:A [[Field Type: GUID|GUID field]] representing the internal id of a prepayment.
:This field can be linked to the [[Xero Accounting Endpoint: Prepayments|Prepayments]] and [[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]] endpoints.

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

;Date
:A [[Field Type: Date|date field]] that provides the date on which it was applied.

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

== Overpayments Fields ==

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

;OverpaymentID
:A [[Field Type: GUID|GUID field]] representing the internal id of a overpayment.
:This field can be linked to the [[Xero Accounting Endpoint: Overpayments|Overpayments]] and [[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]] endpoints.

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

;Date
:A [[Field Type: Date|date field]] that provides the date on which it was applied.

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

== Xero API ==

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

== Related Fields ==

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

== Related Endpoints ==

:[[Xero Accounting Endpoint: BrandingThemes|BrandingThemes]]
:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: CreditNotes|CreditNotes]]
:[[Xero Accounting Endpoint: CreditNotesExpanded|CreditNotesExpanded]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
:[[Xero Accounting Endpoint: Overpayments|Overpayments]]
:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]
:[[Xero Accounting Endpoint: Payments|Payments]]
:[[Xero Accounting Endpoint: Prepayments|Prepayments]]
:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]
:[[Xero Accounting Endpoint: RepeatingInvoices|RepeatingInvoices]]