Taxnexus API v2 API Reference

Cannabis Tax Compliance As A Service

Use Taxnexus API to perform legal commerce in supported jurisdictions. Taxnexus API delivers cannabis tax rates, rates invoices, stores transactions and produces regulatory filings.

See https://docs.taxnexus.net for full API documentation

API Endpoint
http://localhost/v2
Terms of Service: http://taxnexus.net/terms/
Contact: noc@taxnexus.net
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: http
Version: 2.0.1

Schema

Return Taxnexus API Schema as JSON

GET /
200 OK

Taxnexus API Schema

type
object
Response Example (200 OK)
{
  "body": "string"
}

Accounts

Get a list of accounts

GET /accounts/basic

Return a list of all available Accounts

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used a record retrieval

companyId: string
in query

Taxnexus Record Id of a Company

name: string
in query

The Name of this Object

Taxnexus Response with Account objects with Contacts

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "companyid": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "name": "string",
      "accountnumber": "string",
      "customerid": "up-to-36-characters-like-uuid",
      "email": "string",
      "phone": "string",
      "fax": "string",
      "type": "string",
      "site": "string",
      "website": "string",
      "licenses": [
        {
          "id": "string",
          "licensetype": "string",
          "dateissued": "string",
          "expirationdate": "string",
          "iscanceled": "boolean",
          "isrevoked": "boolean",
          "name": "string",
          "status": "string"
        }
      ],
      "billingaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "billingcontact": {
        "id": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "accountname": "string",
        "email": "string",
        "mobilephone": "string",
        "phone": "string",
        "name": "string"
      },
      "preparer": {
        "id": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "accountname": "string",
        "email": "string",
        "mobilephone": "string",
        "phone": "string",
        "name": "string"
      },
      "defaultenduser": {
        "id": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "accountname": "string"
      }
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a list of accounts

GET /accounts

Return a list of all available Accounts

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used a record retrieval

companyId: string
in query

Taxnexus Record Id of a Company

name: string
in query

The Name of this Object

Taxnexus Response with Account objects with Contacts

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "backends": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "accountid": "string",
          "companyid": "string",
          "apikey": "string",
          "applicationname": "string",
          "authtype": "string",
          "backendname": "string",
          "baseurl": "string",
          "callbackurl": "string",
          "clientid": "string",
          "clientsecret": "string",
          "description": "string",
          "loginurl": "string",
          "managementpassword": "string",
          "managementurl": "string",
          "managementusername": "string",
          "password": "string",
          "projectid": "string",
          "providercredentials": "string",
          "realm": "string",
          "securitytoken": "string",
          "seq": "string",
          "tokenuri": "string",
          "type": "string",
          "username": "string"
        }
      ],
      "licenses": [
        {
          "id": "string",
          "licensetype": "string",
          "dateissued": "string",
          "expirationdate": "string",
          "iscanceled": "boolean",
          "isrevoked": "boolean",
          "name": "string",
          "status": "string"
        }
      ],
      "taxtypeaccounts": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountid": "string",
          "accountnumber": "string",
          "active": "boolean",
          "contactid": "string",
          "description": "string",
          "enddate": "string",
          "interest": "number",
          "notes": "string",
          "penalty": "number",
          "reportedadjustments": "number",
          "reporteddeductions": "number",
          "reportednetrevenue": "number",
          "reportedrate": "number",
          "reportedrevenue": "number"
        }
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Add a new account to Taxnexus

POST /accounts

Account record to be added

accountsRequest: object
in body

An array of new Account records

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a single account

PUT /accounts

Update a single account specified by accountId

accountsRequest: object
in body

An array of new Account records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Authorities

Get a list of Authorities

GET /authorities

Return a list of available Authorities

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

companyId: string
in query

Taxnexus Record Id of a Company

authorityId: string
in query

Taxnexus Id of the Authority to be retrieved

Taxnexus Response with an array of Authority objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "account": "string",
      "btn": "string",
      "contact": "string",
      "dateapproved": "string",
      "addressline1": "string",
      "addressline2": "string",
      "city": "string",
      "nameline1": "string",
      "nameline2": "string",
      "name": "string",
      "state": "string",
      "zipcode": "string",
      "losingcarrier": "string",
      "opportunity": "string",
      "order": "string",
      "quote": "string",
      "status": "string",
      "transferdate": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Add new Authorities

POST /authorities

Create new Authorities

authorityRequest: object
in body

A request with an array of Authority Objects

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update Authorities

PUT /authorities

Update fields in an Authority record identified by Taxnexus Id

authorityRequest: object
in body

A request with an array of Authority Objects

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Backends

Get a list of Backends

GET /backends

Return a list of Backends

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used a record retrieval

companyId: string
in query

Taxnexus Record Id of a Company

backendId: string
in query

