mileage-tracker

{'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': 'Matched against the merchant as a case-insensitive regular expression, and as a plain substring if it is not valid regex. The first matching rule in the list wins'}, 'category': {'type': 'string', 'maxLength': 500, 'description': 'Category to apply'}}, 'additionalProperties': False}, 'maxItems': 500, 'description': 'The FULL rule list; it replaces the stored one, so include the rules you want to keep. Omit to list the current rules instead'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['amount'], 'properties': {'vat': {'type': 'number', 'maximum': 100, 'minimum': 0, 'description': 'Alias for vat_rate'}, 'date': {'type': 'string', 'maxLength': 10, 'description': 'ISO date YYYY-MM-DD, default today'}, 'note': {'type': 'string', 'maxLength': 2000}, 'amount': {'type': 'number', 'description': "Gross amount on the receipt, in major units, e.g. 12.34. It is stored as integer minor units in the expense's own currency, so nothing is lost to floating point."}, 'project': {'type': 'string', 'maxLength': 500, 'description': 'Project or client this belongs to'}, 'billable': {'type': 'boolean', 'description': 'Rebillable to the client. Default: true when project is given (a receipt booked to a client project is normally rebilled), false otherwise. Pass it explicitly to override.'}, 'category': {'type': 'string', 'maxLength': 500, 'description': 'Category, e.g. software, travel, office. Omit and the stored category rules are matched against the merchant to fill it in'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': "ISO code. Defaults to your expense_settings default_currency, else the shared business profile's default_currency, else EUR"}, 'merchant': {'type': 'string', 'maxLength': 500, 'description': 'Who was paid, e.g. Adobe'}, 'tax_rate': {'type': 'number', 'maximum': 100, 'minimum': 0, 'description': 'Alias for vat_rate'}, 'vat_rate': {'type': 'number', 'maximum': 100, 'minimum': 0, 'description': 'VAT percent already included in amount; it splits the gross into net and VAT. Omit to use the expense_settings default, or get no split at all when none is set'}, 'receipt_path': {'type': 'string', 'maxLength': 4096, 'description': 'Absolute path to the receipt file; it is checked and hashed'}}, 'additionalProperties': False}

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

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['from', 'to', 'format'], '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': 'Optional file name for the download, e.g. q3.csv'}, 'format': {'enum': ['csv', 'xlsx', 'json'], 'type': 'string'}, 'project': {'type': 'string', 'maxLength': 500}, 'billable': {'type': 'boolean'}, 'category': {'type': 'string', 'maxLength': 500}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'project': {'type': 'string', 'maxLength': 500}, 'billable': {'type': 'boolean'}, 'category': {'type': 'string', 'maxLength': 500}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['invoice_number'], 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'ids': {'type': 'array', 'items': {'type': 'string', 'maxLength': 64}, 'description': 'Expense ids, as returned per currency by expense_to_invoice. Takes precedence over project/from/to'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'project': {'type': 'string', 'maxLength': 500, 'description': 'Project rebilled, used with from, to and currency'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'Required when marking by range: one invoice carries one currency. A range marks only billable, not-yet-rebilled expenses in this one currency, so invoicing the EUR group cannot mark the PLN one'}, 'invoice_number': {'type': 'string', 'maxLength': 64, 'description': 'Invoice the expenses were billed on. Required: the marker records WHICH invoice carries each expense, and it is stored on every expense marked'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'properties': {'default_currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'ISO 4217 code to assume when a call gives none, e.g. EUR. Default EUR'}, 'default_vat_rate': {'type': 'number', 'maximum': 100, 'minimum': 0, 'description': 'VAT percent already included in a receipt, e.g. 23 in Poland, 19 in Germany. Set it once and every later expense gets its net/VAT split without the caller repeating the rate. It applies when the expense is inserted, never retroactively. Pass 0 to clear it'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['from', 'to', 'group_by'], 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'project': {'type': 'string', 'maxLength': 500}, 'billable': {'type': 'boolean'}, 'group_by': {'enum': ['category', 'project', 'month', 'merchant'], 'type': 'string', 'description': 'How to group the totals'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['project', 'from', 'to'], 'properties': {'to': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'from': {'type': 'string', 'maxLength': 10, 'description': 'ISO date, inclusive'}, 'project': {'type': 'string', 'maxLength': 500, 'description': 'Project or client to rebill'}, 'fx_rates': {'type': 'object', 'description': 'Rate per source currency, meaning 1 unit of that currency = X units of target_currency, e.g. {"EUR": 1.08, "GBP": 1.27}. You supply the rate; nothing here fetches or guesses one. Omit it when the range holds several currencies and the response names the exact argument to pass', 'additionalProperties': {'type': 'number', 'exclusiveMinimum': 0}}, 'markup_percent': {'type': 'number', 'maximum': 1000, 'minimum': 0, 'description': "Percent added to each net amount. Every line's unit_price is the NET amount and its tax_rate is the VAT rate recorded on the expense, so the invoice recomputes the same tax instead of charging it twice and the line total comes back to the receipt gross"}, 'assume_vat_rate': {'type': 'number', 'maximum': 100, 'minimum': 0, 'description': 'Split expenses that recorded NO VAT rate at this percent, flagged in the description. Only applied when you pass it here. An expense with no rate holds a GROSS amount and is otherwise rebilled as-is with tax_rate 0 plus a warning in its description, so a default tax rate applied on the invoice would tax that receipt a second time. A stored rate of 0 is a real rate (exempt), not a gap. The expense_settings default is never applied retroactively, because that would rewrite the tax meaning of receipts entered before it existed'}, 'target_currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'Convert every line into this currency and return ONE group, e.g. "USD". Needs fx_rates for each other currency present. Lines are otherwise grouped per currency, because one invoice carries one currency; each converted line carries "[converted from EUR 12.40 at 1.08]" in its description'}, 'include_rebilled': {'type': 'boolean', 'description': 'Include expenses already marked as rebilled, default false'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id'], 'properties': {'id': {'type': 'string', 'maxLength': 64, 'description': 'Expense id from expense_add or expense_list'}, 'date': {'type': 'string', 'maxLength': 10}, 'note': {'type': 'string', 'maxLength': 2000}, 'amount': {'type': 'number'}, 'project': {'type': 'string', 'maxLength': 500}, 'billable': {'type': 'boolean'}, 'category': {'type': 'string', 'maxLength': 500}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$'}, 'merchant': {'type': 'string', 'maxLength': 500}, 'rebilled': {'type': 'boolean', 'description': 'false clears the rebilled marker and the invoice number, so the expense can be billed again'}, 'vat_rate': {'type': 'number', 'maximum': 100, 'minimum': 0}, 'unlink_rebill': {'type': 'boolean', 'description': 'Allow editing amount, currency or vat_rate on a rebilled expense. Clears rebilled_at and rebilled_invoice, because the invoice no longer matches'}}, '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': ['purpose'], 'properties': {'km': {'type': 'number', 'description': 'Distance in kilometres. Give exactly one of km or miles'}, 'date': {'type': 'string', 'description': 'ISO date, default today'}, 'miles': {'type': 'number', 'description': 'Distance in miles. Give exactly one of km or miles'}, 'region': {'enum': ['PL', 'UK', 'US', 'EU'], 'type': 'string', 'description': 'Which built-in table rate to use: PL 1.15 PLN/km, UK 0.45 GBP/mile, US 0.70 USD/mile, EU 0.30 EUR/km. Default US for miles, EU for km. Each is one flat approximate rate per region with no effective dates, no vehicle or engine class and no first-10000-mile band, so it is NOT a tax calculation'}, 'project': {'type': 'string', 'maxLength': 500, 'description': 'Bill the trip to a client or project - use the same name you use in time-tracker and expense_add. Without it the drive is invisible to expense_summary by project and to expense_to_invoice'}, 'purpose': {'type': 'string', 'maxLength': 2000, 'description': 'Why the trip was made, e.g. client meeting in Krakow'}, 'billable': {'type': 'boolean', 'description': 'Whether the trip is rebilled to the client. Default true, so a mileage claim reaches expense_to_invoice unless you pass false'}, 'currency': {'type': 'string', 'pattern': '^[A-Za-z]{3}$', 'description': 'Currency for your own rate. Only accepted together with rate_per_km; a table rate keeps the table currency'}, 'rate_per_km': {'type': 'number', 'minimum': 0, 'description': 'Your own rate per supplied unit, overriding the table. Pass it whenever you need your exact scheme rather than the approximate table rate'}}, 'additionalProperties': False}

{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['id', 'path'], 'properties': {'id': {'type': 'string', 'maxLength': 64, 'description': 'Expense id from expense_add or expense_list'}, 'path': {'type': 'string', 'maxLength': 4096, 'description': 'Path to the receipt file. It must already exist; a leading ~ is expanded. The path and its sha256 are stored on the expense'}}, 'additionalProperties': False}