Taxnexus API API Reference

Tax Compliance Made Easy 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://api.tnxs.net/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.1.2

Tax

Tax

Tax Rate by Situs Lookup

GET /taxrates

Returns full sales tax information for a specific point on the map (tax situs)

limit: integer (int32)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

domain: string
in query

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

address: string
in query

Postal Address URL encoded; partial addresses allowed

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

country: string
in query

The Country abbreviation (2 char)

accountId: string
in query

The Taxnexus Account ID to be used in Situs determination

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "geocode": "string",
      "zip": "string",
      "state": "string",
      "state_rate": "number",
      "county": "string",
      "county_rate": "number",
      "city": "string",
      "city_rate": "number",
      "combined_district_rate": "number",
      "combined_rate": "number",
      "taxtypes": [
        {
          "id": "string",
          "firestore": "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",
                "account": {
                  "name": "string",
                  "accountnumber": "string",
                  "phone": "string"
                }
              }
            }
          }
        }
      ]
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}
Tax

Rate a list of invoices

POST /taxes/invoices

Rate a list of invoices

A list of InvoiceBasic objects

Request Example
"object"

An array of Tax Transactions

default

unexpected error

Response Example (200 OK)
[
  {
    "meta": {
      "boolean  Boolean  test_only": "boolean",
      "object  Coordinate  coordinates": {
        "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"
      },
      "object  Pagination  pagination": {
        "p_offset": "integer (int32)",
        "p_limit": "integer (int32)",
        "page_size": "integer (int32)",
        "set_size": "integer (int32)",
        "next_link": "string"
      },
      "object  RatingIngest  ratingingest": {
        "id": "string",
        "account": "string",
        "date": "string",
        "filename": "string",
        "period": "string",
        "ratingengine": "string",
        "seq": "string",
        "status": "string"
      },
      "string  String  acount_number": "string",
      "string  String  api_info": "string",
      "string  String  api_response_time": "string",
      "string  String  api_timestamp": "string",
      "string  String  api_uid": "string",
      "string  String  contact": "string",
      "string  String  copyright": "string",
      "string  String  info": "string",
      "string  String  license": "string",
      "string  String  operation_id": "string",
      "string  String  org_id": "string",
      "string  String  request_ip": "string",
      "string  String  request_type": "string",
      "string  String  request_url": "string",
      "string  String  server_info": "string",
      "string  String  server_response_time": "string",
      "string  String  server_timestamp": "string",
      "string  String  situs_focus": "string",
      "string  String  user_id": "string",
      "string  String  user_name": "string"
    },
    "data": [
      {
        "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"
      }
    ]
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

TaxTypes

Get a list of Tax Types

GET /taxtypes

Return a complete list of all the tax types handled by Taxnexus; use the lat long parameters to retrieve a Situs lookup

limit: integer (int32)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

domain: string
in query

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

address: string
in query

Postal Address URL encoded; partial addresses allowed

place: string
in query

The City name (must be accompanied by State)

county: string
in query

The County name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

country: string
in query

The Country abbreviation (2 char)

firestoreId: string
in query

The Firestore UUID of the corresponding TaxType record

Expected response to a valid request

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "firestore": "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",
            "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"
              }
            }
          }
        }
      }
    }
  ]
}

Get a single Tax Type by Taxnexus Id

GET /taxtypes/{taxTypeId}

Return record for specified Tax Type

taxTypeId: string
in path

The Taxnexus Id of the Tax Type record to be retrieved

200 OK

Expected response to a valid request

type
Response Example (200 OK)
[
  {
    "id": "string",
    "firestore": "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",
          "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",
              "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",
                  "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",
                      "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"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
]

TaxCodes

Get a list of TaxCodes

GET /taxcodes

Return a list of TaxCodes

limit: integer (int32)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

firestoreId: string
in query

The Firestore UUID of the corresponding User record

An array of taxcodes

201 Created

Null response

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "domain": "object",
      "firestore": "string",
      "code": "string",
      "description": "string",
      "level": "string",
      "seq": "string",
      "part1": "string",
      "part2": "string",
      "part3": "string",
      "part4": "string",
      "suretaxcode": "string"
    }
  ]
}

Get a single TaxCode

GET /taxcodes/{taxcodeId}

Return a single Tax Code specified by taxcodeId

taxcodeId: string
in path

The Taxnexus Record Id of the TaxCode to be retrieved

Expected response to a valid request

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "domain": "object",
      "firestore": "string",
      "code": "string",
      "description": "string",
      "level": "string",
      "seq": "string",
      "part1": "string",
      "part2": "string",
      "part3": "string",
      "part4": "string",
      "suretaxcode": "string"
    }
  ]
}

TaxTypeAccounts

Get a list of Tax Type Accounts

GET /taxtypeaccounts

Return a list of all available Tax Type Accounts

limit: integer (int32)
in query

How many items to return at one time (max 100)

A paged array of Tax Type Accounts

default

Unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "accountnumber": "string",
      "active": "boolean",
      "contactid": "string",
      "description": "string",
      "enddate": "string",
      "interest": "number",
      "notes": "string",
      "penalty": "number",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "subtotal": "number",
      "amount": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "tax": "number",
      "taxontax": "number",
      "unitbase": "number",
      "seq": "string",
      "startdate": "string",
      "taxtypeid": "string",
      "totalamount": "number"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Tax Type Accounts