Taxnexus Id of the Backend to be retrieved

name: string
in query

The Name of this Object

Taxnexus Response with an array of Backend Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "accountid": "string",
      "companyid": "string",
      "apikey": "string",
      "applicationname": "string",
      "authtype": "string",
      "backendname": "string",
      "baseurl": "string",
      "callbackurl": "string",
      "clientid": "string",
      "clientsecret": "string",
      "description": "string",
      "loginurl": "string",
      "managementpassword": "string",
      "managementurl": "string",
      "managementusername": "string",
      "password": "string",
      "projectid": "string",
      "providercredentials": "string",
      "realm": "string",
      "securitytoken": "string",
      "seq": "string",
      "tokenuri": "string",
      "type": "string",
      "username": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Add new Backends

POST /backends

Contact record to be added

backendsRequest: object
in body

An array of new Backend records

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update Backends

PUT /backends

Update Backend records

backendsRequest: object
in body

An array of new Backend records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a Backend

DELETE /backends

Delete Taxnexus Backend record

backendId: string
in query

Taxnexus Id of the Backend to be retrieved

200 OK

Taxnexus Response with Message Objects with Delete Status

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Cash Receipts

Get a list of Cash Receipts

GET /cashreceipts

Return a list of available Taxnexus Cash Receipts

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

companyId: string
in query

Taxnexus Record Id of a Company

cashreceiptId: string
in query

Taxnexus Record Id of a Cash Receipt

Taxnexus Response with an array of Invoice (full) objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "formatted": {
        "accountbalance": "string",
        "amount": "string",
        "amountadjustment": "string",
        "amountdue": "string",
        "amountpaid": "string",
        "cannabistax": "string",
        "dateissued": "string",
        "daysdue": "string",
        "depositamount": "string",
        "discount": "string",
        "invoicedate": "string",
        "issuedaccountbalance": "string",
        "minimumpaymentdue": "string",
        "monthlyamount": "string",
        "overdue0": "string",
        "overdue120": "string",
        "overdue30": "string",
        "overdue60": "string",
        "overdue90": "string",
        "prioraccountbalance": "string",
        "prioradjustments": "string",
        "priorinvoiceamount": "string",
        "priorinvoicedate": "string",
        "priorpayment": "string",
        "priorpaymentdate": "string",
        "prorateddays": "string",
        "salestax": "string",
        "shippinghandling": "string",
        "subtotal": "string"
      },
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "formatted": {
            "listprice": "string",
            "quantity": "string",
            "rejectedquantity": "string",
            "shippedquantity": "string",
            "shippinghandling": "string",
            "subtotal": "string",
            "totalprice": "string",
            "unitprice": "string"
          },
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "censustract": "string",
          "contractid": "string",
          "countyid": "string",
          "exportdescription": "string",
          "family": "string",
          "invoiceid": "string",
          "linenumber": "number",
          "description": "string",
          "listprice": "number",
          "locationid": "string",
          "orderitemid": "string",
          "periodid": "string",
          "productid": "string"
        }
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Cash Receipts

POST /cashreceipts

Create New Cash Receipts

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "invoiceid": "string",
          "quantity": "number",
          "salesregulation": "string",
          "shippinghandling": "number",
          "subtotal": "number",
          "unitprice": "number",
          "units": "string",
          "description": "string",
          "taxnexuscode": "string",
          "productcode": "string"
        }
      ],
      "accountid": "string",
      "amountdue": "number",
      "amountpaid": "number",
      "businessaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "amount": "number",
      "invoicedate": "string",
      "invoicenumber": "string",
      "salesregulation": "string",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Put a list of Cash Receipts

PUT /cashreceipts

Put a list of Cash Receipts

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "invoiceid": "string",
          "quantity": "number",
          "salesregulation": "string",
          "shippinghandling": "number",
          "subtotal": "number",
          "unitprice": "number",
          "units": "string",
          "description": "string",
          "taxnexuscode": "string",
          "productcode": "string"
        }
      ],
      "accountid": "string",
      "amountdue": "number",
      "amountpaid": "number",
      "businessaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "amount": "number",
      "invoicedate": "string",
      "invoicenumber": "string",
      "salesregulation": "string",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Charges

Get a list of Charges

GET /charges

Return a list of available Taxnexus Charges

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

companyId: string
in query

Taxnexus Record Id of a Company

chargeId: string
in query

Taxnexus Record Id of a Charge

Taxnexus Response with Charge objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "account": "string",
      "amount": "number",
      "billingemail": "string",
      "contract": "string",
      "description": "string",
      "emailmessage": "string",
      "externalid": "string",
      "externalmessage": "string",
      "journaldate": "string",
      "kazoouid": "string",
      "partneraccount": "string",
      "paymentterms": "string",
      "period": "string",
      "posted": "string",
      "product": "string",
      "quantity": "number",
      "revenueaccount": "string",
      "seq": "string",
      "unitprice": "number",
      "workorderlineitem": "string",
      "id": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Charges

