{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/ledger/{ledger_id}/statement","version":"1.0.0","description":"Get ledger statement for a date range"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/ledger/{ledger_id}/statement":{"get":{"tags":["businesses"],"summary":"Get ledger statement for a date range","description":"Returns beginning balance, transactions within the range, and ending balance for a specific ledger account.","operationId":"get_ledger_statement_api_v1_businesses__business_id__ledger__ledger_id__statement_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"ledger_id","in":"path","required":true,"schema":{"type":"string","title":"Ledger Id"}},{"name":"start_date","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"Start date (YYYY-MM-DD)","title":"Start Date"},"description":"Start date (YYYY-MM-DD)"},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"End date (YYYY-MM-DD)","title":"End Date"},"description":"End date (YYYY-MM-DD)"},{"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_GetLedgerStatementResponse_"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"GetLedgerStatementResponse":{"properties":{"ledger_id":{"type":"string","title":"Ledger Id"},"ledger_name":{"type":"string","title":"Ledger Name"},"ledger_type":{"anyOf":[{"type":"string","enum":["asset","liability","equity","revenue","expense"]},{"type":"null"}],"title":"Ledger Type"},"is_debit_normal":{"type":"boolean","title":"Is Debit Normal"},"beginning_balance":{"type":"integer","title":"Beginning Balance"},"ending_balance":{"type":"integer","title":"Ending Balance"},"total_debits":{"type":"integer","title":"Total Debits"},"total_credits":{"type":"integer","title":"Total Credits"},"net_activity":{"type":"integer","title":"Net Activity"},"transactions":{"items":{"$ref":"#/components/schemas/LedgerStatementTransaction"},"type":"array","title":"Transactions"}},"additionalProperties":true,"type":"object","required":["ledger_id","ledger_name","is_debit_normal","beginning_balance","ending_balance","total_debits","total_credits","net_activity","transactions"],"title":"GetLedgerStatementResponse","description":"Response for ``get_ledger_statement``."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LedgerStatementTransaction":{"properties":{"date":{"type":"string","title":"Date"},"description":{"type":"string","title":"Description"},"debit":{"type":"integer","title":"Debit"},"credit":{"type":"integer","title":"Credit"},"amount":{"type":"integer","title":"Amount"},"debit_credit":{"type":"string","title":"Debit Credit"},"line_entry_id":{"type":"string","title":"Line Entry Id"},"journal_entry_id":{"type":"string","title":"Journal Entry Id"},"reference":{"type":"string","title":"Reference"},"transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Id"},"transaction_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transaction Source"},"journal_entry_source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Source"},"can_be_deleted":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Can Be Deleted"},"deletes_as_soft_hide":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Deletes As Soft Hide"},"delete_via":{"anyOf":[{"type":"string","enum":["transaction","journal_entry"]},{"type":"null"}],"title":"Delete Via"}},"additionalProperties":true,"type":"object","required":["date","description","debit","credit","amount","debit_credit","line_entry_id","journal_entry_id","reference"],"title":"LedgerStatementTransaction","description":"Transaction line on a ledger statement."},"SuccessEnvelope_GetLedgerStatementResponse_":{"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/GetLedgerStatementResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetLedgerStatementResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}