Create a Business - Asset API Documentation

POST

business

Create a Business

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Roofing Pros",
  "entries_start": "2023-11-07T05:31:56Z",
  "fiscal_year": "01/01",
  "external_id": "1234567890",
  "status": "active",
  "plan": "managed",
  "onboarding_date": "2023-12-25",
  "country": "US",
  "canada_gst_registered": true,
  "home_currency": "USD"
}
'

import requests

url = "https://api.sandbox.getasset.com/v0/business"

payload = {
    "name": "Roofing Pros",
    "entries_start": "2023-11-07T05:31:56Z",
    "fiscal_year": "01/01",
    "external_id": "1234567890",
    "status": "active",
    "plan": "managed",
    "onboarding_date": "2023-12-25",
    "country": "US",
    "canada_gst_registered": True,
    "home_currency": "USD"
}
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: 'Roofing Pros',
    entries_start: '2023-11-07T05:31:56Z',
    fiscal_year: '01/01',
    external_id: '1234567890',
    status: 'active',
    plan: 'managed',
    onboarding_date: '2023-12-25',
    country: 'US',
    canada_gst_registered: true,
    home_currency: 'USD'
  })
};

fetch('https://api.sandbox.getasset.com/v0/business', 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.sandbox.getasset.com/v0/business",
  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' => 'Roofing Pros',
    'entries_start' => '2023-11-07T05:31:56Z',
    'fiscal_year' => '01/01',
    'external_id' => '1234567890',
    'status' => 'active',
    'plan' => 'managed',
    'onboarding_date' => '2023-12-25',
    'country' => 'US',
    'canada_gst_registered' => true,
    'home_currency' => 'USD'
  ]),
  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.sandbox.getasset.com/v0/business"

	payload := strings.NewReader("{\n  \"name\": \"Roofing Pros\",\n  \"entries_start\": \"2023-11-07T05:31:56Z\",\n  \"fiscal_year\": \"01/01\",\n  \"external_id\": \"1234567890\",\n  \"status\": \"active\",\n  \"plan\": \"managed\",\n  \"onboarding_date\": \"2023-12-25\",\n  \"country\": \"US\",\n  \"canada_gst_registered\": true,\n  \"home_currency\": \"USD\"\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.sandbox.getasset.com/v0/business")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Roofing Pros\",\n  \"entries_start\": \"2023-11-07T05:31:56Z\",\n  \"fiscal_year\": \"01/01\",\n  \"external_id\": \"1234567890\",\n  \"status\": \"active\",\n  \"plan\": \"managed\",\n  \"onboarding_date\": \"2023-12-25\",\n  \"country\": \"US\",\n  \"canada_gst_registered\": true,\n  \"home_currency\": \"USD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.getasset.com/v0/business")

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\": \"Roofing Pros\",\n  \"entries_start\": \"2023-11-07T05:31:56Z\",\n  \"fiscal_year\": \"01/01\",\n  \"external_id\": \"1234567890\",\n  \"status\": \"active\",\n  \"plan\": \"managed\",\n  \"onboarding_date\": \"2023-12-25\",\n  \"country\": \"US\",\n  \"canada_gst_registered\": true,\n  \"home_currency\": \"USD\"\n}"

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

{
  "data": {
    "tenant_id": "ten_Vl1a3f7JlZ9pZ5hL2wNfLn",
    "name": "Roofing Pros",
    "industry": "Roofing Contractors",
    "entries_start": "2023-11-07T05:31:56Z",
    "entity_type": "c-corp",
    "fiscal_year": "01/01",
    "external_id": "1234567890",
    "id": "biz_GA6EG2qFxA97NZHtxeLPUy",
    "status": "active",
    "onboarding_date": "2023-12-25",
    "plan": "managed",
    "assigned_bookkeeper": "<string>",
    "phone_number": "<string>",
    "country": "US",
    "region": "california",
    "canada_gst_registered": true,
    "canada_tax_status": "itc_eligible",
    "home_currency": "USD"
  }
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "message": "string",
  "data": "string"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

name

string

required

The name of the Business

Maximum string length: 255

Example:

"Roofing Pros"

entity_type

required

The Business structure, which determines the default Chart of Accounts. Ignored for the core plan, which collects no filing type and always uses the core Chart of Accounts.

Available options:

c-corp,

llc,

partnership,

s-corp,

sole-prop,

non-profit

entries_start

string<date-time>

required

The datetime in UTC ISO 8601 format from which the system will sync a Business' accounting data. All data prior to this date will be ignored

fiscal_year

string

required

The Business' fiscal year start period in format MM/DD. Optional for the core plan, which defaults to 01/01.

Maximum string length: 5

Example:

"01/01"

external_id

string

required

The external ID of the Business

Maximum string length: 255

Example:

"1234567890"

status

enum<string>

default:active

The status of the Business

Available options:

active,

inactive

plan

enum<string>

default:managed

The plan of the Business

Available options:

diy,

managed,

core

onboarding_date

string<date> | null

The date the business was onboarded

country

enum<string>

default:US

The country of the Business

Available options:

CA,

US

region

The region of the Business, such as a state or province

Available options:

alberta,

british_columbia,

manitoba,

new_brunswick,

newfoundland_and_labrador,

northwest_territories,

nova_scotia,

nunavut,

ontario,

prince_edward_island,

quebec,

saskatchewan,

yukon

canada_gst_registered

boolean | null

Whether the Business is registered for GST/HST

canada_tax_status

enum<string> | null

The Canadian tax status of the Business

Available options:

itc_eligible,

exempt

home_currency

enum<string>

default:USD

ISO 4217 currency code for the business home currency

Available options:

USD,

CAD

Example:

"USD"

Response

Successful Response

data

BusinessPublic · object

required

Show child attributes

⌘I

Create a Business

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Roofing Pros",
  "entries_start": "2023-11-07T05:31:56Z",
  "fiscal_year": "01/01",
  "external_id": "1234567890",
  "status": "active",
  "plan": "managed",
  "onboarding_date": "2023-12-25",
  "country": "US",
  "canada_gst_registered": true,
  "home_currency": "USD"
}
'

