{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/import-batches/{staging_id}/documents","version":"1.0.0","description":"Add statement documents to a statements history file"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/import-batches/{staging_id}/documents":{"post":{"tags":["credit"],"summary":"Add statement documents to a statements history file","description":"The PDFs a staged statements file names in its `document` column, one or more `files` (10 MB each at most, up to 200 an upload), scanned for malware and stored as issued. Matched by file name at the run; a name sent again replaces the earlier document and clears the batch's dry run. A statement whose document is not added is rejected; one that names none is attached with its figures only. Open to any token on a sandbox business; on a live business an operator action (an API token receives `403`).","operationId":"credit_history_add_documents","parameters":[{"name":"staging_id","in":"path","required":true,"schema":{"type":"string","description":"The staged history file (its batch id).","title":"Staging Id"},"description":"The staged history file (its batch id)."},{"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":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_credit_history_add_documents_api_v1_credit_import_batches__staging_id__documents_post"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_HistoryDocumentsResponse_"}}}},"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":"credit_history_add_documents_api_v1_credit_import_batches__staging_id__documents_post"}}},"components":{"schemas":{"Body_credit_history_add_documents_api_v1_credit_import_batches__staging_id__documents_post":{"properties":{"files":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"Files","description":"The statement PDFs."}},"type":"object","required":["files"],"title":"Body_credit_history_add_documents_api_v1_credit_import_batches__staging_id__documents_post"},"HistoryDocument":{"properties":{"filename":{"type":"string","title":"Filename","description":"The name the statements file's `document` column refers to it by."},"sha256":{"type":"string","title":"Sha256","description":"SHA-256 of the document."},"size_bytes":{"type":"integer","title":"Size Bytes","description":"Its size in bytes."},"content_type":{"type":"string","title":"Content Type","description":"Its media type: `application/pdf`."}},"type":"object","required":["filename","sha256","size_bytes","content_type"],"title":"HistoryDocument","description":"A statement document added to a statements batch."},"HistoryDocumentsResponse":{"properties":{"staging_id":{"type":"string","title":"Staging Id","description":"The statements batch."},"added":{"items":{"type":"string"},"type":"array","title":"Added","description":"The file names this upload added or replaced."},"documents":{"items":{"$ref":"#/components/schemas/HistoryDocument"},"type":"array","title":"Documents","description":"Every document the batch now holds."}},"type":"object","required":["staging_id"],"title":"HistoryDocumentsResponse","description":"The documents a statements batch holds after an upload."},"SuccessEnvelope_HistoryDocumentsResponse_":{"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/HistoryDocumentsResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[HistoryDocumentsResponse]"},"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":[]}]}