{"openapi":"3.1.0","info":{"title":"GET /api/v1/credit/finance/journal","version":"1.0.0","description":"Credit journal for a month"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/finance/journal":{"get":{"tags":["credit"],"summary":"Credit journal for a month","description":"Every journal entry the credit program posted in the calendar month: date, entry, memo, account, debit, credit, and the line and loan behind it, with totals by account and a control that debits equal credits. `format=csv` returns the same rows as a spreadsheet with a total row.","operationId":"get_journal","parameters":[{"name":"period","in":"query","required":true,"schema":{"type":"string","description":"Calendar month, YYYY-MM.","title":"Period"},"description":"Calendar month, YYYY-MM."},{"name":"program_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["json","csv"],"type":"string","default":"json","title":"Format"}},{"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_JournalExportResponse_"}}}},"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":"get_journal_api_v1_credit_finance_journal_get"}}},"components":{"schemas":{"JournalAccountTotal":{"properties":{"ledger_id":{"type":"string","title":"Ledger Id"},"account":{"type":"string","title":"Account"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"debit_cents":{"type":"integer","title":"Debit Cents"},"credit_cents":{"type":"integer","title":"Credit Cents"},"net_cents":{"type":"integer","title":"Net Cents","description":"Debits minus credits."}},"type":"object","required":["ledger_id","account","debit_cents","credit_cents","net_cents"],"title":"JournalAccountTotal","description":"Debits and credits the period posted to one account."},"JournalControl":{"properties":{"entry_count":{"type":"integer","title":"Entry Count"},"line_count":{"type":"integer","title":"Line Count"},"total_debit_cents":{"type":"integer","title":"Total Debit Cents"},"total_credit_cents":{"type":"integer","title":"Total Credit Cents"},"balanced":{"type":"boolean","title":"Balanced","description":"Total debits equal total credits."},"unbalanced_entry_ids":{"items":{"type":"string"},"type":"array","title":"Unbalanced Entry Ids","description":"Entries whose own debits and credits differ. Always empty on a sound book."}},"type":"object","required":["entry_count","line_count","total_debit_cents","total_credit_cents","balanced"],"title":"JournalControl","description":"The checks an accountant runs before importing the journal."},"JournalExportLine":{"properties":{"journal_entry_id":{"type":"string","title":"Journal Entry Id"},"entry_number":{"type":"string","title":"Entry Number"},"entry_date":{"type":"string","format":"date","title":"Entry Date"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"event":{"type":"string","title":"Event","description":"What the entry records: origination, accrual, accrual_reversal, fee_recognition, payment, payment_reversal, refund, write_off, interchange."},"reference":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reference","description":"Issuer transaction id, partner payment id, or interchange memo."},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id"},"loan_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Loan Id"},"ledger_id":{"type":"string","title":"Ledger Id"},"account":{"type":"string","title":"Account"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"debit_cents":{"type":"integer","title":"Debit Cents","default":0},"credit_cents":{"type":"integer","title":"Credit Cents","default":0}},"type":"object","required":["journal_entry_id","entry_number","entry_date","event","ledger_id","account"],"title":"JournalExportLine","description":"One leg of one journal entry the credit program posted."},"JournalExportResponse":{"properties":{"period":{"type":"string","title":"Period","description":"YYYY-MM."},"period_start":{"type":"string","format":"date","title":"Period Start"},"period_end":{"type":"string","format":"date","title":"Period End"},"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id"},"gl_posting_enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Gl Posting Enabled","description":"Whether the program posts to the GL. Null when no program was named."},"lines":{"items":{"$ref":"#/components/schemas/JournalExportLine"},"type":"array","title":"Lines"},"totals_by_account":{"items":{"$ref":"#/components/schemas/JournalAccountTotal"},"type":"array","title":"Totals By Account"},"control":{"$ref":"#/components/schemas/JournalControl"}},"type":"object","required":["period","period_start","period_end","control"],"title":"JournalExportResponse","description":"Every journal entry the credit program posted in a calendar month."},"SuccessEnvelope_JournalExportResponse_":{"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/JournalExportResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[JournalExportResponse]"},"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":[]}]}