POST /taxtypeaccounts

Create a new Tax Type Account

The new Tax Type Account

Request Example
{
  "id": "string",
  "accountid": "string",
  "accountnumber": "string",
  "active": "boolean",
  "contactid": "string",
  "description": "string",
  "enddate": "string",
  "interest": "number",
  "notes": "string",
  "penalty": "number",
  "reportedadjustments": "number",
  "reporteddeductions": "number",
  "reportednetrevenue": "number",
  "reportedrate": "number",
  "reportedrevenue": "number",
  "subtotal": "number",
  "amount": "number",
  "revenuebase": "number",
  "revenuenet": "number",
  "revenuenottaxable": "number",
  "tax": "number",
  "taxontax": "number",
  "unitbase": "number",
  "seq": "string",
  "startdate": "string",
  "taxtypeid": "string",
  "totalamount": "number"
}

An array of TaxTypeAccount Ids

default

Unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a Tax Type Account

GET /taxtypeaccounts/{taxtypeaccountId}

Return a single Tax Type Account specified by taxtypeaccountId

taxtypeaccountId: string
in path

The Taxnexus Record Id of the Tax Type Account to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "accountnumber": "string",
      "active": "boolean",
      "contactid": "string",
      "description": "string",
      "enddate": "string",
      "interest": "number",
      "notes": "string",
      "penalty": "number",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "subtotal": "number",
      "amount": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "tax": "number",
      "taxontax": "number",
      "unitbase": "number",
      "seq": "string",
      "startdate": "string",
      "taxtypeid": "string",
      "totalamount": "number"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a TaxTypeAccount

PUT /taxtypeaccounts/{taxtypeaccountId}

Update a TaxTypeAccount

undefined

taxtypeaccountId: string
in path

The Taxnexus Record Id of the Tax Type Account to be retrieved

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "accountid": "string",
  "accountnumber": "string",
  "active": "boolean",
  "contactid": "string",
  "description": "string",
  "enddate": "string",
  "interest": "number",
  "notes": "string",
  "penalty": "number",
  "reportedadjustments": "number",
  "reporteddeductions": "number",
  "reportednetrevenue": "number",
  "reportedrate": "number",
  "reportedrevenue": "number",
  "subtotal": "number",
  "amount": "number",
  "revenuebase": "number",
  "revenuenet": "number",
  "revenuenottaxable": "number",
  "tax": "number",
  "taxontax": "number",
  "unitbase": "number",
  "seq": "string",
  "startdate": "string",
  "taxtypeid": "string",
  "totalamount": "number"
}

An array of TaxTypeAccount Ids

default

Unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a TaxTypeAccount

PATCH /taxtypeaccounts/{taxtypeaccountId}

Update a TaxTypeAccount

undefined

taxtypeaccountId: string
in path

The Taxnexus Record Id of the Tax Type Account to be retrieved

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "accountid": "string",
  "accountnumber": "string",
  "active": "boolean",
  "contactid": "string",
  "description": "string",
  "enddate": "string",
  "interest": "number",
  "notes": "string",
  "penalty": "number",
  "reportedadjustments": "number",
  "reporteddeductions": "number",
  "reportednetrevenue": "number",
  "reportedrate": "number",
  "reportedrevenue": "number",
  "subtotal": "number",
  "amount": "number",
  "revenuebase": "number",
  "revenuenet": "number",
  "revenuenottaxable": "number",
  "tax": "number",
  "taxontax": "number",
  "unitbase": "number",
  "seq": "string",
  "startdate": "string",
  "taxtypeid": "string",
  "totalamount": "number"
}

An array of TaxTypeAccount Ids

default

Unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete Tax Type Account

DELETE /taxtypeaccounts/{taxtypeaccountId}

Delete a single Tax Type Account specified by taxtypeaccountId

taxtypeaccountId: string
in path

The Taxnexus Record Id of the Tax Type Account to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "accountid": "string",
      "accountnumber": "string",
      "active": "boolean",
      "contactid": "string",
      "description": "string",
      "enddate": "string",
      "interest": "number",
      "notes": "string",
      "penalty": "number",
      "reportedadjustments": "number",
      "reporteddeductions": "number",
      "reportednetrevenue": "number",
      "reportedrate": "number",
      "reportedrevenue": "number",
      "subtotal": "number",
      "amount": "number",
      "revenuebase": "number",
      "revenuenet": "number",
      "revenuenottaxable": "number",
      "tax": "number",
      "taxontax": "number",
      "unitbase": "number",
      "seq": "string",
      "startdate": "string",
      "taxtypeid": "string",
      "totalamount": "number"
    }
  ]
}
Response Example (default )
{
  "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)
in query

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

domain: string
in query

Filter domain results by general domain type, cannabis, telecom, combo or sales

offset: integer (int32)
in query

The number of records to skip (default 0)

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a Domain record

GET /domains/{domainId}

Return a single Domain record

domainId: string
in path

The Taxnexus Id of the Domain record to be retrieved

Expected response to a valid request

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "description": "string",
      "domain_name": "string",
      "isbusiness": "boolean",
      "iscannabis": "boolean",
      "isexcise": "boolean",
      "issales": "boolean",
      "istelecom": "boolean",
      "picklistvalue": "string"
    }
  ]
}

