The Vendor object
From the Vendors endpoint, you can retrieve a list of all vendors for a specified business.
| Field | Type | Description |
|---|---|---|
| id sortable, filterable | string | Identifier for the vendor, unique for the business in the accounting service. |
| vendorName sortable, filterable | 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. |
| paymentMethodRef | Reference Types | Preferred payment method used by the customer |
| 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. |
| balance sortable, filterable | decimal | Vendor outstanding balance. |
| status sortable, filterable | string | Vendor status of the vendor. |
| isPerson sortable, filterable | boolean | Specifies whether the vendor is an individual person or a company. |
| sourceModifiedDate sortable, filterable | string 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
vendorRefcan be used alone with theidas a value instead of nesting it within.
How to - User Guide
Step-by-step guide on utilizing this endpoint.