crm (1.3.0)

Download OpenAPI specification:Download

Customer Information Microservice

Authentication

ApiKeyAuth

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

Accounts

Delete An Account

Delete Taxnexus Account record

Authorizations:
query Parameters
accountId
string

Taxnexus Record Id of an Account

Responses

Response samples

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

Get a list of accounts

Return a list of all available Accounts

Authorizations:
query Parameters
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?

active
boolean

Only retrieve active records?

accountId
string

Taxnexus Record Id of an Account

email
string

Email address used for identity lookup

Responses

Response samples

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

Add a new account to Taxnexus

Account record to be added

Authorizations:
Request Body schema: application/json

An array of new Account records

Array of objects (Account)

Responses

Request samples

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

Response samples

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

Update a single account

Update a single account specified by accountId

Authorizations:
Request Body schema: application/json

An array of new Account records

Array of objects (Account)

Responses

Request samples

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

Response samples

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

Get Taxnexus Accounts in an observable array

A list of accounts in a simple JSON array

Authorizations:
query Parameters
name
string

The Name of this Object

active
boolean

Only retrieve active records?

accountId
string

Taxnexus Record Id of an Account

email
string

Email address used for identity lookup

Responses

Response samples

Content type
application/json
[
  • {
    }
]

cors

accountOptions

CORS support

Responses

accountOptionsObservable

CORS support

Responses

companyOptions

CORS support

Responses

companyObservableOptions

CORS support

Responses

contactOptions

CORS support

Responses

contactOptionsObservable

CORS support

Responses

leadOptions

CORS support

Responses

leadOptionsObservable

CORS support

Responses

Companies

Get Company records

Retrieve Company records from the datastore

Authorizations:
query Parameters
companyId
string

Taxnexus Company record ID

Responses

Response samples

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

Add new companies

Add new companies

Authorizations:
Request Body schema: application/json

An array of new Contact records

Array of objects (Company)

Responses

Request samples

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

Response samples

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

Get Taxnexus Companies in an observable array

A list of companies in a simple JSON array

Authorizations:
query Parameters
companyId
string

Taxnexus Company record ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Contacts

Delete a Contact

Delete Taxnexus Contact record

Authorizations:
query Parameters
contactId
string

Taxnexus Contact record ID

Responses

Response samples

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

Get a list of contacts

Return a list of all available Contacts

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip?

contactId
string

Taxnexus Contact record ID

active
boolean

Only retrieve active records?

email
string

Email address used for identity lookup

name
string

The Name of this Object

Responses

Response samples

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

Add new contacts

Contact record to be added

Authorizations:
Request Body schema: application/json

An array of new Contact records

Array of objects (Contact)

Responses

Request samples

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

Response samples

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

Update Contact

Update Contact records

Authorizations:
Request Body schema: application/json

An array of new Contact records

Array of objects (Contact)

Responses

Request samples

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

Response samples

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

Get Taxnexus Contacts in an observable array

A list of contacts in a simple JSON array

Authorizations:
query Parameters
contactId
string

Taxnexus Contact record ID

active
boolean

Only retrieve active records?

email
string

Email address used for identity lookup

name
string

The Name of this Object

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Leads

Delete a Contact

Delete Taxnexus Lead record

Authorizations:
query Parameters
leadId
string

Taxnexus Lead record ID

Responses

Response samples

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

Get a list of contacts

Return a list of all available Leads

Authorizations:
query Parameters
limit
integer <int64>

How many objects to return at one time

offset
integer <int64>

How many objects to skip?

leadId
string

Taxnexus Lead record ID

email
string

Email address used for identity lookup

name
string

The Name of this Object

Responses

Response samples

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

Add new Leads

Lead records to be added

Authorizations:
Request Body schema: application/json

An array of new Lead records

Array of objects (Lead)

Responses

Request samples

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

Response samples

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

Update Leads

Update Lead records

Authorizations:
Request Body schema: application/json

An array of new Lead records

Array of objects (Lead)

Responses

Request samples

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

Response samples

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

Get Taxnexus Leads in an observable array

A list of leads in a simple JSON array

Authorizations:
query Parameters
leadId
string

Taxnexus Lead record ID

email
string

Email address used for identity lookup

name
string

The Name of this Object

Responses

Response samples

Content type
application/json
[
  • {
    }
]