mileage-logbook

Log one drive in the mileage log: the date, where from and to, the distance in miles or km, the purpose, and the category (business, medical, moving, charitable, personal). Returns its TR-YYYY-NNNN id. Free tier: 20 trips per calendar month, counted on the month of the trip date.

{
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The day the trip was driven, YYYY-MM-DD. A future date is refused: the trip cannot have been driven yet"
    },
    "from": {
      "type": "string",
      "maxLength": 200,
      "description": "Where the trip started, e.g. Home office, 14 Nowa Street"
    },
    "to": {
      "type": "string",
      "maxLength": 200,
      "description": "Where it ended, e.g. Client site, 2 Mill Lane"
    },
    "distance": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "How far, to the thousandth of the unit, e.g. 12.5"
    },
    "unit": {
      "type": "string",
      "maxLength": 20,
      "description": "miles or km; spellings like mi and kilometre are accepted"
    },
    "purpose": {
      "type": "string",
      "maxLength": 200,
      "description": "Why the trip was made, e.g. Site visit for the Kowalski refit"
    },
    "category": {
      "type": "string",
      "maxLength": 20,
      "description": "One of: business, medical, moving, charitable, personal. Personal trips are kept for the record and priced only if a rate exists"
    },
    "jurisdiction": {
      "type": "string",
      "maxLength": 100,
      "description": "Which rate set prices this trip, when more than one jurisdiction has a rate for its category. Omit when only one does"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "date",
    "from",
    "to",
    "distance",
    "unit",
    "purpose",
    "category"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List trips in the mileage log, oldest first: date, from, to, distance, category, and the amount each earns under the rate in force on its day (or the plain reason it is unpriced). Filter by date range and category. Reads only.

{
  "type": "object",
  "properties": {
    "from_date": {
      "type": "string",
      "maxLength": 10,
      "description": "Only trips dated on or after this, YYYY-MM-DD"
    },
    "to_date": {
      "type": "string",
      "maxLength": 10,
      "description": "Only trips dated on or before this, YYYY-MM-DD"
    },
    "category": {
      "type": "string",
      "maxLength": 20,
      "description": "Only trips of this category: business, medical, moving, charitable, personal"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Remove one trip from the mileage log by its exact TR-YYYY-NNNN id, for entries made by mistake. The id is not reissued: a gap in the TR series is the record that a trip was removed.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 20,
      "description": "The exact trip id, e.g. TR-2026-0003"
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Set what one mile or km is worth for one category in one jurisdiction from a date forward: the jurisdiction label, the category, the rate per unit, the currency, and the date it takes effect. Rates form a series per jurisdiction and category, and each trip earns the rate in force on the day it was driven. No rate ships with this server; the figures are yours to verify. Free tier: one rate per jurisdiction and category; the year-over-year series is Pro.

{
  "type": "object",
  "properties": {
    "jurisdiction": {
      "type": "string",
      "maxLength": 100,
      "description": "A label for the rate set, e.g. US federal or Canada federal. It is a label, not legal advice"
    },
    "category": {
      "type": "string",
      "maxLength": 20,
      "description": "Which category this prices: business, medical, moving, charitable, personal"
    },
    "rate": {
      "type": "number",
      "exclusiveMinimum": 0,
      "description": "The rate per unit in currency units, to the thousandth, e.g. 0.70 for 70 cents a mile"
    },
    "unit": {
      "type": "string",
      "maxLength": 20,
      "description": "The distance unit the rate prices"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO code the rate is in"
    },
    "effective_from": {
      "type": "string",
      "maxLength": 10,
      "description": "The date the rate starts to apply, YYYY-MM-DD. May be in the future: authorities announce next year's rate ahead of time"
    }
  },
  "required": [
    "jurisdiction",
    "category",
    "rate",
    "unit",
    "currency",
    "effective_from"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List every mileage rate on file, grouped by jurisdiction and category with the effective-from dates in order: the series each trip is priced from. Reads only.

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

The deductible mileage for a date range, per category: trips, distance kept per unit, the rate each trip earned (the one in force on its day), and the deductible amount, totalled per currency. Trips with no applicable rate are listed with the reason, not silently dropped. Defaults to the current calendar year. Never metered.

{
  "type": "object",
  "properties": {
    "from_date": {
      "type": "string",
      "maxLength": 10,
      "description": "Start of the range, YYYY-MM-DD. Default January 1 of the current year"
    },
    "to_date": {
      "type": "string",
      "maxLength": 10,
      "description": "End of the range, YYYY-MM-DD. Default December 31 of the current year"
    },
    "category": {
      "type": "string",
      "maxLength": 20,
      "description": "Only this category: business, medical, moving, charitable, personal"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

The mileage log as CSV, one row per trip, oldest first: date, from, to, distance, unit, category, the rate applied (the one in force on the trip's day), the currency and the amount, plus purpose, jurisdiction, effective_from and id. The amount column is a bare number a spreadsheet reads. Refuses while any non-personal trip in the window is unpriced, so an accountant never receives a log with silent gaps. Pro.

{
  "type": "object",
  "properties": {
    "from_date": {
      "type": "string",
      "maxLength": 10,
      "description": "Start of the range, YYYY-MM-DD. Default January 1 of the current year"
    },
    "to_date": {
      "type": "string",
      "maxLength": 10,
      "description": "End of the range, YYYY-MM-DD. Default December 31 of the current year"
    }
  },
  "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#"
}