`parties.create`

Create a customer or vendor account with displayName, optional legal name, contacts, address, jurisdiction (for example CA-ON), tax treatment, currency, payment terms, preferred payment methods, invoice prefix, metadata, and an idempotency key.

POST/api/v1/accounting/parties.create

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required

MCP

accounting_parties_create

Fields

kindenum
Which kind of record or job this is.
customervendorboth
displayNamestringRequired
1–200 characters
legalNamestring or null
emailstring (email) or null
An email address.
phonestring or null
websitestring (uri) or null
contactsarray of objects
at most 25 items
addressobject
No other fields
jurisdictionstring or null
taxTreatmentenum
autohstgstgst_qstzero_ratedexemptnone
taxRateCodeenum or null
HST_13HST_14HST_15
taxIdstring or null
currencystring
Three-letter currency code, such as CAD or USD.
paymentTermsobject or null
preferredPaymentMethodIdsarray of strings (ID)
A list of record IDs.
at most 10 items
invoicePrefixstring or null
notesstring
Notes kept with the record.
at most 5000 characters
metadatamap
externalmap
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

curl https://app.getoatmilk.com/api/v1/accounting/parties.create \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "displayName": "Synthetic Ventures Inc."
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/parties.create", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "displayName": "Synthetic Ventures Inc."
  }),
});
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/parties.create",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "displayName": "Synthetic Ventures Inc.",
    },
    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/parties.create

curl https://app.getoatmilk.com/api/v1/accounting/parties.create \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "displayName": "Synthetic Ventures Inc."
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/parties.create", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "displayName": "Synthetic Ventures Inc."
  }),
});
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/parties.create",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "displayName": "Synthetic Ventures Inc.",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside contacts

Fields inside address

Fields inside paymentTerms

Example

Try it