{"openapi":"3.1.0","info":{"title":"POST /api/v1/close/verification/apply-counterparty-defaults","version":"1.0.0","description":"Apply counterparty defaults to categorized transactions"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/close/verification/apply-counterparty-defaults":{"post":{"tags":["close-verification"],"summary":"Apply counterparty defaults to categorized transactions","description":"Move already-categorized transactions in a period to the ledger their counterparty default names. Rows in a closed period, rows whose default cannot take the direction of the money and rows a person categorized by hand are skipped. Defaults to a dry run.","operationId":"apply_close_verification_counterparty_defaults","parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string","description":"Period start (YYYY-MM-DD)","title":"Start Date"},"description":"Period start (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","description":"Period end (YYYY-MM-DD)","title":"End Date"},"description":"Period end (YYYY-MM-DD)"},{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","description":"Plan only; set false to move the transactions","default":true,"title":"Dry Run"},"description":"Plan only; set false to move the transactions"},{"name":"counterparty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Only rows for this counterparty (default all)","title":"Counterparty"},"description":"Only rows for this counterparty (default all)"},{"name":"include_user_categorized","in":"query","required":false,"schema":{"type":"boolean","description":"Also move rows a person categorized by hand","default":false,"title":"Include User Categorized"},"description":"Also move rows a person categorized by hand"},{"name":"plan_hash","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The plan_hash the dry run returned; the move is refused if the rows changed since","title":"Plan Hash"},"description":"The plan_hash the dry run returned; the move is refused if the rows changed since"},{"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"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ApplyCounterpartyDefaultsResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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"}}}}},"x-fastapi-operation-id":"apply_close_verification_counterparty_defaults_api_v1_close_verification_apply_counterparty_defaults_post"}}},"components":{"schemas":{"ApplyCounterpartyDefaultsResponse":{"properties":{"business_id":{"type":"string","title":"Business Id"},"period_start":{"type":"string","title":"Period Start"},"period_end":{"type":"string","title":"Period End"},"dry_run":{"type":"boolean","title":"Dry Run"},"include_user_categorized":{"type":"boolean","title":"Include User Categorized"},"eligible_count":{"type":"integer","title":"Eligible Count","description":"Rows that would move (dry run) or moved"},"moved_count":{"type":"integer","title":"Moved Count","default":0},"failed_count":{"type":"integer","title":"Failed Count","default":0},"skipped_counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Skipped Counts"},"by_target_ledger":{"additionalProperties":{"type":"integer"},"type":"object","title":"By Target Ledger","description":"Moved/eligible rows per target ledger name"},"moves":{"items":{"$ref":"#/components/schemas/CounterpartyDefaultMove"},"type":"array","title":"Moves"},"moves_truncated":{"type":"boolean","title":"Moves Truncated","default":false}},"type":"object","required":["business_id","period_start","period_end","dry_run","include_user_categorized","eligible_count"],"title":"ApplyCounterpartyDefaultsResponse"},"CounterpartyDefaultMove":{"properties":{"transaction_id":{"type":"string","title":"Transaction Id"},"date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date"},"amount_cents":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Cents"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"counterparty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty"},"from_ledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Ledger Id"},"from_ledger":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From Ledger"},"to_ledger_id":{"type":"string","title":"To Ledger Id"},"to_ledger":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To Ledger"},"default_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Id"},"status":{"type":"string","title":"Status","description":"will_move | moved | skipped_user_categorized | skipped_direction | skipped_closed_period | failed"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["transaction_id","to_ledger_id","status"],"title":"CounterpartyDefaultMove","description":"One categorized transaction the counterparty default would move."},"SuccessEnvelope_ApplyCounterpartyDefaultsResponse_":{"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/ApplyCounterpartyDefaultsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ApplyCounterpartyDefaultsResponse]"},"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":[]}]}