categorize-transactions

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

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'name': {'type': 'string', 'maxLength': 70, 'minLength': 1}}, 'additionalProperties': False}

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

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['name'], 'properties': {'url': {'type': 'string', 'description': "url: fetch a public file instead of pasting base64 (recommended above about 10 KB). Public http(s) only; private, link-local and this endpoint's own zone are refused"}, 'name': {'type': 'string', 'maxLength': 70, 'minLength': 1, 'description': 'Name to refer to this statement by: 1-64 characters of letters, digits, underscore or dash, e.g. "september"'}, 'content': {'type': 'string', 'description': 'The export as text, including the header row'}, 'content_base64': {'type': 'string', 'description': "The file's bytes, base64-encoded, instead of text"}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'rules': {'type': 'array', 'items': {'type': 'object', 'required': ['match', 'category'], 'properties': {'match': {'type': 'string', 'maxLength': 200, 'description': 'Text to look for in the counterparty or description, e.g. "spotify"'}, 'regex': {'type': 'boolean', 'description': 'Treat match as a regular expression. A pattern that can backtrack exponentially is refused and used as a substring instead'}, 'category': {'type': 'string', 'maxLength': 120, 'description': 'Category to set, e.g. "software"'}}, 'additionalProperties': False}, 'description': 'The complete rule list; it replaces the stored one. Omit to list the current rules'}, 'reapply_all': {'type': 'boolean', 'description': 'Also overwrite categories set by an earlier rule or by hand. Default false: only uncategorised transactions are touched'}}, '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': ['from', 'to'], 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'account': {'type': 'string', 'maxLength': 120, 'description': 'Limit to one bank account'}, 'window_days': {'type': 'integer', 'maximum': 31, 'minimum': 0, 'description': 'Allowed gap between the expense date and the bank date, default 3. A card payment usually settles a day or two after the receipt'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'months': {'type': 'integer', 'maximum': 60, 'minimum': 1, 'description': 'How far back to look, default 3. Two occurrences are enough to see a cadence, three make it certain'}, 'account': {'type': 'string', 'maxLength': 120, 'description': 'Limit to one account'}, 'min_occurrences': {'type': 'integer', 'maximum': 24, 'minimum': 2, 'description': 'Occurrences required before a charge counts as recurring, default 2'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['from', 'to', 'format', 'path'], 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'path': {'type': 'string', 'maxLength': 4096, 'description': 'Name for the downloaded file, e.g. september. It comes back as a download link valid for one hour'}, 'format': {'enum': ['csv', 'json'], 'type': 'string', 'description': 'csv for a spreadsheet, json for a program'}, 'account': {'type': 'string', 'maxLength': 120, 'description': 'Limit to one account'}, 'category': {'type': 'string', 'maxLength': 500, 'description': 'Limit to one category'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['path'], 'properties': {'bank': {'enum': ['auto', 'revolut', 'wise', 'mbank', 'pko', 'ing', 'n26', 'generic'], 'type': 'string', 'description': 'Bank profile. Default "auto": the headers decide. "generic" skips profile detection and uses the header heuristics alone'}, 'path': {'type': 'string', 'maxLength': 4096, 'description': 'Name of a statement uploaded with bank_upload'}, 'account': {'type': 'string', 'maxLength': 120, 'description': 'Name for this account, e.g. "business EUR". Default: the file name without its extension. Later imports of the same account are deduplicated against it'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': "Currency for rows where the file names none. Defaults to the shared business profile's default_currency, else EUR; the response says which it used"}, 'overwrite': {'type': 'boolean', 'description': 'Delete every transaction already stored for this account before importing, instead of merging. Use it when the bank reissued a corrected export'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive. Default: today'}, 'top': {'type': 'integer', 'maximum': 200, 'minimum': 1, 'description': 'Groups returned per currency, largest net first. Default 25'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive. Default: the start of the current month'}, 'account': {'type': 'string', 'maxLength': 120, 'description': 'Limit the summary to one account'}, 'group_by': {'enum': ['category', 'month', 'account', 'counterparty'], 'type': 'string', 'description': 'Default category'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['ids', 'category'], 'properties': {'ids': {'type': 'array', 'items': {'type': 'string', 'maxLength': 64}, 'minItems': 1, 'description': 'Transaction ids, as returned by transactions_list or transactions_search'}, 'category': {'type': 'string', 'maxLength': 120, 'description': 'Category to set. Pass an empty string to clear it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date YYYY-MM-DD, inclusive. Default: today'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date YYYY-MM-DD, inclusive. Default: the start of the current month'}, 'limit': {'type': 'integer', 'maximum': 1000, 'minimum': 1, 'description': 'Rows returned, default 200. Totals always cover the whole range'}, 'account': {'type': 'string', 'maxLength': 120, 'description': 'Limit to one account, as named at import'}, 'category': {'type': 'string', 'maxLength': 500, 'description': 'Only transactions in this category'}, 'uncategorized': {'type': 'boolean', 'description': 'Only transactions with no category yet'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['query'], 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'limit': {'type': 'integer', 'maximum': 500, 'minimum': 1, 'description': 'Rows returned, default 100'}, 'query': {'type': 'string', 'maxLength': 200, 'description': 'Text to look for, e.g. "spotify" or "acme"'}}, 'additionalProperties': False}