Xero Accounting Endpoint: RepeatingInvoices
Overview
The Xero RepeatingInvoices endpoint provides the list of repeating / recurring invoices (both sales and purchases) recorded within Xero.
Fields
The following fields are available for the RepeatingInvoices endpoint.
- RepeatingInvoiceID
- A guid field that provides the id of the repeating invoice.
- Type
- A 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 text field that provides the reference of the repeating invoice.
- Status
- A 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 record field that provides the schedule for the repeatng invoice.
- See Schedule Fields for more information.
- Contact
- A record field that provides the Contacts associated with the repeating invoice.
- LineAmountTypes
- A 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 table field that provides the repeating invoice lines.
- See LineItems Fields for more information.
- Subtotal
- A decimal field that provides the tax exclusive amount of the transaction.
- TotalTax
- A decimal field that provides the tax amount of the transaction.
- Total
- A decimal field that provides the total amount of the transaction.
- CurrencyCode
- A text field that indicates the currency of the transaction.
- HasAttachments
- A true/false field that indicates if attachments were uploaded against the transaction.
- BrandingThemeID
- A guid field that indicates the branding theme of the repeating invoice.
Schedule Fields
The Schedule Fields include the following sub fields.
- Period
- A whole number value that indicates how often the invoice recurs (e.g. every 1 week, every 2 weeks, etc.).
- Unit
- A text field that indicates type of period.
- Possible values are:
- MONTHLY
- WEEKLY
- DueDate
- A whole number value that indicates the day it recurs.
- DueDateType
- A 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 date field that indicates the first date the repeating invoice occurs.
- NextScheduledDate
- A date field that indicates the next date the repeating invoice occurs.
- EndDate
- A date field that indicates the last date the repeating invoice occurs.
LineItems Fields
The LineItems Fields include the following sub fields.
- LineItemID
- A guid field that provides an ID for the line.
- Description
- A text field that provides the description of the line.
- Quantity
- A decimal field that provides the quantity of the line.
- UnitAmount
- A decimal field that provides the unit amount of the line.
- LineAmount
- A decimal field that provides the amount of the line.
- TaxAmount
- A decimal field that provides the tax amount of the line.
- DiscountRate
- A decimal field that provides the discount rate applied to the line.
- AccountCode
- A text field that provides the account code of the line.
- ItemCode
- A text field that provides the item code of the line.
- TaxType
- A text field that provides the tax type of the line.
- Tracking
- A table field that provides the tracking category options assigned to the line.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields