Create a new Account
curl --request POST \
--url https://api.tread-horizon.com/v1/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"account_types": [
"customer"
],
"auto_accept_orders": false,
"department": "<string>",
"department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"notes": "<string>",
"external_id": "<string>",
"accounting_id": "<string>",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"truck_count": 0,
"label_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.tread-horizon.com/v1/accounts"
payload = {
"name": "<string>",
"account_types": ["customer"],
"auto_accept_orders": False,
"department": "<string>",
"department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"notes": "<string>",
"external_id": "<string>",
"accounting_id": "<string>",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"truck_count": 0,
"label_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
account_types: ['customer'],
auto_accept_orders: false,
department: '<string>',
department_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
primary_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
billing_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
notes: '<string>',
external_id: '<string>',
accounting_id: '<string>',
company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
truck_count: 0,
label_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.tread-horizon.com/v1/accounts', 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.tread-horizon.com/v1/accounts",
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>',
'account_types' => [
'customer'
],
'auto_accept_orders' => false,
'department' => '<string>',
'department_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'primary_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'billing_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'notes' => '<string>',
'external_id' => '<string>',
'accounting_id' => '<string>',
'company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'truck_count' => 0,
'label_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.tread-horizon.com/v1/accounts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"account_types\": [\n \"customer\"\n ],\n \"auto_accept_orders\": false,\n \"department\": \"<string>\",\n \"department_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"notes\": \"<string>\",\n \"external_id\": \"<string>\",\n \"accounting_id\": \"<string>\",\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"truck_count\": 0,\n \"label_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.tread-horizon.com/v1/accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"account_types\": [\n \"customer\"\n ],\n \"auto_accept_orders\": false,\n \"department\": \"<string>\",\n \"department_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"notes\": \"<string>\",\n \"external_id\": \"<string>\",\n \"accounting_id\": \"<string>\",\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"truck_count\": 0,\n \"label_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tread-horizon.com/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"account_types\": [\n \"customer\"\n ],\n \"auto_accept_orders\": false,\n \"department\": \"<string>\",\n \"department_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"notes\": \"<string>\",\n \"external_id\": \"<string>\",\n \"accounting_id\": \"<string>\",\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"truck_count\": 0,\n \"label_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discarded_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"account_types": [
"customer"
],
"external_id": "<string>",
"accounting_id": "<string>",
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule_on": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"truck_count": 123,
"auto_accept_orders": false,
"managed": true,
"labels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"billing_address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thoroughfare": "<string>",
"premise": "<string>",
"locality": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>"
},
"connected_company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tread_id": "ABC123",
"legal_name": "<string>",
"company_type": "hauler"
},
"billing_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"primary_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thoroughfare": "<string>",
"premise": "<string>",
"locality": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>"
},
"connected_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discarded_at": "2023-11-07T05:31:56Z",
"account_types": [
"customer"
],
"truck_count": 123,
"auto_accept_orders": true
},
"department": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"error_type": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"errors": [
{
"model": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Accounts
Create a new Account
Create a new Account
This endpoint requires the create_account permission
POST
/
v1
/
accounts
Create a new Account
curl --request POST \
--url https://api.tread-horizon.com/v1/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"account_types": [
"customer"
],
"auto_accept_orders": false,
"department": "<string>",
"department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"notes": "<string>",
"external_id": "<string>",
"accounting_id": "<string>",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"truck_count": 0,
"label_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.tread-horizon.com/v1/accounts"
payload = {
"name": "<string>",
"account_types": ["customer"],
"auto_accept_orders": False,
"department": "<string>",
"department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"primary_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"billing_contact": {
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"notes": "<string>",
"external_id": "<string>",
"accounting_id": "<string>",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"truck_count": 0,
"label_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
account_types: ['customer'],
auto_accept_orders: false,
department: '<string>',
department_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
primary_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
billing_contact: {name: '<string>', email: '<string>', phone: '+18885551234'},
notes: '<string>',
external_id: '<string>',
accounting_id: '<string>',
company_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
truck_count: 0,
label_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.tread-horizon.com/v1/accounts', 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.tread-horizon.com/v1/accounts",
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>',
'account_types' => [
'customer'
],
'auto_accept_orders' => false,
'department' => '<string>',
'department_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'primary_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'billing_contact' => [
'name' => '<string>',
'email' => '<string>',
'phone' => '+18885551234'
],
'notes' => '<string>',
'external_id' => '<string>',
'accounting_id' => '<string>',
'company_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'truck_count' => 0,
'label_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.tread-horizon.com/v1/accounts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"account_types\": [\n \"customer\"\n ],\n \"auto_accept_orders\": false,\n \"department\": \"<string>\",\n \"department_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"notes\": \"<string>\",\n \"external_id\": \"<string>\",\n \"accounting_id\": \"<string>\",\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"truck_count\": 0,\n \"label_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.tread-horizon.com/v1/accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"account_types\": [\n \"customer\"\n ],\n \"auto_accept_orders\": false,\n \"department\": \"<string>\",\n \"department_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"notes\": \"<string>\",\n \"external_id\": \"<string>\",\n \"accounting_id\": \"<string>\",\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"truck_count\": 0,\n \"label_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tread-horizon.com/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"account_types\": [\n \"customer\"\n ],\n \"auto_accept_orders\": false,\n \"department\": \"<string>\",\n \"department_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"primary_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"billing_contact\": {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"phone\": \"+18885551234\"\n },\n \"notes\": \"<string>\",\n \"external_id\": \"<string>\",\n \"accounting_id\": \"<string>\",\n \"company_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"truck_count\": 0,\n \"label_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discarded_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"account_types": [
"customer"
],
"external_id": "<string>",
"accounting_id": "<string>",
"company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"schedule_on": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"truck_count": 123,
"auto_accept_orders": false,
"managed": true,
"labels": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>"
}
],
"billing_address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thoroughfare": "<string>",
"premise": "<string>",
"locality": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>"
},
"connected_company": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tread_id": "ABC123",
"legal_name": "<string>",
"company_type": "hauler"
},
"billing_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"primary_contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"phone": "+18885551234"
},
"address": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thoroughfare": "<string>",
"premise": "<string>",
"locality": "<string>",
"administrative_area": "<string>",
"postal_code": "<string>",
"country": "US",
"lat": "<string>",
"lon": "<string>",
"place_id": "<string>"
},
"connected_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"discarded_at": "2023-11-07T05:31:56Z",
"account_types": [
"customer"
],
"truck_count": 123,
"auto_accept_orders": true
},
"department": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"error_type": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>"
}
}{
"error": {
"code": "<string>",
"errors": [
{
"model": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.
Example:
"en"
Body
application/json
Account name
Account type allowing for multiple values
Available options:
customer, vendor Indicates whether orders and their jobs will be accepted automatcially into the vendor account.
Department
The ID of the associated Department.
This should be used instead of department.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Notes
Identifier used to associate an account to any external system
The accounting ID of the Account mapping to any accounting system
The allowable number of trucks that is dispatchable to the customer of this account.
Array of Label IDs to assign to this account.
Response
Created
Show child attributes
Show child attributes
⌘I