POST /charges

Create New Charges

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "account": "string",
      "amount": "number",
      "billingemail": "string",
      "contract": "string",
      "description": "string",
      "emailmessage": "string",
      "externalid": "string",
      "externalmessage": "string",
      "journaldate": "string",
      "kazoouid": "string",
      "partneraccount": "string",
      "paymentterms": "string",
      "period": "string",
      "posted": "string",
      "product": "string",
      "quantity": "number",
      "revenueaccount": "string",
      "seq": "string",
      "unitprice": "number",
      "workorderlineitem": "string",
      "id": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Put a list of Charges

PUT /charges

Put a list of Charges

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "account": "string",
      "amount": "number",
      "billingemail": "string",
      "contract": "string",
      "description": "string",
      "emailmessage": "string",
      "externalid": "string",
      "externalmessage": "string",
      "journaldate": "string",
      "kazoouid": "string",
      "partneraccount": "string",
      "paymentterms": "string",
      "period": "string",
      "posted": "string",
      "product": "string",
      "quantity": "number",
      "revenueaccount": "string",
      "seq": "string",
      "unitprice": "number",
      "workorderlineitem": "string",
      "id": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Chart of Accounts

Get Chart of Accounts reports

GET /coas

Generate new Chart of Account report by report ID

coaId: string
in query

Taxnexus Id of the Chart of Accounts to be retrieved

200 OK

Taxnexus Response with Chart of Accounts objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "account": "object",
      "description": "string",
      "enddate": "string",
      "endperiod": "object",
      "coanumber": "string",
      "startdate": "string",
      "startperiod": "object"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Companies

Get Chart of Accounts reports

GET /companies

Generate new Chart of Account report by report ID

companyId: string
in query

Taxnexus Record Id of a Company

Taxnexus Response with Company objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "billingcontact": {
        "id": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "accountname": "string",
        "email": "string",
        "mobilephone": "string",
        "phone": "string",
        "name": "string"
      },
      "billingaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "usertechlead": {
        "id": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "accountname": "string",
        "email": "string",
        "mobilephone": "string",
        "phone": "string",
        "name": "string"
      },
      "accountnumberprefix": "string",
      "advanceperiod": "string",
      "billingadvice": "string",
      "billingemail": "string",
      "billingphone": "string",
      "billingwebsite": "string",
      "closedperiod": "string",
      "coloraccent1": "string",
      "coloraccent2": "string",
      "colorprimary": "string",
      "currentperiod": "string",
      "currentperiodstatus": "string",
      "dateclosed": "string",
      "defaultcompany": "boolean",
      "fontbody": "string",
      "fontheading": "string",
      "fontheadingnarrow": "string",
      "fontlink": "string",
      "fontmono": "string",
      "international": "boolean",
      "lastaccountnumber": "number",
      "logo": "string",
      "name": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Contacts

Get a list of contacts

GET /contacts/basic

Return a list of all available Contacts

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used a record retrieval

companyId: string
in query

Taxnexus Record Id of a Company

contactId: string
in query

Taxnexus Id of the Contact to be retrieved

name: string
in query

The Name of this Object

Taxnexus Response with Basic Contact objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "accountname": "string",
      "email": "string",
      "mobilephone": "string",
      "phone": "string",
      "name": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a list of contacts

GET /contacts

Return a list of all available Contacts

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used a record retrieval

companyId: string
in query

Taxnexus Record Id of a Company

contactId: string
in query

Taxnexus Id of the Contact to be retrieved

name: string
in query

The Name of this Object

Taxnexus Response with an array of Contact objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "account": {
        "id": "string",
        "companyid": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "name": "string",
        "accountnumber": "string",
        "customerid": "up-to-36-characters-like-uuid",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "type": "string",
        "site": "string",
        "website": "string",
        "licenses": [
          {
            "id": "string",
            "licensetype": "string",
            "dateissued": "string",
            "expirationdate": "string",
            "iscanceled": "boolean",
            "isrevoked": "boolean",
            "name": "string",
            "status": "string"
          }
        ],
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "preparer": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "defaultenduser": {
          "id": "string",
          "ref": "string"
        }
      }
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Add new contacts

POST /contacts

Contact record to be added

contactsRequest: object
in body

An array of new Contact records

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update Contact

PUT /contacts

Update Contact records

contactsRequest: object
in body

An array of existing Contact records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a Contact

DELETE /contacts

Delete Taxnexus Contact record

contactId: string
in query

Taxnexus Id of the Contact to be retrieved

200 OK

Taxnexus Response with Message Objects with Delete Status

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Domains

