work-order

Raise a job order and return its WO-YYYY-NNNN number: the client, the site address, the date it was asked for, what the job is and how urgent. Free tier: 5 open orders.

{
  "type": "object",
  "properties": {
    "client": {
      "type": "string",
      "maxLength": 200,
      "description": "A client name or id from the invoice server's client records. An unknown name needs client_address as well, so a typo is not filed as a new customer"
    },
    "site_address": {
      "type": "string",
      "maxLength": 2000,
      "description": "Where the work happens. This is the site, not the billing address"
    },
    "requested_date": {
      "type": "string",
      "maxLength": 10,
      "description": "The date the work was asked for, YYYY-MM-DD"
    },
    "description": {
      "type": "string",
      "maxLength": 2000,
      "description": "What the job is, e.g. Replace immersion heater and test"
    },
    "priority": {
      "type": "string",
      "enum": [
        "low",
        "normal",
        "high",
        "urgent"
      ],
      "description": "How urgent the job is. Default normal"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO code the job is priced in. Defaults to the shared business profile's currency"
    },
    "client_address": {
      "type": "string",
      "maxLength": 2000,
      "description": "The client's billing address, for a client that is not in the invoice records yet"
    },
    "client_email": {
      "type": "string",
      "maxLength": 200
    },
    "client_vat_id": {
      "type": "string",
      "maxLength": 200
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    },
    "duplicate_ok": {
      "type": "boolean",
      "description": "Raise it even though an identical work order exists, for a genuinely repeated visit. Default false"
    }
  },
  "required": [
    "client",
    "site_address",
    "requested_date",
    "description"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Add one line: parts with quantity, unit_cost_minor in whole MINOR units and optional markup, or labour with hours and rate_minor. A line on an invoiced order, or dated before the request, is refused.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    },
    "kind": {
      "type": "string",
      "enum": [
        "parts",
        "labour"
      ],
      "description": "parts for materials, labour for time on the job"
    },
    "description": {
      "type": "string",
      "maxLength": 2000,
      "description": "What it is, e.g. 3kW immersion element, or Second fix and test"
    },
    "quantity": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 1000000,
      "description": "parts only: how many. A negative or zero quantity is refused"
    },
    "unit_cost_minor": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000,
      "description": "parts only: what one costs YOU, in whole minor units. 1299 is EUR 12.99"
    },
    "markup_percent": {
      "type": "number",
      "minimum": 0,
      "maximum": 1000,
      "description": "parts only: percent added to the UNIT cost before billing. Default 0"
    },
    "hours": {
      "type": "number",
      "exclusiveMinimum": 0,
      "maximum": 100000,
      "description": "labour only: hours worked, e.g. 3.5"
    },
    "rate_minor": {
      "type": "integer",
      "minimum": 0,
      "maximum": 1000000000000,
      "description": "labour only: the hourly rate in whole minor units. Omit only once the shared business profile carries a default rate"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The day this line was worked or fitted, YYYY-MM-DD"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "work_order",
    "kind",
    "description"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Move one work order exactly one step: draft, scheduled, in_progress, done, invoiced, stamping date and note. A skipped, backwards or backdated step is refused and nothing is written. Free.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "scheduled",
        "in_progress",
        "done",
        "invoiced"
      ],
      "description": "The status to move to. It must be the next one along"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The day it reached this status, YYYY-MM-DD. Default today"
    },
    "note": {
      "type": "string",
      "maxLength": 2000,
      "description": "What happened, e.g. Booked for Tuesday morning, or Signed off by the tenant"
    }
  },
  "required": [
    "work_order",
    "status"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Return one work order in full by WO number or client: the site, every parts and labour line with the unit billed, hours, materials, net and VAT, and the status history. Reads only. Free.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    }
  },
  "required": [
    "work_order"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List work orders newest requested first: status, priority, client, site, hours, labour, materials and net value, with totals per currency. Filter by status, client and requested-date range. Free.

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "scheduled",
        "in_progress",
        "done",
        "invoiced",
        "open"
      ],
      "description": "One status, or open for draft, scheduled and in_progress together"
    },
    "client": {
      "type": "string",
      "maxLength": 200,
      "description": "Only jobs whose client name contains this text"
    },
    "from": {
      "type": "string",
      "maxLength": 10,
      "description": "Earliest requested_date, YYYY-MM-DD"
    },
    "to": {
      "type": "string",
      "maxLength": 10,
      "description": "Latest requested_date, YYYY-MM-DD"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "Maximum rows returned, default and ceiling 500"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Delete a DRAFT work order with no lines, freeing an open slot. One past draft is refused, naming the date it got there, and so is one carrying lines. The WO number is never reissued. work_order_status moves it on.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    }
  },
  "required": [
    "work_order"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Turn a work order into a plain-text completion report: what was done, the labour hours, the materials, the totals and a sign-off block, ready to paste into an email. The same text also comes back as a .txt download link valid for one hour. Free on every tier.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    }
  },
  "required": [
    "work_order"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call this tool to render the A4 completion report of one work order and return a download link valid for one hour: the lines, the hours, the materials, the totals and the sign-off block. Pro.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    },
    "out_path": {
      "type": "string",
      "maxLength": 1000,
      "description": "Name for the downloaded file, e.g. harbour-cafe-report. Defaults to the work order id; the report comes back as a download link valid for one hour"
    }
  },
  "required": [
    "work_order"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Build an invoice_create-ready payload from the lines, with VAT at the shared profile rate. Writes nothing and marks nothing: raise the invoice in the invoice server, then set this order invoiced. Pro.

{
  "type": "object",
  "properties": {
    "work_order": {
      "type": "string",
      "maxLength": 200,
      "description": "The work order id, e.g. WO-2026-0001, or the client name when only one job is theirs"
    },
    "issue_date": {
      "type": "string",
      "maxLength": 10,
      "description": "The invoice issue date, YYYY-MM-DD. Default today"
    },
    "tax_rate": {
      "type": "number",
      "minimum": -100,
      "maximum": 1000,
      "description": "VAT percent per line, overriding the shared business profile's default rate"
    }
  },
  "required": [
    "work_order"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Report the whole board: how many work orders sit at each status, the hours logged this month, and the value not yet invoiced per currency, with the oldest open jobs named. Pro.

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string",
      "maxLength": 7,
      "description": "The month for the hours figure, YYYY-MM. Default the current month"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 500,
      "description": "Maximum oldest-open rows listed, default and ceiling 500"
    }
  },
  "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#"
}