Returns the vendor with the given identifier.

GET /accounting/vendors/{id}

Group: Accounting › Vendors · Operation ID: getVendor

To look up a vendor by vendorNumber or externalVendorId, neither of which is unique, use POST accounting/vendors/search. This endpoint does not return the vendor's tax identifiers, bank details, remittance address or custom field values.

Open in the interactive reference

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.
id path string yes The unique identifier for the vendor to return.

Response

200 Success

Under data (getVendorOutput):

Field Type Required Description
id string yes The unique identifier for the vendor.
vendorName string yes The legal or trading name of the vendor.
vendorNumber string no The vendor number, for example 'V-2041'. Absent until one has been assigned.
vendorType string yes The kind of vendor. Possible values: 'supplier', 'contractor', 'tax', 'benefits', 'payrollProvider', 'healthInsurance'.
vendorSubType string no A finer classification within the vendor type. Possible values: 'direct', 'indirect'.
status string yes 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 yes The default payment-terms key applied to this vendor's bills, for example 'net30' or 'dueOnReceipt'. Stored as supplied.
preferredCurrency string no The currency the vendor prefers to be paid in. Format ISO 4217, for example 'USD'.
preferredLanguage string no The language the vendor prefers for messages.
independentContractor string no Whether the vendor is an independent contractor. Possible values: 'yes', 'no', 'unsure'.
externalVendorId string no The identifier this vendor has in an external system. It is not unique.
origin string no The source system that created the vendor, for example 'app'.
mainContactName string no The name of the vendor's main contact.
mainContactEmail string no The email address of the vendor's main contact.
mainContactPhone string no The phone number of the vendor's main contact.
billingEmail string no The email address invoices and remittance advice are sent to.
entityId string no The legal entity the vendor is registered under. See id on GET base/entities.
defaultAccountId string no The GL account this vendor's spend defaults to. See id on GET accounting/accounts/:id.
lastModifiedDate string (date-time) yes The date and time the vendor last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses