Xero Accounting Endpoint: RepeatingInvoices - Revision history

Nic at 23:52, 12 May 2024

2024-05-12T23:52:21Z

← Older revision		Revision as of 18:52, 12 May 2024
Line 128:		Line 128:
	:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Endpoint: Accounts\|account code]] of the line.		:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Endpoint: Accounts\|account code]] of the line.

	;~~ItemID~~		;Item
	:A [[Field Type: ~~GUID~~\|~~guid~~ field]] that provides the [[Xero Accounting Endpoint: Items\|item id]] of the line.		:A [[Field Type: Record\|record field]] that provides the [[Xero Accounting Endpoint: Items\|item]] of the line.

	;ItemCode		;ItemCode
	:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Endpoint: Items\|item code]] of the line.		: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.''
	~~;ItemName~~
	:~~A [[Field Type: Text\|text~~ field~~]] that provides the [[Xero Accounting Endpoint: Items\|item name]] of the line~~.

	;TaxType		;TaxType

Nic at 23:45, 12 May 2024

2024-05-12T23:45:25Z

← Older revision		Revision as of 18:45, 12 May 2024
Line 127:		Line 127:
	;AccountCode		;AccountCode
	:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Endpoint: Accounts\|account code]] of the line.		:A [[Field Type: Text\|text field]] that provides the [[Xero Accounting Endpoint: Accounts\|account code]] of the line.

			;ItemID
			:A [[Field Type: GUID\|guid field]] that provides the [[Xero Accounting Endpoint: Items\|item id]] of the line.

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

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

	;TaxType		;TaxType

Nic at 22:44, 25 October 2023

2023-10-25T22:44:34Z

← Older revision		Revision as of 17:44, 25 October 2023
Line 121:		Line 121:
	;DiscountRate		;DiscountRate
	:A [[Field Type: Decimal\|decimal field]] 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		;AccountCode

Nic at 05:21, 22 September 2021

2021-09-22T05:21:13Z

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

	The Xero '''RepeatingInvoices''' [[Endpoints\|endpoint]] provides the list of repeating / recurring invoices (both sales and purchases) recorded within Xero.		The Xero '''RepeatingInvoices''' [[Xero Accounting Endpoints\|endpoint]] provides the list of repeating / recurring invoices (both sales and purchases) recorded within Xero.


Line 159:		Line 159:
	:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]		:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]
	:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]		:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]


			== Related Topics ==

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

Nic at 04:27, 22 September 2021

2021-09-22T04:27:51Z

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

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

	;CurrencyCode		;CurrencyCode
Line 108:		Line 108:

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

	;AccountCode		;AccountCode

Nic at 03:34, 22 September 2021

2021-09-22T03:34:34Z

← Older revision		Revision as of 22:34, 21 September 2021
Line 9:		Line 9:

	;RepeatingInvoiceID		;RepeatingInvoiceID
	:A [[Field Type: GUID\|guid field]] that provides the id of the ~~repearting~~ invoice.		:A [[Field Type: GUID\|guid field]] that provides the id of the repeating invoice.

	;Type		;Type

Nic at 03:34, 22 September 2021

2021-09-22T03:34:15Z

← Older revision		Revision as of 22:34, 21 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''RepeatingInvoices''' [[Endpoints\|endpoint]] provides the list of ~~repearing~~/recurring invoices (both sales and purchases) recorded within Xero.		The Xero '''RepeatingInvoices''' [[Endpoints\|endpoint]] provides the list of repeating / recurring invoices (both sales and purchases) recorded within Xero.

Nic: Created page with "== Overview == The Xero '''RepeatingInvoices''' endpoint provides the list of repearing/recurring invoices (both sales and purchases) recorded within Xero. ==..."

2021-09-22T01:57:52Z

Created page with "== Overview == The Xero '''RepeatingInvoices''' endpoint provides the list of repearing/recurring invoices (both sales and purchases) recorded within Xero. ==..."

New page

== Overview ==

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

== Fields ==

The following fields are available for the RepeatingInvoices endpoint.

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

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

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

;Status
:A [[Field Type: Text|text field]] that indicates the status of the repeating invoice.
:Possible values are:
:* '''DRAFT''': Indicates the repeating invoice is a draft.
:* '''AUTHORISED''': Indicates the repeating invoice is approved and active.

;Schedule
:A [[Field Type: Record|record field]] that provides the schedule for the repeatng invoice.
:See [[#Schedule Fields|Schedule Fields]] for more information.

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

;LineAmountTypes
:A [[Field Type: Text|text field]] that indicates the type of values on the lines.
:Possible values are:
:* '''Exclusive''': Indicates that line items are exclusive of tax.
:* '''Inclusive''': Indicates that line items are inclusive tax.
:* '''NoTax''': Indicates that line items have no tax.

;LineItems
:A [[Field Type: Table|table field]] that provides the repeating invoice lines.
:See [[#LineItems Fields|LineItems 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.

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

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

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

== Schedule Fields ==

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

;Period
:A [[Field Type: Integer|whole number value]] that indicates how often the invoice recurs (e.g. every 1 week, every 2 weeks, etc.).

;Unit
:A [[Field Type: Text|text field]] that indicates type of period.
:Possible values are:
:* '''MONTHLY'''
:* '''WEEKLY'''

;DueDate
:A [[Field Type: Integer|whole number value]] that indicates the day it recurs.

;DueDateType
:A [[Field Type: Text|text field]] that indicates type of period.
::Possible values are:
:* '''DAYSAFTERBILLDATE''': x days after bill date
:* '''DAYSAFTERBILLMONTH''': x days after bill month
:* '''OFCURRENTMONTH''': on a specific day of the current month
:* '''OFFOLLOWINGMONTH''': on a specific day of the following month

;StartDate
:A [[Field Type: Date|date field]] that indicates the first date the repeating invoice occurs.

;NextScheduledDate
:A [[Field Type: Date|date field]] that indicates the next date the repeating invoice occurs.

;EndDate
:A [[Field Type: Date|date field]] that indicates the last date the repeating invoice occurs.

== LineItems Fields ==

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

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

;Description
:A [[Field Type: Text|text field]] that provides the description of the line.

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

;UnitAmount
:A [[Field Type: Decimal|decimal value]] that provides the unit amount of the line.

;LineAmount
:A [[Field Type: Decimal|decimal value]] that provides the amount of the line.

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

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

;AccountCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line.

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

;TaxType
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Field: TaxTypes|tax type]] of the line.

;Tracking
:A [[Field Type: Table|table field]] that provides the [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] assigned to the line.

== Xero API ==

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

== Related Fields ==

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

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: BrandingThemes|BrandingThemes]]
:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: Items|Items]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
:[[Xero Accounting Endpoint: TaxRates|TaxRates]]
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]