Get Domain records

GET /domains

Return all of the Commerce Domains in the Taxnexus system. Domains categorize general categories of commerce, such as Merchandise, Wholesale Goods, Wholesale Trade, Services, etc.

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

domain: string
in query

The Tax Domain to rate (cannabis, sales or telecom)

domainId: string
in query

Taxnexus Record Id of a Domain

Taxnexus Response with an array of Domain objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "description": "string",
      "domainname": "string",
      "isbusiness": "boolean",
      "iscannabis": "boolean",
      "isexcise": "boolean",
      "issales": "boolean",
      "istelecom": "boolean",
      "picklistvalue": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Filings

Get a list of Filings

GET /filings

Return a list of available Regulatory Filings

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

domain: string
in query

The Tax Domain to rate (cannabis, sales or telecom)

accountId: string
in query

Taxnexus Record Id of an Account

companyId: string
in query

Taxnexus Record Id of a Company

filingId: string
in query

Taxnexus Record Id of a Filing

Taxnexus Response with an array of Filing Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "accountname": "string",
      "amount": "number",
      "billingcontactid": "string",
      "date": "string",
      "filingpenalty": "number",
      "interest": "number",
      "penalty": "number",
      "periodid": "string",
      "protocolaccountid": "string",
      "protocolname": "string",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "subtotal": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "seq": "string",
      "status": "string",
      "tax": "number",
      "taxontax": "number",
      "totalamount": "number",
      "unitbase": "number"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Filings

POST /filings

Create new Filings

filingRequest: object
in body

A request with an array of Filing Objects

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a Filing

PUT /filings

Update all the fields in a Filing record identified by Taxnexus ID

filingRequest: object
in body

A request with an array of Filing Objects

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

GL Accounts

Get a list of General Ledger Accounts

GET /glaccounts

Return a list of available General Ledger Accounts

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

domain: string
in query

The Tax Domain to rate (cannabis, sales or telecom)

accountId: string
in query

Taxnexus Record Id of an Account

Taxnexus Response with an array of License Type Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "glbalances": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "amount": "number",
          "closedate": "string",
          "credits": "number",
          "debits": "number",
          "glaccountid": "string",
          "periodid": "string",
          "rollupcredits": "number",
          "rollupdebits": "number",
          "status": "string"
        }
      ],
      "accountid": "string",
      "accountlevel": "number",
      "accountname": "string",
      "accountnumber": "number",
      "accountsign": "string",
      "accounttype": "string",
      "description": "string",
      "glaccountid": "string",
      "glaccountdisplay": "string",
      "isactive": "boolean",
      "isbankaccount": "boolean",
      "issummary": "boolean",
      "parentfk": "string",
      "parentglaccountnumber": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new GL Accounts

POST /glaccounts

Create new GL Accounts

glAccountRequest: object
in body

An array of new Statement records

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a GL Account

PUT /glaccounts

Update all the fields in a GL Account record identified by Taxnexus ID

glAccountRequest: object
in body

An array of new Statement records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

GL Balances

Get a list of General Ledger Account Balances

GET /glbalances

Return a list of General Ledger Account Balances for a Taxnexus Account

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

domain: string
in query

The Tax Domain to rate (cannabis, sales or telecom)

accountId: string
in query

Taxnexus Record Id of an Account

periodId: string
in query

Taxnexus Record Id of a Period

Taxnexus Response with an array of License Type Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "glbalances": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "amount": "number",
          "closedate": "string",
          "credits": "number",
          "debits": "number",
          "glaccountid": "string",
          "periodid": "string",
          "rollupcredits": "number",
          "rollupdebits": "number",
          "status": "string"
        }
      ],
      "accountid": "string",
      "accountlevel": "number",
      "accountname": "string",
      "accountnumber": "number",
      "accountsign": "string",
      "accounttype": "string",
      "description": "string",
      "glaccountid": "string",
      "glaccountdisplay": "string",
      "isactive": "boolean",
      "isbankaccount": "boolean",
      "issummary": "boolean",
      "parentfk": "string",
      "parentglaccountnumber": "string"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new GL Balance Records

POST /glbalances

Create new GL Balance Records

glAccountRequest: object
in body

An array of new Statement records

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a GL Balance

PUT /glbalances

Update all the fields in a record identified by Taxnexus ID

glAccountRequest: object
in body

An array of new Statement records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Geo

Geo

Retrieve Counties

GET /counties

Retrieve Counties, filter with parameters

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

county: string
in query

The County Name

country: string
in query

The Country abbreviation (2 char)

licenseId: string
in query

Taxnexus Record Id of a License

