Taxnexus API API Reference

The Cannabis Tax Compliance Company

Use Taxnexus API to help you perform legal commerce in supported jurisdictions. Taxnexus API delivers tax rates, rates invoices, stores transactions and produces regulatory filings. See https://taxnexus.io for full developer documentation

API Endpoint
https://gw.tnxs.net/tax/v1
Terms of Service: http://taxnexus.net/terms/
Contact: noc@taxnexus.net
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.3

Authentication

api_key

type
apiKey
name
X-API-Key
in
header

Accounts

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

The Taxnexus Record ID of the Account to be used in Situs determination

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

name: string
in query

The Name of this Object

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Account objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "billingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "billingcontact": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "company": {
        "id": "string",
        "account": {
          "name": "string",
          "accountnumber": "string",
          "phone": "string",
          "type": "string",
          "website": "string",
          "billingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "billingcontact": {
            "id": "string",
            "accountid": "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 (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

An array of Account objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "billingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "billingcontact": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "company": {
        "id": "string",
        "account": {
          "name": "string",
          "accountnumber": "string",
          "phone": "string",
          "type": "string",
          "website": "string",
          "billingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "billingcontact": {
            "id": "string",
            "accountid": "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 (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

An array of Account objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "billingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "billingcontact": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "company": {
        "id": "string",
        "account": {
          "name": "string",
          "accountnumber": "string",
          "phone": "string",
          "type": "string",
          "website": "string",
          "billingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "billingcontact": {
            "id": "string",
            "accountid": "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 (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

The Taxnexus Record ID of the Account to be used in Situs determination

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

cashreceiptId: string
in query

The Taxnexus Record Id of the Cash Receipt to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Cash Receipt objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "accountname": "string",
      "amount": "number",
      "appliedamount": "number",
      "attempt_number": "number",
      "auditmessage": "string",
      "autopay": "boolean",
      "billingcontact": "string",
      "gateway": "string",
      "gatewaykey": "string",
      "gatewaymessage": "string",
      "gatewaytxn": "boolean",
      "glaccount": "number",
      "isvalid": "boolean",
      "cashreceiptdate": "string",
      "description": "string",
      "partneraccount": "string",
      "payment_method": "string",
      "payment_number": "string",
      "status": "string",
      "pending": "boolean",
      "period": "string",
      "picklistvalue": "string",
      "posted": "string",
      "processed": "boolean",
      "processing": "boolean",
      "recordtypeid": "string",
      "reference": "string",
      "referencenumber": "string",
      "rejected": "boolean",
      "source": "string",
      "statementitemtype": "string",
      "suppressworkflow": "boolean",
      "type": "string",
      "unappliedamount": "number",
      "validpayment": "boolean",
      "xeroid": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create a new Cash Receipts

POST /cashreceipts

Create a new Cash Receipt for a particular Account

undefined

Request Content-Types: application/json
Request Example
{
  "accountname": "string",
  "amount": "number",
  "appliedamount": "number",
  "attempt_number": "number",
  "auditmessage": "string",
  "autopay": "boolean",
  "billingcontact": "string",
  "gateway": "string",
  "gatewaykey": "string",
  "gatewaymessage": "string",
  "gatewaytxn": "boolean",
  "glaccount": "number",
  "isvalid": "boolean",
  "cashreceiptdate": "string",
  "description": "string",
  "partneraccount": "string",
  "payment_method": "string",
  "payment_number": "string",
  "status": "string",
  "pending": "boolean",
  "period": "string",
  "picklistvalue": "string",
  "posted": "string",
  "processed": "boolean",
  "processing": "boolean",
  "recordtypeid": "string",
  "reference": "string",
  "referencenumber": "string",
  "rejected": "boolean",
  "source": "string",
  "statementitemtype": "string",
  "suppressworkflow": "boolean",
  "type": "string",
  "unappliedamount": "number",
  "validpayment": "boolean",
  "xeroid": "string"
}
200 OK

An array of Cash Receipt objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "accountname": "string",
      "amount": "number",
      "appliedamount": "number",
      "attempt_number": "number",
      "auditmessage": "string",
      "autopay": "boolean",
      "billingcontact": "string",
      "gateway": "string",
      "gatewaykey": "string",
      "gatewaymessage": "string",
      "gatewaytxn": "boolean",
      "glaccount": "number",
      "isvalid": "boolean",
      "cashreceiptdate": "string",
      "description": "string",
      "partneraccount": "string",
      "payment_method": "string",
      "payment_number": "string",
      "status": "string",
      "pending": "boolean",
      "period": "string",
      "picklistvalue": "string",
      "posted": "string",
      "processed": "boolean",
      "processing": "boolean",
      "recordtypeid": "string",
      "reference": "string",
      "referencenumber": "string",
      "rejected": "boolean",
      "source": "string",
      "statementitemtype": "string",
      "suppressworkflow": "boolean",
      "type": "string",
      "unappliedamount": "number",
      "validpayment": "boolean",
      "xeroid": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Upsert a list of Cash Receipts

PUT /cashreceipts

Upsert a list of Cash Receipts

undefined

Request Content-Types: application/json
Request Example
{
  "accountname": "string",
  "amount": "number",
  "appliedamount": "number",
  "attempt_number": "number",
  "auditmessage": "string",
  "autopay": "boolean",
  "billingcontact": "string",
  "gateway": "string",
  "gatewaykey": "string",
  "gatewaymessage": "string",
  "gatewaytxn": "boolean",
  "glaccount": "number",
  "isvalid": "boolean",
  "cashreceiptdate": "string",
  "description": "string",
  "partneraccount": "string",
  "payment_method": "string",
  "payment_number": "string",
  "status": "string",
  "pending": "boolean",
  "period": "string",
  "picklistvalue": "string",
  "posted": "string",
  "processed": "boolean",
  "processing": "boolean",
  "recordtypeid": "string",
  "reference": "string",
  "referencenumber": "string",
  "rejected": "boolean",
  "source": "string",
  "statementitemtype": "string",
  "suppressworkflow": "boolean",
  "type": "string",
  "unappliedamount": "number",
  "validpayment": "boolean",
  "xeroid": "string"
}
200 OK

An array of Cash Receipt objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "accountname": "string",
      "amount": "number",
      "appliedamount": "number",
      "attempt_number": "number",
      "auditmessage": "string",
      "autopay": "boolean",
      "billingcontact": "string",
      "gateway": "string",
      "gatewaykey": "string",
      "gatewaymessage": "string",
      "gatewaytxn": "boolean",
      "glaccount": "number",
      "isvalid": "boolean",
      "cashreceiptdate": "string",
      "description": "string",
      "partneraccount": "string",
      "payment_method": "string",
      "payment_number": "string",
      "status": "string",
      "pending": "boolean",
      "period": "string",
      "picklistvalue": "string",
      "posted": "string",
      "processed": "boolean",
      "processing": "boolean",
      "recordtypeid": "string",
      "reference": "string",
      "referencenumber": "string",
      "rejected": "boolean",
      "source": "string",
      "statementitemtype": "string",
      "suppressworkflow": "boolean",
      "type": "string",
      "unappliedamount": "number",
      "validpayment": "boolean",
      "xeroid": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Contacts

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

The Taxnexus Record ID of the Account to be used in Situs determination

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

contactId: string
in query

The Taxnexus Record Id of the Contact to be retrieved

name: string
in query

The Name of this Object

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Contact objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (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

An array of Contact objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a Contact

PUT /contacts

Update a Contact record

contactsRequest: object
in body

An array of new Contact records

200 OK

An array of Contact objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a Contact

DELETE /contacts

Delete Taxnexus Contact record

contactId: string
in query

The Taxnexus Record Id of the Contact to be retrieved

200 OK

An array of Contact objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (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 Cannabis, Telecom or General Consumption (items where state sales tax apply). In the case of cannabis, there are currently many domains to help differentiate the different license holders.

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

The Taxnexus Record Id of the Domain to be retrieved

200 OK

An array of Domain objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "description": "string",
      "domain_name": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Documents

Get a list of documents

GET /documents

Get a list of documents

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

The Taxnexus Record ID of the Account to be used in Situs determination

documentId: string
in query

The Taxnexus Record Id of the Document to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Document objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "Checksum": "string",
      "ContentBodyId": "string",
      "ContentDocumentId": "string",
      "ContentLocation": "string",
      "ContentModifiedById": "string",
      "ContentModifiedDate": "string",
      "ContentSize": "number",
      "ContentUrl": "string",
      "Description": "string",
      "Division": "string",
      "ExternalDataSourceId": "string",
      "ExternalDocumentInfo1": "string",
      "ExternalDocumentInfo2": "string",
      "FeaturedContentBoost": "number",
      "FeaturedContentDate": "string",
      "FileExtension": "string",
      "FileType": "string",
      "FirstPublishLocationId": "string",
      "IsAssetEnabled": "boolean",
      "IsEncrypted": "boolean",
      "IsLatest": "boolean",
      "IsMajorVersion": "boolean",
      "Language": "string",
      "NegativeRatingCount": "number",
      "NetworkId": "string",
      "Origin": "string",
      "OwnerId": "string",
      "PathOnClient": "string",
      "PositiveRatingCount": "number",
      "PublishStatus": "string",
      "RatingCount": "string",
      "ReasonForChange": "string",
      "RecordTypeId": "string",
      "SharingOption": "string",
      "SharingPrivacy": "string",
      "TagCsv": "string",
      "TextPreview": "string",
      "Title": "string",
      "VersionData": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Accounts

POST /documents/accounts

Generate PDFs from a list of Accounts

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Authroities

POST /documents/authorities

Generate PDFs from a list of Authroities

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Countries

POST /documents/countries

Generate PDFs from a list of Countries

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Counties

POST /documents/counties

Generate PDFs from a list of Counties

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Filings

POST /documents/filings

Generate PDFs from a list of Filings

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Invoices

POST /documents/invoices

Generate PDFs from a list of Invoices

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Places

POST /documents/places

Generate PDFs from a list of Places

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Process one or more attachments into a new attachment

POST /documents/process

Concatenate PDFs into a new attachment

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Statements

POST /documents/statements

Generate PDFs from a list of Statements

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of States

POST /documents/states

Generate PDFs from a list of Invoices

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Submissions

POST /documents/submissions

Generate PDFs from a list of Submissions

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of TaxTypes

POST /documents/taxtypes

Generate PDFs from a list of TaxTypes

idsRequest: object
in body

An array of existing Taxnexus Record IDs

200 OK

The PDF and HTML document Ids

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "theId": "string",
      "htmlId": "string",
      "pdfId": "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 (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

The Taxnexus Record ID of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

filingId: string
in query

The Taxnexus Record Id of the Filing to be retrieved

200 OK

An array of Filing Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "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 (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

An array of Filing Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "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 (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

An array of Filing Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "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 (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)

accountId: string
in query

The Taxnexus Record ID of the Account to be used in Situs determination

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

The Taxnexus Record Id of the License to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of County objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "amount": "number",
      "areadescription": "string",
      "contactid": "string",
      "enrollmentstatus": "string",
      "fips": "string",
      "fipsclass": "string",
      "firestore": "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 (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)

accountId: string
in query

The Taxnexus Record ID of the Account to be used in Situs determination

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

The Taxnexus Record Id of the License to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Country objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "amount": "number",
      "code": "string",
      "contactid": "string",
      "enrollmentstatus": "string",
      "firestore": "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 (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)

accountId: string
in query

The Taxnexus Record ID of the Account to be used in Situs determination

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

The Taxnexus Record Id of the License to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Place objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "accountvalidation": "string",
      "amount": "number",
      "areadescription": "string",
      "contactid": "string",
      "countyid": "string",
      "enrollmentstatus": "string",
      "fips": "string",
      "fipsclass": "string",
      "firestore": "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 (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)

accountId: string
in query

The Taxnexus Record ID of the Account to be used in Situs determination

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

The Taxnexus Record Id of the License to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of State objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "amount": "number",
      "code": "string",
      "contactid": "string",
      "contryid": "string",
      "division": "string",
      "enrollmentstatus": "string",
      "fips": "string",
      "firestore": "string",
      "geocode": "string",
      "gnis": "number",
      "interest": "number",
      "landarea": "number",
      "name": "string",
      "penalty": "number",
      "polygon_centroid": "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 (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

The Taxnexus Record ID of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

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

The Taxnexus Record Id of the License to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of License Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (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": {
    "test_only": "boolean",
    "acount_number": "string",
    "info": "string",
    "operation_id": "string",
    "org_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "shippingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        }
      },
      "contact": {
        "id": "string",
        "accountid": "string",
        "email": "string",
        "mailingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "mobilephone": "string",
        "name": "string"
      },
      "licensetype": {
        "id": "string",
        "account": {
          "name": "string",
          "accountnumber": "string",
          "phone": "string",
          "type": "string",
          "website": "string",
          "billingaddress": {
            "city": "string"
          }
        }
      }
    }
  ]
}
200 OK

An array of License Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (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": {
    "test_only": "boolean",
    "acount_number": "string",
    "info": "string",
    "operation_id": "string",
    "org_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "shippingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        }
      },
      "contact": {
        "id": "string",
        "accountid": "string",
        "email": "string",
        "mailingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "mobilephone": "string",
        "name": "string"
      },
      "licensetype": {
        "id": "string",
        "account": {
          "name": "string",
          "accountnumber": "string",
          "phone": "string",
          "type": "string",
          "website": "string",
          "billingaddress": {
            "city": "string"
          }
        }
      }
    }
  ]
}
200 OK

