Contractor portal

taxInfo.save

Add, replace or remove one of your tax numbers (SIN, business number, ITN, or your country's tax number) for your tax slips. It's stored encrypted and only ever shown partly again. Add or replace a tax number in your contractor portal. Agents and API tokens can't handle full tax numbers.

POST/api/v1/contractor/taxInfo.save

INTERACTIVE_PORTAL_REQUIRED. Only the contractor does this, in their own portal. API and MCP calls are refused with a portalUrl to the exact step.

Permissions

contractor:readcontractor:write

Who can call it

contractor

Retries

Idempotency key required, with expectedRevision

MCP

contractor_tax_info_save

Fields

  • expectedRevisioninteger or null

    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.

  • idempotencyKeystringRequired

    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

  • taxNumberobject

    No other fields

  • removeTaxNumberenum
    sinbnitnforeign

Example

curl https://app.getoatmilk.com/api/v1/contractor/taxInfo.save \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "taxNumber": {
    "kind": "sin",
    "value": "example"
  }
}'
Response
{
  "data": { … }
}

Try it

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

POST/api/v1/contractor/taxInfo.save
curl https://app.getoatmilk.com/api/v1/contractor/taxInfo.save \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "taxNumber": {
    "kind": "sin",
    "value": "example"
  }
}'

More in Contractor portal.