import requests

url = "https://api.sandbox.getasset.com/v0/business"

payload = {
    "name": "Roofing Pros",
    "entries_start": "2023-11-07T05:31:56Z",
    "fiscal_year": "01/01",
    "external_id": "1234567890",
    "status": "active",
    "plan": "managed",
    "onboarding_date": "2023-12-25",
    "country": "US",
    "canada_gst_registered": True,
    "home_currency": "USD"
}
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: 'Roofing Pros',
    entries_start: '2023-11-07T05:31:56Z',
    fiscal_year: '01/01',
    external_id: '1234567890',
    status: 'active',
    plan: 'managed',
    onboarding_date: '2023-12-25',
    country: 'US',
    canada_gst_registered: true,
    home_currency: 'USD'
  })
};

fetch('https://api.sandbox.getasset.com/v0/business', 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.sandbox.getasset.com/v0/business",
  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' => 'Roofing Pros',
    'entries_start' => '2023-11-07T05:31:56Z',
    'fiscal_year' => '01/01',
    'external_id' => '1234567890',
    'status' => 'active',
    'plan' => 'managed',
    'onboarding_date' => '2023-12-25',
    'country' => 'US',
    'canada_gst_registered' => true,
    'home_currency' => 'USD'
  ]),
  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.sandbox.getasset.com/v0/business"

	payload := strings.NewReader("{\n  \"name\": \"Roofing Pros\",\n  \"entries_start\": \"2023-11-07T05:31:56Z\",\n  \"fiscal_year\": \"01/01\",\n  \"external_id\": \"1234567890\",\n  \"status\": \"active\",\n  \"plan\": \"managed\",\n  \"onboarding_date\": \"2023-12-25\",\n  \"country\": \"US\",\n  \"canada_gst_registered\": true,\n  \"home_currency\": \"USD\"\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.sandbox.getasset.com/v0/business")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Roofing Pros\",\n  \"entries_start\": \"2023-11-07T05:31:56Z\",\n  \"fiscal_year\": \"01/01\",\n  \"external_id\": \"1234567890\",\n  \"status\": \"active\",\n  \"plan\": \"managed\",\n  \"onboarding_date\": \"2023-12-25\",\n  \"country\": \"US\",\n  \"canada_gst_registered\": true,\n  \"home_currency\": \"USD\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.getasset.com/v0/business")

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\": \"Roofing Pros\",\n  \"entries_start\": \"2023-11-07T05:31:56Z\",\n  \"fiscal_year\": \"01/01\",\n  \"external_id\": \"1234567890\",\n  \"status\": \"active\",\n  \"plan\": \"managed\",\n  \"onboarding_date\": \"2023-12-25\",\n  \"country\": \"US\",\n  \"canada_gst_registered\": true,\n  \"home_currency\": \"USD\"\n}"

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

{
  "data": {
    "tenant_id": "ten_Vl1a3f7JlZ9pZ5hL2wNfLn",
    "name": "Roofing Pros",
    "industry": "Roofing Contractors",
    "entries_start": "2023-11-07T05:31:56Z",
    "entity_type": "c-corp",
    "fiscal_year": "01/01",
    "external_id": "1234567890",
    "id": "biz_GA6EG2qFxA97NZHtxeLPUy",
    "status": "active",
    "onboarding_date": "2023-12-25",
    "plan": "managed",
    "assigned_bookkeeper": "<string>",
    "phone_number": "<string>",
    "country": "US",
    "region": "california",
    "canada_gst_registered": true,
    "canada_tax_status": "itc_eligible",
    "home_currency": "USD"
  }
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "message": "string",
  "data": "string"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}