API Reference

Vendors

Vendors are the suppliers, merchants, contractors, and contacts you pay through bills and expense transactions. A vendor holds contact details, an optional address, 1099 tax settings, and status.

Last updated 2026-06-21

The Vendors API lets your integration list, create, update, and delete vendors in a workspace. Vendors represent anyone you pay — suppliers, merchants, contractors, and other contacts.

Partner responses expose each vendor UUID as `id` and remove internal numeric identifiers and foreign keys such as `teamId`.

Key concepts

Identification

Vendors are referenced by UUID returned as `id`. Pass that value in the path to update or delete.

Required fields

Only `name` is required to create a vendor. Address and contacts can be supplied inline.

Duplicate handling

Creating a vendor with a name that matches an active vendor returns 400. Creating with a name that matches an inactive vendor reactivates and updates that record.

1099 vendors

Set `is1099` and related tax fields for contractor reporting. The API validates 1099 field combinations on create and update.

The vendor object

Fields returned on a vendor. Address and contacts are embedded when present.

Attributes

iduuid

Vendor identifier (UUID). Use in path parameters for update and delete.

namestring

Vendor display name. Required on create.

emailstring

Primary email address.

mainPhonestring

Primary phone number.

websitestring

Website URL.

accountNumberstring

Your internal vendor account number.

statusenum

Vendor status. Defaults to active.

One of: active, inactive

typeenum

Vendor classification. Defaults to MERCHANT.

One of: MERCHANT, SUPPLIER, CONTRACTOR, CONTACT, OWNER

legalNamestring

Legal entity name for tax reporting.

businessNamestring

Doing-business-as name when different from legal name.

taxNumberstring

Tax identification number.

taxTypeenum

Tax id type.

One of: none, ssn, ein, itin, atin

is1099boolean

Whether the vendor receives 1099 reporting.

addressobject

Mailing address, or null.

streetstring

Street address.

citystring

City or locality.

statestring

State, province, or region.

zipCodestring

Postal or ZIP code.

countrystring

Country name or ISO code.

contactsarray

Contact people for this vendor.

iduuid

Contact identifier (UUID).

firstNamestring

Contact's first name.

lastNamestring

Contact's last name.

emailstring

Contact's email address.

phonestring

Contact's phone number.

isPrimaryboolean

Marks the primary contact.

createdAtdatetime

ISO 8601 creation timestamp.

updatedAtdatetime

ISO 8601 last update timestamp.

Example

{
  "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "name": "Office Depot",
  "email": "ap@officedepot.com",
  "mainPhone": "+18001234567",
  "website": "https://officedepot.com",
  "accountNumber": "V-1001",
  "status": "active",
  "type": "SUPPLIER",
  "legalName": "Office Depot Inc.",
  "businessName": null,
  "taxNumber": null,
  "taxType": "none",
  "is1099": false,
  "address": {
    "street": "500 Supply Chain Blvd",
    "city": "Boca Raton",
    "state": "FL",
    "zipCode": "33431",
    "country": "USA"
  },
  "contacts": [
    {
      "id": "a5da3577-bf85-4e3a-aa73-df85ca69bc67",
      "firstName": "Accounts",
      "lastName": "Payable",
      "email": "ap@officedepot.com",
      "phone": "+18001234567",
      "isPrimary": true
    }
  ],
  "createdAt": "2026-01-15T10:30:00.000Z",
  "updatedAt": "2026-01-28T14:22:30.000Z"
}

Search covers name, account number, and contact email

The `search` query parameter on list matches vendor name, account number, and contact email addresses (case-insensitive, partial).

Contractor-linked vendors

Vendors linked to a payroll contractor person record have restricted update fields. Attempts to change protected keys return 400.

Recent changes

2026-06-21

Complete Partner API reference

Documented all remaining API reference groups: Chart of Accounts, Vendors, Products & Services, Recurring Invoice Templates, Credit Memos, Bills, Journal Entries, Tags, People, Projects, Tasks, Time Entries, Expense Receipts, Reports, and Workspace Stats. Added missing invoice endpoints (audit log, attachments, credit application, remove transaction) and group overviews for Invoices and Transactions.