An array of License Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (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)

accountId: string
in query

The Taxnexus Record ID of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

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

The Taxnexus Record Id of the License Type to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of License Type Objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {
          "id": "string",
          "accountid": "string",
          "email": "string",
          "mailingaddress": {
            "city": "string",
            "country": "string",
            "countryCode": "string",
            "postalCode": "string",
            "state": "string",
            "stateCode": "string",
            "street": "string"
          },
          "mobilephone": "string",
          "name": "string"
        },
        "shippingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "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 (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

The Taxnexus Record ID of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

invoiceId: string
in query

The Taxnexus Record Id of the Invoice to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Invoice (full) objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "invoiceitems": [
        {
          "id": "string",
          "census_tract": "string",
          "contractid": "string",
          "countyid": "string",
          "domain": "string",
          "exportdescription": "string",
          "family": "string",
          "invoiceid": "string",
          "linenumber": "number",
          "description": "string",
          "list_price": "number",
          "locationid": "string",
          "orderitemid": "string",
          "periodid": "string",
          "productid": "string",
          "productcode": "string",
          "quantity": "number",
          "quotelineitemid": "string",
          "rejected_quantity": "number",
          "revenueaccount": "number",
          "seq": "string",
          "shipped_quantity": "number",
          "shippinghandling": "number",
          "sku": "string",
          "subscriptionid": "string",
          "subtotal": "number",
          "taxnexuscode": "string",
          "totalprice": "number",
          "unitprice": "number"
        }
      ],
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "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 (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": {
    "test_only": "boolean",
    "acount_number": "string",
    "info": "string",
    "operation_id": "string",
    "org_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "items": {
        "id": "string",
        "invoiceid": "string",
        "quantity": "number",
        "shippinghandling": "number",
        "subtotal": "number",
        "unitprice": "number",
        "description": "string",
        "taxnexuscode": "string",
        "domain": "string",
        "productcode": "string"
      },
      "accountid": "string",
      "amountdue": "number",
      "businessaddress": "string",
      "amount": "number",
      "invoicedate": "string",
      "salesregulation": "string",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}
