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

2589 lines
65 KiB
YAML
Raw Normal View History

2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Record Id of an Account
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Id of the User to be retrieved
2022-09-07 00:16:25 +00:00
in: query
name: apikey
required: false
type: string
assetIdQuery:
2023-03-28 17:47:34 +00:00
description: Record Id of an Asset
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Record Id of a Cluster
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: CompanyProduct record ID
2022-09-07 00:16:25 +00:00
in: query
name: companyProductId
required: false
type: string
contactIdQuery:
2023-03-28 17:47:34 +00:00
description: Record Id of a Contact
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Contact record ID
2022-09-07 00:16:25 +00:00
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"
2023-03-28 17:47:34 +00:00
newUserRequest:
description: A single new user record
in: body
name: UserRequest
required: true
schema:
$ref: "#/definitions/UserRequest"
2022-09-07 00:16:25 +00:00
databaseIdQuery:
2023-03-28 17:47:34 +00:00
description: Record Id of a Database
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Industry record ID
2022-09-07 00:16:25 +00:00
in: query
name: industryId
required: false
type: string
industryProductIdQuery:
2023-03-28 17:47:34 +00:00
description: IndustryProduct record ID
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Id of the Role to be retrieved
2022-09-07 00:16:25 +00:00
in: query
name: roleId
required: false
type: string
templateIdQuery:
2023-03-28 17:47:34 +00:00
description: Record Id of a Template
2022-09-07 00:16:25 +00:00
in: query
name: templateId
required: false
type: string
tenantIdQuery:
2023-03-28 17:47:34 +00:00
description: Record Id of a Tenant
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Id of the User to be retrieved
2022-09-07 00:16:25 +00:00
in: query
name: userId
required: false
type: string
responses:
2023-03-28 17:47:34 +00:00
SalesforcePostResponse:
description: Response from Salesforce
schema:
$ref: "#/definitions/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
AccessForbidden:
description: "Access forbidden, account lacks access"
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
AccountResponse:
2023-03-28 17:47:34 +00:00
description: Response with Account objects with Contacts
2022-09-07 00:16:25 +00:00
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/AccountResponse"
AssetResponse:
2023-03-28 17:47:34 +00:00
description: Response with Asset objects with Contacts
2022-09-07 00:16:25 +00:00
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/AssetResponse"
ClusterResponse:
2023-03-28 17:47:34 +00:00
description: Response with Cluster objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/ClusterResponse"
ContactResponse:
2023-03-28 17:47:34 +00:00
description: Response with Contact objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/ContactResponse"
IndustryResponse:
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
2023-03-28 17:47:34 +00:00
description: Response with Industry objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/IndustryResponse"
IndustryProductResponse:
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
2023-03-28 17:47:34 +00:00
description: Response with Industry objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/IndustryProductResponse"
ContractResponse:
2023-03-28 17:47:34 +00:00
description: Response with an array of Contract objects
2022-09-07 00:16:25 +00:00
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/ContractResponse"
CompanyProductResponse:
2023-03-28 17:47:34 +00:00
description: Response with an array of CompanyProduct objects
2022-09-07 00:16:25 +00:00
headers:
Access-Control-Allow-Origin:
type: string
Cache-Control:
type: string
schema:
$ref: "#/definitions/CompanyProductResponse"
DatabaseResponse:
2023-03-28 17:47:34 +00:00
description: Response with Database objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/DatabaseResponse"
DeleteResponse:
2023-03-28 17:47:34 +00:00
description: Response with Message Objects with Delete Status
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Response with Role objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/RoleResponse"
ServerError:
description: Server Internal Error
headers:
Access-Control-Allow-Origin:
type: string
schema:
$ref: "#/definitions/Error"
TemplateResponse:
2023-03-28 17:47:34 +00:00
description: Response with Template objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/TemplateResponse"
TenantResponse:
2023-03-28 17:47:34 +00:00
description: Response with Tenant objects
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Response with User objects
2022-09-07 00:16:25 +00:00
schema:
$ref: "#/definitions/UserResponse"
paths:
/accounts:
delete:
2023-03-28 17:47:34 +00:00
description: Delete Account record
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Update one or more accounts specified by accountId
operationId: putAccounts
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Create Clusters in Salesforce
2022-09-07 00:16:25 +00:00
operationId: postClusters
parameters:
- $ref: "#/parameters/clusterRequest"
responses:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Update Cluster in Salesforce
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Retrieve Contact records from Salesforce
2022-09-07 00:16:25 +00:00
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
2023-03-28 17:47:34 +00:00
put:
description: Update Contact records in Salesforce
operationId: putContacts
parameters:
- $ref: "#/parameters/contactRequest"
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: Update a Contact record
tags:
- Contacts
2022-09-07 00:16:25 +00:00
post:
description: Contacts record to be added
operationId: postContacts
parameters:
- $ref: "#/parameters/contactRequest"
responses:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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
2023-03-28 17:47:34 +00:00
delete:
description: Delete Contact record from Salesforce
operationId: deleteContacts
2022-09-07 00:16:25 +00:00
parameters:
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/contactIdQuery"
2022-09-07 00:16:25 +00:00
responses:
"200":
2023-03-28 17:47:34 +00:00
$ref: "#/responses/ContactResponse"
2022-09-07 00:16:25 +00:00
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
security:
- ApiKeyAuth: []
2023-03-28 17:47:34 +00:00
summary: Delete a Contact record
2022-09-07 00:16:25 +00:00
tags:
2023-03-28 17:47:34 +00:00
- Contacts
/contracts:
get:
description: Return a list of all available Contracts
operationId: getContracts
2022-09-07 00:16:25 +00:00
parameters:
2023-03-28 17:47:34 +00:00
- $ref: "#/parameters/limitQuery"
- $ref: "#/parameters/offsetQuery"
- $ref: "#/parameters/activeQuery"
- $ref: "#/parameters/contractIdQuery"
2022-09-07 00:16:25 +00:00
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: []
2023-03-28 17:47:34 +00:00
summary: Get a list of contracts
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Create Tenants in Salesforce
2022-09-07 00:16:25 +00:00
operationId: Tenants
parameters:
- $ref: "#/parameters/tenantRequest"
responses:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Update Tenant in Salesforce
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Create Databases in Salesforce
2022-09-07 00:16:25 +00:00
operationId: postDatabases
parameters:
- $ref: "#/parameters/databaseRequest"
responses:
2023-03-28 17:47:34 +00:00
"201":
$ref: "#/responses/SalesforcePostResponse"
2022-09-07 00:16:25 +00:00
"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:
2023-03-28 17:47:34 +00:00
description: Update Database in Salesforce
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
post:
description: Create a user record in Salesforce
operationId: postUser
parameters:
- $ref: "#/parameters/newUserRequest"
responses:
"200":
$ref: "#/responses/SalesforcePostResponse"
"401":
$ref: "#/responses/Unauthorized"
"403":
$ref: "#/responses/AccessForbidden"
"404":
$ref: "#/responses/NotFound"
"422":
$ref: "#/responses/UnprocessableEntity"
"500":
$ref: "#/responses/ServerError"
summary: Create new Salesforce User
security:
- ApiKeyAuth: []
tags:
- Users
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
UserRequest:
type: object
2022-09-07 00:16:25 +00:00
properties:
2023-03-28 17:47:34 +00:00
APIKey:
type: string
Address:
$ref: "#/definitions/Address"
Email:
type: string
Environment:
type: string
FirstName:
type: string
ID:
type: string
LastName:
type: string
TaxnexusAccount:
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
Title:
type: string
Account:
properties:
2022-09-07 00:16:25 +00:00
ID:
description: Taxnexus Account Id
type: string
AccountNumber:
description: Account Number
type: string
AccountSource:
2023-03-28 17:47:34 +00:00
description: The marketing origin of this account
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
Active:
type: boolean
2022-09-07 00:16:25 +00:00
AnnualRevenue:
description: Annual Revenue Estimate
format: double
type: number
BillingAddress:
$ref: "#/definitions/Address"
BillingContactID:
description: Contact ID
type: string
CloseDate:
2023-03-28 17:47:34 +00:00
description: Close Date
2022-09-07 00:16:25 +00:00
type: string
CloudRevenueTotal:
type: number
CloudType:
2023-03-28 17:47:34 +00:00
description: The type of cloud company
2022-09-07 00:16:25 +00:00
type: string
CloudYear:
2023-03-28 17:47:34 +00:00
description: The year company started cloud revenue
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
2022-09-07 00:16:25 +00:00
type: string
CrunchbaseURL:
2023-03-28 17:47:34 +00:00
description: Crunchbase URL
2022-09-07 00:16:25 +00:00
type: string
Description:
2023-03-28 17:47:34 +00:00
description: Description of the account
type: string
EIN:
2022-09-07 00:16:25 +00:00
type: string
EarningsCall:
2023-03-28 17:47:34 +00:00
description: Earnings Call Date
2022-09-07 00:16:25 +00:00
type: string
Email:
description: Main Account Email
type: string
EquityFunding:
2023-03-28 17:47:34 +00:00
description: The amount of equity EquityFunding
2022-09-07 00:16:25 +00:00
type: number
2023-03-28 17:47:34 +00:00
Facebook:
description: Company Facebook URL
type: string
2022-09-07 00:16:25 +00:00
Fax:
2023-03-28 17:47:34 +00:00
description: Fax number
2022-09-07 00:16:25 +00:00
type: string
FoundedDate:
2023-03-28 17:47:34 +00:00
description: Date company founded
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
IPODate:
description: IPO Date
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
ImageAltText:
type: string
ImageURL:
2022-09-07 00:16:25 +00:00
type: string
Industries:
2023-03-28 17:47:34 +00:00
description: Industries
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
Industry:
description: Industry
2022-09-07 00:16:25 +00:00
type: string
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
LinkedIn:
2023-03-28 17:47:34 +00:00
description: Company LinkedIn URL
2022-09-07 00:16:25 +00:00
type: string
Location:
2023-03-28 17:47:34 +00:00
description: Headquarters Location Description
2022-09-07 00:16:25 +00:00
type: string
Logo:
2023-03-28 17:47:34 +00:00
description: Company Logo URL
2022-09-07 00:16:25 +00:00
type: string
MarketCapitalization:
2023-03-28 17:47:34 +00:00
description: Market Capitalization
2022-09-07 00:16:25 +00:00
type: number
Name:
description: Account Name
type: string
2023-03-28 17:47:34 +00:00
NumberInvestments:
description: Number of Investments
type: number
2022-09-07 00:16:25 +00:00
NumberOfEmployees:
description: Employee Count Estimate
format: int64
type: number
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:
2023-03-28 17:47:34 +00:00
description: Publish this record?
2022-09-07 00:16:25 +00:00
type: boolean
SIC:
description: SIC Code
type: string
SICDesc:
description: SIC Description
type: string
2023-03-28 17:47:34 +00:00
SalesforceFirst:
description: A Salesforce-First company?
type: boolean
ShippingAddress:
$ref: "#/definitions/Address"
ShippingContactID:
description: Shipping Contact ID
type: string
2022-09-07 00:16:25 +00:00
Site:
description: Account Site
type: string
2023-03-28 17:47:34 +00:00
Slug:
description: Slug
type: string
2022-09-07 00:16:25 +00:00
TagLine:
2023-03-28 17:47:34 +00:00
description: Company tagline
type: string
TenantID:
description: Tenant Identifier
2022-09-07 00:16:25 +00:00
type: string
TickerSymbol:
2023-03-28 17:47:34 +00:00
description: Ticker Symbol
type: string
Twitter:
description: Twitter URL
2022-09-07 00:16:25 +00:00
type: string
Type:
description: Type
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:
2023-03-28 17:47:34 +00:00
City:
2022-09-07 00:16:25 +00:00
description: City
type: string
2023-03-28 17:47:34 +00:00
Country:
2022-09-07 00:16:25 +00:00
description: Country full name
type: string
2023-03-28 17:47:34 +00:00
CountryCode:
2022-09-07 00:16:25 +00:00
description: Country Code
type: string
2023-03-28 17:47:34 +00:00
PostalCode:
2022-09-07 00:16:25 +00:00
description: Postal Code
type: string
2023-03-28 17:47:34 +00:00
State:
2022-09-07 00:16:25 +00:00
description: State full name
type: string
2023-03-28 17:47:34 +00:00
StateCode:
2022-09-07 00:16:25 +00:00
description: State Code
type: string
2023-03-28 17:47:34 +00:00
Street:
2022-09-07 00:16:25 +00:00
description: Street number and name
type: string
type: object
CompanyProduct:
description: A software product or service vended by a Company
properties:
ID:
2023-03-28 17:47:34 +00:00
description: Record Id
type: string
AccountID:
description: Taxnexus ID of the Company that owns this Product
2022-09-07 00:16:25 +00:00
type: string
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
2023-03-28 17:47:34 +00:00
Description:
description: Description of product
type: string
FullDescription:
description: Full Description of product
type: string
Imagealttext:
description: Image Alt Text
type: string
ImageURL:
description: Image URL
type: string
2022-09-07 00:16:25 +00:00
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
2023-03-28 17:47:34 +00:00
Logo:
description: Logo
2022-09-07 00:16:25 +00:00
type: string
Name:
description: Product Name
type: string
2023-03-28 17:47:34 +00:00
Published:
description: Published
type: boolean
SalesforceSpecific:
description: Salesforce Specific
type: boolean
SiteURL:
description: Site URL
type: string
2022-09-07 00:16:25 +00:00
TagLine:
description: TagLine
type: string
URL:
description: Website
type: string
2023-03-28 17:47:34 +00:00
type: object
2022-09-07 00:16:25 +00:00
Asset:
properties:
ID:
2023-03-28 17:47:34 +00:00
description: Record Id
2022-09-07 00:16:25 +00:00
type: string
AccountID:
description: Account
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
Address:
$ref: "#/definitions/Address"
AssetLevel:
description: Asset Level
2023-03-28 17:47:34 +00:00
type: number
2022-09-07 00:16:25 +00:00
AssetProvidedByID:
description: Asset Provided By
type: string
2023-03-28 17:47:34 +00:00
AssetServicedByID:
2022-09-07 00:16:25 +00:00
description: Asset Serviced By
type: string
2023-03-28 17:47:34 +00:00
CompanyProductID:
2022-09-07 00:16:25 +00:00
description: Company Product
type: string
2023-03-28 17:47:34 +00:00
ConsequenceOfFailure:
2022-09-07 00:16:25 +00:00
description: Consequence Of Failure
type: string
2023-03-28 17:47:34 +00:00
ContactID:
2022-09-07 00:16:25 +00:00
description: Contact
type: string
2023-03-28 17:47:34 +00:00
CreatedByID:
2022-09-07 00:16:25 +00:00
description: Created By
type: string
2023-03-28 17:47:34 +00:00
CreatedDate:
2022-09-07 00:16:25 +00:00
description: Created Date
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
CurrentAmount:
description: Current Amount
2023-03-28 17:47:34 +00:00
type: number
2022-09-07 00:16:25 +00:00
CurrentLifecycleEndDate:
description: Current Lifecycle End Date
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
CurrentMrr:
description: Current Monthly Recurring Revenue
type: number
2023-03-28 17:47:34 +00:00
CurrentQuantity:
2022-09-07 00:16:25 +00:00
description: Current Quantity
2023-03-28 17:47:34 +00:00
type: number
2022-09-07 00:16:25 +00:00
Description:
description: Description
type: string
2023-03-28 17:47:34 +00:00
DigitalAssetStatus:
2022-09-07 00:16:25 +00:00
description: Digital Asset Status
type: string
2023-03-28 17:47:34 +00:00
ExternalIdentifier:
2022-09-07 00:16:25 +00:00
description: External Id
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
HasLifecycleManagement:
description: Has Lifecycle Management
2023-03-28 17:47:34 +00:00
type: boolean
2022-09-07 00:16:25 +00:00
InstallDate:
description: Install Date
2023-03-28 17:47:34 +00:00
type: string
IsCompetitorProduct:
description: Competitor Asset
2022-09-07 00:16:25 +00:00
type: boolean
2023-03-28 17:47:34 +00:00
IsInternal:
2022-09-07 00:16:25 +00:00
description: Internal Asset
2023-03-28 17:47:34 +00:00
type: boolean
2022-09-07 00:16:25 +00:00
LastModifiedByID:
description: Last Modified By
type: string
2023-03-28 17:47:34 +00:00
LastModifiedDate:
2022-09-07 00:16:25 +00:00
description: Last Modified Date
type: string
2023-03-28 17:47:34 +00:00
LocationID:
2022-09-07 00:16:25 +00:00
description: Location
type: string
MIMEType:
description: MIME Type
type: string
2023-03-28 17:47:34 +00:00
ManufactureDate:
description: Manufacture Date
type: string
Name:
description: Asset Name
type: string
ParentID:
2022-09-07 00:16:25 +00:00
description: Parent Asset
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
Price:
description: Price
2023-03-28 17:47:34 +00:00
type: number
2022-09-07 00:16:25 +00:00
Product2ID:
description: Product
type: string
2023-03-28 17:47:34 +00:00
ProductCode:
2022-09-07 00:16:25 +00:00
description: Product Code
type: string
2023-03-28 17:47:34 +00:00
ProductDescription:
2022-09-07 00:16:25 +00:00
description: Product Description
type: string
2023-03-28 17:47:34 +00:00
ProductFamily:
2022-09-07 00:16:25 +00:00
description: Product Family
type: string
PurchaseDate:
description: Purchase Date
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
Quantity:
description: Quantity
2023-03-28 17:47:34 +00:00
type: number
2022-09-07 00:16:25 +00:00
RootAssetID:
description: Root Asset
type: string
2023-03-28 17:47:34 +00:00
SerialNumber:
2022-09-07 00:16:25 +00:00
description: Serial Number
type: string
2023-03-28 17:47:34 +00:00
Status:
2022-09-07 00:16:25 +00:00
description: Status
type: string
2023-03-28 17:47:34 +00:00
StatusReason:
2022-09-07 00:16:25 +00:00
description: Status Reason
type: string
2023-03-28 17:47:34 +00:00
StockKeepingUnit:
description: Product SKU
type: string
TenantID:
2022-09-07 00:16:25 +00:00
description: Tenant ID
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
TotalLifecycleAmount:
description: Total Lifecycle Amount
2023-03-28 17:47:34 +00:00
type: number
2022-09-07 00:16:25 +00:00
Type:
description: Type
type: string
URL:
description: URL
type: string
2023-03-28 17:47:34 +00:00
UsageEndDate:
2022-09-07 00:16:25 +00:00
description: Usage End Date
2023-03-28 17:47:34 +00:00
type: string
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
ID:
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
description: Record Id
Name:
2022-09-07 00:16:25 +00:00
type: string
description: Cluster Name
2023-03-28 17:47:34 +00:00
CreatedByID:
2022-09-07 00:16:25 +00:00
type: string
description: Created By
2023-03-28 17:47:34 +00:00
CreatedDate:
2022-09-07 00:16:25 +00:00
type: string
description: Created Date
2023-03-28 17:47:34 +00:00
Description:
2022-09-07 00:16:25 +00:00
type: string
description: Description
2023-03-28 17:47:34 +00:00
Environment:
2022-09-07 00:16:25 +00:00
type: string
description: Environment
2023-03-28 17:47:34 +00:00
Ref:
2022-09-07 00:16:25 +00:00
type: string
description: External Reference
2023-03-28 17:47:34 +00:00
Gateway:
2022-09-07 00:16:25 +00:00
type: string
description: Gateway
2023-03-28 17:47:34 +00:00
IpAddress:
2022-09-07 00:16:25 +00:00
type: string
description: IP Address
2023-03-28 17:47:34 +00:00
LastModifiedByID:
2022-09-07 00:16:25 +00:00
type: string
description: Last Modified By
2023-03-28 17:47:34 +00:00
LastModifiedDate:
2022-09-07 00:16:25 +00:00
type: string
description: Last Modified Date
2023-03-28 17:47:34 +00:00
OwnerID:
2022-09-07 00:16:25 +00:00
type: string
description: Owner
2023-03-28 17:47:34 +00:00
Status:
2022-09-07 00:16:25 +00:00
type: string
description: Status
2023-03-28 17:47:34 +00:00
Subnet:
2022-09-07 00:16:25 +00:00
type: string
description: Subnet
2023-03-28 17:47:34 +00:00
TenantID:
2022-09-07 00:16:25 +00:00
type: string
description: tenantid
2023-03-28 17:47:34 +00:00
Type:
2022-09-07 00:16:25 +00:00
type: string
description: Type
2023-03-28 17:47:34 +00:00
Zone:
2022-09-07 00:16:25 +00:00
type: string
description: Zone
ClusterRequest:
properties:
data:
items:
$ref: "#/definitions/Cluster"
type: array
meta:
$ref: "#/definitions/RequestMeta"
required:
- 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:
ID:
2023-03-28 17:47:34 +00:00
description: Record Id
2022-09-07 00:16:25 +00:00
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
2023-03-28 17:47:34 +00:00
CrunchbaseURL:
description: Crunchbase URL
type: string
2022-09-07 00:16:25 +00:00
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
Facebook:
description: Fax Number
type: string
2023-03-28 17:47:34 +00:00
Fax:
type: string
2022-09-07 00:16:25 +00:00
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
2023-03-28 17:47:34 +00:00
ReportsToID:
description: Reports To User ID
type: string
Salutation:
description: Salutation
type: string
Slug:
description: Slug
type: string
TenantID:
description: tenant identifier
type: string
2022-09-07 00:16:25 +00:00
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:
- 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:
- 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
2023-03-28 17:47:34 +00:00
EndUserID:
description: End User
type: string
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
ID:
description: Record Id
type: string
Active:
2022-09-07 00:16:25 +00:00
description: Is this database active?
type: boolean
2023-03-28 17:47:34 +00:00
ClusterID:
2022-09-07 00:16:25 +00:00
description: The ID of the Cluster in which this database is deployed
type: string
2023-03-28 17:47:34 +00:00
CreatedByID:
2022-09-07 00:16:25 +00:00
description: Created By
type: string
2023-03-28 17:47:34 +00:00
CreatedDate:
2022-09-07 00:16:25 +00:00
description: Created Date
type: string
2023-03-28 17:47:34 +00:00
DatabaseName:
2022-09-07 00:16:25 +00:00
description: The name of the physical database in the cluster
type: string
2023-03-28 17:47:34 +00:00
DSN:
2022-09-07 00:16:25 +00:00
description: Database connection string
type: string
2023-03-28 17:47:34 +00:00
LastModifiedByID:
2022-09-07 00:16:25 +00:00
description: Last Modified By
type: string
2023-03-28 17:47:34 +00:00
LastModifiedDate:
2022-09-07 00:16:25 +00:00
description: Last Modifed Date
type: string
2023-03-28 17:47:34 +00:00
Microservices:
description: List of microservices implemented by this Database
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
Status:
2022-09-07 00:16:25 +00:00
description: The current status of this Tenant
type: string
2023-03-28 17:47:34 +00:00
TenantID:
2022-09-07 00:16:25 +00:00
description: The ID of the tenant who owns this Database
type: string
2023-03-28 17:47:34 +00:00
Type:
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Record Id
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Record Id
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
Companies:
description: The AccountIDs of the Companies in this Industry
items:
type: string
type: array
CompanyProducts:
description: The list of Products in this industry
items:
$ref: "#/definitions/CompanyProduct"
type: array
2022-09-07 00:16:25 +00:00
CreatedByID:
description: Created By User ID
type: string
CreatedDate:
description: Created Date
type: string
2023-03-28 17:47:34 +00:00
Description:
description: Industry Description
type: string
Imagealttext:
description: Image Alt Text
type: string
ImageURL:
description: Image URL
type: string
2022-09-07 00:16:25 +00:00
LastModifiedByID:
description: Last Modified By User ID
type: string
LastModifiedDate:
description: Last Modified Date
type: string
2023-03-28 17:47:34 +00:00
Level:
description: The hierarchical level of this Industry
type: string
Logo:
description: Logo
type: string
2022-09-07 00:16:25 +00:00
Name:
description: Industry Name
type: string
ParentIndustryID:
description: The ID of the Parent Industry
type: string
Path:
description: The full path of this industry, including Parent
type: string
2023-03-28 17:47:34 +00:00
SiteURL:
description: The URL of the corresponding page on the CMS
type: string
2022-09-07 00:16:25 +00:00
Slug:
description: The CMS Slug for this Industry
type: string
2023-03-28 17:47:34 +00:00
TagLine:
description: TagLine
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Account Number of the Reseller or OEM
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
description: Account Number used for recording transactions
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
ID:
2022-09-07 00:16:25 +00:00
type: string
description: record id
2023-03-28 17:47:34 +00:00
Auth0RoleID:
2022-09-07 00:16:25 +00:00
description: the corresponding auth0 role
type: string
2023-03-28 17:47:34 +00:00
CreatedByID::
2022-09-07 00:16:25 +00:00
type: string
description: created by
2023-03-28 17:47:34 +00:00
CreatedDate:
2022-09-07 00:16:25 +00:00
type: string
description: created date
2023-03-28 17:47:34 +00:00
Description:
2022-09-07 00:16:25 +00:00
type: string
description: role description
2023-03-28 17:47:34 +00:00
LastModifiedByID:
2022-09-07 00:16:25 +00:00
type: string
description: last modified by
2023-03-28 17:47:34 +00:00
LastModifiedDate:
2022-09-07 00:16:25 +00:00
type: string
description: last modifed date
2023-03-28 17:47:34 +00:00
RoleName:
2022-09-07 00:16:25 +00:00
type: string
description: the name of this role
2023-03-28 17:47:34 +00:00
TenantID:
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
TenantID:
2022-09-07 00:16:25 +00:00
description: tenant identifier
type: string
CreatedByID:
type: string
CreatedDate:
type: string
Description:
description: Description
type: string
HTML:
description: HTML Body
type: string
format: byte
ID:
2023-03-28 17:47:34 +00:00
description: Record Id
2022-09-07 00:16:25 +00:00
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
2023-03-28 17:47:34 +00:00
description: Account Tenant
2022-09-07 00:16:25 +00:00
properties:
2023-03-28 17:47:34 +00:00
ID:
2022-09-07 00:16:25 +00:00
type: string
description: Record Id
2023-03-28 17:47:34 +00:00
AccountID:
2022-09-07 00:16:25 +00:00
type: string
description: The Account that owns this Tenant
2023-03-28 17:47:34 +00:00
Active:
2022-09-07 00:16:25 +00:00
type: boolean
description: Is this Tenant currently active?
2023-03-28 17:47:34 +00:00
CreatedByID:
2022-09-07 00:16:25 +00:00
type: string
description: Created By
2023-03-28 17:47:34 +00:00
CreatedDate:
2022-09-07 00:16:25 +00:00
type: string
description: Created Date
2023-03-28 17:47:34 +00:00
LastModifiedByID:
2022-09-07 00:16:25 +00:00
type: string
description: Last Modified By
2023-03-28 17:47:34 +00:00
LastModifiedDate:
2022-09-07 00:16:25 +00:00
type: string
description: Last Modifed Date
2023-03-28 17:47:34 +00:00
Status:
2022-09-07 00:16:25 +00:00
type: string
description: The current status of this Tenant
2023-03-28 17:47:34 +00:00
TenantName:
2022-09-07 00:16:25 +00:00
type: string
description: Name of the Tenant Resource
2023-03-28 17:47:34 +00:00
Type:
2022-09-07 00:16:25 +00:00
type: string
description: Type of tenant
2023-03-28 17:47:34 +00:00
Version:
2022-09-07 00:16:25 +00:00
type: string
description: The version number of the Tenant Onboarding system used to
create this tenant
2023-03-28 17:47:34 +00:00
Databases:
2022-09-07 00:16:25 +00:00
items:
$ref: "#/definitions/Database"
type: array
2023-03-28 17:47:34 +00:00
Roles:
2022-09-07 00:16:25 +00:00
items:
$ref: "#/definitions/Role"
type: array
2023-03-28 17:47:34 +00:00
TenantUsers:
2022-09-07 00:16:25 +00:00
items:
$ref: "#/definitions/TenantUser"
type: array
User:
properties:
2023-03-28 17:47:34 +00:00
APIKey:
description: API Key
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
AboutMe:
2022-09-07 00:16:25 +00:00
description: About Me
type: string
2023-03-28 17:47:34 +00:00
AccountID:
2022-09-07 00:16:25 +00:00
description: Account ID
type: string
2023-03-28 17:47:34 +00:00
Address:
2022-09-07 00:16:25 +00:00
$ref: "#/definitions/Address"
2023-03-28 17:47:34 +00:00
Alias:
2022-09-07 00:16:25 +00:00
description: Alias
type: string
2023-03-28 17:47:34 +00:00
Auth0UserID:
description: Auth0 User Id
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
CommunityNickname:
2022-09-07 00:16:25 +00:00
description: Nickname
type: string
2023-03-28 17:47:34 +00:00
CompanyName:
2022-09-07 00:16:25 +00:00
description: Company Name
type: string
2023-03-28 17:47:34 +00:00
ContactID:
2022-09-07 00:16:25 +00:00
description: Contact
type: string
2023-03-28 17:47:34 +00:00
CreatedByID:
2022-09-07 00:16:25 +00:00
description: Created User ID
type: string
2023-03-28 17:47:34 +00:00
CreatedDate:
2022-09-07 00:16:25 +00:00
description: Date Created
type: string
2023-03-28 17:47:34 +00:00
DelegatedApproverID:
2022-09-07 00:16:25 +00:00
description: Delegated Approver
type: string
2023-03-28 17:47:34 +00:00
Department:
2022-09-07 00:16:25 +00:00
description: Department
type: string
2023-03-28 17:47:34 +00:00
Division:
2022-09-07 00:16:25 +00:00
description: Division
type: string
2023-03-28 17:47:34 +00:00
Email:
2022-09-07 00:16:25 +00:00
description: Email address
type: string
2023-03-28 17:47:34 +00:00
EmployeeNumber:
2022-09-07 00:16:25 +00:00
description: Employee Number
type: string
2023-03-28 17:47:34 +00:00
EndOfDay:
2022-09-07 00:16:25 +00:00
description: Time day ends
type: string
2023-03-28 17:47:34 +00:00
Environment:
2022-09-07 00:16:25 +00:00
description: Environment
type: string
2023-03-28 17:47:34 +00:00
Extension:
2022-09-07 00:16:25 +00:00
description: Extension
type: string
2023-03-28 17:47:34 +00:00
FabricAPIKey:
2022-09-07 00:16:25 +00:00
description: Fabric API Key
type: string
2023-03-28 17:47:34 +00:00
Fax:
2022-09-07 00:16:25 +00:00
description: Fax
type: string
2023-03-28 17:47:34 +00:00
FirstName:
2022-09-07 00:16:25 +00:00
description: The first name
type: string
2023-03-28 17:47:34 +00:00
ForecastEnabled:
2022-09-07 00:16:25 +00:00
description: Allow Forecasting
type: boolean
2023-03-28 17:47:34 +00:00
FullPhotoURL:
2022-09-07 00:16:25 +00:00
description: Full Photo URL
type: string
2023-03-28 17:47:34 +00:00
ID:
description: Record ID
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
IsActive:
2022-09-07 00:16:25 +00:00
description: Active
type: boolean
2023-03-28 17:47:34 +00:00
IsPortalEnabled:
2022-09-07 00:16:25 +00:00
description: Is the user enabled for Communities?
type: boolean
2023-03-29 23:07:04 +00:00
IsProfilePhotoActive:
2022-09-07 00:16:25 +00:00
description: Has Profile Photo
type: boolean
2023-03-28 17:47:34 +00:00
IsSystemControlled:
2022-09-07 00:16:25 +00:00
type: boolean
2023-03-28 17:47:34 +00:00
LastIP:
description: IP address of last login
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
LastLogin:
description: Last login time
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
LastModifiedByID:
2022-09-07 00:16:25 +00:00
description: Last Modified User ID
type: string
2023-03-28 17:47:34 +00:00
LastModifiedDate:
2022-09-07 00:16:25 +00:00
description: Last Modified Date
type: string
2023-03-28 17:47:34 +00:00
LastName:
2022-09-07 00:16:25 +00:00
description: The Last Name
type: string
2023-03-28 17:47:34 +00:00
LoginCount:
description: Number of times user has logged in
2022-09-07 00:16:25 +00:00
format: int64
type: number
2023-03-28 17:47:34 +00:00
ManagerID:
2022-09-07 00:16:25 +00:00
description: Manager
type: string
2023-03-28 17:47:34 +00:00
MobilePhone:
2022-09-07 00:16:25 +00:00
description: Mobile
type: string
2023-03-28 17:47:34 +00:00
Name:
2022-09-07 00:16:25 +00:00
description: Name
type: string
2023-03-28 17:47:34 +00:00
OutOfOfficeMessage:
2022-09-07 00:16:25 +00:00
description: Out of office message
type: string
2023-03-28 17:47:34 +00:00
Phone:
2022-09-07 00:16:25 +00:00
description: Phone
type: string
2023-03-28 17:47:34 +00:00
PortalRole:
2022-09-07 00:16:25 +00:00
description: Portal Role Level
type: string
2023-03-28 17:47:34 +00:00
ProfileID:
2022-09-07 00:16:25 +00:00
description: Profile
type: string
2023-03-28 17:47:34 +00:00
ReceivesAdminEmails:
2022-09-07 00:16:25 +00:00
description: Info Emails
type: boolean
2023-03-28 17:47:34 +00:00
ReceivesAdminInfoEmails:
description: Admin Info Emails
type: boolean
SenderEmail:
2022-09-07 00:16:25 +00:00
description: Email Sender Address
type: string
2023-03-28 17:47:34 +00:00
SenderName:
2022-09-07 00:16:25 +00:00
description: Email Sender Name
type: string
2023-03-28 17:47:34 +00:00
Signature:
2022-09-07 00:16:25 +00:00
description: Email Signature
type: string
2023-03-28 17:47:34 +00:00
SmallPhotoURL:
2022-09-07 00:16:25 +00:00
description: Small Photo URL
type: string
2023-03-28 17:47:34 +00:00
StartOfDay:
2022-09-07 00:16:25 +00:00
description: The time day starts
type: string
2023-03-28 17:47:34 +00:00
TaxnexusAccount:
2022-09-07 00:16:25 +00:00
description: Taxnexus Account
type: string
2023-03-28 17:47:34 +00:00
TenantID:
description: Tenant ID associated with this user
type: string
TenantUsers:
items:
$ref: "#/definitions/TenantUser"
type: array
TimeZone:
2022-09-07 00:16:25 +00:00
description: Time Zone
type: string
2023-03-28 17:47:34 +00:00
Title:
2022-09-07 00:16:25 +00:00
description: Title
type: string
2023-03-28 17:47:34 +00:00
UserRoleID:
2022-09-07 00:16:25 +00:00
description: Role
type: string
2023-03-28 17:47:34 +00:00
UserRoles:
2022-09-07 00:16:25 +00:00
items:
$ref: "#/definitions/UserRole"
type: array
2023-03-28 17:47:34 +00:00
UserType:
description: User Type
type: string
Username:
description: Username
type: string
2022-09-07 00:16:25 +00:00
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:
2023-03-28 17:47:34 +00:00
ID:
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
Auth0roleID:
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
CreatedByID:
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
CreatedDate:
type: string
x-nullable: true
Description:
type: string
LastModifiedByID:
type: string
LastModifiedDate:
type: string
x-nullable: true
Name:
2022-09-07 00:16:25 +00:00
type: string
2023-03-28 17:47:34 +00:00
RoleID:
type: string
UserID:
type: string
SalesforcePostResponse:
description: An array of Print-Ready ingest Objects
properties:
data:
items:
$ref: "#/definitions/SalesforcePost"
type: array
meta:
$ref: "#/definitions/ResponseMeta"
type: object
SalesforcePost:
description: Relationship object that connects user to a role
type: object
properties:
ID:
2022-09-07 00:16:25 +00:00
type: string