Sign in
Vendors

Get vendor

Retrieve a specific vendor by ID with address, attachments, and payment information.

get/public/v1/vendors/{vendor_id}/

Path parameters

vendor_idinteger required

Response

OK

created_atstring date-time required
updated_atstring date-time required
term_idinteger nullable required
term_namestring required
preferred_payment_method_idinteger nullable required
preferred_payment_method_namestring required
approval_statusstring nullable
idinteger required
codestring nullable
vendor_typestring required
company_idinteger nullable
company_namestring nullable
customer_account_numberstring
name_on_checkstring
bank_account_numberstring
bank_routing_numberstring
allowed_company_idsinteger[]
single_addressstring nullable
namestring required
unique_idstring nullable

External identifier supplied by the user to disambiguate vendors that share a display name (e.g. an ID from another system).

websitestring nullable
emailstring nullable
is_activeboolean
phonestring nullable
is_1099_eligibleboolean
tinstring nullable
tin_typestring nullable
record_status'draft' | 'posted' | 'archived'

Changes

Changed in 2 of the 27 revisions of this API.4

  • 456ef8c02f622See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • d0cd912ee42d2See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 27 revisions, 1 has no diff computed.