200 OK

An array of Invoice (full) objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "invoiceitems": [
        {
          "id": "string",
          "census_tract": "string",
          "contractid": "string",
          "countyid": "string",
          "domain": "string",
          "exportdescription": "string",
          "family": "string",
          "invoiceid": "string",
          "linenumber": "number",
          "description": "string",
          "list_price": "number",
          "locationid": "string",
          "orderitemid": "string",
          "periodid": "string",
          "productid": "string",
          "productcode": "string",
          "quantity": "number",
          "quotelineitemid": "string",
          "rejected_quantity": "number",
          "revenueaccount": "number",
          "seq": "string",
          "shipped_quantity": "number",
          "shippinghandling": "number",
          "sku": "string",
          "subscriptionid": "string",
          "subtotal": "number",
          "taxnexuscode": "string",
          "totalprice": "number",
          "unitprice": "number"
        }
      ],
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "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 (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": {
    "test_only": "boolean",
    "acount_number": "string",
    "info": "string",
    "operation_id": "string",
    "org_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "items": {
        "id": "string",
        "invoiceid": "string",
        "quantity": "number",
        "shippinghandling": "number",
        "subtotal": "number",
        "unitprice": "number",
        "description": "string",
        "taxnexuscode": "string",
        "domain": "string",
        "productcode": "string"
      },
      "accountid": "string",
      "amountdue": "number",
      "businessaddress": "string",
      "amount": "number",
      "invoicedate": "string",
      "salesregulation": "string",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}
