delivery-schedule

Open a delivery schedule against a quote, work order or change order and return its DS-YYYY-NNNN number: the reference, its own date, the client, a title and the currency. Free tier: 3 open.

{
  "type": "object",
  "properties": {
    "reference": {
      "type": "string",
      "maxLength": 64,
      "description": "The quote, work order or change order this schedule delivers, by its id, e.g. WO-2026-0001, Q-2026-0003 or CO-2026-0001"
    },
    "reference_kind": {
      "type": "string",
      "enum": [
        "quote",
        "work_order",
        "change_order"
      ],
      "description": "What the reference is. Inferred from the id when omitted: WO- is a work order, CO- a change order, anything else a quote"
    },
    "reference_date": {
      "type": "string",
      "maxLength": 10,
      "description": "The date on the reference document itself, YYYY-MM-DD. No due date and no delivery may fall before it"
    },
    "client": {
      "type": "string",
      "maxLength": 200,
      "description": "The client the work is delivered to, as named on the reference document"
    },
    "title": {
      "type": "string",
      "maxLength": 2000,
      "description": "What the job is, in one line, e.g. Website rebuild, phase one"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO code the deliverables are priced in. Defaults to the shared business profile's currency"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "reference",
    "reference_date",
    "client",
    "title"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Add one dated deliverable and return its D number and the new counts. value_minor is NET of VAT in whole MINOR units. A due date before the reference document's own date is refused. It starts as planned.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    },
    "description": {
      "type": "string",
      "maxLength": 2000,
      "description": "What is being handed over, as the client would recognise it, e.g. Wireframes for the five main pages"
    },
    "due_date": {
      "type": "string",
      "maxLength": 10,
      "description": "The day it is due, YYYY-MM-DD. It cannot fall before the reference document's own date"
    },
    "value_minor": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000,
      "description": "What this deliverable is worth, net of VAT, in whole minor units. 90000 is EUR 900.00. Leave it out when the job is a lump sum and this deliverable carries no price of its own"
    },
    "tax_rate": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000,
      "description": "VAT percent for this deliverable, overriding the shared business profile's default"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    },
    "duplicate_ok": {
      "type": "boolean",
      "description": "Add it even though this schedule already carries the same description due on the same day. Default false"
    }
  },
  "required": [
    "schedule",
    "description",
    "due_date"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Record a dated move on one deliverable: planned, in_progress, delivered, then accepted with a note. An out-of-order move, or a date before the reference document, is refused. The date drives lateness.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    },
    "deliverable": {
      "type": "string",
      "maxLength": 200,
      "description": "The deliverable id, e.g. D01, or its description when only one carries it"
    },
    "status": {
      "type": "string",
      "enum": [
        "in_progress",
        "delivered",
        "accepted"
      ],
      "description": "The status to move to"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The day it happened, YYYY-MM-DD. Default today. This is the date every late reading is taken against, not the day you type it"
    },
    "note": {
      "type": "string",
      "maxLength": 2000,
      "description": "What happened. On accepted this is the acceptance note, e.g. Signed off by the client on the call, no snags"
    }
  },
  "required": [
    "schedule",
    "deliverable",
    "status"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Delete one deliverable still planned with no history. One started, delivered or accepted is refused, naming when: add a corrected deliverable instead. The D number on a schedule is never reissued.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    },
    "deliverable": {
      "type": "string",
      "maxLength": 200,
      "description": "The deliverable id, e.g. D01, or its description when only one carries it"
    }
  },
  "required": [
    "schedule",
    "deliverable"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Return one schedule in full as at a date: every deliverable with due date, status, delivered and accepted dates, note and value, plus what is late and the totals. The answer names the as_of it used.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    },
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Read the schedule as at this date, YYYY-MM-DD. Defaults to today"
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List schedules oldest reference first with client, currency and counts as at a date: late, still owed, accepted. Filter by client, reference and state open or complete. Free.

{
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "maxLength": 200,
      "description": "Only schedules whose client name contains this text"
    },
    "reference": {
      "type": "string",
      "maxLength": 64,
      "description": "Only the schedule against this quote, work order or change order"
    },
    "state": {
      "type": "string",
      "enum": [
        "open",
        "complete"
      ],
      "description": "open for a job with a deliverable that is not yet accepted, complete for one where every deliverable is"
    },
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Read the schedule as at this date, YYYY-MM-DD. Defaults to today"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "Maximum schedules returned, default and ceiling 500"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Delete a schedule carrying no deliverables, freeing an open slot. One holding any is refused, naming them, since they record what was owed. The DS number is never reissued. Free on every tier.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

What has slipped as at a date: every deliverable still owed past its due date, worst first, with value at risk per currency, and what was delivered late kept apart. A reference with no schedule is refused.

{
  "type": "object",
  "properties": {
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Read lateness as at this date, YYYY-MM-DD. Defaults to today. Everything in the answer is as at this date, not as at now"
    },
    "reference": {
      "type": "string",
      "maxLength": 64,
      "description": "Only the schedule against this quote, work order or change order"
    },
    "client": {
      "type": "string",
      "maxLength": 200,
      "description": "Only schedules whose client name contains this text"
    },
    "include_delivered_late": {
      "type": "boolean",
      "description": "Include what was handed over after its due date but is no longer outstanding. Default true"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "Maximum rows per section, default and ceiling 500"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Render one schedule as a plain-text document for the client: every deliverable with its due date, status, delivered and accepted dates and value, the counts as at a date, and a sign-off block. Pro.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    },
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Read the schedule as at this date, YYYY-MM-DD. Defaults to today"
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Build the delivered-and-accepted deliverables as invoice_create-ready items in MAJOR units and quote_create-ready items in MINOR units, with VAT at the shared profile rate. Writes nothing. Pro.

{
  "type": "object",
  "properties": {
    "schedule": {
      "type": "string",
      "maxLength": 200,
      "description": "The schedule id, e.g. DS-2026-0001, the reference it delivers, e.g. WO-2026-0001, or its title"
    },
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Bill what had been accepted by this date, YYYY-MM-DD. Defaults to today"
    },
    "issue_date": {
      "type": "string",
      "maxLength": 10,
      "description": "The invoice issue date, YYYY-MM-DD. Default today"
    },
    "tax_rate": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000,
      "description": "VAT percent for deliverables with no rate of their own, overriding the shared business profile's default"
    }
  },
  "required": [
    "schedule"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Report this endpoint's licence state for your token as JSON: the product, the tier free or pro, why it is not Pro, and the checkout URL. Call it to explain a free-tier refusal. No arguments, nothing changes.

{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Turn Pro on for this connection with key, an MCPL1.<payload>.<signature> issued at checkout for this server or the bundle. Data under your token stays; a wrong or expired key changes nothing. license_status confirms it.

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "License key from checkout, MCPL1.<payload>.<signature>"
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}