Create vendor credit

POST/api/v1/vendor-credits

Create a new vendor credit in draft status.

Operation ID: create_vendor_credit·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: Offset ledger to reverse when issued, any Chart of Accounts type (defaults to Uncategorized Expense)
issue_datestring · date: Issue date (defaults to today)
line_itemsarray · VendorCreditLineItem: Optional line items for credit detail
allocation_linesarray · JournalEntryLineItem: Split the credit across any Chart of Accounts accounts on issue. When provided, ledger_id is ignored.
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

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

401Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

403Forbidden - Insufficient permissions

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

404Not Found - Resource does not exist

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

422Validation Error

Schema: ErrorResponse

errorstringrequired: Error category: validation_error, unauthorized, forbidden, not_found, conflict, rate_limited, server_error, or service_unavailable.
messagestringrequired: Human-readable explanation, safe to show to end users.
codestringrequired: Stable machine-readable code in CATEGORY_NNN form (e.g. NOT_FOUND_006, AUTH_010, GEN_002).
request_idstring: Correlation id for support requests. Echoes the x-request-id request header when one was supplied.
errorsobject: Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

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 '{
  "amount_cents": 5000,
  "bill_id": "019ab37c-b111-7000-8000-000000000001",
  "description": "Overcharged on bill #BILL-001",
  "reason": "pricing_error",
  "vendor_credit_number": "CM-9087",
  "vendor_id": "019ab37c-ae0d-7000-8000-000000000001"
}'