{"openapi":"3.1.0","info":{"title":"GET /api/v1/transactions/receipt-coverage","version":"1.0.0","description":"Receipt coverage"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/transactions/receipt-coverage":{"get":{"tags":["transactions"],"summary":"Receipt coverage","description":"How well a period's expenses are backed by receipts, under the business's receipt policy: how many owe one, how many have one, how many were requested from the client, and how many are still missing.","operationId":"get_receipt_coverage","parameters":[{"name":"start_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Include transactions from this date (ISO 8601)","title":"Start Date"},"description":"Include transactions from this date (ISO 8601)"},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Include transactions up to this date (ISO 8601)","title":"End Date"},"description":"Include transactions up to this date (ISO 8601)"},{"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_ReceiptCoverageResponse_"}}}},"401":{"description":"Unauthorized - Missing/invalid token 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"}}}},"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_receipt_coverage_api_v1_transactions_receipt_coverage_get"}}},"components":{"schemas":{"ReceiptCoverageResponse":{"properties":{"policy":{"$ref":"#/components/schemas/ReceiptPolicyModel"},"required_count":{"type":"integer","title":"Required Count","description":"Transactions that owe a receipt (exempt ones excluded).","default":0},"attached_count":{"type":"integer","title":"Attached Count","default":0},"requested_count":{"type":"integer","title":"Requested Count","description":"Owed, none attached, client has an open request.","default":0},"missing_count":{"type":"integer","title":"Missing Count","description":"Owed, none attached, nobody asked.","default":0},"exempt_count":{"type":"integer","title":"Exempt Count","default":0},"requested_amount_cents":{"type":"integer","title":"Requested Amount Cents","default":0},"missing_amount_cents":{"type":"integer","title":"Missing Amount Cents","default":0},"coverage_pct":{"type":"integer","title":"Coverage Pct","description":"attached / required, as a whole percent.","default":100},"oldest_missing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Oldest Missing Date"}},"type":"object","required":["policy"],"title":"ReceiptCoverageResponse","description":"How well a period's expenses are backed by receipts."},"ReceiptPolicyModel":{"properties":{"enabled":{"type":"boolean","title":"Enabled","description":"Track receipts for this business.","default":true},"threshold_cents":{"type":"integer","maximum":100000000.0,"minimum":0.0,"title":"Threshold Cents","description":"Expenses of at least this many cents need a receipt.","default":7500},"reminder_days":{"type":"integer","maximum":60.0,"minimum":1.0,"title":"Reminder Days","description":"Days a client request may sit before each reminder.","default":3},"max_reminders":{"type":"integer","maximum":10.0,"minimum":0.0,"title":"Max Reminders","description":"Reminders per request; 0 turns them off.","default":3}},"type":"object","title":"ReceiptPolicyModel","description":"Which transactions need a receipt, and how hard to chase for one."},"SuccessEnvelope_ReceiptCoverageResponse_":{"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/ReceiptCoverageResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ReceiptCoverageResponse]"},"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":[]}]}