get company

1 min

POST

https://api.upstartcommerce.com/v1/tax/companies

This endpoint displays all the companies associated with a certain tenant.

Authorized permissions:

Authorizers.taxRead

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.

Body Parameters

bodyobject
Description
Tax provider credentials and environment identifying the companies to retrieve.
- userNamestringrequired
  Description
  Username of the configuration this call is for.
  Min Length
  1
- passwordstringrequired
  Description
  Password of the configuration's username this call is for.
  Min Length
  1
- environmentstring<Sandbox | Production>required
  Description
  Environment of the configuration this call is for.
  Allowed
  SandboxProduction
  Min Length
  1

Responses

200

Success-found the company.

object[]
Min Items
1
Unique Items
yes
- idnumber
  Description
  This company's unique identifier.
- accountIdnumber
  Description
  The unique ID number of the account this company belongs to.
- companyCodestring
  Description
  Company's unique code within your account.
  Min Length
  1
- namestring
  Description
  Name of the company.
  Min Length
  1
- isDefaultboolean
  Description
  This flag is true if this company is the default company for this account. Only one company may be set as default.
- isActiveboolean
  Description
  This flag indicates whether tax activity can occur for this company. The flag is set to true to permit the company to process transactions.
- taxpayerIdNumberstring
  Description
  For United States companies, this field contains your Taxpayer Identification Number. This is a nine digit number that is usually called an EIN for an Employer Identification Number if this company is a corporation, or SSN for a Social Security Number if this company is a person. This value is required if the address provided is inside the US and if you subscribed to the Avalara Managed Returns or SST Certified Service Provider service. Otherwise it is optional.
  Min Length
  1
- hasProfileboolean
  Description
  This flag determines whether a company has its own unique tax profile or not. If this flag is true, this company will have its own Nexus, TaxRule, TaxCode, and Item definitions. If this flag is false, this company will inherit all profile values from its parent.
- isReportingEntityboolean
  Description
  Set this flag to true if this company must file its own tax returns. For users who have Returns enabled, this flag turns on monthly Worksheet generation for this company.
- defaultCountrystring
  Description
  The two character country code of the company's default country.
  Min Length
  1
- baseCurrencyCodestring
  Description
  A three character currency code of the default currency used by this company.
  Min Length
  1
- roundingLevelIdstring
  Description
  Indicates whether this company prefers to round amounts at the document level or line level.
  Min Length
  1
- warningsEnabledboolean
  Description
  This flag is set to true to receive warnings in API calls via SOAP.
- isTestboolean
  Description
  This flag is set to true to indicate that this company is a test company. If you have Returns enabled, Test companies will not file tax returns and can be used for validation purposes.
- taxDependencyLevelIdstring
  Description
  This is used to apply tax detail dependency at a jurisdiction level.
  Min Length
  1
- inProgressboolean
  Description
  This flag is set to true to indicate that you are still working to finish configuring this company. While this value is true, no tax reporting will occur and the company will not be usable for transactions.
- createdDatenumber
  Description
  The date when this record was created.
- createdUserIdnumber
  Description
  The User ID of the user who created this record.
- modifiedDatenumber
  Description
  The date when this record was last modified.
- modifiedUserIdnumber
  Description
  The user ID of the user who last modified this record.

400

Bad Request-the request contained data that could not be processed.

GeneralError
Description
Error payload returned by the bad-request and unauthorized responses, identifying the failure by name, code and detail.
- namestringrequired
  Description
  Error name.
  Min Length
  1
- codestringrequired
  Description
  Error code.
  Min Length
  1
- reasonstring
  Description
  Reason why this error occurred.
  Min Length
  1
- detailstringrequired
  Description
  Error details.
  Min Length
  1

401

Unauthorized-the provided credentials were invalid for this endpoint.

GeneralError
Description
Error payload returned by the bad-request and unauthorized responses, identifying the failure by name, code and detail.
- namestringrequired
  Description
  Error name.
  Min Length
  1
- codestringrequired
  Description
  Error code.
  Min Length
  1
- reasonstring
  Description
  Reason why this error occurred.
  Min Length
  1
- detailstringrequired
  Description
  Error details.
  Min Length
  1

404

Not Found-the requested resource was not found in the NoChannel system.

curl

curl --request POST \
     --url https://api.upstartcommerce.com/v1/tax/companies \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-upstart-tenant: string' \
     --data '{
     "userName": "",
     "password": "",
     "environment": ""
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var raw = JSON.stringify({
   "userName": "",
   "password": "",
   "environment": ""
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/tax/companies", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/tax/companies")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"
request.body = JSON.dump({
   "userName": "",
   "password": "",
   "environment": ""
})

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

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/tax/companies"

payload = json.dumps({
   "userName": "",
   "password": "",
   "environment": ""
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Success-found the company.
[
  {
    "id": 0,
    "accountId": 0,
    "companyCode": "",
    "name": "",
    "isDefault": false,
    "isActive": false,
    "taxpayerIdNumber": "",
    "hasProfile": false,
    "isReportingEntity": false,
    "defaultCountry": "",
    "baseCurrencyCode": "",
    "roundingLevelId": "",
    "warningsEnabled": false,
    "isTest": false,
    "taxDependencyLevelId": "",
    "inProgress": false,
    "createdDate": 0,
    "createdUserId": 0,
    "modifiedDate": 0,
    "modifiedUserId": 0
  }
]

GENERATED

// Success-found the company.
[
  {
    "id": 0,
    "accountId": 0,
    "companyCode": "",
    "name": "",
    "isDefault": false,
    "isActive": false,
    "taxpayerIdNumber": "",
    "hasProfile": false,
    "isReportingEntity": false,
    "defaultCountry": "",
    "baseCurrencyCode": "",
    "roundingLevelId": "",
    "warningsEnabled": false,
    "isTest": false,
    "taxDependencyLevelId": "",
    "inProgress": false,
    "createdDate": 0,
    "createdUserId": 0,
    "modifiedDate": 0,
    "modifiedUserId": 0
  }
]

example-1

[
  {
    "id": 0,
    "accountId": 0,
    "companyCode": "string",
    "name": "string",
    "isDefault": true,
    "isActive": true,
    "taxpayerIdNumber": "string",
    "hasProfile": true,
    "isReportingEntity": true,
    "defaultCountry": "string",
    "baseCurrencyCode": "string",
    "roundingLevelId": "string",
    "warningsEnabled": true,
    "isTest": true,
    "taxDependencyLevelId": "string",
    "inProgress": true,
    "createdDate": 0,
    "createdUserId": 0,
    "modifiedDate": 0,
    "modifiedUserId": 0
  }
]

400

// Bad Request-the request contained data that could not be processed.
{
  "name": "",
  "code": "",
  "reason": "",
  "detail": ""
}

401

// Unauthorized-the provided credentials were invalid for this endpoint.
{
  "name": "",
  "code": "",
  "reason": "",
  "detail": ""
}

404

// Not Found-the requested resource was not found in the NoChannel system.