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>"
}
'

import requests

url = "https://api.dots.dev/api/v2/accounts-payable/vendors"

payload = {
    "name": "<string>",
    "address": {
        "country": "US",
        "city": "<string>",
        "line_1": "<string>",
        "postcode": "<string>",
        "line_2": "<string>"
    },
    "contact_email": "[e-mail]",
    "external_id": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    address: {
      country: 'US',
      city: '<string>',
      line_1: '<string>',
      postcode: '<string>',
      line_2: '<string>'
    },
    contact_email: '[e-mail]',
    external_id: '<string>'
  })
};

fetch('https://api.dots.dev/api/v2/accounts-payable/vendors', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dots.dev/api/v2/accounts-payable/vendors",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'address' => [
        'country' => 'US',
        'city' => '<string>',
        'line_1' => '<string>',
        'postcode' => '<string>',
        'line_2' => '<string>'
    ],
    'contact_email' => '[e-mail]',
    'external_id' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dots.dev/api/v2/accounts-payable/vendors"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"country\": \"US\",\n    \"city\": \"<string>\",\n    \"line_1\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"line_2\": \"<string>\"\n  },\n  \"contact_email\": \"[e-mail]\",\n  \"external_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dots.dev/api/v2/accounts-payable/vendors")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"country\": \"US\",\n    \"city\": \"<string>\",\n    \"line_1\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"line_2\": \"<string>\"\n  },\n  \"contact_email\": \"[e-mail]\",\n  \"external_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dots.dev/api/v2/accounts-payable/vendors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"address\": {\n    \"country\": \"US\",\n    \"city\": \"<string>\",\n    \"line_1\": \"<string>\",\n    \"postcode\": \"<string>\",\n    \"line_2\": \"<string>\"\n  },\n  \"contact_email\": \"[e-mail]\",\n  \"external_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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