{"openapi":"3.1.0","info":{"title":"POST /api/v1/ar/subledgers/backfill","version":"1.0.0","description":"Backfill customer AR sub-ledgers"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/ar/subledgers/backfill":{"post":{"tags":["ar-subledgers"],"summary":"Backfill customer AR sub-ledgers","description":"Move historical invoice, payment and credit-memo journal lines from Accounts Receivable onto each customer's 'AR - <name>' sub-ledger by updating the original line. Dry run by default.","operationId":"ar_subledgers_backfill","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/ArSubledgerBackfillRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ArSubledgerBackfillResponse_"}}}},"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":"ar_subledgers_backfill_api_v1_ar_subledgers_backfill_post"}}},"components":{"schemas":{"ArSubledgerAdoption":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"customer_name":{"type":"string","title":"Customer Name","default":""},"ledger_id":{"type":"string","title":"Ledger Id"},"ledger_name":{"type":"string","title":"Ledger Name"},"already_linked":{"type":"boolean","title":"Already Linked","default":false}},"type":"object","required":["customer_id","ledger_id","ledger_name"],"title":"ArSubledgerAdoption"},"ArSubledgerBackfillRequest":{"properties":{"dry_run":{"type":"boolean","title":"Dry Run","description":"Preview only (default). Reports which lines would move, which 'AR - X' ledgers would be adopted or created, and what is skipped — nothing is written.","default":true},"include_closed_periods":{"type":"boolean","title":"Include Closed Periods","description":"Also rewrite lines dated in a closed or locked accounting period. The move stays inside Accounts Receivable, so the AR total for the period is unchanged, but per-ledger balances change.","default":false},"create_missing":{"type":"boolean","title":"Create Missing","description":"Create an 'AR - <Customer Name>' sub-ledger for customers that have none yet. When false, only customers with an existing (or adoptable) sub-ledger are moved.","default":true}},"additionalProperties":false,"type":"object","title":"ArSubledgerBackfillRequest","description":"Move historical canonical-AR lines onto customer sub-ledgers."},"ArSubledgerBackfillResponse":{"properties":{"business_id":{"type":"string","title":"Business Id"},"dry_run":{"type":"boolean","title":"Dry Run"},"ar_subledger_mode":{"type":"string","title":"Ar Subledger Mode"},"canonical_ar_ledger_id":{"type":"string","title":"Canonical Ar Ledger Id"},"canonical_ar_ledger_name":{"type":"string","title":"Canonical Ar Ledger Name"},"lines_considered":{"type":"integer","title":"Lines Considered","default":0},"lines_to_move":{"type":"integer","title":"Lines To Move","default":0},"lines_moved":{"type":"integer","title":"Lines Moved","default":0},"journal_entries_updated":{"type":"integer","title":"Journal Entries Updated","description":"Existing journal entries whose AR line was rewritten.","default":0},"journal_entries_created":{"type":"integer","title":"Journal Entries Created","description":"Always 0 — the backfill never posts a new entry.","default":0},"hit_line_cap":{"type":"boolean","title":"Hit Line Cap","description":"True when the per-call line cap was reached; re-run.","default":false},"adopted_ledgers":{"items":{"$ref":"#/components/schemas/ArSubledgerAdoption"},"type":"array","title":"Adopted Ledgers"},"ledgers_to_create":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Ledgers To Create"},"ledgers_created":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Ledgers Created"},"skipped":{"additionalProperties":{"type":"integer"},"type":"object","title":"Skipped"},"skipped_samples":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Skipped Samples"},"by_customer":{"items":{"$ref":"#/components/schemas/ArSubledgerCustomerMove"},"type":"array","title":"By Customer"}},"type":"object","required":["business_id","dry_run","ar_subledger_mode","canonical_ar_ledger_id","canonical_ar_ledger_name"],"title":"ArSubledgerBackfillResponse","description":"What the backfill moved (or would move, on a dry run)."},"ArSubledgerCustomerMove":{"properties":{"customer_id":{"type":"string","title":"Customer Id"},"customer_name":{"type":"string","title":"Customer Name","default":""},"subledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subledger Id"},"subledger_name":{"type":"string","title":"Subledger Name"},"lines":{"type":"integer","title":"Lines","default":0},"journal_entries":{"type":"integer","title":"Journal Entries","default":0},"debit_cents":{"type":"integer","title":"Debit Cents","default":0},"credit_cents":{"type":"integer","title":"Credit Cents","default":0},"net_cents":{"type":"integer","title":"Net Cents","default":0}},"type":"object","required":["customer_id","subledger_name"],"title":"ArSubledgerCustomerMove"},"SuccessEnvelope_ArSubledgerBackfillResponse_":{"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/ArSubledgerBackfillResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ArSubledgerBackfillResponse]"},"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":[]}]}