deposits

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id', 'invoice'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Deposit id such as DEP-2026-0001, or an exact client name'}, 'date': {'type': 'string', 'description': 'YYYY-MM-DD, the day the deposit was set against the invoice. Defaults to today'}, 'note': {'type': 'string', 'maxLength': 10000, 'description': 'Free text kept on the application row'}, 'invoice': {'type': 'string', 'minLength': 1, 'description': 'The invoice number to apply it to, e.g. INV-2026-0001'}, 'amount_minor': {'type': 'integer', 'maximum': 1000000000000, 'description': 'How much of the deposit to apply, in minor units. Defaults to the smaller of what is held and what the invoice still owes', 'exclusiveMinimum': 0}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'as_of': {'type': 'string', 'description': 'YYYY-MM-DD, count only deposits received on or before this day'}, 'client': {'type': 'string', 'description': 'Client id, exact name or a name containing this text. Leave out for every client'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Deposit id such as DEP-2026-0001, or an exact client name'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'to': {'type': 'string', 'description': 'YYYY-MM-DD, latest received date'}, 'from': {'type': 'string', 'description': 'YYYY-MM-DD, earliest received date'}, 'kind': {'enum': ['security', 'retainer', 'all'], 'type': 'string', 'description': 'Default "all"'}, 'client': {'type': 'string', 'description': 'Only deposits for this client id, exact name, or a name containing this text'}, 'status': {'enum': ['held', 'applied', 'refunded', 'all'], 'type': 'string', 'description': 'Default "all". held means some of the money is still held'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client', 'amount_minor', 'kind'], 'properties': {'kind': {'enum': ['security', 'retainer'], 'type': 'string', 'description': 'security: held against damage or non-payment. retainer: held against work not yet invoiced'}, 'notes': {'type': 'string', 'maxLength': 10000, 'description': 'Free text kept on the record and printed on the statement'}, 'client': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'Client name or client id. A name the invoice server already knows brings its address, email and VAT id onto the deposit'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'Defaults to your business default currency'}, 'reference': {'type': 'string', 'maxLength': 200, 'description': 'Bank reference, transfer note or cheque number the money arrived with'}, 'amount_minor': {'type': 'integer', 'maximum': 1000000000000, 'description': 'What was received, in MINOR units: 50000 = 500.00 EUR, 50000 = JPY 50000. Never a decimal', 'exclusiveMinimum': 0}, 'client_email': {'type': 'string', 'maxLength': 320, 'description': "Only if the user gave it; otherwise the stored client's email is used"}, 'client_vat_id': {'type': 'string', 'maxLength': 64, 'description': 'Client VAT / tax registration id'}, 'received_date': {'type': 'string', 'description': 'YYYY-MM-DD, the day the money arrived. Defaults to today'}, 'client_address': {'type': 'string', 'maxLength': 2000, 'description': "Postal address for the statement's client block, newlines allowed"}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'string', 'minLength': 1, 'description': 'Deposit id such as DEP-2026-0001, or an exact client name'}, 'date': {'type': 'string', 'description': 'YYYY-MM-DD, the day the money went back. Defaults to today'}, 'note': {'type': 'string', 'maxLength': 10000, 'description': 'Free text kept on the refund row'}, 'method': {'type': 'string', 'maxLength': 200, 'description': 'How it was sent, e.g. "bank transfer to the account it came from". Printed on the statement'}, 'amount_minor': {'type': 'integer', 'maximum': 1000000000000, 'description': 'How much to give back, in minor units. Defaults to everything still held', 'exclusiveMinimum': 0}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'as_of': {'type': 'string', 'description': 'YYYY-MM-DD to count from. Defaults to today'}, 'limit': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'How many oldest held deposits to list. Default 10'}, 'older_than_days': {'type': 'integer', 'maximum': 36500, 'minimum': 0, 'description': 'Flag deposits received this many days ago or more with nothing applied. Default 90'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client'], 'properties': {'as_of': {'type': 'string', 'description': 'YYYY-MM-DD printed as the statement date. Defaults to today'}, 'client': {'type': 'string', 'minLength': 1, 'description': 'Client id, exact name or a name containing this text'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'Only needed when the client has deposits in more than one currency'}, 'out_path': {'type': 'string', 'description': 'Name for the downloaded file, e.g. acme-deposits. Defaults to the client and currency; the statement comes back as a download link valid for one hour'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['client'], 'properties': {'as_of': {'type': 'string', 'description': 'YYYY-MM-DD printed as the statement date. Defaults to today'}, 'client': {'type': 'string', 'minLength': 1, 'description': 'Client id, exact name or a name containing this text'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'Only needed when the client has deposits in more than one currency'}, 'greeting': {'type': 'string', 'description': 'Opening line, default "Hello" plus the client name'}, 'sign_off': {'type': 'string', 'description': 'Closing line, default your business name from the shared profile'}}, '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': {}}