200 OK

An array of Invoice (full) objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "invoiceitems": [
        {
          "id": "string",
          "census_tract": "string",
          "contractid": "string",
          "countyid": "string",
          "domain": "string",
          "exportdescription": "string",
          "family": "string",
          "invoiceid": "string",
          "linenumber": "number",
          "description": "string",
          "list_price": "number",
          "locationid": "string",
          "orderitemid": "string",
          "periodid": "string",
          "productid": "string",
          "productcode": "string",
          "quantity": "number",
          "quotelineitemid": "string",
          "rejected_quantity": "number",
          "revenueaccount": "number",
          "seq": "string",
          "shipped_quantity": "number",
          "shippinghandling": "number",
          "sku": "string",
          "subscriptionid": "string",
          "subtotal": "number",
          "taxnexuscode": "string",
          "totalprice": "number",
          "unitprice": "number"
        }
      ],
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "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 (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

The Taxnexus Record ID of the Account to be used in Situs determination

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

orderId: string
in query

The Taxnexus Record Id of the Company to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Order objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "orderitems": [
        {
          "id": "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"
        }
      ]
    }
  ]
}
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 (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
{
  "id": "string",
  "orderitems": [
    {
      "id": "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"
    }
  ],
  "account": {
    "name": "string",
    "accountnumber": "string",
    "phone": "string",
    "type": "string",
    "website": "string",
    "billingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "billingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string",
      "name": "string"
    },
    "shippingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "shippingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string"
    }
  }
}
200 OK

