{"openapi":"3.1.0","info":{"title":"GET /api/v1/businesses/{business_id}/trial-balance/diff","version":"1.0.0","description":"Trial balance movement between two dates"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/businesses/{business_id}/trial-balance/diff":{"get":{"tags":["businesses"],"summary":"Trial balance movement between two dates","description":"Per ledger: balance at the end of the day before `from_date`, balance at `to_date`, and the movement. Debit-positive cents.","operationId":"get_trial_balance_diff","parameters":[{"name":"business_id","in":"path","required":true,"schema":{"type":"string","title":"Business Id"}},{"name":"from_date","in":"query","required":true,"schema":{"type":"string","description":"First day of the window","title":"From Date"},"description":"First day of the window"},{"name":"to_date","in":"query","required":true,"schema":{"type":"string","description":"Last day of the window","title":"To Date"},"description":"Last day of the window"},{"name":"basis","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"`accrual` or `cash`; defaults to the business's basis.","title":"Basis"},"description":"`accrual` or `cash`; defaults to the business's basis."},{"name":"hide_zero_rows","in":"query","required":false,"schema":{"type":"boolean","description":"Omit ledgers with no opening or closing balance","default":true,"title":"Hide Zero Rows"},"description":"Omit ledgers with no opening or closing balance"},{"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_GetTrialBalanceDiffResponse_"}}}},"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_trial_balance_diff_api_v1_businesses__business_id__trial_balance_diff_get"}}},"components":{"schemas":{"GetTrialBalanceDiffResponse":{"properties":{"from_date":{"type":"string","title":"From Date"},"to_date":{"type":"string","title":"To Date"},"opening_as_of":{"type":"string","title":"Opening As Of"},"basis":{"anyOf":[{"type":"string","enum":["accrual","cash"]},{"type":"null"}],"title":"Basis"},"accounts":{"items":{"$ref":"#/components/schemas/TrialBalanceDiffAccount"},"type":"array","title":"Accounts"},"total_movement_cents":{"type":"integer","title":"Total Movement Cents","description":"Sum of every movement; zero when the books balance."}},"type":"object","required":["from_date","to_date","opening_as_of","accounts","total_movement_cents"],"title":"GetTrialBalanceDiffResponse"},"SuccessEnvelope_GetTrialBalanceDiffResponse_":{"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/GetTrialBalanceDiffResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[GetTrialBalanceDiffResponse]"},"TrialBalanceDiffAccount":{"properties":{"ledger_id":{"type":"string","title":"Ledger Id"},"account_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Account Number"},"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"sort_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Sort Code"},"opening_cents":{"type":"integer","title":"Opening Cents","description":"Debit-positive balance at the end of the day before from_date."},"closing_cents":{"type":"integer","title":"Closing Cents","description":"Debit-positive balance at to_date."},"movement_cents":{"type":"integer","title":"Movement Cents","description":"closing - opening."}},"type":"object","required":["ledger_id","name","type","opening_cents","closing_cents","movement_cents"],"title":"TrialBalanceDiffAccount"},"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":[]}]}