API ReferenceEntityCounterpartyVendor Credit

Create

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

counterpartyIdstringRequired

Counterparty Entity ID or Counterparty Entity ForeignID

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
totalAmountdoubleRequired

Total amount of the vendor credit in major units

currencyenumRequired

Currency code for the amount. Defaults to USD.

notestringOptional

An optional note to attach to the vendor credit

Response

This endpoint returns an object.
idstring
vendorIdstring

ID of the vendor the vendor credit may be used for

payerIdstring

ID of the payer who may use the vendor credit

createdAtdatetime
updatedAtdatetime
totalAmountdoubleOptional

Total issued amount of the vendor credit in major units

remainingAmountdoubleOptional

Remaining usable amount in the vendor credit in major units

currencyenumOptional

Currency code for the amount. Defaults to USD.

creatorEntityIdstringOptional

ID of the entity that created this vendor credit

notestringOptional

An optional note to attach to the vendor credit

invoiceIdslist of stringsOptional

The IDs of the invoices that this vendor credit has been applied to

Errors