Taxnexus Response with an array of County objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "accountid": "string",
      "amount": "number",
      "areadescription": "string",
      "contactid": "string",
      "enrollmentstatus": "string",
      "fips": "string",
      "fipsclass": "string",
      "functionalstatus": "string",
      "geocode": "string",
      "gnis": "number",
      "interest": "number",
      "landarea": "number",
      "legalname": "string",
      "name": "string",
      "penalty": "number",
      "polygoncentroid": "object",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "statefips": "string",
      "stateid": "string",
      "status": "string",
      "subtotal": "number",
      "tax": "number",
      "taxontax": "boolean",
      "templateid": "string",
      "totalamount": "number",
      "totalarea": "number",
      "unitbase": "number",
      "waterarea": "number"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Geo

Retrieve Countries

GET /countries

Retrieve Countries, filter with parameters

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

county: string
in query

The County Name

country: string
in query

The Country abbreviation (2 char)

licenseId: string
in query

Taxnexus Record Id of a License

Taxnexus Response with an array of Country objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "accountid": "string",
      "amount": "number",
      "code": "string",
      "contactid": "string",
      "enrollmentstatus": "string",
      "interest": "number",
      "name": "string",
      "penalty": "number",
      "polygoncentroid": "number",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "status": "string",
      "subtotal": "number",
      "tax": "number",
      "taxontax": "boolean",
      "templateid": "string",
      "totalamount": "number",
      "unitbase": "number"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Geo

Retrieve Places

GET /places

Retrieve Places, filter with parameters

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

name: string
in query

The Name of this Object

state: string
in query

The State or Province abbreviation (2 char)

county: string
in query

The County Name

country: string
in query

The Country abbreviation (2 char)

licenseId: string
in query

Taxnexus Record Id of a License

200 OK

Taxnexus Response with an array of Place objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "accountid": "string",
      "accountvalidation": "string",
      "amount": "number",
      "areadescription": "string",
      "contactid": "string",
      "countyid": "string",
      "enrollmentstatus": "string",
      "fips": "string",
      "fipsclass": "string",
      "functionalstatus": "string",
      "geocode": "string",
      "gnis": "number",
      "interest": "number",
      "landarea": "number",
      "legalname": "string",
      "name": "string",
      "penalty": "number",
      "polygoncentroid": "object",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "stateid": "string",
      "status": "string",
      "subtotal": "number",
      "tax": "number",
      "taxontax": "boolean",
      "templateid": "string",
      "totalamount": "number",
      "totalarea": "number",
      "unitbase": "number",
      "waterarea": "number"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Geo

Retrieve States

GET /states

Retrieve States, filter with parameters

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

county: string
in query

The County Name

country: string
in query

The Country abbreviation (2 char)

licenseId: string
in query

Taxnexus Record Id of a License

200 OK

Taxnexus Response with an array of State objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "accountid": "string",
      "amount": "number",
      "code": "string",
      "contactid": "string",
      "contryid": "string",
      "division": "string",
      "enrollmentstatus": "string",
      "fips": "string",
      "geocode": "string",
      "gnis": "number",
      "interest": "number",
      "landarea": "number",
      "name": "string",
      "penalty": "number",
      "polygoncentroid": "object",
      "region": "string",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "sgc": "string",
      "status": "string",
      "subtotal": "number",
      "tax": "number",
      "taxontax": "boolean",
      "templateid": "string",
      "totalamount": "number",
      "totalarea": "number",
      "unitbase": "number",
      "waterarea": "number"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Licenses

Retrieve licenses

GET /licenses

Retrieve all licenses, filter with parameters

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

companyId: string
in query

Taxnexus Record Id of a Company

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

county: string
in query

The County Name

country: string
in query

The Country abbreviation (2 char)

licenseId: string
in query

Taxnexus Record Id of a License

Taxnexus Response with an array of License Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "account": {
        "id": "string",
        "companyid": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "name": "string",
        "accountnumber": "string",
        "customerid": "up-to-36-characters-like-uuid",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "type": "string",
        "site": "string",
        "website": "string",
        "licenses": [
          {
            "id": "string",
            "licensetype": "string",
            "dateissued": "string",
            "expirationdate": "string",
            "iscanceled": "boolean",
            "isrevoked": "boolean",
            "name": "string",
            "status": "string"
          }
        ],
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "preparer": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        }
      }
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Licenses

POST /licenses

Create new Licenses

The new licenses

Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "account": {
        "id": "string",
        "companyid": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "name": "string",
        "accountnumber": "string",
        "customerid": "up-to-36-characters-like-uuid",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "type": "string",
        "site": "string",
        "website": "string",
        "licenses": [
          {
            "id": "string",
            "licensetype": "string",
            "dateissued": "string",
            "expirationdate": "string",
            "iscanceled": "boolean",
            "isrevoked": "boolean",
            "name": "string",
            "status": "string"
          }
        ],
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "preparer": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "defaultenduser": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "shippingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string"
        }
      }
    }
  ]
}

