RepeatingInvoices
Allows you to query templates for repeating invoices in Xero. Repeating invoices are automatically generated for regular billing cycles such as monthly or yearly, reducing the need for manual invoicing.
Table Specific Information
The RepeatingInvoice view allows you to SELECT the line items in repeating invoices for a Xero organization. The Id column is generated by the connector; this value combines the index of the line item with the unique, Xero-generated RepeatingInvoiceId.
SELECT
The Xero API allows extensive filtering and ordering. You can define WHERE and ORDER BY clauses in a query to filter and order the results using any non-line-item column.
Note: The Xero API does not support filtering on line items or journal lines.
Columns
| Name | Type | Description |
| Id [KEY] | String | A unique identifier combining the line item index and the invoice ID to ensure line-level uniqueness. |
| RepeatingInvoiceId | String | The unique identifier of the repeating invoice, assigned by Xero. |
| Type | String | The invoice type. Valid values: ACCPAY (bills) or ACCREC (sales invoices). |
| ContactId | String | The unique identifier of the contact associated with the invoice. Required when creating a new invoice. |
| ContactName | String | The name of the contact associated with the invoice. Required when creating a new invoice. |
| Schedule_Period | Integer | The frequency interval for the schedule, expressed as an integer (for example, 1 for every 1 week). |
| Schedule_Unit | String | The unit of time for the schedule frequency. Valid values: WEEKLY or MONTHLY. |
| Schedule_DueDate | Integer | An integer specifying the due date timing, used in combination with the DueDateType (for example, 20). |
| Schedule_DueDateType | String | Specifies how the due date is calculated. Valid values: DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, OFCURRENTMONTH, OFFOLLOWINGMONTH. |
| Schedule_StartDate | Date | The start date for the repeating invoice schedule. This marks the issue date of the first invoice. |
| Schedule_NextScheduledDate | Date | The next date on which the invoice in the repeating schedule will be generated. |
| Schedule_EndDate | Date | The end date for the repeating schedule, if specified. Only returned if the template includes an end date. |
| LineItem_LineItemId | String | The unique identifier for a line item, assigned by Xero. Required for updates; otherwise, line items are replaced. |
| LineItem_Description | String | A textual description of the line item. Required and must contain at least one character. |
| LineItem_Quantity | Double | The number of units for the line item. Required for approval and must be zero or a positive value. |
| LineItem_UnitAmount | Decimal | The price per unit for the line item. Required for approval. |
| LineItem_ItemCode | String | The item code that identifies the associated inventory or product item. |
| LineItem_AccountCode | String | The account code linked to the line item. Must be active in the organization. Required for invoice approval. |
| LineItem_TaxType | String | Overrides the default tax code of the selected account. Specifies the applicable tax type for the line item. |
| LineItem_TaxAmount | Decimal | The tax amount for the line item, automatically calculated based on the tax rate. |
| LineItem_LineAmount | Decimal | The total amount for the line item, calculated as quantity × unit amount, minus any discounts. |
| LineItem_TrackingCategory1_CategoryId | String | The ID of the first tracking category associated with the line item. |
| LineItem_TrackingCategory1_CategoryName | String | The name of the first tracking category associated with the line item. |
| LineItem_TrackingCategory1_OptionId | String | The ID of the selected option within the first tracking category. |
| LineItem_TrackingCategory1_OptionName | String | The name of the selected option within the first tracking category. |
| LineItem_TrackingCategory1_Option_Stat | String | The status of the first tracking category option (for example, ACTIVE or ARCHIVED). |
| LineItem_TrackingCategory2_CategoryId | String | The ID of the second tracking category associated with the line item. |
| LineItem_TrackingCategory2_CategoryName | String | The name of the second tracking category associated with the line item. |
| LineItem_TrackingCategory2_OptionId | String | The ID of the selected option within the second tracking category. |
| LineItem_TrackingCategory2_OptionName | String | The name of the selected option within the second tracking category. |
| LineItem_TrackingCategory2_Option_Stat | String | The status of the second tracking category option (for example, ACTIVE or ARCHIVED). |
| LineItem_DiscountRate | Double | The discount percentage applied to the line item. Only applicable to ACCREC-type (sales) invoices. |
| LineAmountTypes | String | Specifies how tax is treated in line item amounts. Valid values: Exclusive, Inclusive, NoTax. |
| Reference | String | An optional reference number for ACCREC-type (sales) invoices. |
| BrandingThemeId | String | The ID of the branding theme applied to the invoice. |
| CurrencyCode | String | The currency code used for the invoice, in ISO 4217 format (for example, USD or NZD). |
| Status | String | The current status of the invoice. Valid values: DRAFT, SUBMITTED, AUTHORISED. |
| SubTotal | Decimal | The total of all line items before tax. |
| TotalTax | Decimal | The total amount of tax applied to the invoice. |
| Total | Decimal | The total invoice amount, including tax (SubTotal + TotalTax). |
| HasAttachments | Boolean | Indicates whether the invoice includes any file attachments (true or false). |
| TenantId | String | The ID of the tenant to query, used to specify a tenant different from the connection tenant. |