An array of Order objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "orderitems": [
        {
          "id": "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"
        }
      ]
    }
  ]
}
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 (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",
  "orderitems": [
    {
      "id": "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"
    }
  ],
  "account": {
    "name": "string",
    "accountnumber": "string",
    "phone": "string",
    "type": "string",
    "website": "string",
    "billingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "billingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string",
      "name": "string"
    },
    "shippingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "shippingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string"
    }
  }
}
200 OK

An array of Order objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "orderitems": [
        {
          "id": "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"
        }
      ]
    }
  ]
}
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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Purchase Orders

Get a list of Purchase Orders

GET /pos

Return a list of available Purchase 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

The Taxnexus Record ID of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

invoiceId: string
in query

The Taxnexus Record Id of the Invoice to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Purchase Order objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "string",
          "generalledgerid": "string",
          "invoiceid": "string",
          "invoiceitemid": "string",
          "issummary": "boolean",
          "seq": "string",
          "orderid": "string",
          "orderitemid": "string",
          "percenttaxable": "number",
          "periodid": "string",
          "placeid": "string",
          "posted": "string",
          "quoteid": "string",
          "quoteitemid": "string",
          "ratingingestid": "string",
          "ratingmethod": "string",
          "ratingtype": "string",
          "revenuebase": "number",
          "revenuenet": "number",
          "revenuenottaxable": "number",
          "tax": "number",
          "taxexemptrevenue": "number",
          "taxontax": "number",
          "taxrate": "number",
          "taxtypeid": "string",
          "unitbase": "number",
          "unitfeerate": "number"
        }
      ],
      "purchaseorderitems": [
        {
          "id": "string",
          "product": "object",
          "accountid": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create a new Purchase Order

POST /pos

Create New Purchase Order

Request Content-Types: application/json
Request Example
{
  "meta": {
    "test_only": "boolean",
    "acount_number": "string",
    "info": "string",
    "operation_id": "string",
    "org_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "string",
          "generalledgerid": "string",
          "invoiceid": "string",
          "invoiceitemid": "string",
          "issummary": "boolean",
          "seq": "string",
          "orderid": "string",
          "orderitemid": "string",
          "percenttaxable": "number",
          "periodid": "string",
          "placeid": "string",
          "posted": "string",
          "quoteid": "string",
          "quoteitemid": "string",
          "ratingingestid": "string",
          "ratingmethod": "string",
          "ratingtype": "string",
          "revenuebase": "number",
          "revenuenet": "number",
          "revenuenottaxable": "number",
          "tax": "number",
          "taxexemptrevenue": "number",
          "taxontax": "number",
          "taxrate": "number",
          "taxtypeid": "string",
          "unitbase": "number",
          "unitfeerate": "number"
        }
      ],
      "purchaseorderitems": [
        {
          "id": "string",
          "product": "object",
          "accountid": "string",
          "enduserid": "string",
          "locationid": "string",
          "orderitemid": "string",
          "partneraccountid": "string",
          "purchaseorderid": "string",
          "pricebookentryid": "string",
          "quotelineitemid": "string",
          "shipmentitmeid": "string",
          "due_date": "string",
          "linenumber": "number",
          "quantity": "number",
          "received_qty": "number",
          "rejected_qty": "number",
          "stocked_qty": "number",
          "subtotal": "number",
          "totalprice": "number",
          "unitprice": "number",
          "description": "string",
          "seq": "string",
          "posted": "string",
          "productcode": "string",
          "status": "string",
          "taxable": "string",
          "taxnexuscode": "string"
        }
      ],
      "orderid": "string",
      "opportunityid": "string",
      "quoteid": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {}
      }
    }
  ]
}
200 OK

