Vendors

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 Bank Account Object

From the Vendor Bank Accounts endpoint, you can retrieve a list of bank accounts for a specified vendor of a business.

Field	Type	Description
id sortable, filterable	string	Identifier for the vendor bank account, unique for the business in the accounting service.
name sortable, filterable	string	Name of the account as recorded in the accounting service.
contactName	string	Full name of the primary contact of the vendor.
type sortable, filterable	string	The bank account type. Valid values: `checking` `saving` `creditCard` `loan` `investment` `unknown`
vendorRef	Reference Types	Reference to the vendor against which the payment is created.
accountNumber sortable, filterable	string	Account number for the bank account.
routingNumber sortable, filterable	string	Routing number for the bank associated with the account.
bankName sortable, filterable	string	Name of the bank.
supportsAch sortable, filterable	boolean	Does the account support ACH payments
supportsWire sortable, filterable	boolean	Does the account support wire transfers
supportsCheck sortable, filterable	boolean	Does the account support check payments
address	Reference Types	Address of the bank.
currency	string	ISO-4217 currency code of the vendor's default currency.
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 vendorRef can be used alone with the id as a value instead of nesting it within.

The Vendor object

The Vendor Bank Account Object

The Vendor Reference Object

📘Using Vendor Reference in Push

📘
Using Vendor Reference in Push