Skip to main content
DELETE
Delete vendor credit

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

The UUID of the business the vendor credit belongs to

vendorCreditId
string<uuid>
required

The UUID of the vendor credit to delete

Response

200 - application/json

Vendor credit deleted successfully

id
string<uuid>
required

Unique identifier for the vendor credit

vendor
object
required

The vendor associated with this credit

received_at
string<date-time>
required

Timestamp when the vendor credit was received

line_items
object[]
required

List of line items for this vendor credit

created_at
string<date-time>
required

Timestamp when the vendor credit was created

updated_at
string<date-time>
required

Timestamp when the vendor credit was last updated

transaction_tags
object[]
required

List of tags associated with this vendor credit

external_id
string

External identifier for the vendor credit

allocations
object[]

List of allocations for this vendor credit

deleted_at
string<date-time>

Timestamp when the vendor credit was deleted, if applicable

memo
string | null

Memo for any text you would like to associate with the vendor credit (for example, to display to end users).

metadata
object | null

Arbitrary custom metadata in JSON format with a size limit of 1KB

Example:
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the vendor credit. Can be used to filter when listing vendor credits.