asset-register

Add one fixed asset to the register and return its id with the rate, useful life and convention taken from the bundled tax table. Cost and residual are whole minor units. Free tier holds ten assets.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "What the asset is, e.g. \"MacBook Pro 16\" or \"Delivery van\""
    },
    "scheme": {
      "type": "string",
      "enum": [
        "pl",
        "uk",
        "us"
      ],
      "description": "\"pl\" Polish KST annex rates, \"uk\" HMRC capital allowance pools, \"us\" IRS MACRS GDS. Omit to derive it from the shared business profile currency"
    },
    "category": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A code or name from the bundled table, e.g. \"487\" or \"Computers and computer sets\" (pl), \"main\" (uk), \"5-year\" (us). Read assets://categories for the list"
    },
    "cost_minor": {
      "type": "integer",
      "description": "Acquisition cost in MINOR units (integer cents/grosze), e.g. 549900 for 5499.00. Never a decimal"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO code. Defaults to the shared business profile currency, else the scheme table currency"
    },
    "purchase_date": {
      "type": "string",
      "maxLength": 10,
      "description": "ISO date YYYY-MM-DD the asset was bought"
    },
    "in_service_date": {
      "type": "string",
      "maxLength": 10,
      "description": "ISO date YYYY-MM-DD the asset entered use and the register. Defaults to purchase_date"
    },
    "residual_minor": {
      "type": "integer",
      "description": "Residual or salvage value in MINOR units, default 0. Must be less than cost. MACRS ignores it and the answer says so"
    },
    "method": {
      "type": "string",
      "enum": [
        "straight-line",
        "declining-balance"
      ],
      "description": "\"straight-line\" or \"declining-balance\". Default: the table row method, straight-line for the Polish annex and the reducing-balance pool rate for the UK"
    },
    "life_years": {
      "type": "number",
      "description": "Override the useful life derived from the table, in years. The answer reports that it was an override"
    },
    "rate_pct": {
      "type": "number",
      "description": "Override the annual percentage derived from the table. Use for a lowered Polish rate under art. 16i"
    },
    "declining_coefficient": {
      "type": "number",
      "description": "Declining-balance coefficient. Polish default 2.0, capped by the table; ignored with straight-line"
    },
    "project": {
      "type": "string",
      "maxLength": 200,
      "description": "Project, department or cost centre this asset belongs to"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "name",
    "category",
    "cost_minor",
    "purchase_date"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

List the assets in the register with cost, method, rate and net book value at a date, filtered by scheme, category, project, currency or disposal state. Free and unlimited.

{
  "type": "object",
  "properties": {
    "scheme": {
      "type": "string",
      "enum": [
        "pl",
        "uk",
        "us"
      ],
      "description": "Only assets on this tax scheme"
    },
    "category": {
      "type": "string",
      "maxLength": 200,
      "description": "Only assets in this table category code or name"
    },
    "project": {
      "type": "string",
      "maxLength": 200,
      "description": "Only assets on this project or cost centre"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "Only assets held in this currency"
    },
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Value the register at this month or date, YYYY-MM or YYYY-MM-DD. Default today"
    },
    "include_disposed": {
      "type": "boolean",
      "description": "Include assets already disposed of. Default false"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2000,
      "description": "Maximum rows, default and ceiling 2000"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Build the depreciation schedule for a stored asset, or price one not in the register, per year or per month, to residual or zero, with the table's rate, life and convention. Periods sum exactly to the base.

{
  "type": "object",
  "properties": {
    "asset": {
      "type": "string",
      "maxLength": 200,
      "description": "Asset id such as ASSET-2026-0001, or an exact or partial name. Omit and pass the fields below to price an asset that is not in the register"
    },
    "scheme": {
      "type": "string",
      "enum": [
        "pl",
        "uk",
        "us"
      ],
      "description": "Scheme, when pricing an asset that is not in the register"
    },
    "category": {
      "type": "string",
      "maxLength": 200,
      "description": "Table category code or name, when pricing an asset that is not in the register"
    },
    "cost_minor": {
      "type": "integer",
      "description": "Cost in MINOR units, when pricing an asset that is not in the register"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO code, when pricing an asset that is not in the register"
    },
    "purchase_date": {
      "type": "string",
      "maxLength": 10,
      "description": "ISO date YYYY-MM-DD, when pricing an asset that is not in the register"
    },
    "in_service_date": {
      "type": "string",
      "maxLength": 10,
      "description": "ISO date YYYY-MM-DD the asset entered use. Defaults to purchase_date"
    },
    "residual_minor": {
      "type": "integer",
      "description": "Residual in MINOR units, default 0"
    },
    "method": {
      "type": "string",
      "enum": [
        "straight-line",
        "declining-balance"
      ],
      "description": "\"straight-line\" or \"declining-balance\""
    },
    "life_years": {
      "type": "number",
      "description": "Override the useful life from the table, in years"
    },
    "rate_pct": {
      "type": "number",
      "description": "Override the annual percentage from the table"
    },
    "declining_coefficient": {
      "type": "number",
      "description": "Declining-balance coefficient; ignored with straight-line"
    },
    "granularity": {
      "type": "string",
      "enum": [
        "year",
        "month"
      ],
      "description": "\"year\" for one row per period, \"month\" for the monthly charge. Default \"year\""
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Return the depreciation journal for one month: debit depreciation expense and credit accumulated depreciation, per asset and in total, plus an expense_add-ready payload per currency. It writes no expense. Pro.

{
  "type": "object",
  "properties": {
    "month": {
      "type": "string",
      "maxLength": 10,
      "description": "The month to journal, YYYY-MM. A date YYYY-MM-DD is read as its month"
    },
    "scheme": {
      "type": "string",
      "enum": [
        "pl",
        "uk",
        "us"
      ],
      "description": "Only assets on this tax scheme"
    },
    "project": {
      "type": "string",
      "maxLength": 200,
      "description": "Only assets on this project or cost centre"
    },
    "expense_account": {
      "type": "string",
      "maxLength": 200,
      "description": "Debit account name. Default \"Depreciation expense\""
    },
    "accumulated_account": {
      "type": "string",
      "maxLength": 200,
      "description": "Credit account name. Default \"Accumulated depreciation\""
    },
    "category": {
      "type": "string",
      "maxLength": 200,
      "description": "Expense category to put on the expense_add payload. Default \"depreciation\""
    }
  },
  "required": [
    "month"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Record that an asset left the business on a date and return the gain or loss against net book value. proceeds_minor is in MINOR units. Depreciation stops here, and a second disposal is refused.

{
  "type": "object",
  "properties": {
    "asset": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Asset id such as ASSET-2026-0001, or an exact or partial name"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "ISO date YYYY-MM-DD the asset left the business. It cannot be before the in-service date"
    },
    "proceeds_minor": {
      "type": "integer",
      "description": "Sale proceeds in MINOR units, default 0 for a scrapping or a write-off"
    },
    "note": {
      "type": "string",
      "maxLength": 2000,
      "description": "What happened, e.g. sold to a dealer, written off after a fire"
    }
  },
  "required": [
    "asset",
    "date"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Remove one asset from the register when nothing depends on it: not disposed of, never journaled. Its free-tier slot is free again. An asset with a dependent is refused and the dependent is named. Free.

{
  "type": "object",
  "properties": {
    "asset": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Asset id such as ASSET-2026-0001, or an exact or partial name"
    }
  },
  "required": [
    "asset"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

For one year: net book value by category, scheme and currency at as_of, the year's depreciation charge per currency, and every disposal with its gain or loss. Pro; asset_list and asset_schedule are free per-asset views.

{
  "type": "object",
  "properties": {
    "year": {
      "type": "integer",
      "description": "Calendar year to report, e.g. 2026. Default the year of as_of, else this year"
    },
    "as_of": {
      "type": "string",
      "maxLength": 10,
      "description": "Value the register at this month or date, YYYY-MM or YYYY-MM-DD. Default the last day of the year"
    },
    "scheme": {
      "type": "string",
      "enum": [
        "pl",
        "uk",
        "us"
      ],
      "description": "Only assets on this tax scheme"
    },
    "project": {
      "type": "string",
      "maxLength": 200,
      "description": "Only assets on this project or cost centre"
    }
  },
  "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#"
}