{"openapi":"3.1.0","info":{"title":"PUT /api/v1/credit/debt-facilities","version":"1.0.0","description":"Replace a merchant's existing debt facilities"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/debt-facilities":{"put":{"tags":["credit"],"summary":"Replace a merchant's existing debt facilities","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. `facilities` is the whole list: a facility sent again (same `facility_id`) is updated, one left out is removed, and an empty list attests the merchant has no debt. They land on the merchant's debt schedule, which `existing_debt_facilities` and `debt_service_coverage_ratio` read; with none attested the first reads 0 and the second uncapped cover instead of unmeasured. A `daily`, `weekly`, `biweekly` or `semi_monthly` payment counts at its yearly total (252 business days for `daily`).","operationId":"put_credit_debt_facilities","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/DebtFacilitiesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_DebtFacilitiesResponse_"}}}},"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":"put_credit_debt_facilities_api_v1_credit_debt_facilities_put"}}},"components":{"schemas":{"DebtFacilitiesRequest":{"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."},"facilities":{"items":{"$ref":"#/components/schemas/DebtFacilityItem"},"type":"array","maxItems":100,"title":"Facilities","description":"The merchant's facilities, all of them: one left out of a push is removed. An empty list attests the merchant has none, so `existing_debt_facilities` reads 0 and `debt_service_coverage_ratio` reads as uncapped cover."}},"additionalProperties":false,"type":"object","required":["facilities"],"title":"DebtFacilitiesRequest","description":"Every existing debt facility the merchant has, replacing the last push."},"DebtFacilitiesResponse":{"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},"facilities":{"type":"integer","title":"Facilities","description":"Facilities on the schedule after the push."},"created":{"type":"integer","title":"Created","description":"Facilities added.","default":0},"updated":{"type":"integer","title":"Updated","description":"Facilities changed in place.","default":0},"removed":{"type":"integer","title":"Removed","description":"Facilities left out and removed.","default":0},"none_attested":{"type":"boolean","title":"None Attested","description":"True when the push said the merchant has no facilities."},"total_balance_cents":{"type":"integer","title":"Total Balance Cents","description":"What is owed across them, cents."},"annual_debt_service_cents":{"type":"integer","title":"Annual Debt Service Cents","description":"Scheduled payments over a year across them, cents."},"declared_at":{"type":"string","format":"date-time","title":"Declared At","description":"When this push landed, UTC."}},"type":"object","required":["merchant_business_id","facilities","none_attested","total_balance_cents","annual_debt_service_cents","declared_at"],"title":"DebtFacilitiesResponse","description":"The merchant's debt schedule as the partner declared it."},"DebtFacilityItem":{"properties":{"facility_id":{"type":"string","maxLength":128,"minLength":1,"title":"Facility Id","description":"Your stable id for the facility; a push updates it in place."},"lender":{"type":"string","maxLength":255,"minLength":1,"title":"Lender","description":"Who lent it."},"facility_type":{"type":"string","enum":["term_loan","line_of_credit","mca","revenue_based","sba_loan","equipment_loan","mortgage","credit_card","other"],"title":"Facility Type","description":"What it is. `mca` and `revenue_based` are repaid from sales; `credit_card` is a card balance."},"current_balance_cents":{"type":"integer","minimum":0.0,"title":"Current Balance Cents","description":"What is still owed today, in cents."},"original_amount_cents":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Original Amount Cents","description":"The amount first lent (defaults to the current balance)."},"payment_amount_cents":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Payment Amount Cents","description":"The scheduled payment per `payment_frequency`, in cents. Without it the facility adds nothing to annual debt service."},"payment_frequency":{"anyOf":[{"type":"string","enum":["daily","weekly","biweekly","semi_monthly","monthly","quarterly","annual"]},{"type":"null"}],"title":"Payment Frequency","description":"How often `payment_amount_cents` is paid. `daily` counts 252 business days a year. Required with `payment_amount_cents`."},"interest_rate_bps":{"anyOf":[{"type":"integer","maximum":100000.0,"minimum":0.0},{"type":"null"}],"title":"Interest Rate Bps","description":"Annual interest rate in basis points (500 = 5.00%)."},"started_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Started On","description":"When it was drawn (defaults to today)."},"maturity_on":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Maturity On","description":"When it is due to be repaid (defaults to a year after start)."}},"additionalProperties":false,"type":"object","required":["facility_id","lender","facility_type","current_balance_cents"],"title":"DebtFacilityItem","description":"One existing borrowing: a loan, a line, a merchant cash advance."},"SuccessEnvelope_DebtFacilitiesResponse_":{"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/DebtFacilitiesResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[DebtFacilitiesResponse]"},"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":[]}]}