{"openapi":"3.1.0","info":{"title":"POST /api/v1/transactions/batch/receipt-requests","version":"1.0.0","description":"Request receipts from the client"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/transactions/batch/receipt-requests":{"post":{"tags":["transactions"],"summary":"Request receipts from the client","description":"Ask the client for the receipts behind a batch of transactions. Transactions that already have a receipt, are marked exempt, or already carry an open request are skipped, so it is safe to repeat. Firm staff only: the business must be managed through an advisory firm.","operationId":"request_transaction_receipts","parameters":[{"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkReceiptRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_BulkReceiptRequestResponse_"}}}},"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/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":"request_transaction_receipts_api_v1_transactions_batch_receipt_requests_post"}}},"components":{"schemas":{"BulkReceiptRequest":{"properties":{"transaction_ids":{"items":{"type":"string"},"type":"array","maxItems":200,"minItems":1,"title":"Transaction Ids"},"note":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Note","description":"Optional note added to each request, e.g. 'Needed for Q3 close'."}},"type":"object","required":["transaction_ids"],"title":"BulkReceiptRequest","description":"Ask the client for the receipts behind a batch of transactions."},"BulkReceiptRequestResponse":{"properties":{"requested":{"type":"integer","title":"Requested","description":"New requests sent to the client.","default":0},"already_requested":{"type":"integer","title":"Already Requested","description":"Skipped: an open receipt request already exists.","default":0},"already_attached":{"type":"integer","title":"Already Attached","description":"Skipped: the transaction already has a receipt.","default":0},"exempt":{"type":"integer","title":"Exempt","description":"Skipped: marked as not needing a receipt.","default":0},"not_found":{"type":"integer","title":"Not Found","description":"Skipped: not a transaction of this business.","default":0},"requested_transaction_ids":{"items":{"type":"string"},"type":"array","title":"Requested Transaction Ids"}},"type":"object","title":"BulkReceiptRequestResponse","description":"Outcome of a bulk receipt request."},"SuccessEnvelope_BulkReceiptRequestResponse_":{"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/BulkReceiptRequestResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[BulkReceiptRequestResponse]"},"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":[]}]}