Start free trial

Apply a payment to a contract invoice

POST/api/v1/contracts/invoices/{invoice_id}/payments

Record a payment (amount, method, received date) against a contract invoice, transitioning it to partially/fully paid.

Operation ID: apply_contract_invoice_payment_api_v1_contracts_invoices__invoice_id__payments_post·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

invoice_idstringrequired

Request body

Schema: ContractInvoicePaymentRequest

amount_centsintegerrequired

Payment amount in cents.

methodstring

Payment method: ach, stripe, or manual.

received_datestring

Date the payment was received (YYYY-MM-DD).

Responses

201Successful Response

Schema: SuccessEnvelope_ContractInvoicePaymentResponse_

successboolean
messagestring
codestring
dataContractInvoicePaymentResponse

400Bad Request - Invalid input

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError
5 fields
locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject