{"openapi":"3.1.0","info":{"title":"POST /api/v1/counterparty-defaults/bulk","version":"1.0.0","description":"Set one default category on many counterparties"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-defaults/bulk":{"post":{"tags":["counterparty-defaults"],"summary":"Set one default category on many counterparties","description":"Gives 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.","operationId":"bulk_set_counterparty_defaults","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CounterpartyDefaultBulkRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CounterpartyDefaultBulkResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"bulk_set_counterparty_defaults_api_v1_counterparty_defaults_bulk_post"}}},"components":{"schemas":{"CounterpartyDefaultBulkItem":{"properties":{"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id","description":"Linked registry entry (preferred key)"},"counterparty_name":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Counterparty Name","description":"Name key when the counterparty is not linked"},"default_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Id","description":"The default this counterparty already has (the summary row's ``default_id``); it is updated instead of creating a new one"}},"type":"object","title":"CounterpartyDefaultBulkItem","description":"One counterparty to give the bulk default."},"CounterpartyDefaultBulkRequest":{"properties":{"items":{"items":{"$ref":"#/components/schemas/CounterpartyDefaultBulkItem"},"type":"array","maxItems":500,"minItems":1,"title":"Items"},"default_ledger_id":{"type":"string","title":"Default Ledger Id","description":"Ledger every listed counterparty defaults to"},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo","description":"Memo for new defaults; existing defaults keep theirs when omitted"},"mark_personal":{"type":"boolean","title":"Mark Personal","description":"Mark matched transactions as personal expenses","default":false}},"type":"object","required":["items","default_ledger_id"],"title":"CounterpartyDefaultBulkRequest","description":"Body of ``POST /counterparty-defaults/bulk``: one category for many."},"CounterpartyDefaultBulkResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CounterpartyDefaultBulkResult"},"type":"array","title":"Results"},"created":{"type":"integer","title":"Created","default":0},"updated":{"type":"integer","title":"Updated","default":0},"failed":{"type":"integer","title":"Failed","default":0},"conflicts_checked":{"type":"boolean","title":"Conflicts Checked","description":"False when the batch was too large to list each default's conflicting rules; ``GET /counterparty-defaults/conflicts`` answers per counterparty","default":true}},"type":"object","required":["results"],"title":"CounterpartyDefaultBulkResponse","description":"One result per item, in request order."},"CounterpartyDefaultBulkResult":{"properties":{"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"status":{"type":"string","enum":["created","updated","failed"],"title":"Status"},"default":{"anyOf":[{"$ref":"#/components/schemas/CounterpartyDefaultResponse"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["status"],"title":"CounterpartyDefaultBulkResult","description":"What happened to one listed counterparty."},"CounterpartyDefaultConflict":{"properties":{"type":{"type":"string","enum":["bank_rule","default"],"title":"Type"},"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"ledger_id":{"type":"string","title":"Ledger Id"},"ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Name"}},"type":"object","required":["type","id","name","ledger_id"],"title":"CounterpartyDefaultConflict","description":"A bank rule or another default that disagrees with a default.\n\n``type = \"bank_rule\"``: an enabled rule whose counterparty condition\nmatches this counterparty and books ``ledger_id``. A rule a person wrote\noutranks the default; an auto-learned rule loses to it.\n``type = \"default\"``: another default for the same counterparty under\nthe other key kind (registry entry vs name)."},"CounterpartyDefaultResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"default_ledger_id":{"type":"string","title":"Default Ledger Id"},"default_ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Ledger Name"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"mark_personal":{"type":"boolean","title":"Mark Personal"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"conflicts":{"items":{"$ref":"#/components/schemas/CounterpartyDefaultConflict"},"type":"array","title":"Conflicts","description":"Bank rules / other defaults for the same counterparty that book a different category (returned by create and update)"}},"type":"object","required":["id","business_id","registry_id","counterparty_name","default_ledger_id","memo","mark_personal","created_at","updated_at"],"title":"CounterpartyDefaultResponse","description":"Public shape of a counterparty default."},"SuccessEnvelope_CounterpartyDefaultBulkResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/CounterpartyDefaultBulkResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CounterpartyDefaultBulkResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}