Create a counterparty default

POST/api/v1/counterparty-defaults

Create a new counterparty default.

Provide either registry_id (preferred — survives renames) or a raw counterparty_name string. default_ledger_id must be a non-bank ledger.

Operation ID: create_counterparty_default_api_v1_counterparty_defaults_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Request body

Schema: CounterpartyDefaultCreate

registry_idstring: Linked counterparty registry entry. Preferred — survives name normalisation. When provided, counterparty_name is treated as a display label only.
counterparty_namestring: Raw counterparty string used when the counterparty is not linked to the registry. Required when registry_id is absent.
default_ledger_idstringrequired: Ledger to categorize matched transactions to.
memostring: Optional memo to stamp on matches.
mark_personalboolean: Mark matched transactions as personal expenses.

Responses

201Successful Response

Schema: SuccessEnvelope_CounterpartyDefaultResponse_

successboolean
messagestring
codestring
dataCounterpartyDefaultResponse

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

POST/api/v1/counterparty-defaults

bash

curl -X POST 'https://api.ondayzero.com/api/v1/counterparty-defaults' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "default_ledger_id": "string"
}'