{"openapi":"3.1.0","info":{"title":"POST /api/v1/invoices/{invoice_id}/stripe/sync","version":"1.0.0","description":"Check invoice payment in Stripe"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/invoices/{invoice_id}/stripe/sync":{"post":{"tags":["invoices"],"summary":"Check invoice payment in Stripe","description":"Read the invoice's live payment state from Stripe (paid, processing, failed, awaiting payment) and, when Stripe has collected it but the invoice is still open here, record the payment.","operationId":"sync_invoice_from_stripe","parameters":[{"name":"invoice_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Invoice 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"}}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_InvoiceStripeSyncResponse_"}}}},"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"}}}},"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":"sync_invoice_from_stripe_api_v1_invoices__invoice_id__stripe_sync_post"}}},"components":{"schemas":{"InvoiceStripeSyncResponse":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id","description":"DayZero invoice UUID."},"stripe_invoice_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stripe Invoice Id","description":"Stripe invoice id."},"payment_state":{"type":"string","enum":["paid","processing","awaiting_payment","failed","void","uncollectible","draft","not_in_stripe","not_linked"],"title":"Payment State","description":"paid, processing (payment started, not cleared — e.g. a bank transfer), awaiting_payment, failed (last attempt declined), void, uncollectible, draft, not_in_stripe (Stripe no longer has it) or not_linked (never sent through Stripe)."},"stripe_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stripe Status","description":"Stripe's own invoice status: draft, open, paid, void or uncollectible."},"action":{"type":"string","enum":["booked","already_in_sync","none"],"title":"Action","description":"booked: Stripe said paid and the payment was just recorded here. already_in_sync: both sides already agree it's paid.","default":"none"},"local_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Local Status","description":"The DayZero invoice status after the check."},"amount_due":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Due","description":"Cents Stripe is collecting."},"amount_paid":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Paid","description":"Cents Stripe has collected."},"amount_remaining":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Amount Remaining","description":"Cents still owed."},"payment_method_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Payment Method Type","description":"Stripe payment method type, e.g. card, us_bank_account."},"processing_since":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Processing Since","description":"When the in-flight payment started (processing only)."},"paid_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Paid At","description":"When Stripe marked it paid."},"failure_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Failure Message","description":"Why the last payment attempt failed (failed only)."},"needs_review":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Needs Review","description":"Set when the two sides disagree in a way that shouldn't be fixed automatically, e.g. marked paid by hand while Stripe also collected the money."},"dashboard_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dashboard Url","description":"This invoice in the Stripe dashboard."},"message":{"type":"string","title":"Message","description":"Plain-language summary for the user."}},"type":"object","required":["invoice_id","payment_state","message"],"title":"InvoiceStripeSyncResponse","description":"Live Stripe state of one invoice, from ``POST /invoices/{id}/stripe/sync``.\n\n``payment_state`` is the answer to \"has the customer paid?\" as Stripe sees\nit right now; ``action`` says whether DayZero changed anything as a result."},"SuccessEnvelope_InvoiceStripeSyncResponse_":{"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/InvoiceStripeSyncResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[InvoiceStripeSyncResponse]"},"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":[]}]}