Start free trial

Update vendor credit

PUT/api/v1/vendor-credits/{vendor_credit_id}

Update a draft vendor credit.

Operation ID: update_vendor_credit_api_v1_vendor_credits__vendor_credit_id__put·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: VendorCreditUpdate

amount_centsinteger

Credit amount in cents

reasonVendorCreditReasonEnum

Reason for the vendor credit

descriptionstring

Description of the credit

bill_idstring

Original bill being credited

ledger_idstring

Expense or asset ledger to reverse when issued

issue_datestring · date

Issue date

line_itemsarray · VendorCreditLineItem

Line items for credit detail

allocation_linesarray · JournalEntryLineItem

Split the credit across expense/asset accounts on issue. When provided, ledger_id is ignored.

internal_notesstring

Internal notes

vendor_credit_numberstring

Vendor's reference number

Responses

200Successful 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