lib/swagger/external/sf-gate-vernonkeenan.yaml

2412 lines
61 KiB
YAML

swagger: "2.0"
info:
version: 0.2.0
title: "sf-gate"
description: "Customer Information Microservice"
termsOfService: "http://taxnexus.net/terms/"
contact:
email: "noc@taxnexus.net"
license:
name: "Proprietary - Copyright (c) 2018-2021 by Taxnexus, Inc."
securityDefinitions:
ApiKeyAuth:
type: "apiKey"
in: "header"
name: "X-API-Key"
schemes:
- "https"
basePath: "/vk/sf-gate/v1"
host: "gw.tnxs.net"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
accountIdQuery:
description: Taxnexus Record Id of an Account
in: query
name: accountId
required: false
type: string
accountRequest:
description: A request with an array of Account Objects
in: body
name: accountRequest
required: true
schema:
$ref: "#/definitions/AccountRequest"
activeQuery:
description: Only retrieve active records?
in: query
name: active
required: false
type: boolean
apiKeyQuery:
description: Taxnexus Id of the User to be retrieved
in: query
name: apikey
required: false
type: string
assetIdQuery:
description: Taxnexus Record Id of an Asset
in: query
name: assetId
required: false
type: string
assetRequest:
description: An array of new Asset records
in: body
name: assetRequest
required: true
schema:
$ref: "#/definitions/AssetRequest"
clusterIdQuery:
description: Taxnexus Record Id of a Cluster
in: query
name: clusterId
required: false
type: string
clusterRequest:
description: An array of Cluster records
in: body
name: ClusterRequest
required: true
schema:
$ref: "#/definitions/ClusterRequest"
companyProductIdQuery:
description: Taxnexus CompanyProduct record ID
in: query
name: companyProductId
required: false
type: string
contactIdQuery:
description: Taxnexus Record Id of a Contact
in: query
name: contactId
required: false
type: string
contactRequest:
description: An array of new Contact records
in: body
name: contactRequest
required: true
schema:
$ref: "#/definitions/ContactRequest"
companyProductRequest:
description: An array of new Contact records
in: body
name: contactRequest
required: true
schema:
$ref: "#/definitions/CompanyProductRequest"
contractIdQuery:
description: Taxnexus Contact record ID
in: query
name: contractId
required: false
type: string
contractRequest:
description: An array of new Contract records
in: body
name: contractsRequest
required: true
schema:
$ref: "#/definitions/ContractRequest"
databaseRequest:
description: An array of Database records
in: body
name: DatabaseRequest
required: true
schema:
$ref: "#/definitions/DatabaseRequest"
databaseIdQuery:
description: Taxnexus Record Id of a Database
in: query
name: databaseId
required: false
type: string
emailQuery:
description: Email address used for identity lookup
in: query
name: email
required: false
type: string
industryIdQuery:
description: Taxnexus Industry record ID
in: query
name: industryId
required: false
type: string
industryProductIdQuery:
description: Taxnexus IndustryProduct record ID
in: query
name: industryProductId
required: false
type: string
industryRequest:
description: An array of new Industry records
in: body
name: industryRequest
required: true
schema:
$ref: "#/definitions/IndustryRequest"
industryProductRequest:
description: An array of new Industry records
in: body
name: industryRequest
required: true
schema:
$ref: "#/definitions/IndustryProductRequest"
limitQuery:
description: "How many objects to return at one time"
format: int64
in: query
name: limit
required: false
type: integer
nameQuery:
description: The Name of this Object
in: query
name: name
required: false
type: string
offsetQuery:
description: How many objects to skip?
format: int64
in: query
name: offset
required: false
type: integer
roleIdQuery:
description: Taxnexus Id of the Role to be retrieved
in: query
name: roleId
required: false
type: string
templateIdQuery:
description: Taxnexus Record Id of a Template
in: query
name: templateId
required: false
type: string
tenantIdQuery:
description: Taxnexus Record Id of a Tenant
in: query
name: tenantId
required: false
type: string
tenantRequest:
description: An array of Tenant records
in: body
name: CTenantRequest
required: true
schema:
$ref: "#/definitions/TenantRequest"
userIdQuery:
description: Taxnexus Id of the User to be retrieved
in: query
name: userId
required: false
type: string
responses:
AccessForbidden:
description: "Access forbidden, account lacks access"
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
AccountResponse:
description: Taxnexus Response with Account objects with Contacts
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/AccountResponse"
AssetResponse:
description: Taxnexus Response with Asset objects with Contacts
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/AssetResponse"
ClusterResponse:
description: Taxnexus Response with Cluster objects
schema:
$ref: "#/definitions/ClusterResponse"
ContactResponse:
description: Taxnexus Response with Contact objects
schema:
$ref: "#/definitions/ContactResponse"
IndustryResponse:
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
description: Taxnexus Response with Industry objects
schema:
$ref: "#/definitions/IndustryResponse"
IndustryProductResponse:
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
description: Taxnexus Response with Industry objects
schema:
$ref: "#/definitions/IndustryProductResponse"
ContractResponse:
description: Taxnexus Response with an array of Contract objects
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/ContractResponse"
CompanyProductResponse:
description: Taxnexus Response with an array of CompanyProduct objects
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/CompanyProductResponse"
DatabaseResponse:
description: Taxnexus Response with Database objects
schema:
$ref: "#/definitions/DatabaseResponse"
DeleteResponse:
description: Taxnexus Response with Message Objects with Delete Status
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/DeleteResponse"
InvalidDataError:
headers:
Access-Control-Allow-Origin:
type: string
description: Invalid data was sent
schema:
$ref: "#/definitions/InvalidError"
NotFound:
description: Resource was not found
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
RoleResponse:
description: Taxnexus Response with Role objects
schema:
$ref: "#/definitions/RoleResponse"
ServerError:
description: Server Internal Error
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
TemplateResponse:
description: Taxnexus Response with Template objects
schema:
$ref: "#/definitions/TemplateResponse"
TenantResponse:
description: Taxnexus Response with Tenant objects
schema:
$ref: "#/definitions/TenantResponse"
Unauthorized:
description: "Access unauthorized, invalid API-KEY was used"
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
UnprocessableEntity:
description: "Unprocessable Entity, likely a bad parameter"
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
UserResponse:
description: Taxnexus Response with User objects
schema:
$ref: "#/definitions/UserResponse"
paths:
/accounts:
delete:
description: Delete Taxnexus Account record
operationId: deleteAccount
parameters:
- $ref: "#/parameters/accountIdQuery"
responses:
"200":
$ref: "#/responses/DeleteResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Delete An Account
tags:
- Accounts
get:
description: Return a list of all available Accounts
operationId: getAccounts
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/nameQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/accountIdQuery"
- $ref: "#/parameters/emailQuery"
responses:
"200":
$ref: "#/responses/AccountResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of accounts
tags:
- Accounts
post:
description: Account record to be added
operationId: postAccounts
parameters:
- $ref: "#/parameters/accountRequest"
responses:
"200":
$ref: "#/responses/AccountResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new account to Taxnexus
tags:
- Accounts
put:
description: Update a single account specified by accountId
operationId: putAccount
parameters:
- $ref: "#/parameters/accountRequest"
responses:
"200":
$ref: "#/responses/AccountResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update a single account
tags:
- Accounts
/assets:
get:
description: Return a list of all available Assets
operationId: getAssets
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/assetIdQuery"
responses:
"200":
$ref: "#/responses/AssetResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of assets
tags:
- Assets
post:
description: Industry record to be added
operationId: postAssets
parameters:
- $ref: "#/parameters/assetRequest"
responses:
"200":
$ref: "#/responses/AssetResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new asset to Taxnexus
tags:
- Assets
/clusters:
get:
description: Return a list of Cluster records from the datastore
operationId: getClusters
parameters:
- $ref: "#/parameters/clusterIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
$ref: "#/responses/ClusterResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list Clusters
tags:
- Clusters
post:
description: Create Clusters in Taxnexus
operationId: postClusters
parameters:
- $ref: "#/parameters/clusterRequest"
responses:
"200":
$ref: "#/responses/ClusterResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Create new Clusters
tags:
- Clusters
put:
description: Update Cluster in Taxnexus
operationId: putClusters
parameters:
- $ref: "#/parameters/clusterRequest"
responses:
"200":
$ref: "#/responses/ClusterResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Update Clusters
tags:
- Clusters
/companyproducts:
get:
description: Return a list of all available CompanyProducts
operationId: getCompanyProducts
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/companyProductIdQuery"
responses:
"200":
$ref: "#/responses/CompanyProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of companyproducts
tags:
- CompanyProducts
post:
description: Industry record to be added
operationId: postCompanyProducts
parameters:
- $ref: "#/parameters/companyProductRequest"
responses:
"200":
$ref: "#/responses/CompanyProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new companyproduct to Taxnexus
tags:
- CompanyProducts
/contacts:
get:
description: Retrieve Contact records from the datastore
operationId: getContacts
parameters:
- $ref: "#/parameters/contactIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/nameQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/accountIdQuery"
- $ref: "#/parameters/emailQuery"
responses:
"200":
$ref: "#/responses/ContactResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a Contact record
tags:
- Contacts
post:
description: Contacts record to be added
operationId: postContacts
parameters:
- $ref: "#/parameters/contactRequest"
responses:
"200":
$ref: "#/responses/ContactResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new Contacts to Taxnexus
tags:
- Contacts
/contracts:
get:
description: Return a list of all available Contracts
operationId: getContracts
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/contractIdQuery"
responses:
"200":
$ref: "#/responses/ContractResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of contracts
tags:
- Contracts
post:
description: Contract record to be added
operationId: postContracts
parameters:
- $ref: "#/parameters/contractRequest"
responses:
"200":
$ref: "#/responses/ContractResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new contract to Taxnexus
tags:
- Contracts
/industryproducts:
get:
description: Return a list of all available IndustryProducts
operationId: getIndustryProducts
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/industryProductIdQuery"
responses:
"200":
$ref: "#/responses/IndustryProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of industryproducts
tags:
- Industryproducts
post:
description: Industry record to be added
operationId: postIndustryproducts
parameters:
- $ref: "#/parameters/industryProductRequest"
responses:
"200":
$ref: "#/responses/IndustryProductResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new industryproduct to Taxnexus
tags:
- IndustryProducts
/industries:
get:
description: Return a list of all available Industries
operationId: getIndustries
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/industryIdQuery"
responses:
"200":
$ref: "#/responses/IndustryResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Get a list of industries
tags:
- Industries
post:
description: Industry record to be added
operationId: postIndustries
parameters:
- $ref: "#/parameters/industryRequest"
responses:
"200":
$ref: "#/responses/IndustryResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
summary: Add a new industry to Taxnexus
tags:
- Industries
/roles:
get:
description: Return a list of Roles
operationId: getRoles
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/roleIdQuery"
responses:
"200":
$ref: "#/responses/RoleResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Get a list of Roles
security:
- ApiKeyAuth: []
tags:
- Roles
/templates:
get:
description:
"Returns the PDF rendering template, or a link to where to get
the template"
operationId: getTemplates
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/templateIdQuery"
responses:
"200":
$ref: "#/responses/TemplateResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Get PDF Rendering Templates
security:
- ApiKeyAuth: []
tags:
- Templates
/tenants:
get:
description: Return a list of Tenant records from the datastore
operationId: getTenants
parameters:
- $ref: "#/parameters/tenantIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
$ref: "#/responses/TenantResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Get a list Tenants
security:
- ApiKeyAuth: []
tags:
- Tenants
post:
description: Create Tenants in Taxnexus
operationId: Tenants
parameters:
- $ref: "#/parameters/tenantRequest"
responses:
"200":
$ref: "#/responses/TenantResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Create new Tenants
tags:
- Tenants
put:
description: Update Tenant in Taxnexus
operationId: putTenants
parameters:
- $ref: "#/parameters/tenantRequest"
responses:
"200":
$ref: "#/responses/TenantResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Update Tenants
security:
- ApiKeyAuth: []
tags:
- Tenants
/databases:
get:
description: Return a list of Database records from the datastore
operationId: getDatabases
parameters:
- $ref: "#/parameters/databaseIdQuery"
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
responses:
"200":
$ref: "#/responses/DatabaseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Get a list Databases
security:
- ApiKeyAuth: []
tags:
- Databases
post:
description: Create Databases in Taxnexus
operationId: postDatabases
parameters:
- $ref: "#/parameters/databaseRequest"
responses:
"200":
$ref: "#/responses/DatabaseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Create new Databases
security:
- ApiKeyAuth: []
tags:
- Databases
put:
description: Update Database in Taxnexus
operationId: putDatabases
parameters:
- $ref: "#/parameters/databaseRequest"
responses:
"200":
$ref: "#/responses/DatabaseResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Update Databases
security:
- ApiKeyAuth: []
tags:
- Databases
/users:
get:
description: Return a list of User records from the datastore
operationId: getUsers
parameters:
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/userIdQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/apiKeyQuery"
responses:
"200":
$ref: "#/responses/UserResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Get a list Users
security:
- ApiKeyAuth: []
tags:
- Users
definitions:
Account:
properties:
TenantID:
description: tenant identifier
type: string
ID:
description: Taxnexus Account Id
type: string
AccountNumber:
description: Account Number
type: string
AccountSource:
description: The marketing orgin of this account
type: string
AnnualRevenue:
description: Annual Revenue Estimate
format: double
type: number
BillingAddress:
$ref: "#/definitions/Address"
BillingContactID:
description: Contact ID
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
CloseDate:
description: Date company closed
type: string
CloudRevenueTotal:
type: number
CloudType:
type: string
CloudYear:
type: string
CrunchbaseURL:
type: string
Description:
description: Description
type: string
EarningsCall:
type: string
Email:
description: Main Account Email
type: string
EquityFunding:
type: number
Fax:
description: Fax
type: string
FoundedDate:
type: string
Industry:
description: Industry
type: string
Facebook:
type: string
Industries:
type: string
IPODate:
type: string
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
LinkedIn:
type: string
Location:
type: string
Logo:
type: string
MarketCapitalization:
type: number
Name:
description: Account Name
type: string
NumberOfEmployees:
description: Employee Count Estimate
type: number
format: int64
NumberInvestments:
description: Number of Locations Estimate
type: number
format: int64
OwnerID:
description: Account Owner User ID
type: string
Ownership:
description: Ownership
type: string
ParentID:
description: Parent Account
type: string
Phone:
description: Phone
type: string
Publish:
type: boolean
SalesforceFirst:
type: boolean
ShippingAddress:
$ref: "#/definitions/Address"
ShippingContactID:
type: string
SIC:
description: SIC Code
type: string
SICDesc:
description: SIC Description
type: string
Site:
description: Account Site
type: string
TagLine:
type: string
TickerSymbol:
type: string
Type:
description: Type
type: string
Twitter:
type: string
Website:
description: Website
type: string
YearStarted:
description: Year Started
type: string
type: object
AccountRequest:
properties:
data:
items:
$ref: "#/definitions/Account"
type: array
meta:
$ref: "#/definitions/RequestMeta"
type: object
AccountResponse:
description: An array of Account objects
properties:
data:
items:
$ref: "#/definitions/Account"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
Address:
properties:
city:
description: City
type: string
country:
description: Country full name
type: string
countrycode:
description: Country Code
type: string
postalcode:
description: Postal Code
type: string
state:
description: State full name
type: string
statecode:
description: State Code
type: string
street:
description: Street number and name
type: string
required:
- city
- statecode
type: object
CompanyProduct:
description: A software product or service vended by a Company
type: object
properties:
ID:
description: Taxnexus Record Id
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
AccountID:
description: Taxnexus ID of the Company that owns this Product
type: string
Description:
description: Description of product
type: string
Name:
description: Product Name
type: string
TagLine:
description: TagLine
type: string
URL:
description: Website
type: string
Asset:
properties:
ID:
type: string
description: Taxnexus Record Id
AccountID:
type: string
description: Account
Address:
$ref: "#/definitions/Address"
AssetLevel:
type: number
description: Asset Level
Name:
type: string
description: Asset Name
AssetProvidedByID:
type: string
description: Asset Provided By
AssetServicedByID:
type: string
description: Asset Serviced By
CompanyProductID:
type: string
description: Company Product
IsCompetitorProduct:
type: boolean
description: Competitor Asset
ConsequenceOfFailure:
type: string
description: Consequence Of Failure
ContactID:
type: string
description: Contact
CreatedByID:
type: string
description: Created By
CreatedDate:
type: string
description: Created Date
CurrentAmount:
type: number
description: Current Amount
CurrentLifecycleEndDate:
type: string
description: Current Lifecycle End Date
CurrentMrr:
type: number
description: Current Monthly Recurring Revenue
CurrentQuantity:
type: number
description: Current Quantity
Description:
type: string
description: Description
DigitalAssetStatus:
type: string
description: Digital Asset Status
ExternalIdentifier:
type: string
description: External Id
HasLifecycleManagement:
type: boolean
description: Has Lifecycle Management
InstallDate:
type: string
description: Install Date
IsInternal:
type: boolean
description: Internal Asset
LastModifiedByID:
type: string
description: Last Modified By
LastModifiedDate:
type: string
description: Last Modified Date
LocationID:
type: string
description: Location
ManufactureDate:
type: string
description: Manufacture Date
MIMEType:
type: string
description: MIME Type
ParentID:
type: string
description: Parent Asset
Price:
type: number
description: Price
Product2ID:
type: string
description: Product
ProductCode:
type: string
description: Product Code
ProductDescription:
type: string
description: Product Description
ProductFamily:
type: string
description: Product Family
StockKeepingUnit:
type: string
description: Product SKU
PurchaseDate:
type: string
description: Purchase Date
Quantity:
type: number
description: Quantity
RootAssetID:
type: string
description: Root Asset
SerialNumber:
type: string
description: Serial Number
Status:
type: string
description: Status
StatusReason:
type: string
description: Status Reason
TenantID:
type: string
description: Tenant ID
TotalLifecycleAmount:
type: number
description: Total Lifecycle Amount
Type:
type: string
description: Type
UUID:
type: string
description: Unique Identifier
URL:
type: string
description: URL
UsageEndDate:
type: string
description: Usage End Date
type: object
AssetRequest:
description: An array of Asset objects with Contacts
properties:
Data:
items:
$ref: "#/definitions/Asset"
type: array
type: object
AssetResponse:
description: An array of Asset objects with Contacts
properties:
Data:
items:
$ref: "#/definitions/Asset"
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
Cluster:
type: object
properties:
id:
type: string
description: Taxnexus Record Id
name:
type: string
description: Cluster Name
createdbyid:
type: string
description: Created By
createddate:
type: string
description: Created Date
description:
type: string
description: Description
environment:
type: string
description: Environment
ref:
type: string
description: External Reference
gateway:
type: string
description: Gateway
ip_address:
type: string
description: IP Address
lastmodifiedbyid:
type: string
description: Last Modified By
lastmodifieddate:
type: string
description: Last Modified Date
ownerid:
type: string
description: Owner
status:
type: string
description: Status
subnet:
type: string
description: Subnet
tenantid:
type: string
description: tenantid
type:
type: string
description: Type
zone:
type: string
description: Zone
ClusterRequest:
properties:
data:
items:
$ref: "#/definitions/Cluster"
type: array
meta:
$ref: "#/definitions/RequestMeta"
required:
- meta
- data
type: object
ClusterResponse:
description: An array of cluster objects
properties:
data:
items:
$ref: "#/definitions/Cluster"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
Contact:
properties:
TenantID:
description: tenant identifier
type: string
ID:
description: Taxnexus Record Id
type: string
AccountID:
description: The primary account ID of this contact
type: string
AssistantName:
description: Assistant Name
type: string
AssistantPhone:
description: Asst. Phone
type: string
BirthDate:
description: Birthdate
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
Department:
description: Department
type: string
Description:
description: Description
type: string
DoNotCall:
description: Do Not Call?
type: boolean
Email:
description: Email address
type: string
EmailBounceDate:
description: Email Bounce Date
type: string
EmailBounceReason:
description: Email Bounce Reason
type: string
Fax:
type: string
Facebook:
description: Fax Number
type: string
FirstName:
description: First Name
type: string
HasOptedOutOfEmail:
description: Email Opt Out
type: boolean
HasOptedOutOfFax:
description: Fax Opt Out
type: boolean
HomePhone:
description: Home Phone
type: string
IsEmailBounced:
description: Does this contact have bounced emails?
type: boolean
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
LastName:
description: Last Name
type: string
LeadSource:
description: Lead Source
type: string
LinkedIn:
description: LinkedIn Page
type: string
MailingAddress:
$ref: "#/definitions/Address"
MobilePhone:
description: Mobile Phone
type: string
Name:
description: Full Name
type: string
OtherAddress:
$ref: "#/definitions/Address"
OtherPhone:
description: Other Phone
type: string
OwnerID:
description: The User ID of the user who owns this Contact
type: string
PersonalEmail:
description: Personal Email Address for this Contact
type: string
Phone:
description: Phone Number
type: string
PhotoURL:
description: URL of a photograph of this User
type: string
Title:
description: Contact Title
type: string
Twitter:
type: string
type: object
CompanyProductRequest:
properties:
data:
items:
$ref: "#/definitions/CompanyProduct"
type: array
meta:
$ref: "#/definitions/RequestMeta"
required:
- meta
- data
type: object
CompanyProductResponse:
properties:
data:
items:
$ref: "#/definitions/CompanyProduct"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
ContactRequest:
properties:
data:
items:
$ref: "#/definitions/Contact"
type: array
meta:
$ref: "#/definitions/RequestMeta"
required:
- meta
- data
type: object
ContactResponse:
properties:
data:
items:
$ref: "#/definitions/Contact"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
Contract:
type: object
properties:
AccountID:
description: Account
type: string
ActivatedByID:
description: Activated By
type: string
ActivatedDate:
description: Activated Date
type: string
BillingAddress:
$ref: "#/definitions/Address"
description: Billing Address
BillingContactID:
description: Billing Contact
type: string
CompanySignedDate:
description: Company Signed Date
type: string
CompanySignedID:
description: Company Signed By
type: string
ContractNumber:
description: Contract Number
type: string
ContractTerm:
description: Contract Term (months)
type: number
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
CustomerSignedDate:
description: Customer Signed Date
type: string
CustomerSignedID:
description: Customer Signed By
type: string
CustomerSignedTitle:
description: Customer Signed Title
type: string
DefaultEndUserID:
description: End User
type: string
Description:
description: Description
type: string
EndDate:
description: Contract End Date
type: string
HourlyRate:
description: Hourly Rate
type: number
ID:
description: Telnexus Record Id
type: string
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
Name:
description: Contract Name
type: string
PaymentMethodID:
description: Payment Method
type: string
PaymentTerms:
description: Payment Terms
type: string
Perpetual:
description: Perpetual Agreement?
type: boolean
ShippingAddress:
$ref: "#/definitions/Address"
description: Shipping Address
ShippingContactID:
description: Shipping Contact
type: string
StartDate:
description: Contract Start Date
type: string
Status:
description: Status
type: string
TenantID:
description: Tenant Identifier
type: string
ContractRequest:
properties:
Data:
items:
$ref: "#/definitions/Contract"
type: array
type: object
ContractResponse:
properties:
Data:
items:
$ref: "#/definitions/Contract"
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
Database:
type: object
description: A Database provisioned and owned by a Tenant
properties:
active:
description: Is this database active?
type: boolean
clusterid:
description: The ID of the Cluster in which this database is deployed
type: string
createdbyid:
description: Created By
type: string
createddate:
description: Created Date
type: string
databasename:
description: The name of the physical database in the cluster
type: string
dsn:
description: Database connection string
type: string
id:
description: Record Id
type: string
lastmodifiedbyid:
description: Last Modified By
type: string
lastmodifieddate:
description: Last Modifed Date
type: string
microservices:
description: List of Taxnexus microservices implemented by this Database
type: string
status:
description: The current status of this Tenant
type: string
tenantid:
description: The ID of the tenant who owns this Database
type: string
type:
description: "The type of Database (mysql, etc)"
type: string
DatabaseRequest:
description: An array of Database objects
properties:
data:
items:
$ref: "#/definitions/Database"
type: array
meta:
$ref: "#/definitions/RequestMeta"
type: object
DatabaseResponse:
description: An array of Database objects
properties:
data:
items:
$ref: "#/definitions/Database"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
DeleteResponse:
properties:
Data:
items:
$ref: "#/definitions/Message"
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
Error:
properties:
Code:
format: int64
type: integer
Fields:
type: string
Message:
type: string
type: object
IndustryProduct:
description: Junction object between Industry and CompanyProduct
type: object
properties:
ID:
description: Taxnexus Record Id
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
IndustryID:
type: string
HTML:
type: string
CompanyProductID:
type: string
Industry:
description: An industry that is being researched
type: object
properties:
ID:
description: Taxnexus Record Id
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
Name:
description: Industry Name
type: string
Description:
description: Industry Description
type: string
ParentIndustryID:
description: The ID of the Parent Industry
type: string
Level:
description: The hierarchical level of this Industry
type: string
Path:
description: The full path of this industry, including Parent
type: string
Slug:
description: The CMS Slug for this Industry
type: string
SiteURL:
description: The URL of the corresponding page on the CMS
type: string
IndustryRequest:
description: An array of Industry objects submitted for processing
properties:
Data:
items:
$ref: "#/definitions/Industry"
type: array
type: object
IndustryResponse:
description: An array of Industry objects produced in response to a request
properties:
Data:
items:
$ref: "#/definitions/Industry"
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
IndustryProductRequest:
description: An array of IndustryProduct objects submitted for processing
properties:
Data:
items:
$ref: "#/definitions/IndustryProduct"
type: array
type: object
IndustryProductResponse:
description: An array of IndustryProduct objects produced in response to a request
properties:
Data:
items:
$ref: "#/definitions/IndustryProduct"
type: array
Meta:
$ref: "#/definitions/ResponseMeta"
type: object
InvalidError:
allOf:
- $ref: "#/definitions/Error"
- properties:
details:
items:
type: string
type: array
type: object
Message:
properties:
message:
type: string
ref:
type: string
status:
format: int64
type: number
type: object
Pagination:
properties:
limit:
format: int64
type: number
pagesize:
format: int64
type: number
poffset:
format: int64
type: integer
setsize:
format: int64
type: number
type: object
RequestMeta:
properties:
TaxnexusAccount:
description: Taxnexus Account Number of the Reseller or OEM
type: string
required:
- TaxnexusAccount
type: object
ResponseMeta:
properties:
Contact:
description: Microservice Contact Info
type: string
Copyright:
description: Copyright Info
type: string
License:
description: License Information and Restrictions
type: string
OperationID:
description: Operation ID
type: string
Pagination:
$ref: "#/definitions/Pagination"
RequestIP:
description: Request IP Address
type: string
RequestType:
description: Request Type
type: string
RequestURL:
description: Request URL
type: string
ServerInfo:
description: Data Server Info
type: string
ServerResponseTime:
description: Data Server Response Time (ms)
type: string
ServerTimestamp:
description: Backend Server Timestamp
type: string
TaxnexusAccount:
description: Taxnexus Account Number used for recording transactions
type: string
type: object
TenantRequest:
description: An array of Tenant objects
properties:
data:
items:
$ref: "#/definitions/Tenant"
type: array
meta:
$ref: "#/definitions/RequestMeta"
type: object
TenantResponse:
description: An array of Tenant objects
properties:
data:
items:
$ref: "#/definitions/Tenant"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
TenantUser:
description: Relationship object that connects users to a tenant
type: object
properties:
accesslevel:
type: string
description: The Tenant access level for this User
tenantid:
type: string
description: The Tenant ID
userid:
type: string
description: The User ID
Role:
type: object
description: A functional role within a Tenant
properties:
id:
type: string
description: record id
auth0roleid:
description: the corresponding auth0 role
type: string
createdbyid:
type: string
description: created by
createddate:
type: string
description: created date
description:
type: string
description: role description
lastmodifiedbyid:
type: string
description: last modified by
lastmodifieddate:
type: string
description: last modifed date
rolename:
type: string
description: the name of this role
tenantid:
type: string
description: the id of the tenant that owns this role
RoleRequest:
description: An array of Role objects
properties:
data:
items:
$ref: "#/definitions/Role"
type: array
meta:
$ref: "#/definitions/RequestMeta"
type: object
RoleResponse:
description: An array of Role objects
properties:
data:
items:
$ref: "#/definitions/Role"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
Template:
properties:
tenantid:
description: tenant identifier
type: string
CompanyID:
description: Company
type: string
CreatedByID:
type: string
CreatedDate:
type: string
Description:
description: Description
type: string
HTML:
description: HTML Body
type: string
format: byte
ID:
description: Taxnexus Record Id
type: string
IsActive:
description: Active?
type: boolean
IsMaster:
description: Master Template?
type: boolean
LastModifiedByID:
type: string
LastModifiedDate:
type: string
Name:
description: Template Name
type: string
ObjectType:
description: Object
type: string
RecordTypeName:
description: Record Type Name
type: string
Type:
description: Type
type: string
URL:
description: URL
type: string
type: object
TemplateResponse:
properties:
data:
items:
$ref: "#/definitions/Template"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
Tenant:
type: object
description: Taxnexus Account Tenant
properties:
id:
type: string
description: Record Id
accountid:
type: string
description: The Account that owns this Tenant
active:
type: boolean
description: Is this Tenant currently active?
createdbyid:
type: string
description: Created By
createddate:
type: string
description: Created Date
lastmodifiedbyid:
type: string
description: Last Modified By
lastmodifieddate:
type: string
description: Last Modifed Date
status:
type: string
description: The current status of this Tenant
tenantname:
type: string
description: Name of the Tenant Resource
type:
type: string
description: Type of tenant
version:
type: string
description: The version number of the Tenant Onboarding system used to
create this tenant
databases:
items:
$ref: "#/definitions/Database"
type: array
roles:
items:
$ref: "#/definitions/Role"
type: array
tenantusers:
items:
$ref: "#/definitions/TenantUser"
type: array
User:
properties:
tenantid:
type: string
aboutme:
description: About Me
type: string
accountid:
description: Account ID
type: string
address:
$ref: "#/definitions/Address"
alias:
description: Alias
type: string
apikey:
description: API Key
type: string
auth0userid:
description: Auth0 User ID
type: string
communitynickname:
description: Nickname
type: string
companyname:
description: Company Name
type: string
contactid:
description: Contact
type: string
createdbyid:
description: Created User ID
type: string
createddate:
description: Date Created
type: string
delegatedapproverid:
description: Delegated Approver
type: string
department:
description: Department
type: string
division:
description: Division
type: string
email:
description: Email address
type: string
employeenumber:
description: Employee Number
type: string
endday:
description: Time day ends
type: string
environment:
description: Environment
type: string
extension:
description: Extension
type: string
fabricapikey:
description: Fabric API Key
type: string
fax:
description: Fax
type: string
firstname:
description: The first name
type: string
forecastenabled:
description: Allow Forecasting
type: boolean
fullphotourl:
description: Full Photo URL
type: string
id:
description: Taxnexus ID
type: string
isactive:
description: Active
type: boolean
isportalenabled:
description: Is the user enabled for Communities?
type: boolean
isprofilephotoactive:
description: Has Profile Photo
type: boolean
issystemcontrolled:
type: boolean
lastip:
description: ip address of last login
type: string
lastlogin:
description: last login time
type: string
lastmodifiedbyid:
description: Last Modified User ID
type: string
lastmodifieddate:
description: Last Modified Date
type: string
lastname:
description: The Last Name
type: string
logincount:
description: number of times user has logged in
format: int64
type: number
managerid:
description: Manager
type: string
mobilephone:
description: Mobile
type: string
name:
description: Name
type: string
outofofficemessage:
description: Out of office message
type: string
phone:
description: Phone
type: string
portalrole:
description: Portal Role Level
type: string
profileid:
description: Profile
type: string
receivesadmininfoemails:
description: Admin Info Emails
type: boolean
receivesinfoemails:
description: Info Emails
type: boolean
senderemail:
description: Email Sender Address
type: string
sendername:
description: Email Sender Name
type: string
signature:
description: Email Signature
type: string
smallphotourl:
description: Small Photo URL
type: string
startday:
description: The time day starts
type: string
taxnexusaccount:
description: Taxnexus Account
type: string
timezonesidkey:
description: Time Zone
type: string
title:
description: Title
type: string
username:
description: Username
type: string
userroleid:
description: Role
type: string
usertype:
description: User Type
type: string
userroles:
items:
$ref: "#/definitions/UserRole"
type: array
tenantusers:
items:
$ref: "#/definitions/TenantUser"
type: array
type: object
UserResponse:
description: An array of Print-Ready ingest Objects
properties:
data:
items:
$ref: "#/definitions/User"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
UserRole:
description: Relationship object that connects user to a role
type: object
properties:
description:
type: string
description: Role description
roleid:
type: string
description: The Role ID
userid:
type: string
description: The User ID
name:
type: string
description: Role Name
auth0roleid:
type: string
description: Linked role ID