Update a Domain record

PUT /domains/{domainId}

Return a single Domain record

domainId: string
in path

The Taxnexus Id of the Domain record to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Documents

Get a list of documents

GET /documents

Get a list of documents

limit: integer (int32)
in query

How many items to return at one time (max 100)

200 OK

An array of documents

type
201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Process one or more attachments into a new attachment

POST /documents

Concatenate PDFs into a new attachment

An array of existing Taxnexus Record IDs and the new PDF and HTML documents

Request Example
{
  "operationid": "string",
  "targetobjectid": "string",
  "filename": "string",
  "theIds": [
    "string"
  ]
}

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "meta": {
      "boolean  Boolean  test_only": "boolean",
      "object  Coordinate  coordinates": {
        "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"
      },
      "object  Pagination  pagination": {
        "p_offset": "integer (int32)",
        "p_limit": "integer (int32)",
        "page_size": "integer (int32)",
        "set_size": "integer (int32)",
        "next_link": "string"
      },
      "object  RatingIngest  ratingingest": {
        "id": "string",
        "account": "string",
        "date": "string",
        "filename": "string",
        "period": "string",
        "ratingengine": "string",
        "seq": "string",
        "status": "string"
      },
      "string  String  acount_number": "string",
      "string  String  api_info": "string",
      "string  String  api_response_time": "string",
      "string  String  api_timestamp": "string",
      "string  String  api_uid": "string",
      "string  String  contact": "string",
      "string  String  copyright": "string",
      "string  String  info": "string",
      "string  String  license": "string",
      "string  String  operation_id": "string",
      "string  String  org_id": "string",
      "string  String  request_ip": "string",
      "string  String  request_type": "string",
      "string  String  request_url": "string",
      "string  String  server_info": "string",
      "string  String  server_response_time": "string",
      "string  String  server_timestamp": "string",
      "string  String  situs_focus": "string",
      "string  String  user_id": "string",
      "string  String  user_name": "string"
    },
    "data": [
      {
        "id": "string",
        "domain": "object",
        "firestore": "string",
        "code": "string",
        "description": "string",
        "level": "string",
        "seq": "string",
        "part1": "string",
        "part2": "string",
        "part3": "string",
        "part4": "string",
        "suretaxcode": "string"
      }
    ]
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a single document

GET /documents/{documentId}

Get a single document

documentId: string
in path

The Taxnexus Id of the Document record to be retrieved

200 OK

An array of documents

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a single document

DELETE /documents/{documentId}

Delete a single document

documentId: string
in path

The Taxnexus Id of the Document record to be retrieved

200 OK

An array of documents

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Accounts

POST /documents/accounts

Generate PDFs from a list of Accounts

Ids

An array of existing Taxnexus Account IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Places

POST /documents/places

Generate PDFs from a list of Places

Ids

An array of existing Taxnexus Place IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Counties

POST /documents/counties

Generate PDFs from a list of Counties

Ids

An array of existing Taxnexus County IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of States

POST /documents/states

Generate PDFs from a list of Invoices

Ids

An array of existing Taxnexus State IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Countries

POST /documents/countries

Generate PDFs from a list of Countries

Ids

An array of existing Taxnexus Country IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list Invoices

POST /documents/invoices

Generate PDFs from a list of Invoices

Ids

An array of existing Taxnexus Invoice IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Statements

POST /documents/statements

Generate PDFs from a list of Statements

Ids

An array of existing Taxnexus Statement IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of TaxTypes

POST /documents/taxtypes

Generate PDFs from a list of TaxTypes

Ids

An array of existing Taxnexus TaxType IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Authroities

POST /documents/authorities

Generate PDFs from a list of Authroities

Ids

An array of existing Taxnexus Authority IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Filings

POST /documents/filings

Generate PDFs from a list of Filings

Ids

An array of existing Taxnexus Filing IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Generate PDFs from a list of Submissions

POST /documents/submissions

Generate PDFs from a list of Submissions

Ids

An array of existing Taxnexus Submission IDs

Request Example
[
  "string"
]

