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

# Get Vendor

> This endpoint gets or creates a new vendor.

### Body

<ParamField body="id" required="false" type="string">
  This is the id of the vendor.
</ParamField>

### Response

<ResponseField name="id" type="number">
  This is the id of the vendor.
</ResponseField>

<ResponseField name="vendorName" type="string">
  This is the name of the vendor.
</ResponseField>

<ResponseField name="vendorNotes" type="string">
  This is the notes of the vendor.
</ResponseField>

<ResponseField name="vendorSubtype" type="string">
  This is the subtype of the vendor.
</ResponseField>

<ResponseField name="vendorType" type="string">
  This is the type of the vendor.
</ResponseField>

<ResponseField name="vendor_owner" type="string">
  This is the owner of the vendor.
</ResponseField>

<ResponseField name="vendor_source" type="string">
  This is the source of the vendor.
</ResponseField>

<ResponseField name="annualRevenue" type="string">
  This is the annual revenue of the vendor.
</ResponseField>

<ResponseField name="avatar" type="string">
  This is the avatar of the vendor.
</ResponseField>

<ResponseField name="billingCity" type="string">
  This is the billing city of the vendor.
</ResponseField>

<ResponseField name="billingCountry" type="string">
  This is the billing country of the vendor.
</ResponseField>

<ResponseField name="billingLatitude" type="string">
  This is the billing latitude of the vendor.
</ResponseField>

<ResponseField name="billingLongitude" type="string">
  This is the billing longitude of the vendor.
</ResponseField>

<ResponseField name="billingState" type="string">
  This is the billing state of the vendor.
</ResponseField>

<ResponseField name="billingStreet" type="string">
  This is the billing street of the vendor.
</ResponseField>

<ResponseField name="created_at" type="string">
  This is the created at of the vendor.
</ResponseField>

<ResponseField name="description" type="string">
  This is the description of the vendor.
</ResponseField>

<ResponseField name="employees" type="string">
  This is the employees of the vendor.
</ResponseField>

<ResponseField name="fax" type="string">
  This is the fax of the vendor.
</ResponseField>

<ResponseField name="industry" type="string">
  This is the industry of the vendor.
</ResponseField>

<ResponseField name="is_active" type="string">
  This is the is active of the vendor.
</ResponseField>

<ResponseField name="is_public" type="string">
  This is the is public of the vendor.
</ResponseField>

<ResponseField name="last_modified_by" type="string">
  This is the last modified by of the vendor.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location --request GET 'https://api.stateset.com/v1/vendor' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Token <token>' \
  --data-raw '{
      "user_group_id": "example_1",
      "name": "Example 1",
      "mapping": {"40": "213", "134": "386"},
      "properties": {"filterValue": "value"}
  }'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "success": 1,
    "new_user_group": true,
    "user_group": {
      "team_id": 3,
      "token": "<user_group_token_to_auth_dashboard>",
      "name": "Example 1",
      "provided_id": "example_1"
    }
  }
  ```
</ResponseExample>

# Vendors

Vendors describes the general data about the vendor in Stateset.

## The vendor object

#### Attributes

| Name               | Type      | Description                                             |
| ------------------ | --------- | ------------------------------------------------------- |
| id                 | Text      | Unique identifier for the vendor                        |
| vendorName         | Text      | Name of the vendor                                      |
| vendorNotes        | Text      | Notes or additional information about the vendor        |
| vendorSubtype      | Text      | Subtype or specific category of the vendor              |
| vendorType         | Text      | Type or general category of the vendor                  |
| vendor\_owner      | Text      | Owner or responsible person for the vendor              |
| vendor\_source     | Text      | Source or origin of the vendor                          |
| annualRevenue      | Text      | Annual revenue associated with the vendor               |
| avatar             | Text      | URL or path to the vendor's avatar image                |
| billingCity        | Text      | City of the billing address                             |
| billingCountry     | Text      | Country of the billing address                          |
| billingLatitude    | Text      | Latitude coordinate of the billing address              |
| billingLongitude   | Text      | Longitude coordinate of the billing address             |
| billingState       | Text      | State or province of the billing address                |
| billingStreet      | Text      | Street address of the billing address                   |
| created\_at        | Date/Time | Date and time when the vendor was created               |
| description        | Text      | Description or additional details about the vendor      |
| employees          | Text      | Number or range of employees associated with the vendor |
| fax                | Text      | Fax number of the vendor                                |
| industry           | Text      | Industry or sector of the vendor                        |
| is\_active         | Boolean   | Indicates whether the vendor is currently active        |
| is\_public         | Boolean   | Indicates whether the vendor is public or private       |
| last\_modified\_by | Text      | Last person who modified the vendor                     |
| numberOfEmployees  | Text      | Number of employees associated with the vendor          |
| ownership          | Text      | Ownership type or structure of the vendor               |
| parentVendor       | Text      | Parent vendor associated with the vendor                |
| phone              | Text      | Phone number of the vendor                              |
| rating             | Text      | Rating or evaluation of the vendor                      |
| shippingCity       | Text      | City of the shipping address                            |
| shippingCountry    | Text      | Country of the shipping address                         |
| shippingLatitude   | Text      | Latitude coordinate of the shipping address             |
| shippingLongitude  | Text      | Longitude coordinate of the shipping address            |
| shippingState      | Text      | State or province of the shipping address               |
| shippingStreet     | Text      | Street address of the shipping address                  |
| stockTicker        | Text      | Stock ticker symbol associated with the vendor          |
| website            | Text      | Website URL of the vendor                               |
| yearStarted        | Text      | Year the vendor started or established                  |