{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/finance/journal/push","version":"1.0.0","description":"Push the credit journal to QuickBooks"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/finance/journal/push":{"post":{"tags":["credit"],"summary":"Push the credit journal to QuickBooks","description":"Sends the period's credit journal entries to the business's connected QuickBooks company, one journal entry each, and reports what happened to every entry. Safe to repeat: an entry already pushed is reported as `already_pushed` and not sent again. An entry that touches an account with no QuickBooks counterpart is skipped and named. `400 CREDIT_002` when QuickBooks is not connected. An operator action.","operationId":"push_journal","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/JournalPushRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_JournalPushResponse_"}}}},"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"}}}},"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":"push_journal_api_v1_credit_finance_journal_push_post"}}},"components":{"schemas":{"JournalPushRequest":{"properties":{"period":{"type":"string","title":"Period","description":"Calendar month, YYYY-MM."},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"destination":{"type":"string","const":"quickbooks","title":"Destination","default":"quickbooks"}},"additionalProperties":false,"type":"object","required":["period"],"title":"JournalPushRequest","description":"Push one period's credit journal to the business's accounting system."},"JournalPushResponse":{"properties":{"period":{"type":"string","title":"Period"},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"destination":{"type":"string","title":"Destination"},"entry_count":{"type":"integer","title":"Entry Count"},"pushed":{"type":"integer","title":"Pushed"},"already_pushed":{"type":"integer","title":"Already Pushed"},"skipped":{"type":"integer","title":"Skipped"},"failed":{"type":"integer","title":"Failed"},"results":{"items":{"$ref":"#/components/schemas/JournalPushResult"},"type":"array","title":"Results"}},"type":"object","required":["period","destination","entry_count","pushed","already_pushed","skipped","failed"],"title":"JournalPushResponse","description":"Per-entry outcome of a journal push. Safe to repeat."},"JournalPushResult":{"properties":{"journal_entry_id":{"type":"string","title":"Journal Entry Id"},"entry_number":{"type":"string","title":"Entry Number"},"status":{"type":"string","enum":["pushed","already_pushed","skipped","failed"],"title":"Status"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"The entry's id in the destination."},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"}},"type":"object","required":["journal_entry_id","entry_number","status"],"title":"JournalPushResult","description":"What happened to one entry."},"SuccessEnvelope_JournalPushResponse_":{"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/JournalPushResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[JournalPushResponse]"},"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":[]}]}