{"openapi":"3.1.0","info":{"title":"GET /api/v1/posting-defaults/preview","version":"1.0.0","description":"Preview invoice posting defaults"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/posting-defaults/preview":{"get":{"tags":["posting-defaults"],"summary":"Preview invoice posting defaults","description":"How many existing finalized-invoice entries sit on the system ledgers and how many on the configured ones. Read-only.","operationId":"preview_posting_defaults","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"description":"Sample entries to list","default":20,"title":"Limit"},"description":"Sample entries to list"},{"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":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_PostingDefaultsPreviewResponse_"}}}},"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"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","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":"preview_posting_defaults_api_v1_posting_defaults_preview_get"}}},"components":{"schemas":{"PostingDefaultsPreviewResponse":{"properties":{"invoice_journal_entries":{"type":"integer","title":"Invoice Journal Entries","description":"Finalized-invoice entries in the books"},"on_system_defaults":{"type":"integer","title":"On System Defaults","description":"Entries with a line on one of the four system-key ledgers"},"on_configured_ledgers":{"type":"integer","title":"On Configured Ledgers","description":"Entries with a line on a ledger now configured as a default"},"elsewhere":{"type":"integer","title":"Elsewhere","description":"Entries on neither"},"configured_roles":{"items":{"type":"string"},"type":"array","title":"Configured Roles"},"samples":{"items":{"$ref":"#/components/schemas/PostingDefaultsPreviewSample"},"type":"array","title":"Samples"}},"type":"object","required":["invoice_journal_entries","on_system_defaults","on_configured_ledgers","elsewhere"],"title":"PostingDefaultsPreviewResponse"},"PostingDefaultsPreviewSample":{"properties":{"journal_entry_id":{"type":"string","title":"Journal Entry Id"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"date":{"type":"string","title":"Date"}},"type":"object","required":["journal_entry_id","date"],"title":"PostingDefaultsPreviewSample"},"SuccessEnvelope_PostingDefaultsPreviewResponse_":{"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/PostingDefaultsPreviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[PostingDefaultsPreviewResponse]"},"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":[]}]}