An array of the original record Ids and the new Attachment Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
[
  {
    "theId": "string",
    "htmlId": "string",
    "pdfId": "string"
  }
]
Response Example (default )
{
  "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)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

accountId: string
in query

The Taxnexus Account ID

companyId: string
in query

The Taxnexus Company Id (almost always Taxnexus)

An array of Filings

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "notes": "string",
      "protocolid": "string",
      "protocolname": "string",
      "status": "string",
      "contactid": "string",
      "submissiondate": "string",
      "submissionnumber": "string",
      "filings": [
        {
          "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Filings

POST /filings

Create new Filings

undefined

Request Content-Types: application/json
Request Example
{
  "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"
}

An array of Filing Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a single Filing

GET /filings/{filingId}

Return a single Filing specified by filingId

filingId: string
in path

The Taxnexus Record Id of the Filing to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "notes": "string",
      "protocolid": "string",
      "protocolname": "string",
      "status": "string",
      "contactid": "string",
      "submissiondate": "string",
      "submissionnumber": "string",
      "filings": [
        {
          "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a Filing

PUT /filings/{filingId}

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

undefined

filingId: string
in path

The Taxnexus Record Id of the Filing to be retrieved

Request Content-Types: application/json
Request Example
{
  "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"
}

Expected response to a valid request

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a single field in a Filing

PATCH /filings/{filingId}

Update a single Filing field, useful for firing triggers

undefined

filingId: string
in path

The Taxnexus Record Id of the Filing to be updated

Request Example
{
  "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"
}

Expected response to a valid request

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a Filing

DELETE /filings/{filingId}

Delete a Filing

undefined

filingId: string
in path

The Taxnexus Record Id of the Filing to be updated

Request Example
{
  "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"
}

Expected response to a valid request

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Licenses

Retrieve licenses

GET /licenses

Retrieve all licenses, filter with parameters

limit: integer (int32)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

domain: string
in query

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

address: string
in query

Postal Address URL encoded; partial addresses allowed

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

country: string
in query

The Country abbreviation (2 char)

accountId: string
in query

The Taxnexus Account ID to be used in Situs determination

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {}
            }
          }
        }
      }
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Create new Licenses

POST /licenses

Create new Licenses

The new licenses

Request Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Retrieve a license

GET /licenses/{licenseId}

Retrieve all licenses, filter with parameters

licenseId: string
in path

The Taxnexus Id of the License

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {}
            }
          }
        }
      }
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Upsert a License

PUT /licenses/{licenseId}

Add or update licenses

The new licenses

licenseId: string
in path

The Taxnexus Id of the License

Request Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
200 OK

Expected response to a valid request

default

unexpected error

Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Patch License

PATCH /licenses/{licenseId}

Patch a license

The licenses licenses

licenseId: string
in path

The Taxnexus Id of the License

Request Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {}
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
200 OK

Expected response to a valid request

default

unexpected error

Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a license

DELETE /licenses/{licenseId}

Retrieve all licenses, filter with parameters

licenseId: string
in path

The Taxnexus Id of the License

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {}
            }
          }
        }
      }
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

LicenseTypes

Retrieve LicenseType records

GET /licensetypes

Retrieve LicenseType records

limit: integer (int32)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

domain: string
in query

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

address: string
in query

Postal Address URL encoded; partial addresses allowed

place: string
in query

The City name (must be accompanied by State)

state: string
in query

The State or Province abbreviation (2 char)

country: string
in query

The Country abbreviation (2 char)

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {}
            }
          }
        }
      }
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a LicenseType record

GET /licensetypes/{licenseTypeId}

Return a single License Type record

licenseTypeId: string
in path

The Taxnexus Id of the License Type record to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {}
            }
          }
        }
      }
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a License Type record

PUT /licensetypes/{licenseTypeId}

Return a single License Type record

licenseTypeId: string
in path

The Taxnexus Id of the License Type record to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Submissions

Get a list of Submissions

GET /submissions

Return a list of available Submissions

limit: integer (int32)
in query

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

offset: integer (int32)
in query

The number of records to skip (default 0)

accountId: string
in query

The Taxnexus Account ID

companyId: string
in query

The Taxnexus Company Id (almost always Taxnexus)

An array of Submissions

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "notes": "string",
      "protocolid": "string",
      "protocolname": "string",
      "status": "string",
      "contactid": "string",
      "submissiondate": "string",
      "submissionnumber": "string",
      "filings": [
        {
          "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Add new Submissions

POST /submissions

Create new Sumissions

undefined

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "notes": "string",
  "protocolid": "string",
  "protocolname": "string",
  "status": "string",
  "contactid": "string",
  "submissiondate": "string",
  "submissionnumber": "string",
  "filings": [
    {
      "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"
    }
  ]
}

An array of Submissions Ids

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Get a single Submission

GET /submissions/{submissionId}

Return a single Submission specified by submissionId

submissionId: string
in path

The Taxnexus Record Id of the Submission to be retrieved

Expected response to a valid request

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "notes": "string",
      "protocolid": "string",
      "protocolname": "string",
      "status": "string",
      "contactid": "string",
      "submissiondate": "string",
      "submissionnumber": "string",
      "filings": [
        {
          "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 (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a Submission

PUT /submissions/{submissionId}

Update all the fields in a Submission record identified by Taxnexus Id

undefined

submissionId: string
in path

The Taxnexus Record Id of the Submission to be retrieved

Request Content-Types: application/json
Request Example
{
  "id": "string",
  "notes": "string",
  "protocolid": "string",
  "protocolname": "string",
  "status": "string",
  "contactid": "string",
  "submissiondate": "string",
  "submissionnumber": "string",
  "filings": [
    {
      "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"
    }
  ]
}

Expected response to a valid request

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Update a single field in a Submission

PATCH /submissions/{submissionId}

Update a single Submission field, useful for firing triggers

undefined

submissionId: string
in path

The Taxnexus Record Id of the Submission to be updated

Request Example
{
  "id": "string",
  "notes": "string",
  "protocolid": "string",
  "protocolname": "string",
  "status": "string",
  "contactid": "string",
  "submissiondate": "string",
  "submissionnumber": "string",
  "filings": [
    {
      "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"
    }
  ]
}

Expected response to a valid request

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Delete a Submission

DELETE /submissions/{submissionId}

Delete a Submission

undefined

submissionId: string
in path

The Taxnexus Record Id of the Submission to be updated

Request Example
{
  "id": "string",
  "notes": "string",
  "protocolid": "string",
  "protocolname": "string",
  "status": "string",
  "contactid": "string",
  "submissiondate": "string",
  "submissionnumber": "string",
  "filings": [
    {
      "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"
    }
  ]
}

Expected response to a valid request

201 Created

Null response

default

unexpected error

Response Example (200 OK)
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Schema Definitions

AccountBasic: object

name: string

Account Name

accountnumber: string

Account Number

phone: string

Phone number

type: string

Account Type

website: string

Account Website

billingaddress: Address
billingcontact: ContactBasic
shippingaddress: Address
shippingcontact: ContactBasic
Example
{
  "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",
    "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",
        "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",
            "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",
                "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",
                    "account": {
                      "name": "string",
                      "accountnumber": "string",
                      "phone": "string",
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

AccountBasicResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "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",
        "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",
            "account": {
              "name": "string",
              "accountnumber": "string",
              "phone": "string",
              "type": "string"
            }
          }
        }
      }
    }
  ]
}

