Join us at Xero Developer Roadshow, June 2018 at a city near you. Register Free

Repeating Invoices

Overview

URL https://api.xero.com/api.xro/2.0/RepeatingInvoices
Methods Supported GET
Description Allows you to retrieve any repeating invoice templates
Allows you to retrieve history

GET RepeatingInvoices

Use this method to retrieve either one or many repeating invoices.

Type See Invoice Types
Contact See Contacts
Schedule See Schedule
LineItems See LineItems. The LineItems collection can contain any number of individual LineItem sub-elements.
LineAmountTypes Line amounts are exclusive of tax by default if you don't specify this element. See Line Amount Types
Reference ACCREC only - additional reference number
BrandingThemeID See BrandingThemes
CurrencyCode The currency that invoice has been raised in (see Currencies)
Status One of the following : DRAFT or AUTHORISED - See Invoice Status Codes
SubTotal Total of invoice excluding taxes
TotalTax Total tax on invoice
Total Total of Invoice tax inclusive (i.e. SubTotal + TotalTax)
RepeatingInvoiceID Xero generated unique identifier for repeating invoice template
HasAttachments boolean to indicate if an invoice has an attachment
Elements for Schedule
Period Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
Unit One of the following : WEEKLY or MONTHLY
DueDate Integer used with due date type e.g 20 (of following month), 31 (of current month)
DueDateType See Payment Terms
StartDate Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
NextScheduledDate The calendar date of the next invoice in the schedule to be generated
EndDate Invoice end date - only returned if the template has an end date set
Elements for LineItems
Description Description needs to be at least 1 char long. A line item with just a description (i.e no unit amount or quantity) can be created by specifying just a Description element that contains at least 1 character
Quantity LineItem Quantity
UnitAmount LineItem Unit Amount
ItemCode See Items
AccountCode See Accounts
TaxType Used as an override if the default Tax Code for the selected AccountCode is not correct - see TaxTypes.
TaxAmount The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated TaxAmount is not correct.
LineAmount If you wish to omit either of the Quantity or UnitAmount you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 - DiscountRate)/100)
Tracking Optional Tracking Category - see Tracking. Any LineItem can have a maximum of 2 TrackingCategory elements.
DiscountRate Percentage discount being applied to a line item (only supported on ACCREC invoices - ACC PAY invoices and credit notes in Xero do not support discounts

Optional parameters

RepeatingInvoiceID You can specify an individual record by appending the RepeatingInvoiceID to the url
Where Filter by an any element ( see Filters )
order Order by any element returned ( see Order By )

Example response retrieving RepeatingInvoices

GET https://api.xero.com/api.xro/2.0/RepeatingInvoices

Retrieving History

View a summary of the actions made by all users to the repeating invoice. See the History and Notes page for more details.

Example of retrieving a repeating invoice's history

GET https://api.xero.com/api.xro/2.0/RepeatingInvoices/{Guid}/History