Create vendor credit

POST/api/v1/vendor-credits

Create a new vendor credit in draft status.

Operation ID: create_vendor_credit_api_v1_vendor_credits_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.

Request body

Schema: VendorCreditCreate

vendor_idstringrequired: Vendor issuing the credit
amount_centsintegerrequired: Credit amount in cents
reasonVendorCreditReasonEnumVendorCreditReasonEnum: Reason for the vendor credit
descriptionstring: Description of the credit
bill_idstring: Original bill being credited (optional)
ledger_idstring: Expense or asset ledger to reverse when issued (defaults to Uncategorized Expense)
issue_datestring · date: Issue date (defaults to today)
line_itemsarray · VendorCreditLineItem: Optional line items for credit detail
internal_notesstring: Internal notes
vendor_credit_numberstring: Vendor's reference number from the credit document

Responses

201Successful Response

Schema: SuccessEnvelope_VendorCreditResponse_

successboolean
messagestring
codestring
dataVendorCreditResponse

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

Code samples

POST/api/v1/vendor-credits

bash

curl -X POST 'https://api.ondayzero.com/api/v1/vendor-credits' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "vendor_id": "string",
  "amount_cents": 0
}'