regs (1.3.0)

Download OpenAPI specification:Download

Regulatory Microservice

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-API-Key

Authority

Get a list of Authorities

Return a list of available Authorities

Authorizations:
query Parameters
authorityId
string

Taxnexus Id of the Authority to be retrieved

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Add new Authorities

Create new Authorities

Authorizations:
Request Body schema: application/json

A request with an array of Authority Objects

Array of objects (Authority)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Authorities

Update fields in an Authority record identified by Taxnexus Id

Authorizations:
Request Body schema: application/json

A request with an array of Authority Objects

Array of objects (Authority)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

cors

authorityOptions

CORS support

Responses

backendOptions

CORS support

Responses

filingOptions

CORS support

Responses

filingTypeOptions

CORS support

Responses

licenseOptions

CORS support

Responses

licenseTypeOptions

CORS support

Responses

notebookOptions

CORS support

Responses

ratingEngineOptions

CORS support

Responses

submissionOptions

CORS support

Responses

taxTypeAccountOptions

CORS support

Responses

transactionOptions

CORS support

Responses

Backend

Delete a Backend

Delete Taxnexus Backend record

Authorizations:
query Parameters
backendId
string

Taxnexus Id of the Backend to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Backends

Return a list of Backends

Authorizations:
query Parameters
accountId
string

Taxnexus Record Id of an Account

accountNumber
string

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

backendId
string

Taxnexus Id of the Backend to be retrieved

companyId
string

Taxnexus Record Id of a Company

limit
integer <int64>

How many objects to return at one time

name
string

The Name of this Object

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Add new Backends

Contact record to be added

Authorizations:
Request Body schema: application/json

An array of new Backend records

Array of objects (Backend)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Backends

Update Backend records

Authorizations:
Request Body schema: application/json

An array of new Backend records

Array of objects (Backend)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Filing

Get a list of Filings

Return a list of available Regulatory Filings

Authorizations:
query Parameters
filingId
string

Taxnexus Record Id of a Filing

companyId
string

Taxnexus Record Id of a Company

id
string

Taxnexus Id of the record to be retrieved

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Filings

Create new Filings

Authorizations:
Request Body schema: application/json

A request with an array of Filing Objects

Array of objects (Filing)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update a Filing

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

Authorizations:
Request Body schema: application/json

A request with an array of Filing Objects

Array of objects (Filing)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

FilingType

Get a list of FilingTypes

Return a list of available Regulatory FilingTypes

Authorizations:
query Parameters
filingTypeId
string

Taxnexus Record Id of a Filing

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new FilingTypes

Create new FilingTypes

Authorizations:
Request Body schema: application/json

A request with an array of FilingType Objects

Array of objects (FilingType)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update a FilingType

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

Authorizations:
Request Body schema: application/json

A request with an array of FilingType Objects

Array of objects (FilingType)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

License

Retrieve licenses

Retrieve all licenses, filter with parameters

Authorizations:
query Parameters
accountId
string

Taxnexus Record Id of an Account

companyId
string

Taxnexus Record Id of a Company

licenseId
string

Taxnexus Record Id of a License

id
string

Taxnexus Id of the record to be retrieved

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Licenses

Create new Licenses

Authorizations:
Request Body schema: application/json

The new licenses

Array of objects (License)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Upsert a License

Add or update licenses

Authorizations:
Request Body schema: application/json

The updated licenses

Array of objects (License)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

LicenseType

Retrieve LicenseType records

Retrieve LicenseType records

Authorizations:
query Parameters
companyId
string

Taxnexus Record Id of a Company

licensetypeId
string

Taxnexus Record Id of a License Type

id
string

Taxnexus Id of the record to be retrieved

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Licensetypes

Create new LicenseType

Authorizations:
Request Body schema: application/json

The new license types

Array of objects (LicenseType)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Notebook

Get a list of Notebooks

Return a list of Notebook records from the datastore

Authorizations:
query Parameters
notebookId
string

Template ID

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Notebooka

Create Notebooks in Taxnexus

Authorizations:
Request Body schema: application/json

An array of Notebook records

Array of objects (Notebook)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Notebooks

Update Notebooks in Taxnexus

Authorizations:
Request Body schema: application/json

An array of Notebook records

Array of objects (Notebook)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

RatingEngine

Delete a Rating Engine

Delete Taxnexus Backend record

Authorizations:
query Parameters
id
string

Taxnexus Id of the Record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Rating Engines

Return a list of Rating Engines

Authorizations:
query Parameters
accountId
string

Taxnexus Record Id of an Account

accountNumber
string

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

backendId
string

Taxnexus Id of the Backend to be retrieved

companyId
string

Taxnexus Record Id of a Company

id
string

Taxnexus Id of the record to be retrieved

limit
integer <int64>

How many objects to return at one time

name
string

The Name of this Object

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Add Rating Engine

Rating Engine records to be added

Authorizations:
Request Body schema: application/json

An array of new Submission records

Array of objects (RatingEngine)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Rating Engine

Update Rating Engine records

Authorizations:
Request Body schema: application/json

An array of new Submission records

Array of objects (RatingEngine)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Submission

Get a list of Submissions

Return a list of available Submissions

Authorizations:
query Parameters
submissionId
string

Taxnexus Record Id of a Submisssion

companyId
string

Taxnexus Record Id of a Company

id
string

Taxnexus Id of the record to be retrieved

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Add new Submissions

Create new Sumissions

Authorizations:
Request Body schema: application/json

An array of new Submission records

Array of objects (Submission)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update a Submission

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

Authorizations:
Request Body schema: application/json

An array of new Submission records

Array of objects (Submission)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

TaxTypeAccount

Delete a Tax Type Accounts

Delete Taxnexus Tax Type Accounts

Authorizations:
query Parameters
id
string

Taxnexus Id of the Record to be retrieved

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Get a list of Tax Type Accounts

Return a list of Tax Type Accounts

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

accountId
string

Taxnexus Record Id of an Account

taxTypeId
string

Taxnexus Record Id of the Tax Type

taxTypeAccountId
string

Taxnexus Record Id of the Tax Type Account

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Add new Tax Type Accounts

Tax Type Accounts to be added

Authorizations:
Request Body schema: application/json

A request with an array of Tax Type Account Objects

Array of objects (TaxTypeAccount)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Tax Type Accounts

Update Tax Type Accounts records

Authorizations:
Request Body schema: application/json

A request with an array of Tax Type Account Objects

Array of objects (TaxTypeAccount)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Transaction

Get a list of Transactions

Return a list of Transaction records from the datastore

Authorizations:
query Parameters
transactionId
string

Template ID

limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip? (default 0)

Responses

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Create new Transactiona

Create Transactions in Taxnexus

Authorizations:
Request Body schema: application/json

An array of Transaction records

Array of objects (Transaction)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}

Update Transactions

Update Transactions in Taxnexus

Authorizations:
Request Body schema: application/json

An array of Transaction records

Array of objects (Transaction)

Responses

Request samples

Content type
application/json
{
  • "Data": [
    ]
}

Response samples

Content type
application/json
{
  • "Data": [
    ],
  • "Meta": {
    }
}