Address: object

city: string

City

country: string

Country full name

countryCode: string

Country Code

postalCode: string

Postal Code

state: string

State full name

stateCode: string

State Code

street: string

Street number and name

Example
{
  "city": "string",
  "country": "string",
  "countryCode": "string",
  "postalCode": "string",
  "state": "string",
  "stateCode": "string",
  "street": "string"
}

Company: object

id: string

Taxnexus Record Id

account: AccountBasic
billingcontact: ContactBasic
usertechlead: ContactBasic
accountnumberprefix: string

Account Number Prefix

advanceperiod: string

Advance Period

billingadvice: string

Billing Advice

billingemail: string

Billing Email

billingphone: string

Billing Phone

billingwebsite: string

Billing Website

closedperiod: string

Closed Period

coloraccent1: string

Color Accent1

coloraccent2: string

Color Accent2

colorprimary: string

Color Primary

currentperiod: string

Current Period

currentperiodstatus: string

Current Period Status

dateclosed: string

Date Closed

defaultcompany: boolean

Default Company?

fontbody: string

Font Name for Body Text

fontheading: string

Font Name for Heading

fontheadingnarrow: string

Font Name for Heading Narrow

fontlink: string

Font Names for CSS Link

fontmono: string

Font Name for Monospace

international: boolean

International Customers?

lastaccountnumber: number

Last Account Number

logo: string

Logo URL

name: string

Company Name

Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {
                        "name": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

ContactBasic: object

id: string

Taxnexus Record Id

account: AccountBasic
email: string

Email

mailingaddress: Address
mobilephone: string

Mobile

name: string

Name

Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {
                        "name": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Coordinate: object

latitude: number

The Latitude of the coordinates

longitude: number

The Longitude of the coordinates

formatted_address: string

The geocoded full address string of the coordinates

place_id: string

Google Place Id

place: string

The Place (city, town, village) of the coordinates

neighborhood: string

The neighborhood (if any) of the coordinates

county: string

The county of the coordinates

state: string

The State of the coordinates

country: string

The Country of the coordinates

street_number: string

The Street Number of the coordinates

street: string

The Street name of the coordinates

postal_code: string

The Postal Code of the coordinates

Example
{
  "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"
}

Document: object

Modeled after the Taxnexus ContentVersion object

Checksum: string

MD5 checksum for the file.

ContentBodyId: string

Allows inserting a file version independently

ContentDocumentId: string

ID of the document.

ContentLocation: string

Origin of the document. Valid values are

ContentModifiedById: string

ID of the user who modified the document

ContentModifiedDate: string

Date the document was modified

ContentSize: number

Size of the document in bytes. Always zero for links.

ContentUrl: string

URL for links. was 255.

Description: string

Description of the content version

Division: string

A logical segment of your organization's data.

ExternalDataSourceId: string

ID of the external document referenced in the ExternalDataSource object

ExternalDocumentInfo1: string

Stores the URL of the file in the external content repository.

ExternalDocumentInfo2: string

Contains the external file ID.

FeaturedContentBoost: number

Read only. Designates a document as featured

FeaturedContentDate: string

Date the document was featured

FileExtension: string

File extension of the document

FileType: string

Type of content determined by ContentUrl

FirstPublishLocationId: string

ID of the location where the version was first published.

IsAssetEnabled: boolean

none

IsEncrypted: boolean

Indicates whether files are encrypted

IsLatest: boolean

Indicates whether this is the latest version of the document

IsMajorVersion: boolean

true if the document is a major version;

Language: string

The language for this document.

NegativeRatingCount: number

Read only.

NetworkId: string

ID of the community that this file originated from.

Origin: string

The source of the content version. Valid values are

OwnerId: string

ID of the owner of this document.

PathOnClient: string

The complete path of the document.

PositiveRatingCount: number

Read only.

PublishStatus: string

Indicates if and how the document is published. Valid values

RatingCount: string

Read only. Total number of positive and negative ratings.

ReasonForChange: string

The reason why the document was changed.

RecordTypeId: string

ID of the record type of the version.

SharingOption: string

Controls whether sharing is frozen for a file.

SharingPrivacy: string

Controls sharing privacy for a file.

TagCsv: string

Text used to apply tags to a content version via the API.

TextPreview: string

A preview of a document. Available in API version 35.0 and later.

Title: string

The title of a document.

VersionData: string

Encoded file data.

Example
{
  "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"
}

DocumentRendering: object

theId: string

The Taxnexus Id of the document record that was rendered

htmlId: string

The Taxnexus Id of the HTML document rendered

pdfId: string

The Taxnexus Id of the PDF document rendered

Example
{
  "theId": "string",
  "htmlId": "string",
  "pdfId": "string"
}

DocumentRenderingResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "domain": "object",
      "firestore": "string",
      "code": "string",
      "description": "string",
      "level": "string",
      "seq": "string",
      "part1": "string",
      "part2": "string",
      "part3": "string",
      "part4": "string",
      "suretaxcode": "string"
    }
  ]
}