Taxnexus Response with an array of License Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "account": {
        "id": "string",
        "companyid": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "name": "string",
        "accountnumber": "string",
        "customerid": "up-to-36-characters-like-uuid",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "type": "string",
        "site": "string",
        "website": "string",
        "licenses": [
          {
            "id": "string",
            "licensetype": "string",
            "dateissued": "string",
            "expirationdate": "string",
            "iscanceled": "boolean",
            "isrevoked": "boolean",
            "name": "string",
            "status": "string"
          }
        ],
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "preparer": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        }
      }
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Upsert a License

PUT /licenses

Add or update licenses

The updated licenses

Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "account": {
        "id": "string",
        "companyid": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "name": "string",
        "accountnumber": "string",
        "customerid": "up-to-36-characters-like-uuid",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "type": "string",
        "site": "string",
        "website": "string",
        "licenses": [
          {
            "id": "string",
            "licensetype": "string",
            "dateissued": "string",
            "expirationdate": "string",
            "iscanceled": "boolean",
            "isrevoked": "boolean",
            "name": "string",
            "status": "string"
          }
        ],
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "preparer": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "defaultenduser": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "shippingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string"
        }
      }
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

LicenseTypes

Retrieve LicenseType records

GET /licensetypes

Retrieve LicenseType records

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

companyId: string
in query

Taxnexus Record Id of a Company

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

county: string
in query

The County Name

country: string
in query

The Country abbreviation (2 char)

licensetypeId: string
in query

Taxnexus Record Id of a License Type

Taxnexus Response with an array of License Type Objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "account": {
        "id": "string",
        "companyid": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "name": "string",
        "accountnumber": "string",
        "customerid": "up-to-36-characters-like-uuid",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "type": "string",
        "site": "string",
        "website": "string",
        "licenses": [
          {
            "id": "string",
            "licensetype": "string",
            "dateissued": "string",
            "expirationdate": "string",
            "iscanceled": "boolean",
            "isrevoked": "boolean",
            "name": "string",
            "status": "string"
          }
        ],
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countrycode": "string",
          "postalcode": "string",
          "state": "string",
          "statecode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "preparer": {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "accountname": "string",
          "email": "string",
          "mobilephone": "string",
          "phone": "string",
          "name": "string"
        },
        "defaultenduser": {}
      }
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Invoices

Get a list of Invoices

GET /invoices

Return a list of available Taxnexus Invoices

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

companyId: string
in query

Taxnexus Record Id of a Company

invoiceId: string
in query

Taxnexus Record Id of an Invoice

Taxnexus Response with an array of Invoice (full) objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "formatted": {
        "accountbalance": "string",
        "amount": "string",
        "amountadjustment": "string",
        "amountdue": "string",
        "amountpaid": "string",
        "cannabistax": "string",
        "dateissued": "string",
        "daysdue": "string",
        "depositamount": "string",
        "discount": "string",
        "invoicedate": "string",
        "issuedaccountbalance": "string",
        "minimumpaymentdue": "string",
        "monthlyamount": "string",
        "overdue0": "string",
        "overdue120": "string",
        "overdue30": "string",
        "overdue60": "string",
        "overdue90": "string",
        "prioraccountbalance": "string",
        "prioradjustments": "string",
        "priorinvoiceamount": "string",
        "priorinvoicedate": "string",
        "priorpayment": "string",
        "priorpaymentdate": "string",
        "prorateddays": "string",
        "salestax": "string",
        "shippinghandling": "string",
        "subtotal": "string"
      },
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "formatted": {
            "listprice": "string",
            "quantity": "string",
            "rejectedquantity": "string",
            "shippedquantity": "string",
            "shippinghandling": "string",
            "subtotal": "string",
            "totalprice": "string",
            "unitprice": "string"
          },
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "censustract": "string",
          "contractid": "string",
          "countyid": "string",
          "exportdescription": "string",
          "family": "string",
          "invoiceid": "string",
          "linenumber": "number",
          "description": "string",
          "listprice": "number",
          "locationid": "string",
          "orderitemid": "string",
          "periodid": "string",
          "productid": "string"
        }
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create a new Invoice

POST /invoices

Create New Invoices

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "invoiceid": "string",
          "quantity": "number",
          "salesregulation": "string",
          "shippinghandling": "number",
          "subtotal": "number",
          "unitprice": "number",
          "units": "string",
          "description": "string",
          "taxnexuscode": "string",
          "productcode": "string"
        }
      ],
      "accountid": "string",
      "amountdue": "number",
      "amountpaid": "number",
      "businessaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "amount": "number",
      "invoicedate": "string",
      "invoicenumber": "string",
      "salesregulation": "string",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Put a list of Invoices

PUT /invoices

