Create a vendor

Create a vendor in your app for accounts payable

POST /v2/accounts-payable/vendors

Create a vendor

cURL

curl --request POST \
  --url https://api.dots.dev/api/v2/accounts-payable/vendors \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "address": {
    "country": "US",
    "city": "<string>",
    "line_1": "<string>",
    "postcode": "<string>",
    "line_2": "<string>"
  },
  "contact_email": "[e-mail]",
  "external_id": "<string>"
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "active": true,
  "address": {
    "city": "<string>",
    "country": "<string>",
    "line_1": "<string>",
    "line_2": "<string>",
    "postcode": "<string>",
    "state": "<string>"
  },
  "api_app_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contact_email": "[e-mail]",
  "created": "2023-11-07T05:31:56Z",
  "external_id": "<string>"
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

name · string · required

address · object · required

Show child attributes

contact_email · string<email>

external_id · string

Response

201 - application/json

Created

id · string

ID of the vendor.

name · string

Name of the vendor.

description · string

active · boolean

Indicates if the vendor is active.

address · object

Show child attributes

api_app_id · string<uuid>

contact_email · string<email>

created · string<date-time>

external_id · string | null