work-order

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['work_order'], 'properties': {'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'}, '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'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['work_order'], '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'}}, 'additionalProperties': False}

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

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

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

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

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['work_order'], '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'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['work_order'], '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'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['work_order'], 'properties': {'tax_rate': {'type': 'number', 'maximum': 1000, 'minimum': -100, 'description': "VAT percent per line, overriding the shared business profile's default rate"}, 'issue_date': {'type': 'string', 'maxLength': 10, 'description': 'The invoice issue date, YYYY-MM-DD. Default today'}, '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'}}, 'additionalProperties': False}

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

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'limit': {'type': 'integer', 'maximum': 500, 'minimum': 1, 'description': 'Maximum oldest-open rows listed, default and ceiling 500'}, 'month': {'type': 'string', 'maxLength': 7, 'description': 'The month for the hours figure, YYYY-MM. Default the current month'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['work_order', 'status'], 'properties': {'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'}, 'status': {'enum': ['draft', 'scheduled', 'in_progress', 'done', 'invoiced'], 'type': 'string', 'description': 'The status to move to. It must be the next one along'}, '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'}}, 'additionalProperties': False}