Start free trial

Apply vendor credit to bill

POST/api/v1/vendor-credits/{vendor_credit_id}/apply

Apply a portion or all of a vendor credit to a bill.

Operation ID: apply_vendor_credit_api_v1_vendor_credits__vendor_credit_id__apply_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

vendor_credit_idstringrequired

Request body

Schema: VendorCreditApplicationCreate

bill_idstringrequired

Bill to apply credit to

amount_centsintegerrequired

Amount to apply in cents

Responses

201Successful Response

Schema: SuccessEnvelope_VendorCreditApplicationResponse_

successboolean
messagestring
codestring
dataVendorCreditApplicationResponse

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