v2

latestOpenAPI 3.0.42026-08-084694591.6 MB

Vendor

Update a specific vendor

put/api/vendors/{vendorId}

Path parameters

vendorIdstring required

Request body

namestring required

The name to give the entity. Must be unique to all active vendors.

paymentTermsIdstring nullable

Payment terms key identifier. Please reference /api/payment-terms endpoint.

vendorCodestring nullable

Unique identifier for this vendor.

notesstring nullable

General notes associated to this vendor.

currencyCodestring nullable

The currency of the vendor. When omitted, the existing value is preserved.

statusstring nullable

Approval/quality status of the vendor. One of: Approved, Probation, Monitor, Disqualified, Other. When omitted, the existing value is preserved.

activeboolean nullable

Whether the vendor is active. When omitted, the existing value is preserved.

leadTimeinteger nullable

Default lead time in days.

urlstring uri nullable

Vendor website URL.

vendorSincestring date-time nullable

Date the vendor relationship began.

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Response

The vendor for the given id

idstring required

namestring required

The name to give the vendor. Must be unique to all active vendors.

vendorCodestring nullable

Unique identifier for this vendor.

paymentTermsIdstring nullable

Payment terms identifier. Please reference /api/payment-terms endpoint.

notesstring nullable

General notes associated to this vendor

externalReferencesobject nullable

External references associated with this entity.

customFieldsobject nullable

Custom fields that have been defined on this entity.

currencyCodestring nullable

The currency of the vendor.