The Vendor object

From the Vendors endpoint, you can retrieve a list of all vendors for a specified business.

sortable, filterable
string Identifier for the vendor, unique for the business in the accounting service.
sortable, filterable
stringName of the vendor as recorded in the accounting service, typically the company name.
contactNamestringFull name of the primary contact of the vendor.
contactFirstNamestringFirst name of the primary contact of the vendor.
contactLastNamestringLast name of the primary contact of the vendor.
emailAddress stringEmail of the vendor.
website stringWebsite of the vendor.
parentRefReference TypesReference to parent vendor if this represents a sub-vendor.
currency stringISO-4217 currency code of the customer's default currency.
phone stringPhone number of the vendor.
billingAddress Reference TypesBilling address of the vendor.
shippingAddressReference TypesShipping address of the vendor.
contacts arrayAn array of contact information associated with the vendor.
taxNumber stringVendor tax number.
sortable, filterable
decimalVendor outstanding balance.
sortable, filterable
stringVendor status of the vendor.
sortable, filterable
booleanSpecifies whether the vendor is an individual person or a company.
sortable, filterable
See Date
Date the record was last changed in the accounting system.

The Vendor Reference Object

Data types that reference a vendor, for example, bills and purchase orders, use a vendorRef that includes the id and name of the linked vendor.


Using Vendor Reference in Push

For convenience, when pushing data vendorRef can be used alone with the id as a value instead of nesting it within.

How to - User Guide

Step-by-step guide on utilizing this endpoint.