Sign in
Vendor

Get a vendor.

get/api/vendors/{id}

Path parameters

idstring required

Response

The vendor for the given id

idstring required

Id

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.

statusstring nullable

Approval/quality status of the vendor. One of: Approved, Probation, Monitor, Disqualified, Other.

activeboolean

Whether the vendor is active.

leadTimeinteger nullable

Default lead time in days.

urlstring uri nullable

Vendor website URL.

vendorSincestring date-time nullable

Date the vendor relationship began.

Changes

No recorded changes to this endpoint across all 12 revisions of this API.