Put a list of Invoices

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "invoiceid": "string",
          "quantity": "number",
          "salesregulation": "string",
          "shippinghandling": "number",
          "subtotal": "number",
          "unitprice": "number",
          "units": "string",
          "description": "string",
          "taxnexuscode": "string",
          "productcode": "string"
        }
      ],
      "accountid": "string",
      "amountdue": "number",
      "amountpaid": "number",
      "businessaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "amount": "number",
      "invoicedate": "string",
      "invoicenumber": "string",
      "salesregulation": "string",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Journal Entries

Get a list of Journal Entries

GET /journalentries

Return a list of Journal Entries by by GlBalance ID

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

domain: string
in query

The Tax Domain to rate (cannabis, sales or telecom)

glbalanceId: string
in query

Taxnexus Record Id of a GL Balance Record

Taxnexus Response with Journal Entry objects with Journal Items

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "account": "string",
      "balanced": "boolean",
      "credits": "number",
      "debits": "number",
      "description": "string",
      "journaldate": "string",
      "parentfk": "string",
      "periodid": "string",
      "posted": "string",
      "ratingingestid": "string",
      "reference": "string",
      "salesregulation": "string",
      "items": [
        {
          "id": "string",
          "ref": "string",
          "uuid": "string",
          "credit": "number",
          "debit": "number",
          "glaccountid": "string",
          "glbalanceid": "string",
          "invoiceitemid": "string",
          "journalentryid": "string",
          "poitemid": "string",
          "productcode": "string",
          "productid": "string",
          "referencetype": "string",
          "taxnexuscodeid": "string",
          "taxtransactionid": "string"
        }
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Journal Entry Records

POST /journalentries

Create new Journal Entry Records

journalEntryRequest: object
in body

An array of Journal Entry records

200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a Journal Entries

PUT /journalentries

Update all the fields in a record identified by Taxnexus ID

journalEntryRequest: object
in body

An array of Journal Entry records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Orders

Get a list of Orders

GET /orders

Return a list of Orders

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used a record retrieval

companyId: string
in query

Taxnexus Record Id of a Company

orderId: string
in query

Taxnexus Record Id of an Order

200 OK

Taxnexus Response with an array of Order objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "formatted": {
        "amount": "string",
        "cannabistax": "string",
        "companyauthorizeddate": "string",
        "customerauthorizeddate": "string",
        "effectivedate": "string",
        "enddate": "string",
        "installationdate": "string",
        "monthlyamount": "string",
        "podate": "string",
        "purchaseamount": "string",
        "salestax": "string",
        "shippinghandling": "string",
        "subtotal": "string",
        "telecomtax": "string",
        "totalamount": "string"
      },
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": [
        {
          "id": "string",
          "formatted": {
            "discount": "string",
            "linegrossamount": "string",
            "listprice": "string",
            "quantity": "string",
            "quantityonhand": "string",
            "shippinghandling": "string",
            "subtotal": "string",
            "totalprice": "string",
            "unitprice": "string"
          },
          "ref": "string",
          "uuid": "string",
          "parentfk": "string",
          "account": "object",
          "activated": "boolean",
          "activatedby": "string",
          "availablequantity": "number",
          "contractid": "string",
          "createreservation": "boolean",
          "datedelivered": "string",
          "dateordered": "string",
          "datepromised": "string",
          "description": "string",
          "discount": "number",
          "enddate": "string",
          "family": "string",
          "inventorytracking": "boolean",
          "invoiceitemid": "string",
          "linegrossamount": "number",
          "lineitemnumber": "number",
          "listprice": "number",
          "locationid": "string",
          "orderid": "string",
          "orderitemnumber": "string",
          "originalorderitemid": "string",
          "posted": "string",
          "product2id": "string",
          "productid": "string",
          "productname": "string"
        }
      ]
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Orders

POST /orders

Create new Orders

undefined

