{
 "data": {
   "type": "VendorData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "vendor-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ACTIVE",
   "transaction_tags": [
     {
       "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
       "key": "ExampleTagKey",
       "value": "ExampleTagValue",
       "created_at": "2023-11-07T05:31:56Z",
       "updated_at": "2023-11-07T05:31:56Z",
       "deleted_at": "2023-11-07T05:31:56Z"
     }
   ]
 }
}

A Vendor of a business can send bills and have payments applied to their bills.

Vendors can be referenced when creating bills using either the Layer id, or the external id.

​
Attributes

​
id
string
required

Unique identifier for the vendor.

​
external_id
string

Unique ID of the vendor in your system for linking and idempotency.

​
individual_name
string

Full name of the individual vendor or contact at a corporate vendor.

​
company_name
string

Name of the company vendor.

​
email
string

Email address of the vendor.

​
mobile_phone
string

Mobile phone number of the vendor.

​
office_phone
string

Office phone number of the vendor.

​
address_string
string

Full address of the vendor.

​
notes
string

Notes about the vendor.

​
status
enum

Status of the vendor. Possible values are: ACTIVE, ARCHIVED Archived vendors will not appear when listing vendors, but their accounting continues to be tracked and they can still be retrieved directly in the API.

​
transaction_tags
Array of Tags
{
 "data": {
   "type": "VendorData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "vendor-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ACTIVE",
   "transaction_tags": [
     {
       "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
       "key": "ExampleTagKey",
       "value": "ExampleTagValue",
       "created_at": "2023-11-07T05:31:56Z",
       "updated_at": "2023-11-07T05:31:56Z",
       "deleted_at": "2023-11-07T05:31:56Z"
     }
   ]
 }
}