board (1.3.0)

Download OpenAPI specification:Download

Taxnexus Onboarding Service

Authentication

ApiKeyAuth

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

cors

developerOptions

CORS support

Responses

iqOptions

CORS support

Responses

leadsOptions

CORS support

Responses

userAuthOptions

CORS support

Responses

userOptions

CORS support

Responses

Developers

Onboard new developer

Register new developers with POST

Authorizations:
Request Body schema: application/json

A single Developer struct for onboarding

object (Account)
object (Contact)
object (PaymentMethod)

Describes the EFT or other payment information for an account and billing contact

Responses

Request samples

Content type
application/json
{
  • "Account": {
    },
  • "Contact": {
    },
  • "PaymentMethod": {
    }
}

Response samples

Content type
application/json
{
  • "SagaID": "string",
  • "SagaType": "string",
  • "RuleID": "string",
  • "RunID": "string"
}

Iq

Onboard new new Taxnexus IQ Customer

Register new Taxnexus IQ Customer with POST

Authorizations:
Request Body schema: application/json

A single Taxnexus IQ Customer struct for onboarding

object (Account)
object (Contact)
object (Lead)
object (PaymentMethod)

Describes the EFT or other payment information for an account and billing contact

object (Tenant)

Taxnexus Account Tenant

object (User)

Responses

Request samples

Content type
application/json
{
  • "Account": {
    },
  • "Contact": {
    },
  • "Lead": {
    },
  • "PaymentMethod": {
    },
  • "Tenant": {
    },
  • "User": {
    }
}

Response samples

Content type
application/json
{
  • "SagaID": "string",
  • "SagaType": "string",
  • "RuleID": "string",
  • "RunID": "string"
}

Leads

Add a new Lead record

Add a new full Lead Record

Authorizations:
Request Body schema: application/json

A new Lead record as a single JSON object

object (Address)
Company
string

Company

Description
string

Description

Email
string

Email

FirstName
string

First Name

ID
string

Taxnexus Record Id

LastName
string

Last Name

MobilePhone
string

Mobile

Name
string

Name

OwnerId
string

LeadBasic Owner

PartnerAccountId
string

Partner Account

Phone
string

Phone

ProductID
string

Product

RefererURL
string

referer_url

Status
string

LeadBasic Status

Title
string

Title

Type
string

Type

UTMCampaign
string

utm_campaign

UTMContent
string

utm_content

UTMMedium
string

utm_medium

UTMSource
string

utm_source

UTMTerm
string

utm_term

Website
string

Website

Responses

Request samples

Content type
application/json
{
  • "Address": {
    },
  • "Company": "string",
  • "Description": "string",
  • "Email": "string",
  • "FirstName": "string",
  • "ID": "string",
  • "LastName": "string",
  • "MobilePhone": "string",
  • "Name": "string",
  • "OwnerId": "string",
  • "PartnerAccountId": "string",
  • "Phone": "string",
  • "ProductID": "string",
  • "RefererURL": "string",
  • "Status": "string",
  • "Title": "string",
  • "Type": "string",
  • "UTMCampaign": "string",
  • "UTMContent": "string",
  • "UTMMedium": "string",
  • "UTMSource": "string",
  • "UTMTerm": "string",
  • "Website": "string"
}

Response samples

Content type
application/json
{
  • "SagaID": "string",
  • "SagaType": "string",
  • "RuleID": "string",
  • "RunID": "string"
}

Update Leads

Update Lead records

Authorizations:
Request Body schema: application/json

A new Lead record as a single JSON object

object (Address)
Company
string

Company

Description
string

Description

Email
string

Email

FirstName
string

First Name

ID
string

Taxnexus Record Id

LastName
string

Last Name

MobilePhone
string

Mobile

Name
string

Name

OwnerId
string

LeadBasic Owner

PartnerAccountId
string

Partner Account

Phone
string

Phone

ProductID
string

Product

RefererURL
string

referer_url

Status
string

LeadBasic Status

Title
string

Title

Type
string

Type

UTMCampaign
string

utm_campaign

UTMContent
string

utm_content

UTMMedium
string

utm_medium

UTMSource
string

utm_source

UTMTerm
string

utm_term

Website
string

Website

Responses

Request samples

Content type
application/json
{
  • "Address": {
    },
  • "Company": "string",
  • "Description": "string",
  • "Email": "string",
  • "FirstName": "string",
  • "ID": "string",
  • "LastName": "string",
  • "MobilePhone": "string",
  • "Name": "string",
  • "OwnerId": "string",
  • "PartnerAccountId": "string",
  • "Phone": "string",
  • "ProductID": "string",
  • "RefererURL": "string",
  • "Status": "string",
  • "Title": "string",
  • "Type": "string",
  • "UTMCampaign": "string",
  • "UTMContent": "string",
  • "UTMMedium": "string",
  • "UTMSource": "string",
  • "UTMTerm": "string",
  • "Website": "string"
}

Response samples

Content type
application/json
{
  • "SagaID": "string",
  • "SagaType": "string",
  • "RuleID": "string",
  • "RunID": "string"
}

UserAuth

Get a single UserAuth object

Return a single UserAuth object from datastore as a Singleton

Authorizations:
path Parameters
usernamePath
required
string

Username in the query path

Responses

Response samples

Content type
application/json
{
  • "APIKey": "string",
  • "AccountID": "string",
  • "ContactID": "string",
  • "Email": "string",
  • "Roles": [
    ],
  • "Tenants": [
    ],
  • "UserID": "string"
}

Users

getUsers

Get a clean user record

Authorizations:
query Parameters
email
required
string

Email address

Responses

Response samples

Content type
application/json
{
  • "APIKey": "string",
  • "AboutMe": "string",
  • "AccountID": "string",
  • "Address": {
    },
  • "Alias": "string",
  • "Auth0UserID": "string",
  • "CommunityNickname": "string",
  • "CompanyName": "string",
  • "ContactID": "string",
  • "CreatedByID": "string",
  • "CreatedDate": "string",
  • "DelegatedApproverID": "string",
  • "Department": "string",
  • "Division": "string",
  • "Email": "string",
  • "EmployeeNumber": "string",
  • "EndOfDay": "string",
  • "Environment": "string",
  • "Extension": "string",
  • "FabricAPIKey": "string",
  • "Fax": "string",
  • "FirstName": "string",
  • "ForecastEnabled": true,
  • "FullPhotoURL": "string",
  • "ID": "string",
  • "IsActive": true,
  • "IsPortalEnabled": true,
  • "IsProphilePhotoActive": true,
  • "IsSystemControlled": true,
  • "LastIP": "string",
  • "LastLogin": "string",
  • "LastModifiedByID": "string",
  • "LastModifiedDate": "string",
  • "LastName": "string",
  • "LoginCount": 0,
  • "ManagerID": "string",
  • "MobilePhone": "string",
  • "Name": "string",
  • "OutOfOfficeMessage": "string",
  • "Phone": "string",
  • "PortalRole": "string",
  • "ProfileID": "string",
  • "ReceivesAdminEmails": true,
  • "ReceivesAdminInfoEmails": true,
  • "SenderEmail": "string",
  • "SenderName": "string",
  • "Signature": "string",
  • "SmallPhotoURL": "string",
  • "StartOfDay": "string",
  • "TaxnexusAccount": "string",
  • "TenantID": "string",
  • "TenantUsers": [
    ],
  • "TimeZone": "string",
  • "Title": "string",
  • "UserRoleID": "string",
  • "UserRoles": [
    ],
  • "UserType": "string",
  • "Username": "string"
}