`contractorOps.salesTax.confirm`

Confirm or correct the GST/HST a contractor declared, with contractorId, expectedRevision (the profile revision reviewed), chargesSalesTax, salesTaxRateBps (1 to 10000 when charged), a note, and idempotencyKey. Payouts add sales tax only at a confirmed rate, and a confirmation stops applying when the declared answers change. Payouts that aren't paid and have no Wise transfer are updated to the confirmed rate; approved ones go back for approval.

POST/api/v1/accounting/contractorOps.salesTax.confirm

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_contractor_ops_sales_tax_confirm

Fields

contractorIdstring (ID)Required
The ID of a contractor, from contractors.list.
expectedRevisionintegerRequired
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.
at most 9007199254740991 · greater than 0
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
chargesSalesTaxbooleanRequired
salesTaxRateBpsinteger or null
notestringRequired
A short note, kept with the record.
3–500 characters

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.salesTax.confirm \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "chargesSalesTax": true,
  "note": "Synthetic example from the docs",
  "salesTaxRateBps": 1
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.salesTax.confirm", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "expectedRevision": 3,
    "chargesSalesTax": true,
    "note": "Synthetic example from the docs",
    "salesTaxRateBps": 1
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/contractorOps.salesTax.confirm",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "chargesSalesTax": True,
        "note": "Synthetic example from the docs",
        "salesTaxRateBps": 1,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

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.

Input

POST/api/v1/accounting/contractorOps.salesTax.confirm

curl https://app.getoatmilk.com/api/v1/accounting/contractorOps.salesTax.confirm \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "expectedRevision": 3,
  "chargesSalesTax": true,
  "note": "Synthetic example from the docs",
  "salesTaxRateBps": 1
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/contractorOps.salesTax.confirm", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "expectedRevision": 3,
    "chargesSalesTax": true,
    "note": "Synthetic example from the docs",
    "salesTaxRateBps": 1
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/contractorOps.salesTax.confirm",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "contractorId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "expectedRevision": 3,
        "chargesSalesTax": True,
        "note": "Synthetic example from the docs",
        "salesTaxRateBps": 1,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it