RepeatingInvoices
Query Repeating Invoice templates.
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 driver; 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 | The line item index combined with the Id of the invoice. |
| RepeatingInvoiceId | String | The Id of the invoice. This field is assigned by Xero. |
| Type | String | The type of the invoice. The valid values are ACCPAY and ACCREC. |
| ContactId | String | The Id of the contact. This value is required when inserting. |
| ContactName | String | The name of the contact. This value is required when inserting. |
| Schedule_Period | Integer | Integer used with the unit for the scheduled period. e.g. 1 (every 1 week). |
| Schedule_Unit | String | the schedule unit. The valid values are WEEKLY or MONTHLY. |
| Schedule_DueDate | Integer | Integer used with the due date type for the scheduled period. e.g. 20 (of following month). |
| Schedule_DueDateType | String | The due date type of the schedule. The valid values are DAYSAFTERBILLDATE, DAYSAFTERBILLMONTH, OFCURRENTMONTH, and OFFOLLOWINGMONTH |
| Schedule_StartDate | Date | Invoice date the first invoice in the repeating schedule. |
| Schedule_NextScheduledDate | Date | The calendar date of the next invoice in the schedule to be generated. |
| Schedule_EndDate | Date | Invoice end date. Only returned if the template has an end date set. |
| LineItem_LineItemId | String | The Xero generated identifier for a LineItem. If LineItemIDs are not included with line items in an update request then the line items are deleted and recreated. |
| LineItem_Description | String | The description for the line item. This field must contain at least 1 character and is required to create an approved invoice. |
| LineItem_Quantity | Double | The quantity of the associated item in the line item. This field is required for invoice approval and must be zero or positive. |
| LineItem_UnitAmount | Decimal | The unit amount of the associated item in the line item. This field is required for invoice approval. |
| LineItem_ItemCode | String | The code that identifies the associated item. |
| LineItem_AccountCode | String | The account code. This must be active for the organisation. This field is required for invoice approval. |
| LineItem_TaxType | String | The tax type. This field is used to override AccountCode, the default tax code for the selected account. |
| LineItem_TaxAmount | Decimal | The automatically calculated percentage of tax, based on the tax rate, for the line amount. |
| LineItem_LineAmount | Decimal | The total of the quantity multiplied by the unit amount with any discounts applied. |
| LineItem_TrackingCategory1_CategoryId | String | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory1_CategoryName | String | The name of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory1_OptionId | String | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory1_OptionName | String | The option of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory1_Option_Stat | String | The status of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory2_CategoryId | String | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory2_CategoryName | String | The name of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory2_OptionId | String | The Id of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory2_OptionName | String | The option of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_TrackingCategory2_Option_Stat | String | The status of a tracking category. The API allows two optional tracking categories to be defined. |
| LineItem_DiscountRate | Double | The discount percentage being applied to the line item. Discounts are only supported on ACCREC-type (sales) invoices. |
| LineAmountTypes | String | This field specifies whether line amounts include tax (default). When this field is not specified, line amount totals do not include tax. The valid values are Exclusive, Inclusive, and NoTax. |
| Reference | String | An additional reference number for ACCREC-type invoices. |
| BrandingThemeId | String | The Id of the branding theme. |
| CurrencyCode | String | The ISO 4217 currency code. |
| Status | String | The status code for the invoice. The valid values are DRAFT, SUBMITTED, and AUTHORISED. |
| SubTotal | Decimal | The subtotal for the invoice, which excludes taxes. |
| TotalTax | Decimal | The total tax for the invoice. |
| Total | Decimal | The total for the invoice, including tax -- the sum of SubTotal and TotalTax. |
| HasAttachments | Boolean | This field indicates whether the invoice has an attachment. |
| TenantId | String | The ID of the tenant to query instead of the connection tenant |