{"openapi":"3.1.0","info":{"title":"POST /api/v1/counterparty-defaults","version":"1.0.0","description":"Create a counterparty default"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-defaults":{"post":{"tags":["counterparty-defaults"],"summary":"Create a counterparty default","description":"Create a new counterparty default.\n\nProvide either ``registry_id`` (preferred — survives renames) or a\nraw ``counterparty_name`` string. ``default_ledger_id`` must be a\nnon-bank ledger.","operationId":"create_counterparty_default_api_v1_counterparty_defaults_post","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/CounterpartyDefaultCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CounterpartyDefaultResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CounterpartyDefaultCreate":{"properties":{"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id","description":"Linked counterparty registry entry. Preferred — survives name normalisation. When provided, ``counterparty_name`` is treated as a display label only."},"counterparty_name":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Counterparty Name","description":"Raw counterparty string used when the counterparty is not linked to the registry. Required when ``registry_id`` is absent."},"default_ledger_id":{"type":"string","title":"Default Ledger Id","description":"Ledger to categorize matched transactions to."},"memo":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Memo","description":"Optional memo to stamp on matches."},"mark_personal":{"type":"boolean","title":"Mark Personal","description":"Mark matched transactions as personal expenses.","default":false}},"type":"object","required":["default_ledger_id"],"title":"CounterpartyDefaultCreate","description":"Payload to create a counterparty default."},"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"}},"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."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}