Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
vendors
Create vendor
curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/vendors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "<string>",
  "individual_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "mobile_phone": "<string>",
  "office_phone": "<string>",
  "address_string": "<string>",
  "memo": "<string>",
  "tags": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "individual_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "mobile_phone": "<string>",
  "office_phone": "<string>",
  "address_string": "<string>",
  "memo": "<string>",
  "status": "ACTIVE",
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimension_display_name": "<string>",
      "value_display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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.

Authorizations

ā€‹
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

ā€‹
businessId
string<uuid>
required

The UUID of the business to create the vendor for.

Body

application/json
ā€‹
external_id
string | null

External ID for the vendor.

ā€‹
individual_name
string | null

Name of individual vendor or contact.

ā€‹
company_name
string | null

Name of company vendor.

ā€‹
email
string | null

Email address.

ā€‹
mobile_phone
string | null

Mobile phone number.

ā€‹
office_phone
string | null

Office phone number.

ā€‹
address_string
string | null

Physical address.

ā€‹
memo
string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

ā€‹
tags
object[]

Response

201 - application/json

Vendor created successfully.

ā€‹
id
string<uuid>

Unique identifier for the vendor.

ā€‹
external_id
string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

ā€‹
individual_name
string | null

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

ā€‹
company_name
string | null

Name of the company vendor.

ā€‹
email
string | null

Email address of the vendor.

ā€‹
mobile_phone
string | null

Mobile phone number of the vendor.

ā€‹
office_phone
string | null

Office phone number of the vendor.

ā€‹
address_string
string | null

Address of the vendor.

ā€‹
memo
string | null

Memo for any text you would like to associate with the vendor (for example, to display to end users).

ā€‹
status
enum<string>

Status of the vendor.

Available options:
ACTIVE,
ARCHIVED
ā€‹
transaction_tags
object[]