Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Vendors endpoint, you can retrieve a list of all vendors for a specified business.
|string||Identifier for the vendor, unique for the business in the accounting service.|
|string||Name of the vendor as recorded in the accounting service, typically the company name.|
|contactName||string||Full name of the primary contact of the vendor.|
|contactFirstName||string||First name of the primary contact of the vendor.|
|contactLastName||string||Last name of the primary contact of the vendor.|
|emailAddress||string||Email of the vendor.|
|website||string||Website of the vendor.|
|parentRef||Reference Types||Reference to parent vendor if this represents a sub-vendor.|
|currency||string||ISO-4217 currency code of the customer's default currency.|
|phone||string||Phone number of the vendor.|
|billingAddress||Reference Types||Billing address of the vendor.|
|shippingAddress||Reference Types||Shipping address of the vendor.|
|contacts||array||An array of contact information associated with the vendor.|
|taxNumber||string||Vendor tax number.|
|decimal||Vendor outstanding balance.|
|string||Vendor status of the vendor.|
|boolean||Specifies whether the vendor is an individual person or a company.|
|Date the record was last changed in the accounting system.|
Data types that reference a vendor, for example, bills and purchase orders, use a vendorRef that includes the
name of the linked vendor.
Using Vendor Reference in Push
For convenience, when pushing data
vendorRefcan be used alone with the
idas a value instead of nesting it within.
Step-by-step guide on utilizing this endpoint.