Vendors

A vendor is a person or organization that sells goods or services.

Overview

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

Data Model

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

sourceModifiedData
sortable, filterable

string
See Date

Date the record was last changed in the accounting service provider.

Vendor Reference

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.

Example Data

{
  "data":
  [
    {
      "id": "1",
      "vendorName": "ACME Inc.",
      "contactName": "Jane Smith",
      "emailAddress": "[email protected]",
      "website": "www.acme.com",
      "defaultCurrency":
      {
        "id": "CAD",
        "name": "Canadian Dollar"
      },
      "phone": "8889990000",
      "addresses":
      [
        {
          "type": "Billing",
          "line1": "1234 Park Street",
          "line2": "Suite 1000",
          "city": "Toronto",
          "region": "ON",
          "country": "CAN",
          "postalCode": "A0B1C2"
        }
      ],
      "contacts":
      [
        {
          "name": "John Smith",
          "email": "[email protected]",
          "phone":
          [
            {
              "number": "8887779999"
            }
          ],
          "address":
          {
            "type": "Billing",
            "line1": "1234 Park Street",
            "line2": "Suite 1000",
            "city": "Toronto",
            "region": "ON",
            "country": "CAN",
            "postalCode": "A0B1C2"
          },
          "status": "unknown",
          "modifiedDate": "2021-03-09T08:49:36.035Z"
        }
      ],
      "taxNumber": "987654321",
      "balance": 5000,
      "status": "active",
      "sourceModifiedDate": "2021-03-09T08:49:36.035Z"
    }
  ]
}

Did this page help you?