{"openapi":"3.1.0","info":{"title":"POST /api/v1/credit-memos/{credit_memo_id}/unapply","version":"1.0.0","description":"Un-apply credit memo from invoice"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit-memos/{credit_memo_id}/unapply":{"post":{"tags":["credit-memos"],"summary":"Un-apply credit memo from invoice","description":"Remove (un-link) a credit memo from an invoice, restoring balances.","operationId":"unapply_credit_memo_api_v1_credit_memos__credit_memo_id__unapply_post","parameters":[{"name":"credit_memo_id","in":"path","required":true,"schema":{"type":"string","title":"Credit Memo 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":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditMemoUnapply"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreditMemoUnapplyResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CreditMemoUnapply":{"properties":{"invoice_id":{"type":"string","title":"Invoice Id","description":"Invoice to remove (un-link) the credit from"}},"type":"object","required":["invoice_id"],"title":"CreditMemoUnapply","description":"Request schema for un-applying a credit memo from an invoice.","example":{"invoice_id":"019ab37c-inv2-7000-8000-000000000002"}},"CreditMemoUnapplyResponse":{"properties":{"credit_memo_id":{"type":"string","title":"Credit Memo Id","description":"The credit memo ID"},"invoice_id":{"type":"string","title":"Invoice Id","description":"Invoice the credit was removed from"},"amount_unapplied":{"type":"integer","title":"Amount Unapplied","description":"Total amount un-applied in cents"},"amount_unapplied_dollars":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Amount Unapplied Dollars","description":"Total amount un-applied in dollars"},"applications_removed":{"type":"integer","title":"Applications Removed","description":"Number of application records removed"},"credit_memo_status":{"type":"string","title":"Credit Memo Status","description":"Resulting credit memo status"},"amount_remaining":{"type":"integer","title":"Amount Remaining","description":"Credit memo remaining available balance in cents"},"amount_remaining_dollars":{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$","title":"Amount Remaining Dollars","description":"Credit memo remaining available balance in dollars"},"invoice_status":{"type":"string","title":"Invoice Status","description":"Resulting invoice status"}},"type":"object","required":["credit_memo_id","invoice_id","amount_unapplied","amount_unapplied_dollars","applications_removed","credit_memo_status","amount_remaining","amount_remaining_dollars","invoice_status"],"title":"CreditMemoUnapplyResponse","description":"Response schema for un-applying a credit memo from an invoice."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_CreditMemoUnapplyResponse_":{"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/CreditMemoUnapplyResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditMemoUnapplyResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}