An array of Purchase Order objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "string",
          "generalledgerid": "string",
          "invoiceid": "string",
          "invoiceitemid": "string",
          "issummary": "boolean",
          "seq": "string",
          "orderid": "string",
          "orderitemid": "string",
          "percenttaxable": "number",
          "periodid": "string",
          "placeid": "string",
          "posted": "string",
          "quoteid": "string",
          "quoteitemid": "string",
          "ratingingestid": "string",
          "ratingmethod": "string",
          "ratingtype": "string",
          "revenuebase": "number",
          "revenuenet": "number",
          "revenuenottaxable": "number",
          "tax": "number",
          "taxexemptrevenue": "number",
          "taxontax": "number",
          "taxrate": "number",
          "taxtypeid": "string",
          "unitbase": "number",
          "unitfeerate": "number"
        }
      ],
      "purchaseorderitems": [
        {
          "id": "string",
          "product": "object",
          "accountid": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Upsert a list of Purchase Order

PUT /pos

Upsert a list of Purchase Order

Request Content-Types: application/json
Request Example
{
  "meta": {
    "test_only": "boolean",
    "acount_number": "string",
    "info": "string",
    "operation_id": "string",
    "org_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "string",
          "generalledgerid": "string",
          "invoiceid": "string",
          "invoiceitemid": "string",
          "issummary": "boolean",
          "seq": "string",
          "orderid": "string",
          "orderitemid": "string",
          "percenttaxable": "number",
          "periodid": "string",
          "placeid": "string",
          "posted": "string",
          "quoteid": "string",
          "quoteitemid": "string",
          "ratingingestid": "string",
          "ratingmethod": "string",
          "ratingtype": "string",
          "revenuebase": "number",
          "revenuenet": "number",
          "revenuenottaxable": "number",
          "tax": "number",
          "taxexemptrevenue": "number",
          "taxontax": "number",
          "taxrate": "number",
          "taxtypeid": "string",
          "unitbase": "number",
          "unitfeerate": "number"
        }
      ],
      "purchaseorderitems": [
        {
          "id": "string",
          "product": "object",
          "accountid": "string",
          "enduserid": "string",
          "locationid": "string",
          "orderitemid": "string",
          "partneraccountid": "string",
          "purchaseorderid": "string",
          "pricebookentryid": "string",
          "quotelineitemid": "string",
          "shipmentitmeid": "string",
          "due_date": "string",
          "linenumber": "number",
          "quantity": "number",
          "received_qty": "number",
          "rejected_qty": "number",
          "stocked_qty": "number",
          "subtotal": "number",
          "totalprice": "number",
          "unitprice": "number",
          "description": "string",
          "seq": "string",
          "posted": "string",
          "productcode": "string",
          "status": "string",
          "taxable": "string",
          "taxnexuscode": "string"
        }
      ],
      "orderid": "string",
      "opportunityid": "string",
      "quoteid": "string",
      "account": {
        "name": "string",
        "accountnumber": "string",
        "phone": "string",
        "type": "string",
        "website": "string",
        "billingaddress": {
          "city": "string",
          "country": "string",
          "countryCode": "string",
          "postalCode": "string",
          "state": "string",
          "stateCode": "string",
          "street": "string"
        },
        "billingcontact": {}
      }
    }
  ]
}
200 OK

