imprest-account

Open a petty cash float on the imprest system and return its id. The imprest is the cash the tin is topped back up to at every replenishment, in whole minor units. Free tier: one float.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "description": "What this tin is, e.g. Office float or Warehouse float"
    },
    "currency": {
      "type": "string",
      "pattern": "^[A-Za-z]{3}$",
      "description": "ISO code the cash is held in"
    },
    "imprest_minor": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000000000000,
      "description": "The float amount in whole minor units (integer cents). 50000 is EUR 500.00"
    },
    "custodian": {
      "type": "string",
      "maxLength": 200,
      "description": "Who holds the tin. Defaults to the shared business profile's name"
    },
    "opened": {
      "type": "string",
      "maxLength": 10,
      "description": "The date the float was handed over, YYYY-MM-DD. Default today"
    },
    "note": {
      "type": "string",
      "maxLength": 2000
    }
  },
  "required": [
    "name",
    "currency",
    "imprest_minor"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Record cash put into the tin, in whole MINOR units, with the date and source, and return the new balance against the imprest. It also reimburses every voucher up to that date, as a replenishment does.

{
  "type": "object",
  "properties": {
    "amount_minor": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000000000000,
      "description": "Cash added, in whole minor units"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The date the cash went in, YYYY-MM-DD"
    },
    "source": {
      "type": "string",
      "maxLength": 200,
      "description": "Where it came from, e.g. Cheque 0142, Bank withdrawal, or Owner"
    },
    "float": {
      "type": "string",
      "maxLength": 200,
      "description": "The float id, e.g. FLOAT-2026-0001, or its name. Omit when there is only one"
    }
  },
  "required": [
    "amount_minor",
    "date",
    "source"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Record one voucher paid out of the tin and return its VOU-YYYY-NNNN number. More than the float holds is refused, and so is a byte-identical duplicate. Free tier: 20 vouchers a calendar month.

{
  "type": "object",
  "properties": {
    "amount_minor": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100000000000000,
      "description": "What was paid out, in whole minor units. 1250 is EUR 12.50"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The date the cash left the tin, YYYY-MM-DD"
    },
    "category": {
      "type": "string",
      "maxLength": 200,
      "description": "What kind of spend, e.g. postage, travel, office. It becomes the expenses:<category> account"
    },
    "description": {
      "type": "string",
      "maxLength": 2000,
      "description": "What was bought, e.g. Printer paper x5"
    },
    "paid_to": {
      "type": "string",
      "maxLength": 200,
      "description": "Who was paid, e.g. Corner Shop"
    },
    "receipt_ref": {
      "type": "string",
      "maxLength": 200,
      "description": "The receipt number or where the paper is filed"
    },
    "float": {
      "type": "string",
      "maxLength": 200,
      "description": "The float id, e.g. FLOAT-2026-0001, or its name. Omit when there is only one"
    },
    "duplicate_ok": {
      "type": "boolean",
      "description": "Record it even though an identical voucher exists, for a genuinely repeated purchase. Default false"
    }
  },
  "required": [
    "amount_minor",
    "date",
    "category",
    "description",
    "paid_to"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Delete a voucher entered wrongly, by its VOU number. One already covered by a reconciliation is refused, naming the count it would falsify: record a correcting voucher instead. Free.

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

Count the tin: give the cash counted in whole MINOR units and the date, and get the expected balance, the difference, and every voucher since the last count, which this marks reconciled. Free.

{
  "type": "object",
  "properties": {
    "counted_minor": {
      "type": "integer",
      "minimum": 0,
      "maximum": 100000000000000,
      "description": "The cash actually counted, in whole minor units"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The date it was counted, YYYY-MM-DD"
    },
    "float": {
      "type": "string",
      "maxLength": 200,
      "description": "The float id, e.g. FLOAT-2026-0001, or its name. Omit when there is only one"
    }
  },
  "required": [
    "counted_minor",
    "date"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Work out what puts the float back to its imprest: the amount, the vouchers it reimburses, the totals per category as an expense_add-ready payload, and the double entry. Writes nothing. Pro.

{
  "type": "object",
  "properties": {
    "float": {
      "type": "string",
      "maxLength": 200,
      "description": "The float id, e.g. FLOAT-2026-0001, or its name. Omit when there is only one"
    },
    "date": {
      "type": "string",
      "maxLength": 10,
      "description": "The date the request is made, YYYY-MM-DD. Default today"
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Report each float: balance against imprest, what it takes to restore it, unreconciled vouchers with their total, the last count, and the history of what counts found over or short. Pro.

{
  "type": "object",
  "properties": {
    "float": {
      "type": "string",
      "maxLength": 200,
      "description": "The float id, e.g. FLOAT-2026-0001, or its name. Omit when there is only one"
    },
    "limit": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2000,
      "description": "Maximum unreconciled vouchers listed per float, default and ceiling 2000"
    }
  },
  "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#"
}