Sign in
Vendor

Find vendors based on search parameters.

post/api/vendors/list

Query parameters

Sort.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

namestring nullable

Filter to vendors who's name contains the given string

vendorCodestring nullable

Unique identifier for this vendor.

Response

List of vendors matching the filters

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