Create vendor

Create vendor

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/vendors/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "is_active": true,
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "website": "<string>",
  "gst_registration_numbers": [
    {
      "registration_number": "<string>",
      "region": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "custom_fields": [
    {}
  ],
  "date_format_custom": "<string>",
  "unique_id": "<string>",
  "single_address": "",
  "country": "",
  "is_1099_eligible": false,
  "address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "tin": "",
  "tin_type": "",
  "attachments": [],
  "record_status": "posted",
  "term_id": 123,
  "customer_account_number": "",
  "name_on_check": "",
  "preferred_payment_method_id": 123,
  "bank_account_number": "",
  "bank_routing_number": "",
  "bank_account_type": "",
  "default_expense_account_id": 123,
  "default_ap_account_id": 123,
  "allowed_company_ids": [
    123
  ],
  "classification_line_ids": [
    123
  ]
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/vendors/"

payload = {
    "is_active": True,
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "gst_registration_numbers": [
        {
            "registration_number": "<string>",
            "region": "<string>"
        }
    ],
    "vat_registration_numbers": [
        {
            "country": "<string>",
            "registration_number": "<string>"
        }
    ],
    "custom_fields": [{}],
    "date_format_custom": "<string>",
    "unique_id": "<string>",
    "single_address": "",
    "country": "",
    "is_1099_eligible": False,
    "address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "tin": "",
    "tin_type": "",
    "attachments": [],
    "record_status": "posted",
    "term_id": 123,
    "customer_account_number": "",
    "name_on_check": "",
    "preferred_payment_method_id": 123,
    "bank_account_number": "",
    "bank_routing_number": "",
    "bank_account_type": "",
    "default_expense_account_id": 123,
    "default_ap_account_id": 123,
    "allowed_company_ids": [123],
    "classification_line_ids": [123]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_active: true,
    name: '<string>',
    email: '<string>',
    phone: '<string>',
    website: '<string>',
    gst_registration_numbers: [{registration_number: '<string>', region: '<string>'}],
    vat_registration_numbers: [{country: '<string>', registration_number: '<string>'}],
    custom_fields: [{}],
    date_format_custom: '<string>',
    unique_id: '<string>',
    single_address: '',
    country: '',
    is_1099_eligible: false,
    address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    tin: '',
    tin_type: '',
    attachments: [],
    record_status: 'posted',
    term_id: 123,
    customer_account_number: '',
    name_on_check: '',
    preferred_payment_method_id: 123,
    bank_account_number: '',
    bank_routing_number: '',
    bank_account_type: '',
    default_expense_account_id: 123,
    default_ap_account_id: 123,
    allowed_company_ids: [123],
    classification_line_ids: [123]
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/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.dualentry.com/public/v3-alpha/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([
    'is_active' => true,
    'name' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'website' => '<string>',
    'gst_registration_numbers' => [
        [
                'registration_number' => '<string>',
                'region' => '<string>'
        ]
    ],
    'vat_registration_numbers' => [
        [
                'country' => '<string>',
                'registration_number' => '<string>'
        ]
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'date_format_custom' => '<string>',
    'unique_id' => '<string>',
    'single_address' => '',
    'country' => '',
    'is_1099_eligible' => false,
    'address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'tin' => '',
    'tin_type' => '',
    'attachments' => [
        
    ],
    'record_status' => 'posted',
    'term_id' => 123,
    'customer_account_number' => '',
    'name_on_check' => '',
    'preferred_payment_method_id' => 123,
    'bank_account_number' => '',
    'bank_routing_number' => '',
    'bank_account_type' => '',
    'default_expense_account_id' => 123,
    'default_ap_account_id' => 123,
    'allowed_company_ids' => [
        123
    ],
    'classification_line_ids' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.dualentry.com/public/v3-alpha/vendors/"

	payload := strings.NewReader("{\n  \"is_active\": true,\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"date_format_custom\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"single_address\": \"\",\n  \"country\": \"\",\n  \"is_1099_eligible\": false,\n  \"address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"tin\": \"\",\n  \"tin_type\": \"\",\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"term_id\": 123,\n  \"customer_account_number\": \"\",\n  \"name_on_check\": \"\",\n  \"preferred_payment_method_id\": 123,\n  \"bank_account_number\": \"\",\n  \"bank_routing_number\": \"\",\n  \"bank_account_type\": \"\",\n  \"default_expense_account_id\": 123,\n  \"default_ap_account_id\": 123,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"classification_line_ids\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.dualentry.com/public/v3-alpha/vendors/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": true,\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"date_format_custom\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"single_address\": \"\",\n  \"country\": \"\",\n  \"is_1099_eligible\": false,\n  \"address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"tin\": \"\",\n  \"tin_type\": \"\",\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"term_id\": 123,\n  \"customer_account_number\": \"\",\n  \"name_on_check\": \"\",\n  \"preferred_payment_method_id\": 123,\n  \"bank_account_number\": \"\",\n  \"bank_routing_number\": \"\",\n  \"bank_account_type\": \"\",\n  \"default_expense_account_id\": 123,\n  \"default_ap_account_id\": 123,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"classification_line_ids\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/vendors/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": true,\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"date_format_custom\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"single_address\": \"\",\n  \"country\": \"\",\n  \"is_1099_eligible\": false,\n  \"address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"tin\": \"\",\n  \"tin_type\": \"\",\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"term_id\": 123,\n  \"customer_account_number\": \"\",\n  \"name_on_check\": \"\",\n  \"preferred_payment_method_id\": 123,\n  \"bank_account_number\": \"\",\n  \"bank_routing_number\": \"\",\n  \"bank_account_type\": \"\",\n  \"default_expense_account_id\": 123,\n  \"default_ap_account_id\": 123,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"classification_line_ids\": [\n    123\n  ]\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "term_id": 123,
  "term_name": "<string>",
  "preferred_payment_method_id": 123,
  "preferred_payment_method_name": "<string>",
  "id": 123,
  "address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "vendor_type": "<string>",
  "name": "<string>",
  "gst_registration_numbers": [
    {
      "id": 123,
      "country": "AU",
      "region": "<string>",
      "registration_type": "GST",
      "registration_number": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "id": 123,
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "classification_line_ids": [],
  "classifications": [],
  "custom_fields": [],
  "attachments": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "approval_status": "<string>",
  "next_approvers": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "rejected_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "rejection_reason": "<string>"
  },
  "date_style": "<string>",
  "date_format_custom": "<string>",
  "code": "<string>",
  "tin": "",
  "tin_type": "",
  "company_id": 123,
  "company_name": "<string>",
  "customer_account_number": "",
  "name_on_check": "",
  "bank_account_number": "",
  "bank_routing_number": "",
  "bank_account_type": "",
  "default_expense_account_id": 123,
  "default_ap_account_id": 123,
  "allowed_company_ids": [],
  "merged_into_id": 123,
  "single_address": "<string>",
  "country": "",
  "unique_id": "<string>",
  "website": "<string>",
  "email": "<string>",
  "is_active": true,
  "phone": "<string>",
  "is_1099_eligible": false,
  "record_status": "posted"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

POST

public

v3-alpha

vendors

Create vendor

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/vendors/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "is_active": true,
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "website": "<string>",
  "gst_registration_numbers": [
    {
      "registration_number": "<string>",
      "region": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "custom_fields": [
    {}
  ],
  "date_format_custom": "<string>",
  "unique_id": "<string>",
  "single_address": "",
  "country": "",
  "is_1099_eligible": false,
  "address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "tin": "",
  "tin_type": "",
  "attachments": [],
  "record_status": "posted",
  "term_id": 123,
  "customer_account_number": "",
  "name_on_check": "",
  "preferred_payment_method_id": 123,
  "bank_account_number": "",
  "bank_routing_number": "",
  "bank_account_type": "",
  "default_expense_account_id": 123,
  "default_ap_account_id": 123,
  "allowed_company_ids": [
    123
  ],
  "classification_line_ids": [
    123
  ]
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/vendors/"

payload = {
    "is_active": True,
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "gst_registration_numbers": [
        {
            "registration_number": "<string>",
            "region": "<string>"
        }
    ],
    "vat_registration_numbers": [
        {
            "country": "<string>",
            "registration_number": "<string>"
        }
    ],
    "custom_fields": [{}],
    "date_format_custom": "<string>",
    "unique_id": "<string>",
    "single_address": "",
    "country": "",
    "is_1099_eligible": False,
    "address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "tin": "",
    "tin_type": "",
    "attachments": [],
    "record_status": "posted",
    "term_id": 123,
    "customer_account_number": "",
    "name_on_check": "",
    "preferred_payment_method_id": 123,
    "bank_account_number": "",
    "bank_routing_number": "",
    "bank_account_type": "",
    "default_expense_account_id": 123,
    "default_ap_account_id": 123,
    "allowed_company_ids": [123],
    "classification_line_ids": [123]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    is_active: true,
    name: '<string>',
    email: '<string>',
    phone: '<string>',
    website: '<string>',
    gst_registration_numbers: [{registration_number: '<string>', region: '<string>'}],
    vat_registration_numbers: [{country: '<string>', registration_number: '<string>'}],
    custom_fields: [{}],
    date_format_custom: '<string>',
    unique_id: '<string>',
    single_address: '',
    country: '',
    is_1099_eligible: false,
    address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    tin: '',
    tin_type: '',
    attachments: [],
    record_status: 'posted',
    term_id: 123,
    customer_account_number: '',
    name_on_check: '',
    preferred_payment_method_id: 123,
    bank_account_number: '',
    bank_routing_number: '',
    bank_account_type: '',
    default_expense_account_id: 123,
    default_ap_account_id: 123,
    allowed_company_ids: [123],
    classification_line_ids: [123]
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/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.dualentry.com/public/v3-alpha/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([
    'is_active' => true,
    'name' => '<string>',
    'email' => '<string>',
    'phone' => '<string>',
    'website' => '<string>',
    'gst_registration_numbers' => [
        [
                'registration_number' => '<string>',
                'region' => '<string>'
        ]
    ],
    'vat_registration_numbers' => [
        [
                'country' => '<string>',
                'registration_number' => '<string>'
        ]
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'date_format_custom' => '<string>',
    'unique_id' => '<string>',
    'single_address' => '',
    'country' => '',
    'is_1099_eligible' => false,
    'address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'tin' => '',
    'tin_type' => '',
    'attachments' => [
        
    ],
    'record_status' => 'posted',
    'term_id' => 123,
    'customer_account_number' => '',
    'name_on_check' => '',
    'preferred_payment_method_id' => 123,
    'bank_account_number' => '',
    'bank_routing_number' => '',
    'bank_account_type' => '',
    'default_expense_account_id' => 123,
    'default_ap_account_id' => 123,
    'allowed_company_ids' => [
        123
    ],
    'classification_line_ids' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.dualentry.com/public/v3-alpha/vendors/"

	payload := strings.NewReader("{\n  \"is_active\": true,\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"date_format_custom\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"single_address\": \"\",\n  \"country\": \"\",\n  \"is_1099_eligible\": false,\n  \"address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"tin\": \"\",\n  \"tin_type\": \"\",\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"term_id\": 123,\n  \"customer_account_number\": \"\",\n  \"name_on_check\": \"\",\n  \"preferred_payment_method_id\": 123,\n  \"bank_account_number\": \"\",\n  \"bank_routing_number\": \"\",\n  \"bank_account_type\": \"\",\n  \"default_expense_account_id\": 123,\n  \"default_ap_account_id\": 123,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"classification_line_ids\": [\n    123\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.dualentry.com/public/v3-alpha/vendors/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"is_active\": true,\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"date_format_custom\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"single_address\": \"\",\n  \"country\": \"\",\n  \"is_1099_eligible\": false,\n  \"address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"tin\": \"\",\n  \"tin_type\": \"\",\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"term_id\": 123,\n  \"customer_account_number\": \"\",\n  \"name_on_check\": \"\",\n  \"preferred_payment_method_id\": 123,\n  \"bank_account_number\": \"\",\n  \"bank_routing_number\": \"\",\n  \"bank_account_type\": \"\",\n  \"default_expense_account_id\": 123,\n  \"default_ap_account_id\": 123,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"classification_line_ids\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/vendors/")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"is_active\": true,\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"date_format_custom\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"single_address\": \"\",\n  \"country\": \"\",\n  \"is_1099_eligible\": false,\n  \"address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"tin\": \"\",\n  \"tin_type\": \"\",\n  \"attachments\": [],\n  \"record_status\": \"posted\",\n  \"term_id\": 123,\n  \"customer_account_number\": \"\",\n  \"name_on_check\": \"\",\n  \"preferred_payment_method_id\": 123,\n  \"bank_account_number\": \"\",\n  \"bank_routing_number\": \"\",\n  \"bank_account_type\": \"\",\n  \"default_expense_account_id\": 123,\n  \"default_ap_account_id\": 123,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"classification_line_ids\": [\n    123\n  ]\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "term_id": 123,
  "term_name": "<string>",
  "preferred_payment_method_id": 123,
  "preferred_payment_method_name": "<string>",
  "id": 123,
  "address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "vendor_type": "<string>",
  "name": "<string>",
  "gst_registration_numbers": [
    {
      "id": 123,
      "country": "AU",
      "region": "<string>",
      "registration_type": "GST",
      "registration_number": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "id": 123,
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "classification_line_ids": [],
  "classifications": [],
  "custom_fields": [],
  "attachments": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "approval_status": "<string>",
  "next_approvers": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "rejected_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "rejection_reason": "<string>"
  },
  "date_style": "<string>",
  "date_format_custom": "<string>",
  "code": "<string>",
  "tin": "",
  "tin_type": "",
  "company_id": 123,
  "company_name": "<string>",
  "customer_account_number": "",
  "name_on_check": "",
  "bank_account_number": "",
  "bank_routing_number": "",
  "bank_account_type": "",
  "default_expense_account_id": 123,
  "default_ap_account_id": 123,
  "allowed_company_ids": [],
  "merged_into_id": 123,
  "single_address": "<string>",
  "country": "",
  "unique_id": "<string>",
  "website": "<string>",
  "email": "<string>",
  "is_active": true,
  "phone": "<string>",
  "is_1099_eligible": false,
  "record_status": "posted"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Headers

Idempotency-Key

string

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

Maximum string length: 255

Body

application/json

is_active

boolean

required

vendor_type

enum<string>

required

Available options:

individual,

company,

intercompany,

tax_agency

name

string

required

Required string length: 2 - 255

string

required

Maximum string length: 128

phone

string

required

Maximum string length: 64

Pattern: (?i)^(?:[0-9\s+\-.]*|[0-9\s+\-.]+(?:\s*(?:x|ext\.?|extension)\s*\d+))$

website

string

required

Maximum string length: 128

gst_registration_numbers

GstRegistrationItemSchema · object[] | null

Show child attributes

vat_registration_numbers

VatRegistrationItemSchema · object[] | null

Show child attributes

custom_fields

Custom Fields · object[] | null

date_style

enum<string> | null

Date display style: short, medium, long, or custom. Null means the organization default applies.

Available options:

short,

medium,

long,

custom

date_format_custom

string | null

Day.js / Moment-style date pattern (max 16 chars). Tokens: YYYY, YY, MMMM, MMM, MM, M, DD, D. Separators: / . - , and space. Examples: DD.MM.YYYY, MM/DD/YYYY, YYYY-MM-DD. Not ICU or raw Intl.

Maximum string length: 16

unique_id

string | null

Required string length: 1 - 64

single_address

string | null

default:""

Maximum string length: 2048

country

default:""

Allowed value: ""

is_1099_eligible

boolean

default:false

address

AddressSchemaIn · object | null

Show child attributes

tin

string | null

default:""

Tax identification number. Set it together with tin_type. Format by type: ein 12-3456789, ssn 123-45-6789, rfc 3 or 4 uppercase letters, a YYMMDD date, 2 uppercase letters or digits, then a digit or A, for example ABC010203XY9. On an update, send an empty string or null to clear it.

Maximum string length: 13

tin_type

default:""

Type of tax identification number: ein, ssn, utr, or rfc (Mexico). Set it together with tin. On an update, send an empty string or null to clear it.

Allowed value: ""

attachments

AttachmentSchemaOut · object[]

Show child attributes

record_status

enum<string>

default:posted

Available options:

draft,

posted,

archived

term_id

integer | null

customer_account_number

string

default:""

Maximum string length: 128

name_on_check

string

default:""

Maximum string length: 255

preferred_payment_method_id

integer | null

bank_account_number

string

default:""

Maximum string length: 34

bank_routing_number

string

default:""

Maximum string length: 9

bank_account_type

default:""

Allowed value: ""

default_expense_account_id

integer | null

default_ap_account_id

integer | null

allowed_company_ids

integer[] | null

Company IDs allowed to use this vendor. Empty list means global (all companies).

classification_line_ids

integer[] | null

Classification lines stored on this record.

Response

Created

created_at

string<date-time>

required

updated_at

string<date-time>

required

term_id

integer | null

required

term_name

string

required

preferred_payment_method_id

integer | null

required

preferred_payment_method_name

string

required

integer

required

address

AddressSchemaIn · object | null

required

Show child attributes

vendor_type

string

required

name

string

required

Maximum string length: 255

gst_registration_numbers

GstRegistrationItemSchemaOut · object[]

Show child attributes

vat_registration_numbers

VatRegistrationItemSchemaOut · object[]

Show child attributes

classification_line_ids

integer[]

classifications

RecordClassificationsSchemaOut · object[]

Show child attributes

custom_fields

CustomFieldValuePairOutputSchema · object[]

Show child attributes

attachments

PublicAttachmentSchemaOut · object[]

Show child attributes

created_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

updated_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

approval_status

string | null

next_approvers

ApproverDictSchema · object[] | null

Show child attributes

rejected_by

RejectedBySchema · object | null

Schema for rejector information including rejection reason.

Show child attributes

date_style

string | null

Maximum string length: 16

date_format_custom

string | null

Maximum string length: 16

code

string | null

tin

string

default:""

Tax identification number. The value is an empty string when the number is not set.

tin_type

string

default:""

Type of tax identification number: ein, ssn, utr, or rfc (Mexico). The value is an empty string when the type is not set.

company_id

integer | null

company_name

string | null

customer_account_number

string

default:""

name_on_check

string

default:""

bank_account_number

string

default:""

bank_routing_number

string

default:""

bank_account_type

default:""

Allowed value: ""

default_expense_account_id

integer | null

default_ap_account_id

integer | null

allowed_company_ids

integer[]

merged_into_id

integer | null

When you merge this vendor into another vendor, the ID of that vendor.

single_address

string | null

Maximum string length: 2048

country

default:""

Available options:

AA,

AB,

AC,

AD,

AE,

AF,

AG,

AH,

AI,

AJ,

AK,

AL,

AM,

AN,

AO,

AP,

AQ,

AR,

AS,

AT,

AU,

AV,

AW,

AX,

AY,

AZ,

BA,

BB,

BC,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BK,

BL,

BM,

BN,

BO,

BP,

BQ,

BR,

BS,

BT,

BU,

BV,

BW,

BX,

BY,

BZ,

CA,

CB,

CC,

CD,

CE,

CF,

CG,

CH,

CI,

CJ,

CK,

CL,

CM,

CN,

CO,

CP,

CQ,

CR,

CS,

CT,

CU,

CV,

CW,

CX,

CY,

CZ,

DA,

DB,

DC,

DD,

DE,

DF,

DG,

DH,

DI,

DJ,

DK,

DL,

DM,

DN,

DO,

DP,

DQ,

DR,

DS,

DT,

DU,

DV,

DW,

DX,

DY,

DZ,

EA,

EB,

EC,

ED,

EE,

EF,

EG,

EH,

EI,

EJ,

EK,

EL,

EM,

EN,

EO,

EP,

EQ,

ER,

ES,

ET,

EU,

EV,

EW,

EX,

EY,

EZ,

FA,

FB,

FC,

FD,

FE,

FF,

FG,

FH,

FI,

FJ,

FK,

FL,

FM,

FN,

FO,

FP,

FQ,

FR,

FS,

FT,

FU,

FV,

FW,

FX,

FY,

FZ,

GA,

GB,

GC,

GD,

GE,

GF,

GG,

GH,

GI,

GJ,

GK,

GL,

GM,

GN,

GO,

GP,

GQ,

GR,

GS,

GT,

GU,

GV,

GW,

GX,

GY,

GZ,

HA,

HB,

HC,

HD,

HE,

HF,

HG,

HH,

HI,

HJ,

HK,

HL,

HM,

HN,

HO,

HP,

HQ,

HR,

HS,

HT,

HU,

HV,

HW,

HX,

HY,

HZ,

IA,

IB,

IC,

ID,

IE,

IF,

IG,

IH,

II,

IJ,

IK,

IL,

IM,

IN,

IO,

IP,

IQ,

IR,

IS,

IT,

IU,

IV,

IW,

IX,

IY,

IZ,

JA,

JB,

JC,

JD,

JE,

JF,

JG,

JH,

JI,

JJ,

JK,

JL,

JM,

JN,

JO,

JP,

JQ,

JR,

JS,

JT,

JU,

JV,

JW,

JX,

JY,

JZ,

KA,

KB,

KC,

KD,

KE,

KF,

KG,

KH,

KI,

KJ,

KK,

KL,

KM,

KN,

KO,

KP,

KQ,

KR,

KS,

KT,

KU,

KV,

KW,

KX,

KY,

KZ,

LA,

LB,

LC,

LD,

LE,

LF,

LG,

LH,

LI,

LJ,

LK,

LL,

LM,

LN,

LO,

LP,

LQ,

LR,

LS,

LT,

LU,

LV,

LW,

LX,

LY,

LZ,

MA,

MB,

MC,

MD,

ME,

MF,

MG,

MH,

MI,

MJ,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NB,

NC,

ND,

NE,

NF,

NG,

NH,

NI,

NJ,

NK,

NL,

NM,

NN,

NO,

NP,

NQ,

NR,

NS,

NT,

NU,

NV,

NW,

NX,

NY,

NZ,

OA,

OB,

OC,

OD,

OE,

OF,

OG,

OH,

OI,

OJ,

OK,

OL,

OM,

ON,

OO,

OP,

OQ,

OR,

OS,

OT,

OU,

OV,

OW,

OX,

OY,

OZ,

PA,

PB,

PC,

PD,

PE,

PF,

PG,

PH,

PI,

PJ,

PK,

PL,

PM,

PN,

PO,

PP,

PQ,

PR,

PS,

PT,

PU,

PV,

PW,

PX,

PY,

PZ,

QA,

QB,

QC,

QD,

QE,

QF,

QG,

QH,

QI,

QJ,

QK,

QL,

QM,

QN,

QO,

QP,

QQ,

QR,

QS,

QT,

QU,

QV,

QW,

QX,

QY,

QZ,

RA,

RB,

RC,

RD,

RE,

RF,

RG,

RH,

RI,

RJ,

RK,

RL,

RM,

RN,

RO,

RP,

RQ,

RR,

RS,

RT,

RU,

RV,

RW,

RX,

RY,

RZ,

SA,

SB,

SC,

SD,

SE,

SF,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SP,

SQ,

SR,

SS,

ST,

SU,

SV,

SW,

SX,

SY,

SZ,

TA,

TB,

TC,

TD,

TE,

TF,

TG,

TH,

TI,

TJ,

TK,

TL,

TM,

TN,

TO,

TP,

TQ,

TR,

TS,

TT,

TU,

TV,

TW,

TX,

TY,

TZ,

UA,

UB,

UC,

UD,

UE,

UF,

UG,

UH,

UI,

UJ,

UK,

UL,

UM,

UN,

UO,

UP,

UQ,

UR,

US,

UT,

UU,

UV,

UW,

UX,

UY,

UZ,

VA,

VB,

VC,

VD,

VE,

VF,

VG,

VH,

VI,

VJ,

VK,

VL,

VM,

VN,

VO,

VP,

VQ,

VR,

VS,

VT,

VU,

VV,

VW,

VX,

VY,

VZ,

WA,

WB,

WC,

WD,

WE,

WF,

WG,

WH,

WI,

WJ,

WK,

WL,

WM,

WN,

WO,

WP,

WQ,

WR,

WS,

WT,

WU,

WV,

WW,

WX,

WY,

WZ,

XA,

XB,

XC,

XD,

XE,

XF,

XG,

XH,

XI,

XJ,

XK,

XL,

XM,

XN,

XO,

XP,

XQ,

XR,

XS,

XT,

XU,

XV,

XW,

XX,

XY,

XZ,

YA,

YB,

YC,

YD,

YE,

YF,

YG,

YH,

YI,

YJ,

YK,

YL,

YM,

YN,

YO,

YP,

YQ,

YR,

YS,

YT,

YU,

YV,

YW,

YX,

YY,

YZ,

ZA,

ZB,

ZC,

ZD,

ZE,

ZF,

ZG,

ZH,

ZI,

ZJ,

ZK,

ZL,

ZM,

ZN,

ZO,

ZP,

ZQ,

ZR,

ZS,

ZT,

ZU,

ZV,

ZW,

ZX,

ZY,

ZZ

Maximum string length: 2

unique_id

string | null

External identifier supplied by the user to disambiguate vendors that share a display name (e.g. an ID from another system).

Maximum string length: 64

website

string | null

Maximum string length: 128

string | null

Maximum string length: 128

is_active

boolean

default:true

phone

string | null

Maximum string length: 64

is_1099_eligible

boolean

default:false

record_status

enum<string>

default:posted

Available options:

draft,

posted,

archived

Overview

Organization

Accounting Setup

Transactions

Money In

Money Out

Financial & Banking

Assets

Tax

Financial Planning

Reporting

Governance

Developers

Monitoring

OAuth

Authorizations

Headers

Body

Response