{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/income-statement","version":"1.0.0","description":"Get income statement (sectioned)"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/income-statement":{"get":{"tags":["businesses"],"summary":"Get income statement (sectioned)","description":"Income statement grouped by section. Each section contains ledger line items with period values as top-level keys.","operationId":"get_income_statement","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business 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":"hide_zero_rows","in":"query","required":false,"schema":{"type":"boolean","description":"Exclude line items with all-zero values","default":false,"title":"Hide Zero Rows"},"description":"Exclude line items with all-zero values"},{"name":"period_granularity","in":"query","required":false,"schema":{"type":"string","description":"Period grouping: monthly, quarterly, yearly, or total (one column for the whole range, keyed `start_date/end_date`)","default":"monthly","title":"Period Granularity"},"description":"Period grouping: monthly, quarterly, yearly, or total (one column for the whole range, keyed `start_date/end_date`)"},{"name":"tag_ids","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Filter by tag UUIDs — only line entries tagged with at least one of these tags are included","default":[],"title":"Tag Ids"},"description":"Filter by tag UUIDs — only line entries tagged with at least one of these tags are included"},{"name":"basis","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Accounting basis: `accrual` or `cash`. Defaults to the business's configured basis (accrual unless changed). Cash basis recognises invoice revenue and bill expense when paid, not when issued.","title":"Basis"},"description":"Accounting basis: `accrual` or `cash`. Defaults to the business's configured basis (accrual unless changed). Cash basis recognises invoice revenue and bill expense when paid, not when issued."},{"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_GetIncomeStatementResponse_"}}}},"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_income_statement_api_v1_businesses__business_id__income_statement_get"}}},"components":{"schemas":{"GetIncomeStatementResponse":{"items":{"$ref":"#/components/schemas/IncomeStatementSectionBlock"},"type":"array","title":"GetIncomeStatementResponse","description":"Sectioned income statement (list of section blocks)."},"IncomeStatementRow":{"properties":{"ledger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Id"},"ledger_name":{"type":"string","title":"Ledger Name"},"parent_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent Id","description":"Chart-of-accounts parent ledger UUID, or null for a top-level account. Rows are returned flat; clients that group sub-ledgers under their parent nest on this and derive the subtotal, so section totals stay a plain sum of the rows."},"total":{"type":"integer","title":"Total"}},"additionalProperties":true,"type":"object","required":["ledger_name","total"],"title":"IncomeStatementRow","description":"Ledger row within an income-statement section; period keys are dynamic."},"IncomeStatementSectionBlock":{"properties":{"section":{"type":"string","title":"Section"},"rows":{"items":{"$ref":"#/components/schemas/IncomeStatementRow"},"type":"array","title":"Rows"},"total_amount":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Amount"}},"additionalProperties":true,"type":"object","required":["section","rows"],"title":"IncomeStatementSectionBlock","description":"Revenue / expense section with period-valued rows."},"SuccessEnvelope_GetIncomeStatementResponse_":{"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/GetIncomeStatementResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetIncomeStatementResponse]"},"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":[]}]}