Vendors

GET /accounting/vendors

Group: Accounting › Vendors · Operation ID: vendors

Returns a list of vendors. To match by name or contact email, use POST accounting/vendors/search.

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
vendorNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
vendorType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
vendorSubType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
status — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
paymentTerms — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
preferredCurrency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
independentContractor — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalVendorId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
origin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, vendorNumber, vendorType, vendorSubType, status, paymentTerms, preferredCurrency, lastModifiedDate
Selectable: id, vendorName, vendorNumber, vendorType, vendorSubType, status, paymentTerms, preferredCurrency, independentContractor, externalVendorId, origin, mainContactEmail, mainContactName, lastModifiedDate

Response

200 Success

Under data, an array of vendorsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the vendor.
`vendorName`	string or null	no	The legal or trading name of the vendor.
`vendorNumber`	string or null	no	The vendor number, for example 'V-2041'. Absent until one has been assigned.
`vendorType`	string or null	no	The kind of vendor. Possible values: 'supplier', 'contractor', 'tax', 'benefits', 'payrollProvider', 'healthInsurance'.
`vendorSubType`	string or null	no	A finer classification within the vendor type. Possible values: 'direct', 'indirect'.
`status`	string or null	no	The lifecycle status of the vendor. Possible values: 'active', 'inactive'. An inactive vendor stays readable so historical documents still resolve, and is not offered for new ones.
`paymentTerms`	string or null	no	The default payment-terms key applied to this vendor's bills, for example 'net30' or 'dueOnReceipt'. Stored as supplied.
`preferredCurrency`	string or null	no	The currency the vendor prefers to be paid in. Format ISO 4217, for example 'USD'.
`independentContractor`	string or null	no	Whether the vendor is an independent contractor. Possible values: 'yes', 'no', 'unsure'.
`externalVendorId`	string or null	no	The identifier this vendor has in an external system. It is not unique.
`origin`	string or null	no	The source system that created the vendor, for example 'app'.
`mainContactEmail`	string or null	no	The email address of the vendor's main contact.
`mainContactName`	string or null	no	The name of the vendor's main contact.
`lastModifiedDate`	string (date-time) or null	no	The date and time the vendor last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error