DocumentsProcess: object

Post a list of existing PDFs and concatenate them into a new attachment

operationid: string

Type of operation, currently only 'pdf-concatenate'

targetobjectid: string

The Taxnexus record Id of the target object

filename: string

Target filename

theIds: string[]

Taxnexus Record Ids that have PDF attachments to be merged

string
Example
{
  "operationid": "string",
  "targetobjectid": "string",
  "filename": "string",
  "theIds": [
    "string"
  ]
}

Domain: object

id: string

Taxnexus Record Id

description: string

Description

domain_name: string

Domain Name

isbusiness: boolean

Is Business Tax?

iscannabis: boolean

Is Cannabis Tax?

isexcise: boolean

Is Excise Tax?

issales: boolean

Is Sales Tax?

istelecom: boolean

Is Telecom Tax?

picklistvalue: string

Picklist Value

Example
{
  "id": "string",
  "description": "string",
  "domain_name": "string",
  "isbusiness": "boolean",
  "iscannabis": "boolean",
  "isexcise": "boolean",
  "issales": "boolean",
  "istelecom": "boolean",
  "picklistvalue": "string"
}

DomainResponse: object

meta: ResponseMeta
data: Domain
Domain
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "description": "string",
      "domain_name": "string",
      "isbusiness": "boolean",
      "iscannabis": "boolean",
      "isexcise": "boolean",
      "issales": "boolean",
      "istelecom": "boolean",
      "picklistvalue": "string"
    }
  ]
}

DomainPostResponse: object

meta: ResponseMeta
data: Domain
Domain
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "description": "string",
      "domain_name": "string",
      "isbusiness": "boolean",
      "iscannabis": "boolean",
      "isexcise": "boolean",
      "issales": "boolean",
      "istelecom": "boolean",
      "picklistvalue": "string"
    }
  ]
}

Error: object

code: integer (int32)
message: string
fields: string
Example
{
  "code": "integer (int32)",
  "message": "string",
  "fields": "string"
}

Filing: object

id: string

Record Id

accountname: string

Account Name

amount: number

Amount

billingcontactid: string

Billing Contact

date: string

Filing Date

filingpenalty: number

Filing Penalty

interest: number

Interest

penalty: number

Penalty

periodid: string

Period

protocolaccountid: string

Protocol Account

protocolname: string

Protocol Name

reportedadjustments: number

Reported Adjustments

reporteddeductions: number

Reported Deductions

reportednetrevenue: number

Reported Net Revenue

reportedrate: number

Reported Rate

reportedrevenue: number

Reported Revenue

subtotal: number

Reported Tax

revenuebase: number

Revenue Base

revenuenet: number

Revenue Net

revenuenottaxable: number

Revenue Not Taxable

seq: string

Seq

status: string

Status

tax: number

Tax

taxontax: number

Tax On Tax

totalamount: number

Total Amount

unitbase: number

Unit Base

Example
{
  "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"
}

FilingPostResponse: object

meta: ResponseMeta
data: Ids

Taxnexus TaxTypeAccount Record Ids

Ids
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}

FilingResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "notes": "string",
      "protocolid": "string",
      "protocolname": "string",
      "status": "string",
      "contactid": "string",
      "submissiondate": "string",
      "submissionnumber": "string",
      "filings": [
        {
          "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"
        }
      ]
    }
  ]
}

Id: object

theId: string

Arrray of Taxnexus Ids

Example
{
  "theId": "string"
}

Ids: array

Taxnexus Record Ids

string
Example
[
  "string"
]

InvoiceBasic: object

id: string

Invoice Id

invoiceitems: InvoiceitemBasic
accountid: string

Account

amountdue: number

Amount Due

businessaddress: string

Business Address for Tax Rating

amount: number

Invoice Amount

invoicedate: string

Invoice Date

status: string

Status

subtotal: number

Subtotal

type: string

Type

Example
{
  "id": "string",
  "invoiceitems": {
    "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",
  "status": "string",
  "subtotal": "number",
  "type": "string"
}

InvoiceBasicResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "invoiceitems": {
        "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",
      "status": "string",
      "subtotal": "number",
      "type": "string"
    }
  ]
}