An array of Purchase Order objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "taxitems": [
        {
          "id": "string",
          "accountid": "string",
          "amount": "number",
          "domainid": "string",
          "effectiverate": "number",
          "filingid": "string",
          "generalledgerid": "string",
          "invoiceid": "string",
          "invoiceitemid": "string",
          "issummary": "boolean",
          "seq": "string",
          "orderid": "string",
          "orderitemid": "string",
          "percenttaxable": "number",
          "periodid": "string",
          "placeid": "string",
          "posted": "string",
          "quoteid": "string",
          "quoteitemid": "string",
          "ratingingestid": "string",
          "ratingmethod": "string",
          "ratingtype": "string",
          "revenuebase": "number",
          "revenuenet": "number",
          "revenuenottaxable": "number",
          "tax": "number",
          "taxexemptrevenue": "number",
          "taxontax": "number",
          "taxrate": "number",
          "taxtypeid": "string",
          "unitbase": "number",
          "unitfeerate": "number"
        }
      ],
      "purchaseorderitems": [
        {
          "id": "string",
          "product": "object",
          "accountid": "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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Quotes

Get a list of Quotes

GET /quotes

Return a list of available Taxnexus Quotes

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

The Taxnexus Record ID of the Account to be used in Situs determination

accountNumber: string
in query

The Taxnexus Account Number of the Account to be used in Situs determination

companyId: string
in query

The Taxnexus Record Id of the Company to be retrieved

quoteId: string
in query

The Taxnexus Record Id of the Company to be retrieved

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

200 OK

An array of Quote objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "quoteitems": [
        {
          "id": "string",
          "locationid": "string",
          "product": {
            "id": "string",
            "name": "string",
            "description": "string",
            "Telnexuscode": "string",
            "mrcinterval": "number",
            "descriptionsku": "string",
            "units": "string",
            "cost": "number",
            "prices": [
              {
                "id": "string",
                "accountid": "string",
                "agentid": "string",
                "unitprice": "number",
                "pricebook": {
                  "id": "string",
                  "isactive": "boolean",
                  "description": "string",
                  "isstandard": "boolean",
                  "name": "string"
                },
                "procuct": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "Telnexuscode": "string",
                  "mrcinterval": "number",
                  "descriptionsku": "string",
                  "units": "string",
                  "cost": "number",
                  "prices": [
                    null
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}
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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Quotes

POST /quotes

Create new Quotes

undefined

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "orderitems": [
    {
      "id": "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"
    }
  ],
  "account": {
    "name": "string",
    "accountnumber": "string",
    "phone": "string",
    "type": "string",
    "website": "string",
    "billingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "billingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string",
      "name": "string"
    },
    "shippingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "shippingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string"
    }
  }
}
200 OK

An array of Quote objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "quoteitems": [
        {
          "id": "string",
          "locationid": "string",
          "product": {
            "id": "string",
            "name": "string",
            "description": "string",
            "Telnexuscode": "string",
            "mrcinterval": "number",
            "descriptionsku": "string",
            "units": "string",
            "cost": "number",
            "prices": [
              {
                "id": "string",
                "accountid": "string",
                "agentid": "string",
                "unitprice": "number",
                "pricebook": {
                  "id": "string",
                  "isactive": "boolean",
                  "description": "string",
                  "isstandard": "boolean",
                  "name": "string"
                },
                "procuct": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "Telnexuscode": "string",
                  "mrcinterval": "number",
                  "descriptionsku": "string",
                  "units": "string",
                  "cost": "number",
                  "prices": [
                    null
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}
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 (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update Quotes

PUT /quotes

Update QUotes

undefined

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "orderitems": [
    {
      "id": "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"
    }
  ],
  "account": {
    "name": "string",
    "accountnumber": "string",
    "phone": "string",
    "type": "string",
    "website": "string",
    "billingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "billingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string",
      "name": "string"
    },
    "shippingaddress": {
      "city": "string",
      "country": "string",
      "countryCode": "string",
      "postalCode": "string",
      "state": "string",
      "stateCode": "string",
      "street": "string"
    },
    "shippingcontact": {
      "id": "string",
      "accountid": "string",
      "email": "string",
      "mailingaddress": {
        "city": "string",
        "country": "string",
        "countryCode": "string",
        "postalCode": "string",
        "state": "string",
        "stateCode": "string",
        "street": "string"
      },
      "mobilephone": "string"
    }
  }
}
200 OK

An array of Quote objects

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

500 Internal Server Error

Server Internal Error

Response Example (200 OK)
{
  "meta": {
    "test_only": "boolean",
    "coordinate": {
      "latitude": "number",
      "longitude": "number",
      "formatted_address": "string",
      "place_id": "string",
      "place": "string",
      "neighborhood": "string",
      "county": "string",
      "state": "string",
      "country": "string",
      "street_number": "string",
      "street": "string",
      "postal_code": "string"
    },
    "pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "acount_number": "string",
    "api_info": "string",
    "api_response_time": "string",
    "api_timestamp": "string",
    "api_uid": "string",
    "contact": "string",
    "copyright": "string",
    "info": "string",
    "license": "string",
    "operation_id": "string",
    "org_id": "string",
    "request_ip": "string",
    "request_type": "string",
    "request_url": "string",
    "server_info": "string",
    "server_response_time": "string",
    "server_timestamp": "string",
    "situs_focus": "string",
    "user_id": "string",
    "user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "quoteitems": [
        {
          "id": "string",
          "locationid": "string",
          "product": {
            "id": "string",
            "name": "string",
            "description": "string",
            "Telnexuscode": "string",
            "mrcinterval": "number",
            "descriptionsku": "string",
            "units": "string",
            "cost": "number",
            "prices": [
              {
                "id": "string",
                "accountid": "string",
                "agentid": "string",
                "unitprice": "number",
                "pricebook": {
                  "id": "string",
                  "isactive": "boolean",
                  "description": "string",
                  "isstandard": "boolean",
                  "name": "string"
                },
                "procuct": {
                  "id": "string",
                  "name": "string",
                  "description": "string",
                  "Telnexuscode": "string",
                  "mrcinterval": "number",
                  "descriptionsku": "string",
                  "units": "string",
                  "cost": "number",
                  "prices": [
                    null
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  ]
}