Vendors

The Vendor Object

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

FieldTypeDescription
id string Identifier for the vendor, unique to the business in the accounting service provider.
vendorName
sortable, filterable
stringName of the vendor as recorded in the accounting service provider, typically the company name.
contactName
sortable, filterable
stringName of the main contact for the vendor.
emailAddress stringVendor's primary email address.
website stringVendor's website
defaultCurrency Reference TypesVendor's default currency.

Pushing data will fail if the business has not enabled or does not support multiple currency. Leaving this blank would default to the business' default currency.
phone stringVendor's phone number.
addresses arrayAn array of Addresses
contacts arrayAn array of Contacts
taxNumber stringVendor's tax number.
balance
sortable, filterable
decimalVendor's current balance.
status
sortable, filterable
stringVendor current status, either:
unknown
active
archived
subsidiaryRefsReference TypesAn array of subsidiaries the vendor refers to.
sourceModifiedDate
sortable, filterable
string
See Date
Date the record was last changed in the accounting service provider.

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.