InvoiceitemBasic: object

id: string

Taxnexus Record Id

invoiceid: string

Invoice

quantity: number

Quantity

shippinghandling: number

Shipping & Handling

subtotal: number

Subtotal

unitprice: number

Unit Price

description: string

Line Item Description

taxnexuscode: string

Taxnexus Code

domain: string

Taxnexus Domain

productcode: string

Product Code

Example
{
  "id": "string",
  "invoiceid": "string",
  "quantity": "number",
  "shippinghandling": "number",
  "subtotal": "number",
  "unitprice": "number",
  "description": "string",
  "taxnexuscode": "string",
  "domain": "string",
  "productcode": "string"
}

License: object

id: string

Taxnexus Record Id

account: AccountBasic
contact: ContactBasic
licensetype: LicenseType
dateissued: string

Date

expirationdate: string

Expiration Date

iscanceled: boolean

Is Canceled?

isrevoked: boolean

Is Revoked?

name: string

License Number

seq: string

Seq

status: string

Status

statuscalc: string

StatusCalc

Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {
                        "name": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

LicensePostResponse: object

meta: ResponseMeta
data: Ids

Taxnexus License Record Ids

Ids
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}

LicenseResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {
                "name": "string"
              }
            }
          }
        }
      }
    }
  ]
}

LicenseType: object

id: string

Taxnexus Record Id

account: AccountBasic
agent: AccountBasic
contact: ContactBasic
cost: number

Cost

domain: string

Domain

frequency: string

Frequency

level: string

Level

name: string

License Type Name

picklistvalue: string

Picklist Value

restriction: string

Restriction

tier: string

Tier

Example
{
  "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",
      "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",
          "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",
              "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",
                  "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",
                      "account": {
                        "name": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

LicenseTypeResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  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",
          "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",
              "account": {
                "name": "string"
              }
            }
          }
        }
      }
    }
  ]
}

LicenseTypePostResponse: object

meta: ResponseMeta
data: Ids

Taxnexus Record Ids

Ids
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}

Pagination: object

p_offset: integer (int32)
p_limit: integer (int32)
page_size: integer (int32)
set_size: integer (int32)
next_link: string
Example
{
  "p_offset": "integer (int32)",
  "p_limit": "integer (int32)",
  "page_size": "integer (int32)",
  "set_size": "integer (int32)",
  "next_link": "string"
}

RatingIngest: object

id: string

Record Id

account: string

Account

date: string

Date

filename: string

Filename

period: string

Period

ratingengine: string

Rating Engine

seq: string

Seq

status: string

Status

Example
{
  "id": "string",
  "account": "string",
  "date": "string",
  "filename": "string",
  "period": "string",
  "ratingengine": "string",
  "seq": "string",
  "status": "string"
}

ResponseMeta: object

boolean Boolean test_only: boolean

Test Only

object Coordinate coordinates: Coordinate

Coordinate Object

object Pagination pagination: Pagination

Pagination Object

object RatingIngest ratingingest: RatingIngest

Tax Rating Ingest Object

string String acount_number: string

Taxnexus Account Number for recording transactions

string String api_info: string

App Server Information

string String api_response_time: string

App Server Response Time (ms)

string String api_timestamp: string

App Server Timestamp

string String api_uid: string

App Server Transaction Id

string String contact: string

Contact Info

string String copyright: string

Copyright Info

string String info: string

API Information

string String license: string

License Info

string String operation_id: string

Operation ID

string String org_id: string

Salesforce Org Id

string String request_ip: string

Request IP Address

string String request_type: string

Request Type

string String request_url: string

Request URL

string String server_info: string

Backend Server Info

string String server_response_time: string

Backend Server Response Time (ms)

string String server_timestamp: string

Backend Server Timestamp

string String situs_focus: string

Situs Focus Tier

string String user_id: string

Server User Id

string String user_name: string

Server User Name

Example
{
  "boolean  Boolean  test_only": "boolean",
  "object  Coordinate  coordinates": {
    "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"
  },
  "object  Pagination  pagination": {
    "p_offset": "integer (int32)",
    "p_limit": "integer (int32)",
    "page_size": "integer (int32)",
    "set_size": "integer (int32)",
    "next_link": "string"
  },
  "object  RatingIngest  ratingingest": {
    "id": "string",
    "account": "string",
    "date": "string",
    "filename": "string",
    "period": "string",
    "ratingengine": "string",
    "seq": "string",
    "status": "string"
  },
  "string  String  acount_number": "string",
  "string  String  api_info": "string",
  "string  String  api_response_time": "string",
  "string  String  api_timestamp": "string",
  "string  String  api_uid": "string",
  "string  String  contact": "string",
  "string  String  copyright": "string",
  "string  String  info": "string",
  "string  String  license": "string",
  "string  String  operation_id": "string",
  "string  String  org_id": "string",
  "string  String  request_ip": "string",
  "string  String  request_type": "string",
  "string  String  request_url": "string",
  "string  String  server_info": "string",
  "string  String  server_response_time": "string",
  "string  String  server_timestamp": "string",
  "string  String  situs_focus": "string",
  "string  String  user_id": "string",
  "string  String  user_name": "string"
}

