> ## Documentation Index
> Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vendor object

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

<ParamField body="id" required={true} type="string">
  Unique identifier for the vendor.
</ParamField>

<ParamField body="external_id" type="string">
  Unique ID of the vendor in your system for linking and idempotency.
</ParamField>

<ParamField body="individual_name" type="string">
  Full name of the individual vendor or contact at a corporate vendor.
</ParamField>

<ParamField body="company_name" type="string">
  Name of the company vendor.
</ParamField>

<ParamField body="email" type="string">
  Email address of the vendor.
</ParamField>

<ParamField body="mobile_phone" type="string">
  Mobile phone number of the vendor.
</ParamField>

<ParamField body="office_phone" type="string">
  Office phone number of the vendor.
</ParamField>

<ParamField body="address_string" type="string">
  Full address of the vendor.
</ParamField>

<ParamField body="status" type="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.
</ParamField>

<ResponseField name="transaction_tags" type="Array of Tags">
  <Expandable title="Tag properties">
    <ResponseField name="id" required="true" type="string">
      Unique identifier for the tag
    </ResponseField>

    <ResponseField name="key" required="true" type="string">
      The tag's key
    </ResponseField>

    <ResponseField name="value" required="true" type="string">
      The tag's value
    </ResponseField>

    <ResponseField name="dimension_display_name" type="string">
      Display name for the tag dimension
    </ResponseField>

    <ResponseField name="value_display_name" type="string">
      Display name for the tag value
    </ResponseField>

    <ResponseField name="dimension_id" required="true" type="string">
      ID of the tag dimension
    </ResponseField>

    <ResponseField name="definition_id" required="true" type="string">
      ID of the tag value definition
    </ResponseField>

    <ResponseField name="created_at" required="true" type="ISO8601 timestamp">
      When the tag was created
    </ResponseField>

    <ResponseField name="updated_at" required="true" type="ISO8601 timestamp">
      When the tag was last updated
    </ResponseField>

    <ResponseField name="deleted_at" type="ISO8601 timestamp">
      When the tag was deleted
    </ResponseField>

    <ResponseField name="archived_at" type="ISO8601 timestamp">
      When the tag was archived
    </ResponseField>
  </Expandable>
</ResponseField>

<ParamField body="memo" type="string">
  Memo for any text you would like to associate with the vendor (for example, to display to end users).
</ParamField>

<ParamField body="metadata" type="object">
  Arbitrary custom metadata in JSON format with a size limit of 1KB.
</ParamField>

<ParamField body="reference_number" type="string">
  Any (typically user-visible) identifier you would like to associate with the vendor. Can be used to filter when listing vendors.
</ParamField>

<ResponseExample>
  ```json Response theme={null}
  {
   "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"
       }
     ]
   }
  }
  ```
</ResponseExample>