The Vendor Object
From the Vendors endpoint, you can retrieve a list of all vendors for a specified business.
Field | Type | Description |
---|---|---|
id | string | Identifier for the vendor, unique to the business in the accounting service provider. |
vendorName sortable, filterable | string | Name of the vendor as recorded in the accounting service provider, typically the company name. |
contactName sortable, filterable | string | Name of the main contact for the vendor. |
emailAddress | string | Vendor's primary email address. |
website | string | Vendor's website |
defaultCurrency | Reference Types | Vendor'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 | string | Vendor's phone number. |
addresses | array | An array of Addresses |
contacts | array | An array of Contacts |
taxNumber | string | Vendor's tax number. |
balance sortable, filterable | decimal | Vendor's current balance. |
status sortable, filterable | string | Vendor current status, either:unknown active archived |
subsidiaryRefs | Reference Types | An 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 theid
as a value instead of nesting it within.