Request Content-Types: application/json
Request Example
{
  "meta": {
    "testonly": "boolean",
    "taxnexusaccount": "string",
    "username": "string",
    "password": "string",
    "token": "string"
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "items": {
        "id": "string",
        "ref": "string",
        "uuid": "string",
        "parentfk": "string",
        "invoiceid": "string",
        "quantity": "number",
        "salesregulation": "string",
        "shippinghandling": "number",
        "subtotal": "number",
        "unitprice": "number",
        "units": "string",
        "description": "string",
        "taxnexuscode": "string",
        "productcode": "string"
      },
      "accountid": "string",
      "amountdue": "number",
      "businessaddress": {
        "city": "string",
        "country": "string",
        "countrycode": "string",
        "postalcode": "string",
        "state": "string",
        "statecode": "string",
        "street": "string"
      },
      "amount": "number",
      "orderdate": "string",
      "status": "string",
      "subtotal": "number",
      "salesregulation": "string",
      "type": "string"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a POST -> ["ref", "id"]

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Orders

PUT /orders

Create new Orders

undefined

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "formatted": {
    "amount": "string",
    "cannabistax": "string",
    "companyauthorizeddate": "string",
    "customerauthorizeddate": "string",
    "effectivedate": "string",
    "enddate": "string",
    "installationdate": "string",
    "monthlyamount": "string",
    "podate": "string",
    "purchaseamount": "string",
    "salestax": "string",
    "shippinghandling": "string",
    "subtotal": "string",
    "telecomtax": "string",
    "totalamount": "string"
  },
  "ref": "string",
  "uuid": "string",
  "parentfk": "string",
  "items": [
    {
      "id": "string",
      "formatted": {
        "discount": "string",
        "linegrossamount": "string",
        "listprice": "string",
        "quantity": "string",
        "quantityonhand": "string",
        "shippinghandling": "string",
        "subtotal": "string",
        "totalprice": "string",
        "unitprice": "string"
      },
      "ref": "string",
      "uuid": "string",
      "parentfk": "string",
      "account": "object",
      "activated": "boolean",
      "activatedby": "string",
      "availablequantity": "number",
      "contractid": "string",
      "createreservation": "boolean",
      "datedelivered": "string",
      "dateordered": "string",
      "datepromised": "string",
      "description": "string",
      "discount": "number",
      "enddate": "string",
      "family": "string",
      "inventorytracking": "boolean",
      "invoiceitemid": "string",
      "linegrossamount": "number",
      "lineitemnumber": "number",
      "listprice": "number",
      "locationid": "string",
      "orderid": "string",
      "orderitemnumber": "string",
      "originalorderitemid": "string",
      "posted": "string",
      "product2id": "string",
      "productid": "string",
      "productname": "string",
      "quantity": "number",
      "quantityonhand": "number",
      "quotelineitemid": "string",
      "servicedate": "string",
      "shippinghandling": "number",
      "status": "string",
      "subscriptionid": "string",
      "subtotal": "number",
      "taxnexuscodeid": "string",
      "totalprice": "number",
      "unitprice": "number"
    }
  ],
  "taxitems": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "amount": "number",
      "displayname": "string",
      "effectiverate": "number",
      "itemref": "string",
      "percenttaxable": "number",
      "parentref": "string",
      "placegeocode": "string",
      "ratingtype": "string",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "tax": "number",
      "taxexemptrevenue": "number",
      "taxnexuscodedisplay": "string",
      "taxontax": "number",
      "taxrate": "number",
      "unitbase": "number",
      "unitfeerate": "number"
    }
  ]
}
200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Periods

Get a list of Periods

GET /periods

Return a list of Periods for an Account

limit: integer (int32) 100
in query

How many objects to return at one time (max 300, default 100)

offset: integer (int32) 0
in query

How many objects to skip? (default 0)

accountId: string
in query

Taxnexus Record Id of an Account

Taxnexus Response with Period objects

401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "id": "string",
      "ref": "string",
      "uuid": "string",
      "accountid": "string",
      "days": "number",
      "enddate": "string",
      "month": "number",
      "name": "string",
      "quarter": "number",
      "semiannual": "number",
      "startdate": "string",
      "status": "string",
      "year": "number"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (422 Unprocessable Entity)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update Periods

PUT /periods

Update Period records

periodRequest: object
in body

An array of Period records

200 OK

Taxnexus Response with an array of Message objects in response to a PUT

type
object
401 Unauthorized

Access unauthorized, invalid API-KEY was used

403 Forbidden

Access forbidden, account lacks access

404 Not Found

Resource was not found

422 Unprocessable Entity

Unprocessable Entity, likely a bad parameter

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "apiinfo": "string",
    "apiresponsetime": "string",
    "apitimestamp": "string",
    "apiuid": "string",
    "contact": "string",
    "copyright": "string",
    "license": "string",
    "info": "string",
    "operationid": "string",
    "orgid": "string",
    "ratingingestid": "string",
    "requestip": "string",
    "requesttype": "string",
    "requesturl": "string",
    "serverinfo": "string",
    "serverresponsetime": "string",
    "servertimestamp": "string",
    "situsfocus": "string",
    "starttime": "integer (int32)",
    "taxnexusaccount": "string",
    "testonly": "boolean",
    "useraccount": "string",
    "userid": "string",
    "username": "string",
    "pagination": {
      "poffset": "integer (int32)",
      "limit": "integer (int32)",
      "pagesize": "integer (int32)",
      "setsize": "integer (int32)"
    }
  },
  "data": [
    {
      "ref": "Object Id or Reference",
      "message": "Application Message",
      "status": "integer"
    }
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Response Example (403 Forbidden)