Xero · Schema

Schedule

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Properties

Name Type Description
Period integer Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
Unit string One of the following - WEEKLY or MONTHLY
DueDate integer Integer used with due date type e.g 20 (of following month), 31 (of current month)
DueDateType string the payment terms
StartDate string Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
NextScheduledDate string The calendar date of the next invoice in the schedule to be generated
EndDate string Invoice end date – only returned if the template has an end date set
View JSON Schema on GitHub

JSON Schema

xero-schedule-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Schedule",
  "title": "Schedule",
  "externalDocs": {
    "url": "http://developer.xero.com/documentation/api/repeating-invoices/"
  },
  "properties": {
    "Period": {
      "description": "Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)",
      "type": "integer"
    },
    "Unit": {
      "description": "One of the following - WEEKLY or MONTHLY",
      "type": "string",
      "enum": [
        "WEEKLY",
        "MONTHLY"
      ]
    },
    "DueDate": {
      "description": "Integer used with due date type e.g 20 (of following month), 31 (of current month)",
      "type": "integer"
    },
    "DueDateType": {
      "description": "the payment terms",
      "type": "string",
      "enum": [
        "DAYSAFTERBILLDATE",
        "DAYSAFTERBILLMONTH",
        "DAYSAFTERINVOICEDATE",
        "DAYSAFTERINVOICEMONTH",
        "OFCURRENTMONTH",
        "OFFOLLOWINGMONTH"
      ]
    },
    "StartDate": {
      "description": "Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)",
      "type": "string",
      "x-is-msdate": true
    },
    "NextScheduledDate": {
      "description": "The calendar date of the next invoice in the schedule to be generated",
      "type": "string",
      "x-is-msdate": true
    },
    "EndDate": {
      "description": "Invoice end date \u2013 only returned if the template has an end date set",
      "type": "string",
      "x-is-msdate": true
    }
  },
  "type": "object"
}