{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit/receivables","version":"1.0.0","description":"Push a merchant's invoices to its customers"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/receivables":{"post":{"tags":["credit"],"summary":"Push a merchant's invoices to its customers","description":"Name the merchant as on `POST /credit/bank-feeds` (`program_id` and `external_merchant_id`, or `credit_line_id`); DayZero uses its business, creating it the first time, and gives your token read access to it. Upserts invoices by `invoice_id` (customer, amount, issued, due and paid dates). `revenue_concentration_top_customer` reads them when the merchant has no DayZero invoices (`evidence.source: partner_receivables`): the top customer's share of the last 365 days' invoiced total, void invoices left out.","operationId":"push_credit_receivables","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/ReceivablesPushRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ReceivablesPushResponse_"}}}},"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":"push_credit_receivables_api_v1_credit_receivables_post"}}},"components":{"schemas":{"ReceivableItem":{"properties":{"invoice_id":{"type":"string","maxLength":128,"minLength":1,"title":"Invoice Id","description":"Your stable id for the invoice; sending it again updates it."},"customer_id":{"type":"string","maxLength":255,"minLength":1,"title":"Customer Id","description":"Your stable id for the customer billed."},"customer_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Customer Name","description":"The customer's name."},"amount_cents":{"type":"integer","minimum":0.0,"title":"Amount Cents","description":"The invoice total, in cents."},"currency":{"type":"string","pattern":"^[A-Za-z]{3}$","title":"Currency","description":"ISO 4217 currency."},"issued_on":{"type":"string","format":"date","title":"Issued On","description":"When it was issued."},"due_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Due On","description":"When it falls due."},"paid_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Paid On","description":"When it was paid in full, if it has been."},"status":{"anyOf":[{"type":"string","enum":["open","paid","void"]},{"type":"null"}],"title":"Status","description":"`void` leaves it out of revenue. Defaults to `paid` with `paid_on`, else `open`."}},"additionalProperties":false,"type":"object","required":["invoice_id","customer_id","amount_cents","currency","issued_on"],"title":"ReceivableItem","description":"One invoice the merchant raised to a customer."},"ReceivablesPushRequest":{"properties":{"program_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Program Id","description":"Your program the merchant is applying under. Required without `credit_line_id`; with it, must be the line's program if sent."},"external_merchant_id":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"External Merchant Id","description":"Your id for the merchant, as on `POST /credit/bank-feeds` and `POST /credit/lines`. Required without `credit_line_id`."},"credit_line_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Credit Line Id","description":"The merchant's open line, when there is one."},"merchant_legal_name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Merchant Legal Name","description":"Names the merchant's DayZero business when this call creates it. Ignored when the business exists."},"merchant_business_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merchant Business Id","description":"The merchant's existing DayZero business, when your token can reach it. Leave it out and DayZero uses the business the merchant was linked to before, or creates one."},"invoices":{"items":{"$ref":"#/components/schemas/ReceivableItem"},"type":"array","maxItems":5000,"title":"Invoices","description":"Invoices to add or update. Invoices not sent are kept; send one with `status: void` to take it out."}},"additionalProperties":false,"type":"object","required":["invoices"],"title":"ReceivablesPushRequest","description":"Invoices upserted by `invoice_id`."},"ReceivablesPushResponse":{"properties":{"merchant_business_id":{"type":"string","title":"Merchant Business Id","description":"The merchant's DayZero business."},"merchant_business_created":{"type":"boolean","title":"Merchant Business Created","description":"Whether this call created the business.","default":false},"upserted":{"type":"integer","title":"Upserted","description":"Invoices inserted or updated by this push."},"invoices":{"type":"integer","title":"Invoices","description":"Invoices on file for the merchant in total."},"customers":{"type":"integer","title":"Customers","description":"Distinct customers across them."},"declared_at":{"type":"string","format":"date-time","title":"Declared At","description":"When this push landed, UTC."}},"type":"object","required":["merchant_business_id","upserted","invoices","customers","declared_at"],"title":"ReceivablesPushResponse","description":"What DayZero now holds of the merchant's receivables."},"SuccessEnvelope_ReceivablesPushResponse_":{"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/ReceivablesPushResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ReceivablesPushResponse]"},"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":[]}]}