201Successful Response
Schema: SuccessEnvelope_CounterpartyDefaultBulkResponse_
successbooleanmessagestringcodestringdataCounterpartyDefaultBulkResponse
/api/v1/counterparty-defaults/bulkGives every listed counterparty (up to 500) the same default category: an item with default_id, or whose key already has a default, is updated; the rest are created. Each item succeeds or fails on its own (results in request order). Each saved default lists its conflicts when the batch has at most 25 items (conflicts_checked). When every item fails the same way (a category that is not an active category ledger of this business) the request fails with that error.
Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.
Schema: CounterpartyDefaultBulkRequest
itemsarray · CounterpartyDefaultBulkItemrequiredCounterpartyDefaultBulkItemregistry_idstringLinked registry entry (preferred key)
counterparty_namestringName key when the counterparty is not linked
default_idstringThe default this counterparty already has (the summary row's default_id); it is updated instead of creating a new one
default_ledger_idstringrequiredLedger every listed counterparty defaults to
memostringMemo for new defaults; existing defaults keep theirs when omitted
mark_personalbooleanMark matched transactions as personal expenses
Schema: SuccessEnvelope_CounterpartyDefaultBulkResponse_
successbooleanmessagestringcodestringdataCounterpartyDefaultBulkResponseSchema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.
Schema: ErrorResponse
errorstringrequiredError category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequiredHuman-readable explanation, safe to show to end users.
codestringrequiredStable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstringCorrelation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobjectField-level validation messages keyed by field name. Present on 400/422 validation failures only.