# budgets.obligations.save

Create or edit a tax, GST/HST, accountant or other payment plan, keeping filing and payment dates separate and distinguishing an estimate from a confirmed amount. A negative amount is an expected refund and never offsets another obligation. Recording paidMinor is a planning note, not a bank payment or filed return. Link a complianceItemId to replace its automatic funding plan.

`POST /api/v1/accounting/budgets.obligations.save`

Permissions: `accounting:read`, `accounting:write` · Roles: admin, finance · Idempotency key required · Send `expectedRevision`

MCP tool: `accounting_budgets_obligations_save`

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `id` | string (ID) |  | The record's ID. |
| `expectedRevision` | integer | Yes | The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again. 0 to 9007199254740991. |
| `idempotencyKey` | string | Yes | Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match. 8–200 characters. |
| `name` | string | Yes | A display name. 1–160 characters. |
| `kind` | enum | Yes | Which kind of record or job this is. One of: `gst_hst`, `income_tax`, `accountant`, `other`. |
| `amountMinor` | string or null | Yes | An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50. |
| `amountBasis` | enum | Yes | One of: `estimate`, `confirmed`. |
| `paidMinor` | string | Yes | An amount in cents (the currency's smallest unit), written as a whole-number string such as "1250" for $12.50. Matches ^\d{1,15}$. |
| `currency` | string | Yes | Three-letter currency code, such as CAD or USD. |
| `periodFrom` | string (date) or null | Yes |  |
| `periodTo` | string (date) or null | Yes |  |
| `filingDueOn` | string (date) or null | Yes |  |
| `paymentDueOn` | string (date) or null | Yes |  |
| `accountId` | string (ID) or null | Yes | The ID of a bank, card or payment account, from accounts.list. |
| `reminderDays` | integer | Yes | 0 to 365. |
| `note` | string | Yes | A short note, kept with the record. at most 2000 characters. |
| `active` | boolean | Yes | Whether the record is turned on. |
| `complianceItemId` | string (ID) or null |  | Default `null`. |

## Example request

```bash
curl https://app.getoatmilk.com/api/v1/accounting/budgets.obligations.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "expectedRevision": 3,
  "name": "Synthetic Ventures Inc.",
  "kind": "gst_hst",
  "amountMinor": "1",
  "amountBasis": "estimate",
  "paidMinor": "1250",
  "currency": "CAD",
  "periodFrom": "2026-09-01",
  "periodTo": "2026-09-01",
  "filingDueOn": "2026-09-01",
  "paymentDueOn": "2026-09-01",
  "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "reminderDays": 7,
  "note": "Synthetic example from the docs",
  "active": true,
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d"
}'
```

Reference page: https://app.getoatmilk.com/docs/api/budgets.obligations.save