{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/balance-sheet","version":"1.0.0","description":"Get balance sheet (sectioned)"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/balance-sheet":{"get":{"tags":["businesses"],"summary":"Get balance sheet (sectioned)","description":"Balance sheet grouped by section (Assets, Liabilities, Equity). Each section contains ledger line items with ledger_id, ledger_name, sort_code, and total_amount.","operationId":"get_balance_sheet_api_v1_businesses__business_id__balance_sheet_get","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"as_of_date","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"As-of date (YYYY-MM-DD)","title":"As Of Date"},"description":"As-of date (YYYY-MM-DD)"},{"name":"hide_zero_rows","in":"query","required":false,"schema":{"type":"boolean","description":"Exclude line items with a zero balance","default":false,"title":"Hide Zero Rows"},"description":"Exclude line items with a zero balance"},{"name":"period_granularity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional period grouping: monthly, quarterly, or yearly. When set, requires start_date and adds one as-of balance per period end between start_date and as_of_date.","title":"Period Granularity"},"description":"Optional period grouping: monthly, quarterly, or yearly. When set, requires start_date and adds one as-of balance per period end between start_date and as_of_date."},{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date (YYYY-MM-DD); required when period_granularity is set","title":"Start Date"},"description":"Start date (YYYY-MM-DD); required when period_granularity is set"},{"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_GetBalanceSheetResponse_"}}}},"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":{"BalanceSheetRow":{"properties":{"ledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Id"},"ledger_name":{"type":"string","title":"Ledger Name"},"sort_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sort Code"},"sub_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Type"},"total_amount":{"type":"integer","title":"Total Amount"}},"additionalProperties":true,"type":"object","required":["ledger_name","total_amount"],"title":"BalanceSheetRow","description":"Ledger row within a balance-sheet section."},"BalanceSheetSectionBlock":{"properties":{"section":{"type":"string","title":"Section"},"total_amount":{"type":"integer","title":"Total Amount"},"rows":{"items":{"$ref":"#/components/schemas/BalanceSheetRow"},"type":"array","title":"Rows"}},"additionalProperties":true,"type":"object","required":["section","total_amount","rows"],"title":"BalanceSheetSectionBlock","description":"Assets / Liabilities / Equity section."},"GetBalanceSheetResponse":{"items":{"$ref":"#/components/schemas/BalanceSheetSectionBlock"},"type":"array","title":"GetBalanceSheetResponse","description":"Sectioned balance sheet (list of section blocks)."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_GetBalanceSheetResponse_":{"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/GetBalanceSheetResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetBalanceSheetResponse]"},"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":[]}]}