Submission: object

id: string

Taxnexus Record Id

notes: string

Cover Letter

protocolid: string

Protocol

protocolname: string

Protocol Name

status: string

Status

contactid: string

Submission Contact

submissiondate: string

Submission Date

submissionnumber: string

Submission Number

filings: Filing
Filing
Example
{
  "id": "string",
  "notes": "string",
  "protocolid": "string",
  "protocolname": "string",
  "status": "string",
  "contactid": "string",
  "submissiondate": "string",
  "submissionnumber": "string",
  "filings": [
    {
      "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"
    }
  ]
}

SubmissionPostResponse: object

meta: ResponseMeta
data: Ids

Taxnexus TaxTypeAccount Record Ids

Ids
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    [
      "string"
    ]
  ]
}

SubmissionResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "notes": "string",
      "protocolid": "string",
      "protocolname": "string",
      "status": "string",
      "contactid": "string",
      "submissiondate": "string",
      "submissionnumber": "string",
      "filings": [
        {
          "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"
        }
      ]
    }
  ]
}

TaxCode: object

id: string

Salesforce Record Id

domain: object

Domain

firestore: string

Firestore corresponding TaxCode record

code: string

Code

description: string

Description

level: string

Level

seq: string

Seq

part1: string

Part 1

part2: string

Part 2

part3: string

Part 3

part4: string

Part 4

suretaxcode: string

Suretax Code

Example
{
  "id": "string",
  "domain": "object",
  "firestore": "string",
  "code": "string",
  "description": "string",
  "level": "string",
  "seq": "string",
  "part1": "string",
  "part2": "string",
  "part3": "string",
  "part4": "string",
  "suretaxcode": "string"
}

TaxCodeResponse: object

Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "id": "string",
      "domain": "object",
      "firestore": "string",
      "code": "string",
      "description": "string",
      "level": "string",
      "seq": "string",
      "part1": "string",
      "part2": "string",
      "part3": "string",
      "part4": "string",
      "suretaxcode": "string"
    }
  ]
}

TaxRateResponse: object

meta: ResponseMeta
data: object[]
object
geocode: string

The Taxnexus Geocode for this location

zip: string

The local postal code for this location

state: string

State full name

state_rate: number

State Sales Tax Rate

county: string

Country full name

county_rate: number

County Sales Tax Rate

city: string

City full name

city_rate: number

City Tax Rate

combined_district_rate: number

Combined District Tax(es) Rate

combined_rate: number

Total Sales Tax Rate (use this one!)

taxtypes: TaxType
TaxType
Example
{
  "meta": {
    "boolean  Boolean  test_only": "boolean",
    "object  Coordinate  coordinates": {
      "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"
    },
    "object  Pagination  pagination": {
      "p_offset": "integer (int32)",
      "p_limit": "integer (int32)",
      "page_size": "integer (int32)",
      "set_size": "integer (int32)",
      "next_link": "string"
    },
    "object  RatingIngest  ratingingest": {
      "id": "string",
      "account": "string",
      "date": "string",
      "filename": "string",
      "period": "string",
      "ratingengine": "string",
      "seq": "string",
      "status": "string"
    },
    "string  String  acount_number": "string",
    "string  String  api_info": "string",
    "string  String  api_response_time": "string",
    "string  String  api_timestamp": "string",
    "string  String  api_uid": "string",
    "string  String  contact": "string",
    "string  String  copyright": "string",
    "string  String  info": "string",
    "string  String  license": "string",
    "string  String  operation_id": "string",
    "string  String  org_id": "string",
    "string  String  request_ip": "string",
    "string  String  request_type": "string",
    "string  String  request_url": "string",
    "string  String  server_info": "string",
    "string  String  server_response_time": "string",
    "string  String  server_timestamp": "string",
    "string  String  situs_focus": "string",
    "string  String  user_id": "string",
    "string  String  user_name": "string"
  },
  "data": [
    {
      "geocode": "string",
      "zip": "string",
      "state": "string",
      "state_rate": "number",
      "county": "string",
      "county_rate": "number",
      "city": "string",
      "city_rate": "number",
      "combined_district_rate": "number",
      "combined_rate": "number",
      "taxtypes": [
        {
          "id": "string",
          "firestore": "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",
                "account": {
                  "name": "string",
                  "accountnumber": "string",
                  "phone": "string",
                  "type": "string"
                }
              }
            }
          }
        }
      ]
    }
  ]
}

TaxTransaction: object

id: string

Taxnexus Record Id

accountid: string

Account

amount: number

Amount

domainid: string

Domain

effectiverate: number

Effective Rate

filingid: string

Filing

generalledgerid: string

General Ledger

invoiceid: string

Invoice

invoiceitemid: string

Invoice Item

issummary: boolean

isSummary

seq: string

Seq

orderid: string

Order

orderitemid: string

Order Product

percenttaxable: number

Percent Taxable

periodid: string

Period

placeid: string

Place

posted: string

Posted

quoteid: string

Quote

quoteitemid: string

Quote Line Item

ratingingestid: string

Rating Ingest

ratingmethod: string

Rating Method

ratingtype: string

Rating Type

revenuebase: number

Revenue Base

revenuenet: number

Revenue Net