9173 lines
241 KiB
YAML
9173 lines
241 KiB
YAML
swagger: "2.0"
|
|
info:
|
|
title: "sf-gate"
|
|
version: 1.3.0
|
|
description: "Salesforce Gateway Microservice"
|
|
termsOfService: "http://taxnexus.net/terms/"
|
|
contact:
|
|
email: "noc@taxnexus.net"
|
|
license:
|
|
name: "Proprietary - Copyright (c) 2018-2021 by Taxnexus, Inc."
|
|
schemes:
|
|
- "http"
|
|
basePath: "/v1"
|
|
host: "sf-gate.fabric.tnxs.net:8080"
|
|
securityDefinitions:
|
|
ApiKeyAuth:
|
|
type: apiKey
|
|
in: header
|
|
name: X-API-Key
|
|
security:
|
|
- ApiKeyAuth: []
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
accountIdQuery:
|
|
description:
|
|
Taxnexus Id of the Account to be used a record retrieval
|
|
in: query
|
|
name: accountId
|
|
required: false
|
|
type: string
|
|
accountIdQueryRequired:
|
|
description:
|
|
Taxnexus Id of the Account to be used a record retrieval
|
|
in: query
|
|
name: accountId
|
|
required: true
|
|
type: string
|
|
accountNumberQuery:
|
|
description:
|
|
The Taxnexus Account Number of the Account to be used a record
|
|
retrieval
|
|
in: query
|
|
name: accountNumber
|
|
required: false
|
|
type: string
|
|
accountRequest:
|
|
description: A request with an array of Account Objects
|
|
in: body
|
|
name: accountRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/AccountRequest"
|
|
accountTypeQuery:
|
|
description: The Type of this Object
|
|
enum:
|
|
- channel_partner_member
|
|
- channel_partner_prospect
|
|
- new
|
|
- other
|
|
- system
|
|
- tax_administrator_member
|
|
- tax_administrator_prospect
|
|
- taxpayer_customer
|
|
- taxpayer_prospect
|
|
in: query
|
|
name: type
|
|
required: false
|
|
type: string
|
|
activeQuery:
|
|
description: Retrieve only active records?
|
|
in: query
|
|
name: active
|
|
required: false
|
|
type: boolean
|
|
addressQuery:
|
|
description: Postal Address URL encoded; partial addresses allowed
|
|
in: query
|
|
name: address
|
|
required: false
|
|
type: string
|
|
apiKeyQuery:
|
|
description: Taxnexus Id of the User to be retrieved
|
|
in: query
|
|
name: apikey
|
|
required: false
|
|
type: string
|
|
authorityIdQuery:
|
|
description: Taxnexus Id of the Authority to be retrieved
|
|
in: query
|
|
name: authorityId
|
|
required: false
|
|
type: string
|
|
authorityRequestBody:
|
|
description: A request with an array of Authority Objects
|
|
in: body
|
|
name: authorityRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/AuthorityRequest"
|
|
roleIdQuery:
|
|
description: Taxnexus Id of the Role to be retrieved
|
|
in: query
|
|
name: roleId
|
|
required: false
|
|
type: string
|
|
backendIdQuery:
|
|
description: Taxnexus Id of the Backend to be retrieved
|
|
in: query
|
|
name: backendId
|
|
required: false
|
|
type: string
|
|
backendRequestBody:
|
|
description: An array of new Backend records
|
|
in: body
|
|
name: backendsRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/BackendRequest"
|
|
cashReceiptIdQuery:
|
|
description: Taxnexus Record Id of a Cash Receipt
|
|
in: query
|
|
name: cashReceiptId
|
|
required: false
|
|
type: string
|
|
cashReceiptRequest:
|
|
description: The response to a Cash Receipt Request
|
|
in: body
|
|
name: cashReceiptRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/CashReceiptRequest"
|
|
clusterIdQuery:
|
|
description: Taxnexus Record Id of a Cluster
|
|
in: query
|
|
name: clusterId
|
|
required: false
|
|
type: string
|
|
databaseIdQuery:
|
|
description: Taxnexus Record Id of a Database
|
|
in: query
|
|
name: databaseId
|
|
required: false
|
|
type: string
|
|
tenantIdQuery:
|
|
description: Taxnexus Record Id of a Tenant
|
|
in: query
|
|
name: tenantId
|
|
required: false
|
|
type: string
|
|
clusterRequest:
|
|
description: An array of Cluster records
|
|
in: body
|
|
name: ClusterRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/ClusterRequest"
|
|
tenantRequest:
|
|
description: An array of Tenant records
|
|
in: body
|
|
name: CTenantRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/TenantRequest"
|
|
databaseRequest:
|
|
description: An array of Database records
|
|
in: body
|
|
name: DatabaseRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/DatabaseRequest"
|
|
companyIdQuery:
|
|
description: Taxnexus Id of the Company to be retrieved
|
|
in: query
|
|
name: companyId
|
|
required: false
|
|
type: string
|
|
contactIdQuery:
|
|
description: Taxnexus Id of the Contact to be retrieved
|
|
in: query
|
|
name: contactId
|
|
required: false
|
|
type: string
|
|
contactRequest:
|
|
description: An array of new Contact records
|
|
in: body
|
|
name: contactsRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/ContactRequest"
|
|
countryIdQuery:
|
|
description: The Country Taxnexus ID
|
|
in: query
|
|
name: countryId
|
|
required: false
|
|
type: string
|
|
countryQuery:
|
|
description: The Country abbreviation (2 char)
|
|
in: query
|
|
name: country
|
|
required: false
|
|
type: string
|
|
countyIdQuery:
|
|
description: The County Taxnexus ID
|
|
in: query
|
|
name: countyId
|
|
required: false
|
|
type: string
|
|
countyQuery:
|
|
description: The County Name
|
|
in: query
|
|
name: county
|
|
required: false
|
|
type: string
|
|
dateFromQuery:
|
|
description: The Starting Date for an object retrieval
|
|
in: query
|
|
name: dateFrom
|
|
required: false
|
|
type: string
|
|
dateToQuery:
|
|
description: The Ending Date for an object retrieval
|
|
in: query
|
|
name: dateTo
|
|
required: false
|
|
type: string
|
|
documentIdQuery:
|
|
description: Taxnexus Id of the Document to be retrieved
|
|
in: query
|
|
name: documentId
|
|
required: false
|
|
type: string
|
|
domainIdQuery:
|
|
description: Taxnexus Id of the Domain to be retrieved
|
|
in: query
|
|
name: domainId
|
|
required: false
|
|
type: string
|
|
domainQuery:
|
|
description: "The Tax Domain to rate (cannabis, sales or telecom)"
|
|
in: query
|
|
name: name
|
|
required: false
|
|
type: string
|
|
filingIdQuery:
|
|
description: Taxnexus Id of the Filing to be retrieved
|
|
in: query
|
|
name: filingId
|
|
required: false
|
|
type: string
|
|
filingRequestBody:
|
|
description: A request with an array of Filing Objects
|
|
in: body
|
|
name: filingRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/FilingRequest"
|
|
filingTypeIdQuery:
|
|
description: Taxnexus Record Id of a Filing
|
|
in: query
|
|
name: filingTypeId
|
|
required: false
|
|
type: string
|
|
filingTypeRequest:
|
|
description: A request with an array of FilingType Objects
|
|
in: body
|
|
name: FilingTypeRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/FilingTypeRequest"
|
|
glAccountRequest:
|
|
description: An array of new Statement records
|
|
in: body
|
|
name: glAccountRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/GlAccountRequest"
|
|
glBalanceIdQueryRequired:
|
|
description: Taxnexus Id of a GL Balance Record
|
|
in: query
|
|
name: glbalanceId
|
|
required: true
|
|
type: string
|
|
idRequestBody:
|
|
description: An array of existing Taxnexus Record IDs
|
|
in: body
|
|
name: idsRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/IdsRequest"
|
|
ingestIdQuery:
|
|
description: Taxnexus Record Id of an Ingest
|
|
in: query
|
|
name: ingestId
|
|
required: false
|
|
type: string
|
|
ingestRequest:
|
|
description: An array of new Ingest records
|
|
in: body
|
|
name: IngestRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/IngestRequest"
|
|
invoiceIdQuery:
|
|
description: Taxnexus Id of the Invoice to be retrieved
|
|
in: query
|
|
name: invoiceId
|
|
required: false
|
|
type: string
|
|
invoiceRequestBody:
|
|
description: An array of new Invoice records
|
|
in: body
|
|
name: invoicesRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/InvoiceRequest"
|
|
jobIdQuery:
|
|
description: Taxnexus Record Id of a Job record
|
|
in: query
|
|
name: jobId
|
|
required: false
|
|
type: string
|
|
jobRequest:
|
|
description: An array of new Job records
|
|
in: body
|
|
name: JobRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/JobRequest"
|
|
journalEntryRequest:
|
|
description: An array of Journal Entry records
|
|
in: body
|
|
name: journalEntryRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/SubmissionRequest"
|
|
licenseIdQuery:
|
|
description: Taxnexus Id of the License to be retrieved
|
|
in: query
|
|
name: licenseId
|
|
required: false
|
|
type: string
|
|
licenseTypeIdQuery:
|
|
description: Taxnexus Id of the License Type to be retrieved
|
|
in: query
|
|
name: licensetypeId
|
|
required: false
|
|
type: string
|
|
limitQuery:
|
|
description: "How many objects to return at one time"
|
|
format: int64
|
|
in: query
|
|
name: limit
|
|
required: false
|
|
type: integer
|
|
masterQuery:
|
|
description: Retrieve only master records?
|
|
in: query
|
|
name: master
|
|
required: false
|
|
type: boolean
|
|
nameQuery:
|
|
description: The Name of this Object
|
|
in: query
|
|
name: name
|
|
required: false
|
|
type: string
|
|
offsetQuery:
|
|
description: How many objects to skip? (default 0)
|
|
format: int64
|
|
in: query
|
|
name: offset
|
|
required: false
|
|
type: integer
|
|
orderIdQuery:
|
|
description: Taxnexus Id of the Company to be retrieved
|
|
in: query
|
|
name: orderId
|
|
required: false
|
|
type: string
|
|
periodIdQuery:
|
|
description: Taxnexus Id of the Period to be used a record retrieval
|
|
in: query
|
|
name: periodId
|
|
required: false
|
|
type: string
|
|
periodIdQueryRequired:
|
|
description:
|
|
Taxnexus Id of the Period to be used in a record retrieval
|
|
in: query
|
|
name: periodId
|
|
required: true
|
|
type: string
|
|
periodNameQueryRequired:
|
|
description: The Taxnexus Accounting Period
|
|
in: query
|
|
name: period
|
|
required: false
|
|
type: string
|
|
periodRequest:
|
|
description: An array of Period records
|
|
in: body
|
|
name: periodRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/PeriodRequest"
|
|
placeIdQuery:
|
|
description: The City name (must be accompanied by State)
|
|
in: query
|
|
name: placeId
|
|
required: false
|
|
type: string
|
|
placeQuery:
|
|
description: The City name (must be accompanied by State)
|
|
in: query
|
|
name: place
|
|
required: false
|
|
type: string
|
|
poIdQuery:
|
|
description: Taxnexus Id of the Purchase Order to be retrieved
|
|
in: query
|
|
name: poId
|
|
required: false
|
|
type: string
|
|
productIdQuery:
|
|
description:
|
|
Taxnexus Id of the Account to be used a record retrieval
|
|
in: query
|
|
name: productId
|
|
required: false
|
|
type: string
|
|
productRequestBody:
|
|
description: A request with an array of Product Objects
|
|
in: body
|
|
name: productRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/ProductRequest"
|
|
productdQuery:
|
|
description: Taxnexus Id of the Product to be retrieved
|
|
in: query
|
|
name: productId
|
|
required: false
|
|
type: string
|
|
quoteIdQuery:
|
|
description: Taxnexus Id of the Company to be retrieved
|
|
in: query
|
|
name: quoteId
|
|
required: false
|
|
type: string
|
|
serviceIdQuery:
|
|
description: Service ID
|
|
in: query
|
|
name: serviceId
|
|
type: string
|
|
serviceRequest:
|
|
description: An array of Service records
|
|
in: body
|
|
name: ServiceRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/ServiceRequest"
|
|
stateIdQuery:
|
|
description: The State or Province abbreviation (2 char)
|
|
in: query
|
|
name: stateId
|
|
required: false
|
|
type: string
|
|
stateQuery:
|
|
description: The State or Province abbreviation (2 char)
|
|
in: query
|
|
name: state
|
|
required: false
|
|
type: string
|
|
statementIdQuery:
|
|
description: Taxnexus Id of the Company to be retrieved
|
|
in: query
|
|
name: statementId
|
|
required: false
|
|
type: string
|
|
statementRequestBody:
|
|
description: An array of new Statement records
|
|
in: body
|
|
name: statementsRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/StatementRequest"
|
|
submissionIdQuery:
|
|
description: Taxnexus Id of the Submisssion to be retrieved
|
|
in: query
|
|
name: submissionId
|
|
required: false
|
|
type: string
|
|
submissionRequestBody:
|
|
description: An array of new Submission records
|
|
in: body
|
|
name: submisssionsRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/SubmissionRequest"
|
|
subscriptionIdQuery:
|
|
description: Taxnexus Id of the Subscription to be retrieved
|
|
in: query
|
|
name: subscriptionId
|
|
required: false
|
|
type: string
|
|
subscriptionRequestBody:
|
|
description: A request with an array of Subscription Objects
|
|
in: body
|
|
name: subscriptionRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/SubscriptionRequest"
|
|
taxInvoiceRequestBody:
|
|
description: A list of InvoiceBasic objects
|
|
in: body
|
|
name: taxInvoicesRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/TaxInvoicesRequest"
|
|
taxOrderRequestBody:
|
|
description: A list of InvoiceBasic objects
|
|
in: body
|
|
name: taxOrdersRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/TaxOrdersRequest"
|
|
taxPoRequestBody:
|
|
description: A list of PurchaseOrderBasic objects
|
|
in: body
|
|
name: taxPosRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/TaxPurchaseOrdersRequest"
|
|
taxQuoteRequestBody:
|
|
description: A list of InvoiceBasic objects
|
|
in: body
|
|
name: taxQuotesRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/TaxQuotesRequest"
|
|
taxTypeAccountIdQuery:
|
|
description: Taxnexus Id of the Tax Type Account to be retrieved
|
|
in: query
|
|
name: taxtypeaccountId
|
|
required: false
|
|
type: string
|
|
taxTypeIdQuery:
|
|
description: Taxnexus Id of the Tax Type to be retrieved
|
|
in: query
|
|
name: taxtypeId
|
|
required: false
|
|
type: string
|
|
taxnexuscodeIdQuery:
|
|
description: Taxnexus Id of the Taxnexus Code to be retrieved
|
|
in: query
|
|
name: taxnexuscodeId
|
|
required: false
|
|
type: string
|
|
templateIdQuery:
|
|
description: Taxnexus Record Id of a Template
|
|
in: query
|
|
name: templateId
|
|
required: false
|
|
type: string
|
|
typeQuery:
|
|
description: The Type of this Object
|
|
in: query
|
|
name: type
|
|
required: false
|
|
type: string
|
|
userIdQuery:
|
|
description: Taxnexus Id of the User to be retrieved
|
|
in: query
|
|
name: userId
|
|
required: false
|
|
type: string
|
|
notebookIdQuery:
|
|
description: Template ID
|
|
in: query
|
|
name: notebookId
|
|
type: string
|
|
notebookRequest:
|
|
description: An array of Notebook records
|
|
in: body
|
|
name: NotebookRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/NotebookRequest"
|
|
responses:
|
|
AccessForbidden:
|
|
description: "Access forbidden, account lacks access"
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
AccountResponse:
|
|
description: Taxnexus Response with Account objects
|
|
schema:
|
|
$ref: "#/definitions/AccountResponse"
|
|
AccountingRuleResponse:
|
|
description: Taxnexus Response with Accounting Rule objects
|
|
schema:
|
|
$ref: "#/definitions/AccountingRuleResponse"
|
|
AccountingRulesetResponse:
|
|
description: Taxnexus Response with Accounting Ruleset objects
|
|
schema:
|
|
$ref: "#/definitions/AccountingRulesetResponse"
|
|
AuthorityResponse:
|
|
description: An array of Authority objects
|
|
schema:
|
|
$ref: "#/definitions/AuthorityResponse"
|
|
BackendResponse:
|
|
description: Taxnexus Response with Backend objects
|
|
schema:
|
|
$ref: "#/definitions/BackendResponse"
|
|
RoleResponse:
|
|
description: Taxnexus Response with Role objects
|
|
schema:
|
|
$ref: "#/definitions/RoleResponse"
|
|
CashReceiptResponse:
|
|
description: Taxnexus Response with Cash Receipt objects
|
|
schema:
|
|
$ref: "#/definitions/CashReceiptResponse"
|
|
ClusterResponse:
|
|
description: Taxnexus Response with Cluster objects
|
|
schema:
|
|
$ref: "#/definitions/ClusterResponse"
|
|
DatabaseResponse:
|
|
description: Taxnexus Response with Database objects
|
|
schema:
|
|
$ref: "#/definitions/DatabaseResponse"
|
|
TenantResponse:
|
|
description: Taxnexus Response with Tenant objects
|
|
schema:
|
|
$ref: "#/definitions/TenantResponse"
|
|
CompanyResponse:
|
|
description: Taxnexus Response with Company objects
|
|
schema:
|
|
$ref: "#/definitions/CompanyResponse"
|
|
Conflict:
|
|
description: Conflict
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
ContactResponse:
|
|
description: An array of Contact objects
|
|
schema:
|
|
$ref: "#/definitions/ContactResponse"
|
|
CountryResponse:
|
|
description: Taxnexus Response with an array of Country objects
|
|
schema:
|
|
$ref: "#/definitions/CountryResponse"
|
|
CountyResponse:
|
|
description: Taxnexus Response with an array of County objects
|
|
schema:
|
|
$ref: "#/definitions/CountyResponse"
|
|
DeleteResponse:
|
|
description: An array of Message Objects with Delete Status
|
|
schema:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Message"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
DomainResponse:
|
|
description: Taxnexus Response with an array of Domain objects
|
|
schema:
|
|
$ref: "#/definitions/DomainResponse"
|
|
FilingResponse:
|
|
description: Taxnexus Response with an array of Filing objects
|
|
schema:
|
|
$ref: "#/definitions/FilingResponse"
|
|
FilingTypeResponse:
|
|
description: Taxnexus Response with an array of FilingType objects
|
|
schema:
|
|
$ref: "#/definitions/FilingTypeResponse"
|
|
GlAccountResponse:
|
|
description: An array of GL Account Objects
|
|
schema:
|
|
$ref: "#/definitions/GlAccountResponse"
|
|
GlBalanceResponse:
|
|
description: An array of GL Balance Objects
|
|
schema:
|
|
$ref: "#/definitions/GlBalanceResponse"
|
|
IngestResponse:
|
|
description: Taxnexus Response with Ingest objects
|
|
schema:
|
|
$ref: "#/definitions/IngestResponse"
|
|
InvalidDataError:
|
|
description: Invalid data was sent
|
|
schema:
|
|
$ref: "#/definitions/InvalidError"
|
|
InvoiceResponse:
|
|
description:
|
|
Taxnexus Response with an array of Invoice (full) objects
|
|
schema:
|
|
$ref: "#/definitions/InvoiceResponse"
|
|
JobResponse:
|
|
description: Taxnexus Response with Job objects
|
|
schema:
|
|
$ref: "#/definitions/JobResponse"
|
|
LicenseResponse:
|
|
description: An array of License Objects
|
|
schema:
|
|
$ref: "#/definitions/LicenseResponse"
|
|
LicenseTypeResponse:
|
|
description: An array of License Type Objects
|
|
schema:
|
|
$ref: "#/definitions/LicenseTypeResponse"
|
|
NotFound:
|
|
description: Resource was not found
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
OrderResponse:
|
|
description: An array of Order objects
|
|
schema:
|
|
$ref: "#/definitions/OrderResponse"
|
|
PeriodResponse:
|
|
description: Taxnexus Response with Period objects
|
|
schema:
|
|
$ref: "#/definitions/PeriodResponse"
|
|
PlaceResponse:
|
|
description: Taxnexus Response with an array of Place objects
|
|
schema:
|
|
$ref: "#/definitions/PlaceResponse"
|
|
ProductResponse:
|
|
description: An array of Product objects
|
|
schema:
|
|
$ref: "#/definitions/ProductResponse"
|
|
PurchaseOrderResponse:
|
|
description: An array of Purchase Order objects
|
|
schema:
|
|
$ref: "#/definitions/PurchaseOrderResponse"
|
|
QuoteResponse:
|
|
description: An array of Quote objects
|
|
schema:
|
|
$ref: "#/definitions/QuoteResponse"
|
|
ServerError:
|
|
description: Server Internal Error
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
ServiceResponse:
|
|
description: Taxnexus Response with Service objects
|
|
schema:
|
|
$ref: "#/definitions/ServiceResponse"
|
|
StateResponse:
|
|
description: Taxnexus Response with an array of State objects
|
|
schema:
|
|
$ref: "#/definitions/StateResponse"
|
|
StatementResponse:
|
|
description: An array of Statement objects
|
|
schema:
|
|
$ref: "#/definitions/StatementResponse"
|
|
SubmissionResponse:
|
|
description: Taxnexus Response with Submission objects
|
|
schema:
|
|
$ref: "#/definitions/SubmissionResponse"
|
|
SubscriptionResponse:
|
|
description: An array of Subscription Objects
|
|
schema:
|
|
$ref: "#/definitions/SubscriptionResponse"
|
|
TaxTransactionResponse:
|
|
description: An array of Tax Transaction Objects
|
|
schema:
|
|
$ref: "#/definitions/TaxTransactionResponse"
|
|
TaxTypeAccountResponse:
|
|
description: An array of TaxTypeAccount objects
|
|
schema:
|
|
$ref: "#/definitions/TaxTypeAccountResponse"
|
|
TaxTypeResponse:
|
|
description: Taxnexus Response with an array of Tax Type objects
|
|
schema:
|
|
$ref: "#/definitions/TaxTypeResponse"
|
|
TaxnexusCodeResponse:
|
|
description:
|
|
Taxnexus Response with an array of Taxnexus Code objects
|
|
schema:
|
|
$ref: "#/definitions/TaxnexusCodeResponse"
|
|
TemplateResponse:
|
|
description: Taxnexus Response with Template objects
|
|
schema:
|
|
$ref: "#/definitions/TemplateResponse"
|
|
Unauthorized:
|
|
description: "Access unauthorized, invalid API-KEY was used"
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
UnprocessableEntity:
|
|
description: "Unprocessable Entity, likely a bad parameter"
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
UserResponse:
|
|
description: Taxnexus Response with User objects
|
|
schema:
|
|
$ref: "#/definitions/UserResponse"
|
|
NotebookResponse:
|
|
description: Taxnexus Response with Notebook objects
|
|
schema:
|
|
$ref: "#/definitions/NotebookResponse"
|
|
paths:
|
|
/accountingrules:
|
|
get:
|
|
description: Return a list of Accounting Rules for an Account
|
|
operationId: getAccountingRules
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/AccountingRuleResponse"
|
|
"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 Accounting Rules
|
|
tags:
|
|
- AccountingRules
|
|
/accountingrulesets:
|
|
get:
|
|
description: Return a list of Accounting Rulesets for an Account
|
|
operationId: getAccountingRulesets
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/AccountingRulesetResponse"
|
|
"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 Accounting Rulesets
|
|
tags:
|
|
- AccountingRulesets
|
|
/accounts:
|
|
get:
|
|
description: Return a list of Accounts
|
|
operationId: getAccounts
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
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"
|
|
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"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
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"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update a single account
|
|
tags:
|
|
- Accounts
|
|
/authorities:
|
|
get:
|
|
description: Return a list of available Authorities
|
|
operationId: getAuthorities
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/authorityIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/AuthorityResponse"
|
|
"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 Authorities
|
|
tags:
|
|
- Authorities
|
|
/backends:
|
|
get:
|
|
description: Return a list of Backends
|
|
operationId: getBackends
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/backendIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/BackendResponse"
|
|
"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 Backends
|
|
tags:
|
|
- Backends
|
|
/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
|
|
tags:
|
|
- Roles
|
|
/cashreceipts:
|
|
get:
|
|
description: Return a list of available Taxnexus Cash Receipts
|
|
operationId: getCashReceipts
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
- $ref: "#/parameters/cashReceiptIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/CashReceiptResponse"
|
|
"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 Cash Receipts
|
|
tags:
|
|
- CashReceipts
|
|
post:
|
|
description: Create New Cash Receipts
|
|
operationId: postCashReceipts
|
|
parameters:
|
|
- in: body
|
|
name: cashReceiptRequest
|
|
schema:
|
|
$ref: "#/definitions/CashReceiptRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/CashReceiptResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Cash Receipts
|
|
tags:
|
|
- CashReceipts
|
|
put:
|
|
description: Put a list of Cash Receipts
|
|
operationId: putCashRecipts
|
|
parameters:
|
|
- in: body
|
|
name: cashReceiptRequest
|
|
schema:
|
|
$ref: "#/definitions/CashReceiptRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/CashReceiptResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Put a list of Cash Receipts
|
|
tags:
|
|
- CashReceipts
|
|
/clusters:
|
|
get:
|
|
description: Return a list of Cluster records from the datastore
|
|
operationId: getClusters
|
|
parameters:
|
|
- $ref: "#/parameters/clusterIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $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"
|
|
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"
|
|
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"
|
|
summary: Update Clustera
|
|
tags:
|
|
- Clusters
|
|
/tenants:
|
|
get:
|
|
description: Return a list of Tenant records from the datastore
|
|
operationId: getTenants
|
|
parameters:
|
|
- $ref: "#/parameters/tenantIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $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
|
|
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
|
|
tags:
|
|
- Tenants
|
|
/databases:
|
|
get:
|
|
description: Return a list of Database records from the datastore
|
|
operationId: getDatabases
|
|
parameters:
|
|
- $ref: "#/parameters/databaseIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $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
|
|
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
|
|
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
|
|
tags:
|
|
- Databases
|
|
/companies:
|
|
get:
|
|
description: Retrieve a Company record from the datastore
|
|
operationId: getCompanies
|
|
parameters:
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/CompanyResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a Company record
|
|
tags:
|
|
- Companies
|
|
/contacts:
|
|
delete:
|
|
description: Delete Taxnexus Contact record
|
|
operationId: deleteContact
|
|
parameters:
|
|
- $ref: "#/parameters/contactIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/DeleteResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Delete a Contact
|
|
tags:
|
|
- Contacts
|
|
get:
|
|
description: Return a list of all available Contacts
|
|
operationId: getContacts
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/contactIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
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"
|
|
summary: Get a list of contacts
|
|
tags:
|
|
- Contacts
|
|
post:
|
|
description: Contact 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"
|
|
summary: Add new contacts
|
|
tags:
|
|
- Contacts
|
|
put:
|
|
description: Update Contact records
|
|
operationId: putContacts
|
|
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"
|
|
summary: Update Contact
|
|
tags:
|
|
- Contacts
|
|
/counties:
|
|
get:
|
|
description: "Retrieve Counties, filter with parameters"
|
|
operationId: getCounties
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/stateQuery"
|
|
- $ref: "#/parameters/countyIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/CountyResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Retrieve Counties
|
|
tags:
|
|
- Counties
|
|
/countries:
|
|
get:
|
|
description: "Retrieve Countries, filter with parameters"
|
|
operationId: getCountries
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/countryIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/CountryResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Retrieve Countries
|
|
tags:
|
|
- Countries
|
|
/domains:
|
|
get:
|
|
description:
|
|
"Return all of the Commerce Domains in the Taxnexus system.
|
|
Domains categorize general categories of commerce, such as
|
|
Merchandise, Wholesale Goods, Wholesale Trade, Services, etc."
|
|
operationId: getDomains
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/domainQuery"
|
|
- $ref: "#/parameters/domainIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/DomainResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get Domain records
|
|
tags:
|
|
- Domains
|
|
/filings:
|
|
get:
|
|
description: Return a list of available Regulatory Filings
|
|
operationId: getFilings
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/domainQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/filingIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/FilingResponse"
|
|
"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 Filings
|
|
tags:
|
|
- Filings
|
|
post:
|
|
description: Create new Filings
|
|
operationId: postFilings
|
|
parameters:
|
|
- $ref: "#/parameters/filingRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/FilingResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Filings
|
|
tags:
|
|
- Filings
|
|
put:
|
|
description:
|
|
Update all the fields in a Filing record identified by Taxnexus
|
|
ID
|
|
operationId: putFilings
|
|
parameters:
|
|
- $ref: "#/parameters/filingRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/FilingResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update a Filing
|
|
tags:
|
|
- Filings
|
|
/filingtypes:
|
|
get:
|
|
description: Return a list of available Regulatory FilingTypes
|
|
operationId: getFilingTypes
|
|
parameters:
|
|
- $ref: "#/parameters/filingTypeIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/FilingTypeResponse"
|
|
"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 FilingTypes
|
|
tags:
|
|
- FilingTypes
|
|
post:
|
|
description: Create new FilingTypes
|
|
operationId: postFilingTypes
|
|
parameters:
|
|
- $ref: "#/parameters/filingTypeRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/FilingTypeResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new FilingTypes
|
|
tags:
|
|
- FilingTypes
|
|
put:
|
|
description:
|
|
Update all the fields in a FilingType record identified by
|
|
Taxnexus ID
|
|
operationId: putFilingTypes
|
|
parameters:
|
|
- $ref: "#/parameters/filingTypeRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/FilingTypeResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update a FilingType
|
|
tags:
|
|
- FilingTypes
|
|
/glaccounts:
|
|
get:
|
|
description: Return a list of available General Ledger Accounts
|
|
operationId: getGlAccounts
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/GlAccountResponse"
|
|
"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 General Ledger Accounts
|
|
tags:
|
|
- GlAccounts
|
|
/glbalances:
|
|
get:
|
|
description:
|
|
Return a list of General Ledger Account Balances for a Taxnexus
|
|
Account
|
|
operationId: getGlBalances
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/GlBalanceResponse"
|
|
"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 General Ledger Account Balances
|
|
tags:
|
|
- GlBalances
|
|
/ingests:
|
|
get:
|
|
description: Return a list of Print-Ready Ingest records
|
|
operationId: getIngests
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/accountNumberQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/ingestIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/IngestResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list Ingests
|
|
tags:
|
|
- Ingests
|
|
post:
|
|
description: Update Ingests
|
|
operationId: postIngests
|
|
parameters:
|
|
- $ref: "#/parameters/ingestRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/IngestResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Ingests
|
|
tags:
|
|
- Ingests
|
|
put:
|
|
description: Update Ingests
|
|
operationId: putIngests
|
|
parameters:
|
|
- $ref: "#/parameters/ingestRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/IngestResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Ingests
|
|
tags:
|
|
- Ingests
|
|
/invoices:
|
|
get:
|
|
description: Return a list of available Taxnexus Invoices
|
|
operationId: getInvoices
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/invoiceIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/InvoiceResponse"
|
|
"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 Invoices
|
|
tags:
|
|
- Invoices
|
|
post:
|
|
description: Create New Invoices
|
|
operationId: postInvoices
|
|
parameters:
|
|
- in: body
|
|
name: invoiceRequest
|
|
schema:
|
|
$ref: "#/definitions/InvoiceRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/InvoiceResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create a new Invoice
|
|
tags:
|
|
- Invoices
|
|
put:
|
|
description: Put a list of Invoices
|
|
operationId: putInvoices
|
|
parameters:
|
|
- in: body
|
|
name: invoiceRequest
|
|
schema:
|
|
$ref: "#/definitions/InvoiceRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/InvoiceResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Put a list of Invoices
|
|
tags:
|
|
- Invoices
|
|
/jobs:
|
|
get:
|
|
description: Return a list of Job records from the datastore
|
|
operationId: getJobs
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/accountNumberQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/jobIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/JobResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list Jobs
|
|
tags:
|
|
- Jobs
|
|
post:
|
|
description: Create and enqueue Jobs in Taxnexus
|
|
operationId: postJobs
|
|
parameters:
|
|
- $ref: "#/parameters/jobRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/JobResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Jobs
|
|
tags:
|
|
- Jobs
|
|
put:
|
|
description: Update Jobs in Taxnexus
|
|
operationId: putJobs
|
|
parameters:
|
|
- $ref: "#/parameters/jobRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/JobResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Jobs
|
|
tags:
|
|
- Jobs
|
|
/licenses:
|
|
get:
|
|
description: "Retrieve all licenses, filter with parameters"
|
|
operationId: getLicenses
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/licenseIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/LicenseResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Retrieve licenses
|
|
tags:
|
|
- Licenses
|
|
post:
|
|
description: Create new Licenses
|
|
operationId: postLicenses
|
|
parameters:
|
|
- description: The new licenses
|
|
in: body
|
|
name: licenseRequest
|
|
schema:
|
|
$ref: "#/definitions/LicenseRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/LicenseResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Licenses
|
|
tags:
|
|
- Licenses
|
|
put:
|
|
description: Add or update licenses
|
|
operationId: putLicenses
|
|
parameters:
|
|
- description: The updated licenses
|
|
in: body
|
|
name: licenseRequest
|
|
schema:
|
|
$ref: "#/definitions/LicenseRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/LicenseResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Upsert a License
|
|
tags:
|
|
- Licenses
|
|
/licensetypes:
|
|
get:
|
|
description: Retrieve LicenseType records
|
|
operationId: getLicenseTypes
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/licenseTypeIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/LicenseTypeResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Retrieve LicenseType records
|
|
tags:
|
|
- LicenseTypes
|
|
/orders:
|
|
get:
|
|
description: Return a list of Orders
|
|
operationId: getOrders
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/accountNumberQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/orderIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/OrderResponse"
|
|
"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 Orders
|
|
tags:
|
|
- Orders
|
|
post:
|
|
description: Create new Orders
|
|
operationId: postOrders
|
|
parameters:
|
|
- in: body
|
|
name: order
|
|
schema:
|
|
$ref: "#/definitions/OrderBasicRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/OrderResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Orders
|
|
tags:
|
|
- Orders
|
|
put:
|
|
description: Create new Orders
|
|
operationId: putOrders
|
|
parameters:
|
|
- in: body
|
|
name: order
|
|
schema:
|
|
$ref: "#/definitions/Order"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/OrderResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Orders
|
|
tags:
|
|
- Orders
|
|
/periods:
|
|
get:
|
|
description: Return a list of Periods for an Account
|
|
operationId: getPeriods
|
|
parameters:
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/periodIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PeriodResponse"
|
|
"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 Periods
|
|
tags:
|
|
- Periods
|
|
/places:
|
|
get:
|
|
description: "Retrieve Places, filter with parameters"
|
|
operationId: getPlaces
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/stateQuery"
|
|
- $ref: "#/parameters/placeIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PlaceResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Retrieve Places
|
|
tags:
|
|
- Places
|
|
/pos:
|
|
get:
|
|
description: Return a list of available Purchase Orders
|
|
operationId: getPos
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/poIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PurchaseOrderResponse"
|
|
"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 Purchase Orders
|
|
tags:
|
|
- PurchaseOrders
|
|
post:
|
|
description: Create New Purchase Order
|
|
operationId: postPos
|
|
parameters:
|
|
- in: body
|
|
name: purchaseOrderRequest
|
|
schema:
|
|
$ref: "#/definitions/PurchaseOrderRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PurchaseOrderResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create a new Purchase Order
|
|
tags:
|
|
- PurchaseOrders
|
|
put:
|
|
description: Upsert a list of Purchase Order
|
|
operationId: putPos
|
|
parameters:
|
|
- in: body
|
|
name: purchaseOrderRequest
|
|
schema:
|
|
$ref: "#/definitions/PurchaseOrderRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PurchaseOrderResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Upsert a list of Purchase Order
|
|
tags:
|
|
- PurchaseOrders
|
|
/products:
|
|
get:
|
|
description: Return a list of all available Products
|
|
operationId: getProducts
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/productIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/ProductResponse"
|
|
"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 Products
|
|
tags:
|
|
- Products
|
|
/quotes:
|
|
get:
|
|
description: Return a list of available Taxnexus Quotes
|
|
operationId: getQuotes
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/accountNumberQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/quoteIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/QuoteResponse"
|
|
"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 Quotes
|
|
tags:
|
|
- Quotes
|
|
post:
|
|
description: Create new Quotes
|
|
operationId: postQuotes
|
|
parameters:
|
|
- in: body
|
|
name: order
|
|
schema:
|
|
$ref: "#/definitions/Order"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/QuoteResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Quotes
|
|
tags:
|
|
- Quotes
|
|
put:
|
|
description: Update QUotes
|
|
operationId: putQuotes
|
|
parameters:
|
|
- in: body
|
|
name: order
|
|
schema:
|
|
$ref: "#/definitions/Order"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/QuoteResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Quotes
|
|
tags:
|
|
- Quotes
|
|
/services:
|
|
get:
|
|
description: Return a list of Services records from the datastore
|
|
operationId: getServices
|
|
parameters:
|
|
- $ref: "#/parameters/serviceIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/ServiceResponse"
|
|
"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 Services
|
|
tags:
|
|
- Services
|
|
post:
|
|
description: Create Services in Taxnexus
|
|
operationId: postServices
|
|
parameters:
|
|
- $ref: "#/parameters/serviceRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/ServiceResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Services
|
|
tags:
|
|
- Services
|
|
put:
|
|
description: Update Services in Taxnexus
|
|
operationId: putServices
|
|
parameters:
|
|
- $ref: "#/parameters/serviceRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/ServiceResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Services
|
|
tags:
|
|
- Services
|
|
/statements:
|
|
get:
|
|
description: Return a list of all available Statements
|
|
operationId: getStatements
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/accountNumberQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/statementIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/StatementResponse"
|
|
"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 statements
|
|
tags:
|
|
- Statements
|
|
post:
|
|
description:
|
|
Create a new Statement for a particular Account with a Date
|
|
Range
|
|
operationId: postStatements
|
|
parameters:
|
|
- $ref: "#/parameters/statementRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/StatementResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Statements
|
|
tags:
|
|
- Statements
|
|
/states:
|
|
get:
|
|
description: "Retrieve States, filter with parameters"
|
|
operationId: getStates
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/countryQuery"
|
|
- $ref: "#/parameters/stateIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/StateResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Retrieve States
|
|
tags:
|
|
- States
|
|
/submissions:
|
|
get:
|
|
description: Return a list of available Submissions
|
|
operationId: getSubmissions
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/submissionIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/SubmissionResponse"
|
|
"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 Submissions
|
|
tags:
|
|
- Submissions
|
|
post:
|
|
description: Create new Sumissions
|
|
operationId: postSubmissions
|
|
parameters:
|
|
- $ref: "#/parameters/submissionRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/SubmissionResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Submissions
|
|
tags:
|
|
- Submissions
|
|
put:
|
|
description:
|
|
Update all the fields in a Submission record identified by
|
|
Taxnexus Id
|
|
operationId: putSubmissions
|
|
parameters:
|
|
- $ref: "#/parameters/submissionRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/SubmissionResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update a Submission
|
|
tags:
|
|
- Submissions
|
|
/subscriptions:
|
|
get:
|
|
description: Return a list of available Subscriptions
|
|
operationId: getSubscriptions
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/companyIdQuery"
|
|
- $ref: "#/parameters/subscriptionIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/SubscriptionResponse"
|
|
"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 Subscriptions
|
|
tags:
|
|
- Subscriptions
|
|
post:
|
|
description: Create new Sumissions
|
|
operationId: postSubscriptions
|
|
parameters:
|
|
- $ref: "#/parameters/subscriptionRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/SubscriptionResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Subscriptions
|
|
tags:
|
|
- Subscriptions
|
|
put:
|
|
description:
|
|
Update all the fields in a Subscription record identified by
|
|
Taxnexus Id
|
|
operationId: putSubscriptions
|
|
parameters:
|
|
- $ref: "#/parameters/subscriptionRequestBody"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/SubscriptionResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update a Subscription
|
|
tags:
|
|
- Subscriptions
|
|
/taxnexuscodes:
|
|
get:
|
|
description: Return a list of TaxnexusCodes
|
|
operationId: getTaxnexusCodes
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/taxnexuscodeIdQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/TaxnexusCodeResponse"
|
|
"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 TaxnexusCodes
|
|
tags:
|
|
- TaxnexusCodes
|
|
/taxtypeaccounts:
|
|
get:
|
|
description: Return a list of Tax Type Accounts
|
|
operationId: getTaxTypeAccounts
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/accountIdQuery"
|
|
- $ref: "#/parameters/placeQuery"
|
|
- $ref: "#/parameters/stateQuery"
|
|
- $ref: "#/parameters/countyQuery"
|
|
- $ref: "#/parameters/countryQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
- $ref: "#/parameters/taxTypeAccountIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/TaxTypeAccountResponse"
|
|
"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 Tax Type Accounts
|
|
tags:
|
|
- TaxTypeAccounts
|
|
post:
|
|
description: Create a new Tax Type Account
|
|
operationId: postTaxTypeAccounts
|
|
parameters:
|
|
- description: The new Tax Type Account
|
|
in: body
|
|
name: taxtypeaccount
|
|
schema:
|
|
$ref: "#/definitions/TaxTypeAccountRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/TaxTypeAccountResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Tax Type Accounts
|
|
tags:
|
|
- TaxTypeAccounts
|
|
put:
|
|
description: Update a TaxTypeAccount
|
|
operationId: putTaxTypeAccounts
|
|
parameters:
|
|
- in: body
|
|
name: taxtypeaccount
|
|
schema:
|
|
$ref: "#/definitions/TaxTypeAccountRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/TaxTypeAccountResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update TaxTypeAccounts
|
|
tags:
|
|
- TaxTypeAccounts
|
|
/taxtypes:
|
|
get:
|
|
description:
|
|
Return a complete list of all the tax types handled by Taxnexus;
|
|
use the lat long parameters to retrieve a Situs lookup
|
|
operationId: getTaxTypes
|
|
parameters:
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
- $ref: "#/parameters/addressQuery"
|
|
- $ref: "#/parameters/placeQuery"
|
|
- $ref: "#/parameters/stateQuery"
|
|
- $ref: "#/parameters/countyQuery"
|
|
- $ref: "#/parameters/countryQuery"
|
|
- $ref: "#/parameters/activeQuery"
|
|
- $ref: "#/parameters/taxTypeIdQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/TaxTypeResponse"
|
|
"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 Tax Types
|
|
tags:
|
|
- TaxTypes
|
|
/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
|
|
tags:
|
|
- Templates
|
|
/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
|
|
tags:
|
|
- Users
|
|
/notebooks:
|
|
get:
|
|
description: Return a list of Notebook records from the datastore
|
|
operationId: getNotebooks
|
|
parameters:
|
|
- $ref: "#/parameters/notebookIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/NotebookResponse"
|
|
"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 Notebooks
|
|
tags:
|
|
- Notebooks
|
|
post:
|
|
description: Create Notebooks in Taxnexus
|
|
operationId: postNotebooks
|
|
parameters:
|
|
- $ref: "#/parameters/notebookRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/NotebookResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Create new Notebooks
|
|
tags:
|
|
- Notebooks
|
|
put:
|
|
description: Update Notebooks in Taxnexus
|
|
operationId: putNotebooks
|
|
parameters:
|
|
- $ref: "#/parameters/notebookRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/NotebookResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Notebooks
|
|
tags:
|
|
- Notebooks
|
|
definitions:
|
|
AccountingRule:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
id:
|
|
type: string
|
|
description: Taxnexus Record Id
|
|
accountid:
|
|
type: string
|
|
description: The Account for whom this Account Rule exists
|
|
code:
|
|
type: string
|
|
description: The Code used for Accounting Rule Lookups
|
|
cogsaccountid:
|
|
type: string
|
|
description:
|
|
The Cost of Goods Sold account to be used for this Accounting
|
|
Rule
|
|
cogsaccountname:
|
|
type: string
|
|
description: COGS Account Name
|
|
createdbyid:
|
|
type: string
|
|
description: Created By
|
|
createddate:
|
|
type: string
|
|
description: Created Date
|
|
creditaccountid:
|
|
type: string
|
|
description:
|
|
The GL Account that is the Credit Account to be used in this
|
|
Accounting Rule
|
|
creditaccountname:
|
|
type: string
|
|
description: Credit Account Name
|
|
debitaccountid:
|
|
type: string
|
|
description:
|
|
The GL Account that is the Debit Account to be used in this
|
|
Accounting Rule
|
|
debitaccountname:
|
|
type: string
|
|
description: Debit Account Name
|
|
description:
|
|
type: string
|
|
description: Description
|
|
inventoryaccountid:
|
|
type: string
|
|
description:
|
|
The GL Account that is the Inventory Account to be used in
|
|
this Accounting Rule
|
|
inventoryaccountname:
|
|
type: string
|
|
description: Inventory Account Name
|
|
isdeferred:
|
|
type: boolean
|
|
description:
|
|
Is this a deferred tax, not to be charged on the invoice?
|
|
lastmodifiedbyid:
|
|
type: string
|
|
description: Last Modified By
|
|
lastmodifieddate:
|
|
type: string
|
|
description: Last Modified Date
|
|
parentfk:
|
|
type: string
|
|
description: Parent Foreign Key
|
|
proportion:
|
|
type: number
|
|
description:
|
|
The Proportion of Revenue which is governed by this Accounting
|
|
Rule; used for proportional taxing of products and services
|
|
AccountingRuleRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/AccountingRule"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
AccountingRuleResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/AccountingRule"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
AccountingRuleset:
|
|
type: object
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
id:
|
|
type: string
|
|
description: Taxnexus Record Id
|
|
accountid:
|
|
type: string
|
|
description: Taxnexus Account ID
|
|
code:
|
|
type: string
|
|
description: Accounting Ruleset Code
|
|
createdbyid:
|
|
type: string
|
|
description: Created By
|
|
createddate:
|
|
type: string
|
|
description: Created Date
|
|
description:
|
|
type: string
|
|
description: Ruleset Description
|
|
lastmodifiedbyid:
|
|
type: string
|
|
description: Last Modified By
|
|
lastmodifieddate:
|
|
type: string
|
|
description: Last Modified Date
|
|
number:
|
|
type: string
|
|
description: Taxnexus Ruleset Number
|
|
items:
|
|
items:
|
|
$ref: "#/definitions/AccountingRulesetItem"
|
|
type: array
|
|
AccountingRulesetRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/AccountingRuleset"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
AccountingRulesetResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/AccountingRuleset"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
AccountingRulesetItem:
|
|
type: object
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
id:
|
|
type: string
|
|
description: Taxnexus Record Id
|
|
accountingrulecode:
|
|
type: string
|
|
description: The code of the rule in this ruleset
|
|
Account:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountnumber:
|
|
description: Account Number
|
|
type: string
|
|
accountsource:
|
|
description: The marketing orgin of this account
|
|
type: string
|
|
active:
|
|
description: Active
|
|
type: boolean
|
|
administrativelevel:
|
|
description:
|
|
"For tax authorities, this account's administrative level,
|
|
e.g. Local, County, State or Federal"
|
|
type: string
|
|
amount:
|
|
description: Rollup Tax Amount
|
|
type: number
|
|
amountinvoiced:
|
|
description: Amount Invoiced
|
|
type: number
|
|
amountpaid:
|
|
description: Amount Paid
|
|
type: number
|
|
annualrevenue:
|
|
description: Annual Revenue Estimate
|
|
format: double
|
|
type: number
|
|
balance:
|
|
description: Account Balance
|
|
type: number
|
|
billingaddress:
|
|
$ref: "#/definitions/Address"
|
|
billingcontactid:
|
|
description: Contact ID
|
|
type: string
|
|
billingpreference:
|
|
description: Billing Preference
|
|
type: string
|
|
businessaddress:
|
|
$ref: "#/definitions/Address"
|
|
cannabiscustomer:
|
|
type: boolean
|
|
description: Is this a cannabis customer?
|
|
channelprogramlevelname:
|
|
description: Channel Program Level Name
|
|
type: string
|
|
channelprogramname:
|
|
description: Channel Program Name
|
|
type: string
|
|
clientenddate:
|
|
description: Client End Date
|
|
type: string
|
|
clientstartdate:
|
|
description: Client Start Date
|
|
type: string
|
|
companyid:
|
|
description: The Company ID of this Account
|
|
type: string
|
|
coordinateid:
|
|
description: The Id of the geo coordinates of this account
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
customerid:
|
|
description: Customer ID from source system
|
|
type: string
|
|
customerpriority:
|
|
description: Customer Priority
|
|
type: string
|
|
dandbcompanyid:
|
|
description: D-n-B Company
|
|
type: string
|
|
dba:
|
|
description: This Account's 'Doing Business As' name
|
|
type: string
|
|
defaultaddress:
|
|
$ref: "#/definitions/Address"
|
|
defaultbackendid:
|
|
description: Default Backend ID
|
|
type: string
|
|
defaultdeliverycontactid:
|
|
description: Default Delivery Address Contact ID
|
|
type: string
|
|
defaultenduserid:
|
|
description: Default End User Contact ID
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
dunsnumber:
|
|
description: D-U-N-S Number
|
|
type: string
|
|
ein:
|
|
description: EIN
|
|
type: string
|
|
email:
|
|
description: Main Account Email
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Enrollment Status
|
|
type: string
|
|
fax:
|
|
description: Fax
|
|
type: string
|
|
id:
|
|
description: Taxnexus Account Id
|
|
type: string
|
|
industry:
|
|
description: Industry
|
|
type: string
|
|
iscustomerportal:
|
|
description: Customer Portal Account
|
|
type: boolean
|
|
ispartner:
|
|
description: Partner Account
|
|
type: boolean
|
|
ispcustomer:
|
|
description: ISP Customer?
|
|
type: boolean
|
|
jigsaw:
|
|
description: Data.com Key
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
mspcustomer:
|
|
description: MSP Customer?
|
|
type: boolean
|
|
naicscode:
|
|
description: NAICS Code
|
|
type: string
|
|
naicsdesc:
|
|
description: NAICS Description
|
|
type: string
|
|
name:
|
|
description: Account Name
|
|
type: string
|
|
numberofemployees:
|
|
description: Employee Count Estimate
|
|
type: number
|
|
format: int64
|
|
numberoflocations:
|
|
description: Number of Locations Estimate
|
|
type: number
|
|
format: int64
|
|
opencharges:
|
|
description: Open Charges
|
|
type: number
|
|
ordercontactid:
|
|
description: Vendor Order Contact ID
|
|
type: string
|
|
orderemail:
|
|
description: Order Email
|
|
type: string
|
|
ownerid:
|
|
description: Account Owner User ID
|
|
type: string
|
|
ownership:
|
|
description: Ownership
|
|
type: string
|
|
parentfk:
|
|
description: Parent Foreign Key
|
|
type: string
|
|
parentid:
|
|
description: Parent Account
|
|
type: string
|
|
phone:
|
|
description: Phone
|
|
type: string
|
|
placeid:
|
|
description:
|
|
The ID of the Place situs record that applies to this Account
|
|
type: string
|
|
preparerid:
|
|
description: Tax Preparer Contact ID
|
|
type: string
|
|
rating:
|
|
description: Rating
|
|
type: string
|
|
ratingengineid:
|
|
description: Rating Engine identifier
|
|
type: string
|
|
ref:
|
|
description: External Reference ID
|
|
type: string
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
type: number
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
type: number
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
type: number
|
|
shippingaddress:
|
|
$ref: "#/definitions/Address"
|
|
shippingcensustract:
|
|
description: Shipping Census Tract
|
|
type: string
|
|
shippingcounty:
|
|
description: Shipping County
|
|
type: string
|
|
shippingcontactid:
|
|
description: Shipping Contact ID
|
|
type: string
|
|
sic:
|
|
description: SIC Code
|
|
type: string
|
|
sicdesc:
|
|
description: SIC Description
|
|
type: string
|
|
site:
|
|
description: Account Site
|
|
type: string
|
|
status:
|
|
description: Account Status
|
|
type: string
|
|
taxexemption:
|
|
description: Tax Exemption
|
|
type: string
|
|
taxontax:
|
|
description: Rollup Tax On Tax
|
|
type: number
|
|
telecomcustomer:
|
|
description: Telecom Customer?
|
|
type: boolean
|
|
tickersymbol:
|
|
description: Ticker Symbol
|
|
type: string
|
|
tradestyle:
|
|
description: Tradestyle
|
|
type: string
|
|
type:
|
|
description: Type
|
|
type: string
|
|
unappliedpayments:
|
|
description: Unapplied Payments
|
|
type: number
|
|
unitbase:
|
|
description: Rollup Unit Base
|
|
type: number
|
|
upsellopportunity:
|
|
description: Upsell Opportunity
|
|
type: string
|
|
website:
|
|
description: Website
|
|
type: string
|
|
whmcsclientid:
|
|
description: WHMCS Client ID
|
|
type: number
|
|
format: int64
|
|
xerocontactid:
|
|
description: Xero Contact ID
|
|
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
|
|
Authority:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
addressline1:
|
|
description: Address Line 1
|
|
type: string
|
|
addressline2:
|
|
description: Address Line 2
|
|
type: string
|
|
btn:
|
|
description: Billing Telephone Number
|
|
type: string
|
|
city:
|
|
description: City
|
|
type: string
|
|
contactid:
|
|
description: Contact ID
|
|
type: string
|
|
country:
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
date:
|
|
type: string
|
|
dateapproved:
|
|
description: Date Approved
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Identifier
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
losingcarrier:
|
|
description: Losing Carrier
|
|
type: string
|
|
name:
|
|
description: Authority Number
|
|
type: string
|
|
nameline1:
|
|
description: Name Line 1
|
|
type: string
|
|
nameline2:
|
|
description: Name Line 2
|
|
type: string
|
|
opportunityid:
|
|
description: Opportunity ID
|
|
type: string
|
|
orderid:
|
|
description: Order ID
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
postalcode:
|
|
description: Zip Code
|
|
type: string
|
|
quoteid:
|
|
description: Quote ID
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
state:
|
|
description: State
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
transferdate:
|
|
description: Transfer Date
|
|
type: string
|
|
type:
|
|
description: Authority Type
|
|
type: string
|
|
type: object
|
|
AuthorityRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Authority"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
AuthorityResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Authority"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Backend:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: The Account that owns this Backend
|
|
type: string
|
|
active:
|
|
description: Active
|
|
type: boolean
|
|
apikey:
|
|
description: apikey
|
|
type: string
|
|
applicationname:
|
|
description: Used to identify the State were required
|
|
type: string
|
|
authtype:
|
|
description: Authentication Type
|
|
type: string
|
|
backendname:
|
|
description: Backend Name
|
|
type: string
|
|
baseurl:
|
|
description: base_url
|
|
type: string
|
|
callbackurl:
|
|
description: callback_url
|
|
type: string
|
|
clientid:
|
|
description: client_id
|
|
type: string
|
|
clientsecret:
|
|
description: client_secret
|
|
type: string
|
|
companyid:
|
|
description: Company
|
|
type: string
|
|
createdbyid:
|
|
type: string
|
|
description: Created By
|
|
createddate:
|
|
type: string
|
|
description: Created Date
|
|
description:
|
|
description: Description
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
lastmodifiedbyid:
|
|
type: string
|
|
description: Last Modified By
|
|
lastmodifieddate:
|
|
type: string
|
|
description: Last Modified Date
|
|
loginurl:
|
|
description: login_url
|
|
type: string
|
|
managementpassword:
|
|
description: Management Password
|
|
type: string
|
|
managementurl:
|
|
description: Management URL
|
|
type: string
|
|
managementusername:
|
|
description: Management Username
|
|
type: string
|
|
metrclicense:
|
|
description: MetrcLicense
|
|
type: string
|
|
metrcstate:
|
|
description: MetrcState
|
|
type: string
|
|
ownerid:
|
|
description: Ownerid
|
|
type: string
|
|
password:
|
|
description: password
|
|
type: string
|
|
production:
|
|
description: Production
|
|
type: boolean
|
|
projectid:
|
|
description: project_id
|
|
type: string
|
|
providercredentials:
|
|
description: Provider Credentials
|
|
type: string
|
|
realm:
|
|
description: realm
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
resellerbackendid:
|
|
description: Resellerbackendid
|
|
type: string
|
|
securitytoken:
|
|
description: security_token
|
|
type: string
|
|
timeout:
|
|
description: Timeout
|
|
format: int64
|
|
type: number
|
|
tokenuri:
|
|
description: token_uri
|
|
type: string
|
|
type:
|
|
description: Type
|
|
type: string
|
|
username:
|
|
description: username
|
|
type: string
|
|
vendor:
|
|
description: Backend Vendor Name
|
|
type: string
|
|
type: object
|
|
BackendRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Backend"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
BackendResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Backend"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
CashReceipt:
|
|
description:
|
|
Cash Receipt tracks all cash transactions in and out of the
|
|
enterprise
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountbalance:
|
|
description: Account Balance
|
|
type: number
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
accountname:
|
|
description: Account Name
|
|
type: string
|
|
amount:
|
|
description: Amount
|
|
type: number
|
|
appliedamount:
|
|
description: Applied Amount
|
|
type: number
|
|
attempt_number:
|
|
description: Attempt Number
|
|
type: number
|
|
auditmessage:
|
|
description: Audit Trail Message
|
|
type: string
|
|
autopay:
|
|
description: Autopay?
|
|
type: boolean
|
|
billingcontactid:
|
|
description: Billing Contact
|
|
type: string
|
|
billingrunid:
|
|
description: Billing Run
|
|
type: string
|
|
createdbyid:
|
|
description: Created By
|
|
type: string
|
|
customerid:
|
|
description: Customer Id
|
|
type: string
|
|
date:
|
|
description: Journal Date
|
|
type: string
|
|
description:
|
|
description: Memo
|
|
type: string
|
|
gateway:
|
|
description: Gateway
|
|
type: string
|
|
gatewaykey:
|
|
description: Gateway Key
|
|
type: string
|
|
gatewaymessage:
|
|
description: Gateway Message
|
|
type: string
|
|
gatewaytxn:
|
|
description: GatewayTxn?
|
|
type: boolean
|
|
id:
|
|
description: Taxnexus Record ID
|
|
type: string
|
|
invoiceid:
|
|
description: Invoice
|
|
type: string
|
|
isvalid:
|
|
description: Is Valid?
|
|
type: boolean
|
|
lastmodifiedbyid:
|
|
description: Last Modified By
|
|
type: string
|
|
name:
|
|
description: Payment Number
|
|
type: string
|
|
parentfk:
|
|
description: Parent Foreign Key
|
|
type: string
|
|
partneraccountid:
|
|
description: Partner Account
|
|
type: string
|
|
payment_method:
|
|
description: Payment Method
|
|
type: string
|
|
pending:
|
|
description: Pending?
|
|
type: boolean
|
|
periodid:
|
|
description: Period
|
|
type: string
|
|
picklistvalue:
|
|
description: Picklist Value
|
|
type: string
|
|
posted:
|
|
description: Posted
|
|
type: boolean
|
|
processed:
|
|
description: Processed
|
|
type: boolean
|
|
processing:
|
|
description: Processing
|
|
type: boolean
|
|
recordtypeid:
|
|
description: Record Type
|
|
type: string
|
|
ref:
|
|
description: External Reference
|
|
type: string
|
|
reference:
|
|
description: Reference
|
|
type: string
|
|
referencenumber:
|
|
description: Reference Number
|
|
type: number
|
|
rejected:
|
|
description: Rejected?
|
|
type: boolean
|
|
sourceid:
|
|
description: Source Payment Method
|
|
type: string
|
|
statementitemtype:
|
|
description: Statement Item Type
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
type:
|
|
description: Type
|
|
type: string
|
|
unappliedamount:
|
|
description: Unapplied Amount
|
|
type: number
|
|
validpayment:
|
|
description: Valid Payment?
|
|
type: boolean
|
|
xeroid:
|
|
description: Xero Credit Note Id
|
|
type: string
|
|
type: object
|
|
CashReceiptRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/CashReceipt"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
CashReceiptResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/CashReceipt"
|
|
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
|
|
Company:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Taxnexus ID of the Account that owns this Company
|
|
type: string
|
|
accountnumberprefix:
|
|
description: Account Number Prefix
|
|
type: string
|
|
advancedperiodid:
|
|
description: The next period to be used in periodic billing
|
|
type: string
|
|
billingaddress:
|
|
$ref: "#/definitions/Address"
|
|
billingadvice:
|
|
description: Billing Advice
|
|
type: string
|
|
billingcontactid:
|
|
description: Contact ID
|
|
type: string
|
|
billingemail:
|
|
description: Billing Email
|
|
type: string
|
|
billingphone:
|
|
description: Billing Phone
|
|
type: string
|
|
billingwebsite:
|
|
description: Billing Website
|
|
type: string
|
|
closedperiodid:
|
|
description: The last closed period
|
|
type: string
|
|
coatemplateid:
|
|
description: Chart of Accounts Template Account ID
|
|
type: string
|
|
coloraccent1:
|
|
description: Color Accent1
|
|
type: string
|
|
coloraccent2:
|
|
description: Color Accent2
|
|
type: string
|
|
colorprimary:
|
|
description: Color Primary
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
currentperiodid:
|
|
description: The current period
|
|
type: string
|
|
currentperiodstatus:
|
|
description: The current period's status value
|
|
type: string
|
|
customersuccessid:
|
|
description: User ID of default Customer Success user
|
|
type: string
|
|
dateclosed:
|
|
description: Date Closed
|
|
type: string
|
|
defaultaddress:
|
|
$ref: "#/definitions/Address"
|
|
defaultcompany:
|
|
description: Default Company?
|
|
type: boolean
|
|
fontbody:
|
|
description: Font Name for Body Text
|
|
type: string
|
|
fontheading:
|
|
description: Font Name for Heading
|
|
type: string
|
|
fontheadingnarrow:
|
|
description: Font Name for Heading Narrow
|
|
type: string
|
|
fontlink:
|
|
description: Font Names for CSS Link
|
|
type: string
|
|
fontmono:
|
|
description: Font Name for Monospace
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
international:
|
|
description: International Customers?
|
|
type: boolean
|
|
lastaccountnumber:
|
|
description: Last Account Number
|
|
format: int64
|
|
type: number
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
lasttaxtypenumber:
|
|
description: Last TaxType Number
|
|
format: int64
|
|
type: number
|
|
logo:
|
|
description: Logo URL
|
|
type: string
|
|
name:
|
|
description: Company Name
|
|
type: string
|
|
ownerid:
|
|
description: The ID of the contact who owns this Company
|
|
type: string
|
|
preparerid:
|
|
description: User ID of the default tax preparer
|
|
type: string
|
|
pricebookid:
|
|
description: The ID of the default Pricebook for this company
|
|
type: string
|
|
usertechleadid:
|
|
description:
|
|
The ID of the contact who is the User Tech Lead for Company
|
|
type: string
|
|
type: object
|
|
CompanyResponse:
|
|
description: An array of Company objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Company"
|
|
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
|
|
emailbounceddate:
|
|
description: Email Bounce Date
|
|
type: string
|
|
emailbouncedreason:
|
|
description: Email Bounce Reason
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Taxnexus Enrollment Status
|
|
type: string
|
|
fax:
|
|
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
|
|
isprovisioned:
|
|
description: Is Provisioned?
|
|
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
|
|
level:
|
|
description: Level
|
|
type: string
|
|
linkedin:
|
|
description: LinkedIn Page
|
|
type: string
|
|
mailingaddress:
|
|
$ref: "#/definitions/Address"
|
|
mailinglists:
|
|
description: Mailing Lists
|
|
type: string
|
|
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
|
|
recruitingstatus:
|
|
description: Recruiting Status
|
|
type: string
|
|
ref:
|
|
description: External reference to this contact, if any
|
|
type: string
|
|
reportstoid:
|
|
description: Reports To Contact ID
|
|
type: string
|
|
salutation:
|
|
description: Contact Salutation
|
|
type: string
|
|
status:
|
|
description: The Contact Status
|
|
type: string
|
|
title:
|
|
description: Contact Title
|
|
type: string
|
|
type:
|
|
description: Contact Type
|
|
type: string
|
|
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
|
|
ContractBasic:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
enddate:
|
|
description: Contract End Date
|
|
type: string
|
|
hourlyrate:
|
|
description: Hourly Rate
|
|
type: number
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
isactive:
|
|
description: Is Active?
|
|
type: boolean
|
|
name:
|
|
description: Contract Name
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
paymentterms:
|
|
description: Payment Terms
|
|
type: string
|
|
pricebook2id:
|
|
description: Price Book
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
startdate:
|
|
description: Contract Start Date
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
type:
|
|
description: Contract Type
|
|
type: string
|
|
type: object
|
|
Country:
|
|
properties:
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
amount:
|
|
description: Rollup Amount
|
|
type: number
|
|
format: double
|
|
code:
|
|
description: Code
|
|
type: string
|
|
latitude:
|
|
type: number
|
|
format: double
|
|
longitude:
|
|
type: number
|
|
format: double
|
|
contactid:
|
|
description: Contact
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Enrollment Status
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
interest:
|
|
description: Interest
|
|
type: number
|
|
format: double
|
|
name:
|
|
description: Country Name
|
|
type: string
|
|
penalty:
|
|
description: Penalty
|
|
type: number
|
|
format: double
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
type: number
|
|
format: double
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
type: number
|
|
format: double
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
type: number
|
|
format: double
|
|
reportedrate:
|
|
description: Reported Rate
|
|
type: number
|
|
format: double
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
type: number
|
|
format: double
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
type: number
|
|
format: double
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
type: number
|
|
format: double
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
type: number
|
|
format: double
|
|
status:
|
|
description: Document Status
|
|
type: string
|
|
format: double
|
|
subtotal:
|
|
description: Reported Tax
|
|
type: number
|
|
format: double
|
|
taxinstances:
|
|
items:
|
|
$ref: "#/definitions/TaxInstance"
|
|
type: array
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount
|
|
type: number
|
|
format: double
|
|
unitbase:
|
|
description: Unit Base
|
|
type: number
|
|
type: object
|
|
CountryResponse:
|
|
description: An array of Country objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Country"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
County:
|
|
properties:
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
latitude:
|
|
type: number
|
|
format: double
|
|
longitude:
|
|
type: number
|
|
format: double
|
|
amount:
|
|
description: Rollup Amount
|
|
type: number
|
|
format: double
|
|
areadescription:
|
|
description: AreaDescription
|
|
type: string
|
|
contactid:
|
|
description: Contact
|
|
type: string
|
|
countryid:
|
|
description: Country Taxnexus ID
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Enrollment Status
|
|
type: string
|
|
fips:
|
|
description: FIPS
|
|
type: string
|
|
fipsclass:
|
|
description: FIPS Class
|
|
type: string
|
|
functionalstatus:
|
|
description: Functional Status
|
|
type: string
|
|
geocode:
|
|
description: Geocode
|
|
type: string
|
|
gnis:
|
|
description: GNIS Code
|
|
format: int64
|
|
type: number
|
|
hasdistricttaxes:
|
|
description: True if this Place has District Sales taxes
|
|
type: boolean
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
interest:
|
|
description: Interest
|
|
format: double
|
|
type: number
|
|
landarea:
|
|
description: Land Area
|
|
type: number
|
|
format: int64
|
|
legalname:
|
|
description: Legal Name
|
|
type: string
|
|
name:
|
|
description: County Name
|
|
type: string
|
|
penalty:
|
|
description: Penalty
|
|
format: double
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
type: number
|
|
format: double
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
type: number
|
|
format: double
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
type: number
|
|
format: double
|
|
reportedrate:
|
|
description: Reported Rate
|
|
type: number
|
|
format: double
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
type: number
|
|
format: double
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
type: number
|
|
format: double
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
type: number
|
|
format: double
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
type: number
|
|
format: double
|
|
stateid:
|
|
description: State
|
|
type: string
|
|
status:
|
|
description: Document Status
|
|
type: string
|
|
subtotal:
|
|
description: Reported Tax
|
|
format: double
|
|
type: number
|
|
taxinstances:
|
|
items:
|
|
$ref: "#/definitions/TaxInstance"
|
|
type: array
|
|
templateid:
|
|
description: Print Template ID
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount
|
|
format: double
|
|
type: number
|
|
totalarea:
|
|
description: Total Area
|
|
format: int64
|
|
type: number
|
|
unitbase:
|
|
description: Unit Base
|
|
type: number
|
|
format: double
|
|
waterarea:
|
|
description: Water Area
|
|
format: int64
|
|
type: number
|
|
type: object
|
|
CountyResponse:
|
|
description: An array of County objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/County"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
CreditCard:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
active:
|
|
description: Active
|
|
type: boolean
|
|
billingcity:
|
|
description: Billing City
|
|
type: string
|
|
billingstate:
|
|
description: Billing State
|
|
type: string
|
|
billingstreet:
|
|
description: Billing Street
|
|
type: string
|
|
billingzip:
|
|
description: Billing Zip
|
|
type: string
|
|
cc_cid:
|
|
description: CC CID
|
|
type: string
|
|
cc_number:
|
|
description: CC Number
|
|
type: string
|
|
cc_print:
|
|
description: CC_Print
|
|
type: string
|
|
cc_type:
|
|
description: CC Type
|
|
type: string
|
|
companyid:
|
|
description: Company
|
|
type: string
|
|
expmonth:
|
|
description: Exp Month
|
|
type: string
|
|
expyear:
|
|
description: Exp Year
|
|
type: string
|
|
id:
|
|
description: Record Id
|
|
type: string
|
|
name:
|
|
description: CC Name
|
|
type: string
|
|
type: object
|
|
Domain:
|
|
properties:
|
|
active:
|
|
description: Active
|
|
type: boolean
|
|
description:
|
|
description: Description
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
name:
|
|
description: Name
|
|
type: string
|
|
type: object
|
|
DomainResponse:
|
|
description: An array of Domain objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Domain"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Error:
|
|
properties:
|
|
code:
|
|
format: int64
|
|
type: integer
|
|
fields:
|
|
type: string
|
|
message:
|
|
type: string
|
|
type: object
|
|
Filing:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
type: string
|
|
authorityid:
|
|
type: string
|
|
accountname:
|
|
description: Account Name on Filing
|
|
type: string
|
|
amount:
|
|
description: The amount of tax to be paid with this filing
|
|
format: double
|
|
type: number
|
|
contactid:
|
|
description: Billing Contact
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
date:
|
|
description: Filing Date
|
|
type: string
|
|
duedate:
|
|
description: Due Date
|
|
format: string
|
|
filingnumber:
|
|
description: Due Date
|
|
format: string
|
|
filingtypeid:
|
|
description: The ID of the Filing Type for this Filing
|
|
format: string
|
|
frequency:
|
|
description: Due Date
|
|
format: string
|
|
id:
|
|
description: Record Id
|
|
type: string
|
|
interest:
|
|
description: Interest
|
|
format: double
|
|
type: number
|
|
interestrate:
|
|
description: Interest
|
|
format: double
|
|
type: number
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
monthnumber:
|
|
description: The number of the Month of the filing
|
|
format: int64
|
|
type: number
|
|
ownerid:
|
|
description: Taxneuxs ID of the User who owns this record
|
|
type: string
|
|
penalty:
|
|
description: Penalty
|
|
format: double
|
|
type: number
|
|
penaltydays:
|
|
description: Penalty Days
|
|
format: double
|
|
type: number
|
|
penaltyrate:
|
|
description: Penalty Days
|
|
format: double
|
|
type: number
|
|
periodid:
|
|
description: Period
|
|
type: string
|
|
preparerid:
|
|
description: Taxnexus ID of the Contact who prepared this filing
|
|
type: string
|
|
quarternumber:
|
|
description: The number of the Month of the filing
|
|
format: int64
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
format: double
|
|
type: number
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
format: double
|
|
type: number
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
format: double
|
|
type: number
|
|
reportedrate:
|
|
description: Reported Rate
|
|
format: double
|
|
type: number
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
format: double
|
|
type: number
|
|
revenuebase:
|
|
description: Revenue Base
|
|
format: double
|
|
type: number
|
|
revenuenet:
|
|
description: Revenue Net
|
|
format: double
|
|
type: number
|
|
revenuenottaxable:
|
|
description: Revenue Not Taxable
|
|
format: double
|
|
type: number
|
|
semiannualnumber:
|
|
description: The number of the Month of the filing
|
|
format: int64
|
|
type: number
|
|
status:
|
|
description: Status
|
|
type: string
|
|
submissionid:
|
|
description: Taxnexus ID of the Submission that owns this Filing
|
|
type: string
|
|
subtotal:
|
|
description: Reported Tax
|
|
format: double
|
|
type: number
|
|
taxontax:
|
|
description: Tax On Tax
|
|
format: double
|
|
type: number
|
|
taxtypeaccountid:
|
|
description:
|
|
The TaxType Account for which this Filing is paying remittance
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount
|
|
format: double
|
|
type: number
|
|
unitbase:
|
|
description: Unit Base
|
|
format: double
|
|
type: number
|
|
yearnumber:
|
|
description: The number of the Month of the filing
|
|
format: int64
|
|
type: number
|
|
type: object
|
|
FilingRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Filing"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
FilingResponse:
|
|
description: An array of Filing Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Filing"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
FilingDueDate:
|
|
type: object
|
|
description: Dates when this FilingType is due for filing
|
|
properties:
|
|
duedate:
|
|
type: string
|
|
description:
|
|
type: string
|
|
FilingTypeInstance:
|
|
type: object
|
|
description: A list of jurisdictions that use this Filing Type
|
|
properties:
|
|
countryid:
|
|
type: string
|
|
description: Country Id
|
|
countyid:
|
|
type: string
|
|
description: County ID
|
|
objecttype:
|
|
type: string
|
|
description:
|
|
The type of object that owns this FilingType instance
|
|
filingtypeid:
|
|
description: The ID of the Filing Type for this Filing
|
|
format: string
|
|
placeid:
|
|
type: string
|
|
description: Place ID
|
|
stateid:
|
|
type: string
|
|
description: StateID
|
|
FilingType:
|
|
type: object
|
|
description: An array of FilingType Objects
|
|
properties:
|
|
accountid:
|
|
description: Tax Authority
|
|
type: string
|
|
contactid:
|
|
description: Contact
|
|
type: string
|
|
createdbyid:
|
|
description: Created By
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
duedates:
|
|
items:
|
|
$ref: "#/definitions/FilingDueDate"
|
|
type: array
|
|
filingcity:
|
|
description: Filing City
|
|
type: string
|
|
filingcountry:
|
|
description: Filing Country
|
|
type: string
|
|
filingpostalcode:
|
|
description: Filing Postal Code
|
|
type: string
|
|
filingstate:
|
|
description: Filing State
|
|
type: string
|
|
filingstreet:
|
|
description: Filing Street
|
|
type: string
|
|
formname:
|
|
description: Form Name
|
|
type: string
|
|
formversion:
|
|
description: Form Version
|
|
type: string
|
|
frequency:
|
|
description: Frequency
|
|
type: string
|
|
fullname:
|
|
description: Filing Full Name
|
|
type: string
|
|
id:
|
|
description: Record Id
|
|
type: string
|
|
instances:
|
|
items:
|
|
$ref: "#/definitions/FilingTypeInstance"
|
|
type: array
|
|
lastmodifiedbyid:
|
|
description: Last Modified By
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modifed Date
|
|
type: string
|
|
level:
|
|
description: Jurisdictional Level
|
|
type: string
|
|
name:
|
|
description: Name
|
|
type: string
|
|
ownerid:
|
|
description: Owner
|
|
type: string
|
|
sagatype:
|
|
description: Saga Type
|
|
type: string
|
|
submissionmethod:
|
|
description: Submission Method
|
|
type: string
|
|
templateinstructionsid:
|
|
description: Instructions Template
|
|
type: string
|
|
templatereturnid:
|
|
description: Return Template
|
|
type: string
|
|
FilingTypeRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/FilingType"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
required:
|
|
- meta
|
|
- data
|
|
type: object
|
|
FilingTypeResponse:
|
|
description: An array of Filing Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/FilingType"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
GlAccount:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
accountlevel:
|
|
description: Account Level
|
|
type: number
|
|
accountname:
|
|
description: Account Name
|
|
type: string
|
|
accountnumber:
|
|
description: Account Number
|
|
type: number
|
|
accountsign:
|
|
description: Account Sign
|
|
type: string
|
|
accounttype:
|
|
description: Account Type
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
name:
|
|
description: Display Name
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
isactive:
|
|
description: Is Active?
|
|
type: boolean
|
|
isbankaccount:
|
|
description: Is Bank Account ?
|
|
type: boolean
|
|
issummary:
|
|
description: Is Summary?
|
|
type: boolean
|
|
parentfk:
|
|
description: Parent Foreign Key
|
|
type: string
|
|
parentglaccountid:
|
|
description: Parent GL Account
|
|
type: string
|
|
ref:
|
|
description: Reference
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
type: object
|
|
GlAccountRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/GlAccount"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
GlAccountResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/GlAccount"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
GlBalance:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountname:
|
|
description: Account Name
|
|
type: string
|
|
amount:
|
|
description: Amount
|
|
type: number
|
|
closedate:
|
|
description: Close Date
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
credits:
|
|
description: Credits
|
|
type: number
|
|
debits:
|
|
description: Debits
|
|
type: number
|
|
description:
|
|
description: Description
|
|
type: string
|
|
glaccountdisplay:
|
|
description: GL Account Display Value
|
|
type: string
|
|
glaccountid:
|
|
description: GL Account
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
periodid:
|
|
description: Period ID
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
rollupcredits:
|
|
description: Rollup Credits
|
|
type: number
|
|
rollupdebits:
|
|
description: Rollup Debits
|
|
type: number
|
|
status:
|
|
description: Status
|
|
type: string
|
|
type: object
|
|
GlBalanceResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/GlBalance"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Ids:
|
|
description: Taxnexus Record Ids
|
|
items:
|
|
type: string
|
|
type: array
|
|
IdsRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Ids"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
Ingest:
|
|
description: A record of the Ingest of information into Taxnexus
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account ID
|
|
type: string
|
|
amount:
|
|
description: Rollup Tax Amount
|
|
format: double
|
|
type: number
|
|
backendid:
|
|
description: Backend ID
|
|
type: string
|
|
companyid:
|
|
description: Company ID
|
|
type: string
|
|
createdbyid:
|
|
description: Taxnexus User ID
|
|
type: string
|
|
createddate:
|
|
description: Date of Job Creation
|
|
type: string
|
|
description:
|
|
description: Ingest Description
|
|
type: string
|
|
enddate:
|
|
description: End Date
|
|
type: string
|
|
filename:
|
|
description: Filename
|
|
type: string
|
|
formatted:
|
|
description: Numeric and Date Values Pre-formatted as Text
|
|
properties:
|
|
amount:
|
|
type: string
|
|
ingestdate:
|
|
type: string
|
|
invoicecount:
|
|
type: string
|
|
pocount:
|
|
type: string
|
|
revenuebase:
|
|
type: string
|
|
revenuenottaxable:
|
|
type: string
|
|
unitbase:
|
|
type: string
|
|
type: object
|
|
id:
|
|
description: Record Id
|
|
type: string
|
|
ingestdate:
|
|
description: Ingest Date
|
|
type: string
|
|
ingestfailurereason:
|
|
description: Ingest Failure Reason
|
|
type: string
|
|
ingesttype:
|
|
description: Ingest Type
|
|
enum:
|
|
- fabric
|
|
- internal
|
|
- suretax
|
|
- taxnexus-api
|
|
type: string
|
|
invoicecount:
|
|
description: Invoice Count
|
|
format: int64
|
|
type: number
|
|
jobid:
|
|
description: Job ID
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Taxnexus User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
metrclicense:
|
|
description: License
|
|
type: string
|
|
metrcstate:
|
|
description: State Code
|
|
type: string
|
|
objecttype:
|
|
description: Ingest Object Type
|
|
enum:
|
|
- account
|
|
- cash-receipt
|
|
- contact
|
|
- invoice
|
|
- order
|
|
- po
|
|
- quote
|
|
type: string
|
|
parentfk:
|
|
description: Parent Foreign Key
|
|
type: string
|
|
periodid:
|
|
description: Period ID
|
|
type: string
|
|
pocount:
|
|
description: PO Count
|
|
format: int64
|
|
type: number
|
|
postfailurereason:
|
|
description: Post Failure Reason
|
|
type: string
|
|
ratingengineid:
|
|
description: Rating Engine ID
|
|
type: string
|
|
ref:
|
|
description: Source System Reference
|
|
type: string
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
format: double
|
|
type: number
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
format: double
|
|
type: number
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
format: double
|
|
type: number
|
|
sagaid:
|
|
description:
|
|
The Saga ID used to link log entries and transactions
|
|
type: string
|
|
sagatype:
|
|
description: The type of Saga transaction being performed
|
|
type: string
|
|
source:
|
|
description: The source system that generated this job
|
|
type: string
|
|
startdate:
|
|
description: Start Date
|
|
type: string
|
|
status:
|
|
description: Ingest Status
|
|
enum:
|
|
- failed_accounting
|
|
- failed_existing
|
|
- failed_glpost
|
|
- failed_invoice
|
|
- failed_po
|
|
- ingested
|
|
- new
|
|
- posted
|
|
- queued
|
|
- rated
|
|
- rejected
|
|
type: string
|
|
taxtransactioncount:
|
|
description: Tax Transaction Count
|
|
format: int64
|
|
type: number
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
unitbase:
|
|
description: Rollup Unit Base
|
|
format: int64
|
|
type: number
|
|
required:
|
|
- accountid
|
|
- objecttype
|
|
type: object
|
|
IngestRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Ingest"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
required:
|
|
- meta
|
|
- data
|
|
type: object
|
|
IngestResponse:
|
|
description: An array of Print-Ready ingest Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Ingest"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
InvalidError:
|
|
allOf:
|
|
- $ref: "#/definitions/Error"
|
|
- properties:
|
|
details:
|
|
items:
|
|
type: string
|
|
type: array
|
|
type: object
|
|
Invoice:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountbalance:
|
|
description: Account Balance
|
|
format: double
|
|
type: number
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
accountname:
|
|
description: Account Name
|
|
type: string
|
|
advance:
|
|
description: Advance?
|
|
type: boolean
|
|
amount:
|
|
description: Invoice Amount
|
|
format: double
|
|
type: number
|
|
amount_adjustment:
|
|
description: Amount Adjustment
|
|
format: double
|
|
type: number
|
|
amountdue:
|
|
description: Amount Due
|
|
format: double
|
|
type: number
|
|
amountpaid:
|
|
description: Amount Paid
|
|
format: double
|
|
type: number
|
|
auditmessage:
|
|
description: Audit Trail Message
|
|
type: string
|
|
billingcity:
|
|
description: Billing City
|
|
type: string
|
|
billingcountry:
|
|
description: Billing Country
|
|
type: string
|
|
billingpostalcode:
|
|
description: Billing Postal Code
|
|
type: string
|
|
billingrunid:
|
|
description: Billing Run
|
|
type: string
|
|
billingstate:
|
|
description: Billing State
|
|
type: string
|
|
billingstreet:
|
|
description: Billing Street
|
|
type: string
|
|
billtocontactid:
|
|
type: string
|
|
cannabistax:
|
|
description: Cannabis Tax
|
|
format: double
|
|
type: number
|
|
contractid:
|
|
description: Contract
|
|
type: string
|
|
coordinate:
|
|
$ref: "#/definitions/Address"
|
|
customerid:
|
|
description: Customer ID
|
|
type: string
|
|
dateissued:
|
|
description: Date Issued
|
|
type: string
|
|
daysdue:
|
|
description: Days Due
|
|
format: double
|
|
type: number
|
|
depositamount:
|
|
description: Deposit Amount
|
|
format: double
|
|
type: number
|
|
description:
|
|
description: Description
|
|
type: string
|
|
discount:
|
|
description: Discount
|
|
format: double
|
|
type: number
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
invoicedate:
|
|
description: Invoice Date
|
|
type: string
|
|
invoicenumber:
|
|
description: Invoice Number
|
|
type: string
|
|
isinternational:
|
|
description: Is International?
|
|
type: boolean
|
|
issuedaccountbalance:
|
|
description: Issued Account Balance
|
|
format: double
|
|
type: number
|
|
issuedamountdue:
|
|
description: Issued Amount Due
|
|
format: double
|
|
type: number
|
|
issuedbyid:
|
|
description: Issued By
|
|
type: string
|
|
isvalid:
|
|
description: Is Valid?
|
|
type: boolean
|
|
items:
|
|
description: The items associated with this Invoice
|
|
items:
|
|
$ref: "#/definitions/InvoiceItem"
|
|
type: array
|
|
lineitemcount:
|
|
description: Line Item Count
|
|
format: int64
|
|
type: number
|
|
minimumpaymentdue:
|
|
description: Minimum Payment Due
|
|
format: double
|
|
type: number
|
|
monthlyamount:
|
|
description: Monthly Amount
|
|
format: double
|
|
type: number
|
|
opportunityid:
|
|
description: Opportunity
|
|
type: string
|
|
orderid:
|
|
description: Order
|
|
type: string
|
|
overdue0:
|
|
description: Overdue0
|
|
format: double
|
|
type: number
|
|
overdue120:
|
|
description: Overdue 120 Days Amount
|
|
format: double
|
|
type: number
|
|
overdue30:
|
|
description: Overdue 30 Days Amount
|
|
format: double
|
|
type: number
|
|
overdue45:
|
|
description: Overdue 45 Days Amount
|
|
format: double
|
|
type: number
|
|
overdue60:
|
|
description: Overdue 60 Days Amount
|
|
format: double
|
|
type: number
|
|
overdue90:
|
|
description: Overdue 90 Days Amount
|
|
format: double
|
|
type: number
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
partneraccountid:
|
|
description: Partner Account
|
|
type: string
|
|
payment_method:
|
|
description: Payment Method
|
|
type: string
|
|
paymentdue:
|
|
description: Payment Due
|
|
type: string
|
|
paymentmethodid:
|
|
description: Payment Method
|
|
type: string
|
|
paymentterms:
|
|
description: Payment Terms
|
|
type: string
|
|
periodid:
|
|
description: Period
|
|
type: string
|
|
picklistvalue:
|
|
description: Picklist Value
|
|
type: string
|
|
posted:
|
|
description: Posted
|
|
type: boolean
|
|
prioraccountbalance:
|
|
description: Prior Account Balance
|
|
format: double
|
|
type: number
|
|
prioradjustments:
|
|
description: Prior Adjustments
|
|
format: double
|
|
type: number
|
|
priorinvoiceamount:
|
|
description: Prior Invoice Amount
|
|
format: double
|
|
type: number
|
|
priorinvoicedate:
|
|
description: Prior Invoice Date
|
|
type: string
|
|
priorinvoiceid:
|
|
description: Prior Invoice
|
|
type: string
|
|
priorpaymentamount:
|
|
description: Prior Payment Amount
|
|
format: double
|
|
type: number
|
|
priorpaymentdate:
|
|
description: Prior Payment Date
|
|
type: string
|
|
priorpaymentid:
|
|
description: Prior Payment
|
|
type: string
|
|
priorpaymentmemo:
|
|
description: Prior Payment Memo
|
|
type: string
|
|
prorated:
|
|
description: Prorated?
|
|
type: boolean
|
|
prorateddays:
|
|
description: Prorated Days
|
|
format: double
|
|
type: number
|
|
purchaseamount:
|
|
description: Purchase Amount
|
|
format: double
|
|
type: number
|
|
quoteid:
|
|
description: Quote
|
|
type: string
|
|
ratingingestid:
|
|
description: Rating Ingest
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
reference:
|
|
description: Reference
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type (Medicinal or Recreational)
|
|
type: string
|
|
salestax:
|
|
description: Sales Tax
|
|
format: double
|
|
type: number
|
|
scheduledpaymentdate:
|
|
description: Scheduled Payment Date
|
|
type: string
|
|
service_term:
|
|
description: Service Term
|
|
type: string
|
|
shippingcity:
|
|
description: Shipping City
|
|
type: string
|
|
shippingcountry:
|
|
description: Shipping Country
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
format: double
|
|
type: number
|
|
shippingpostalcode:
|
|
description: Shipping Postal Code
|
|
type: string
|
|
shippingstate:
|
|
description: Shipping State
|
|
type: string
|
|
shippingstreet:
|
|
description: Shipping Street
|
|
type: string
|
|
statementitemtype:
|
|
description: Statement Item Type
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
suppressworkflow:
|
|
description: Suppress Workflow?
|
|
type: boolean
|
|
taxitems:
|
|
description: The taxes associated with this Invoice
|
|
items:
|
|
$ref: "#/definitions/TaxTransaction"
|
|
type: array
|
|
telecomtax:
|
|
description: Telecom Tax
|
|
format: double
|
|
type: number
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
type:
|
|
description: Type
|
|
type: string
|
|
whmcsclientid:
|
|
description: WHMCS Client ID
|
|
type: string
|
|
whmcsinvoiceid:
|
|
description: WHMCS Invoice ID
|
|
type: string
|
|
xeroid:
|
|
description: Xero Invoice Id
|
|
type: string
|
|
year:
|
|
description: Year
|
|
format: int64
|
|
type: number
|
|
type: object
|
|
InvoiceBasic:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description:
|
|
Account Identifier from Source System; ignored in tax
|
|
calculations
|
|
type: string
|
|
amount:
|
|
description: Invoice Amount; ignored in tax calculation
|
|
format: double
|
|
type: number
|
|
amountdue:
|
|
description: Amount Due; ignored in tax calculations
|
|
format: double
|
|
type: number
|
|
coordinate:
|
|
$ref: "#/definitions/Address"
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
invoicedate:
|
|
description:
|
|
Invoice Date; should be date only or correct time zone if in
|
|
time notation
|
|
type: string
|
|
invoicenumber:
|
|
description:
|
|
Source System Customer-Facing Invoice Number; ignored in tax
|
|
calculation
|
|
type: string
|
|
items:
|
|
description: The items associated with this Invoice
|
|
items:
|
|
$ref: "#/definitions/ItemBasic"
|
|
type: array
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type
|
|
type: string
|
|
status:
|
|
description:
|
|
Status used by for Billing Balances; ignored in tax
|
|
calculation
|
|
enum:
|
|
- closed
|
|
- delivered
|
|
- hold
|
|
- issued
|
|
- new
|
|
- posted
|
|
- rated
|
|
- rating_failed
|
|
- rating_ready
|
|
- reissued
|
|
- rendered
|
|
- uncollectable
|
|
- voided
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
type:
|
|
description: Invoice Type
|
|
type: string
|
|
type: object
|
|
InvoiceItem:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
census_tract:
|
|
description: Census Tract
|
|
type: string
|
|
cogs:
|
|
description: Cost of Goods Sold
|
|
type: number
|
|
format: double
|
|
contractid:
|
|
description: Contract Number
|
|
type: string
|
|
countyid:
|
|
description: County
|
|
type: string
|
|
description:
|
|
description: Line Item Description
|
|
type: string
|
|
exportdescription:
|
|
description: Export Description
|
|
type: string
|
|
family:
|
|
description: Family
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
invoiceid:
|
|
description: Invoice
|
|
type: string
|
|
linenumber:
|
|
description: Line
|
|
format: int64
|
|
type: number
|
|
list_price:
|
|
description: List Price
|
|
type: number
|
|
locationid:
|
|
description: Location
|
|
type: string
|
|
orderitemid:
|
|
description: Order Item
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
periodid:
|
|
description: Period
|
|
type: string
|
|
productcode:
|
|
description: Product Code
|
|
type: string
|
|
productid:
|
|
description: Product
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
format: double
|
|
type: number
|
|
quotelineitemid:
|
|
description: Quote Line Item
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
rejected_quantity:
|
|
description: Rejected Quantity
|
|
format: double
|
|
type: number
|
|
revenueaccount:
|
|
description: Revenue Account
|
|
type: number
|
|
seq:
|
|
description: Seq
|
|
type: string
|
|
shipped_quantity:
|
|
description: Shipped Quantity
|
|
type: number
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
type: number
|
|
sku:
|
|
description: SKU
|
|
type: string
|
|
subscriptionid:
|
|
description: Subscription
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
type: number
|
|
taxnexuscode:
|
|
description: Taxnexus Code
|
|
type: string
|
|
totalprice:
|
|
description: Total Price
|
|
type: number
|
|
unitprice:
|
|
description: Unit Price
|
|
type: number
|
|
type: object
|
|
InvoiceRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/InvoiceBasic"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
InvoiceResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Invoice"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
ItemBasic:
|
|
properties:
|
|
description:
|
|
description: Line Item Description
|
|
type: string
|
|
cogs:
|
|
description: Cost of Goods Sold
|
|
type: number
|
|
format: double
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
invoiceid:
|
|
description: Source System Parent Foreign Key to Invoice
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
productcode:
|
|
description: Product Code
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
format: double
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling and Delivery Fees for this Item
|
|
format: double
|
|
type: number
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
taxnexuscode:
|
|
description: Taxnexus Code
|
|
type: string
|
|
unitprice:
|
|
description: Unit Price
|
|
format: double
|
|
type: number
|
|
units:
|
|
description: The Unit of Measure for this item
|
|
enum:
|
|
- each
|
|
- month
|
|
- day
|
|
- week
|
|
- hour
|
|
- oz_drywt_flower
|
|
- oz_drywt_leaves
|
|
- oz_fresh
|
|
- gm
|
|
- oz
|
|
- lb
|
|
type: string
|
|
required:
|
|
- quantity
|
|
- unitprice
|
|
- taxnexuscode
|
|
- ref
|
|
type: object
|
|
Job:
|
|
properties:
|
|
accountid:
|
|
description: Taxnexus Account Id
|
|
type: string
|
|
backendid:
|
|
description: Taxnexus Backend ID
|
|
type: string
|
|
companyid:
|
|
description: Taxnexus Company ID
|
|
type: string
|
|
coordinateid:
|
|
description: Taxnexus Coordinate ID
|
|
type: string
|
|
createdbyid:
|
|
description: Taxnexus User ID
|
|
type: string
|
|
createddate:
|
|
description: Date of Job Creation
|
|
type: string
|
|
month:
|
|
type: number
|
|
format: int64
|
|
quarter:
|
|
type: number
|
|
format: int64
|
|
semiannual:
|
|
type: number
|
|
format: int64
|
|
year:
|
|
type: number
|
|
format: int64
|
|
duration:
|
|
description:
|
|
The amount of time after the Start Time to perform one or more
|
|
jobs
|
|
enum:
|
|
- day
|
|
- document
|
|
- hour
|
|
- minute
|
|
- month
|
|
- quarter
|
|
- second
|
|
- week
|
|
- year
|
|
type: string
|
|
enddate:
|
|
description: End Date/Time
|
|
type: string
|
|
errorreason:
|
|
description: Error Reason
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id of the Job record
|
|
type: string
|
|
interval:
|
|
description:
|
|
The time interval by which multiple jobs are executed within
|
|
the Duration
|
|
enum:
|
|
- day
|
|
- each
|
|
- hour
|
|
- minute
|
|
- month
|
|
- quarter
|
|
- second
|
|
- week
|
|
- year
|
|
type: string
|
|
jobdate:
|
|
description: Job Date
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Last Modified By
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
nextjobid:
|
|
description: Next Job
|
|
type: string
|
|
objecttype:
|
|
description: Object Type
|
|
enum:
|
|
- invoice
|
|
- order
|
|
- po
|
|
- quote
|
|
type: string
|
|
ownerid:
|
|
description: The user ID that owns this job
|
|
type: string
|
|
parameters:
|
|
description: Any parameters needed to process the job
|
|
type: string
|
|
periodid:
|
|
description: Period
|
|
type: string
|
|
ratingengineid:
|
|
description: Rating Engine
|
|
type: string
|
|
ref:
|
|
description: External Reference
|
|
type: string
|
|
reschedule:
|
|
description: Reschedule?
|
|
type: boolean
|
|
rescheduleinterval:
|
|
description: Reschedule Interval
|
|
format: int64
|
|
type: number
|
|
sagaid:
|
|
description:
|
|
The Saga ID used to link log entries and transactions
|
|
type: string
|
|
sagatype:
|
|
description: The type of Saga transaction being performed
|
|
enum:
|
|
- newGLPostInvoices
|
|
- newIngestInvoice
|
|
- newIngestPO
|
|
type: string
|
|
source:
|
|
description: The source system that generated this job
|
|
enum:
|
|
- api
|
|
- fabric
|
|
- taxnexus
|
|
- telnexus
|
|
type: string
|
|
startdate:
|
|
description: Start Date/Time
|
|
type: string
|
|
status:
|
|
description: Status
|
|
enum:
|
|
- active
|
|
- complete
|
|
- error
|
|
- new
|
|
- queued
|
|
type: string
|
|
target:
|
|
description: The target system that executes this job
|
|
enum:
|
|
- api
|
|
- fabric
|
|
- taxnexus
|
|
- telnexus
|
|
type: string
|
|
type:
|
|
description: Type
|
|
enum:
|
|
- coordinate
|
|
- email
|
|
- ingest
|
|
- tax
|
|
type: string
|
|
type: object
|
|
JobRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Job"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
required:
|
|
- meta
|
|
- data
|
|
type: object
|
|
JobResponse:
|
|
description: An array of Print-Ready ingest Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Job"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
License:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
type: string
|
|
backendid:
|
|
type: string
|
|
contactid:
|
|
type: string
|
|
createdbyid:
|
|
type: string
|
|
createddate:
|
|
type: string
|
|
dateissued:
|
|
description: Date
|
|
type: string
|
|
expirationdate:
|
|
description: Expiration Date
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
iscanceled:
|
|
description: Is Canceled?
|
|
type: boolean
|
|
isrevoked:
|
|
description: Is Revoked?
|
|
type: boolean
|
|
lastmodifiedbyid:
|
|
type: string
|
|
lastmodifieddate:
|
|
type: string
|
|
licensetypeid:
|
|
description: License Type Number
|
|
type: string
|
|
licensenumber:
|
|
description: License Number
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
type: object
|
|
LicenseRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/License"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
LicenseResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/License"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
LicenseType:
|
|
properties:
|
|
accountid:
|
|
type: string
|
|
agentid:
|
|
type: string
|
|
contactid:
|
|
type: string
|
|
cost:
|
|
description: Cost
|
|
type: number
|
|
format: double
|
|
createdbyid:
|
|
type: string
|
|
createddate:
|
|
type: string
|
|
domainid:
|
|
type: string
|
|
frequency:
|
|
description: Frequency
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
lastmodifiedbyid:
|
|
type: string
|
|
lastmodifieddate:
|
|
type: string
|
|
level:
|
|
description: Level
|
|
type: string
|
|
name:
|
|
description: License Type Name
|
|
type: string
|
|
picklistvalue:
|
|
description: Picklist Value
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
restriction:
|
|
description: Restriction
|
|
type: string
|
|
tier:
|
|
description: Tier
|
|
type: string
|
|
domains:
|
|
type: array
|
|
items:
|
|
type: string
|
|
jurisdictions:
|
|
type: array
|
|
items:
|
|
$ref: "#/definitions/GeoLicenseTypeInstance"
|
|
type: object
|
|
GeoLicenseTypeInstance:
|
|
description: Links a license type to a geography
|
|
type: object
|
|
properties:
|
|
objecttype:
|
|
type: string
|
|
placeid:
|
|
type: string
|
|
countyid:
|
|
type: string
|
|
stateid:
|
|
type: string
|
|
countryid:
|
|
type: string
|
|
LicenseTypeResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/LicenseType"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Message:
|
|
properties:
|
|
message:
|
|
type: string
|
|
ref:
|
|
type: string
|
|
status:
|
|
type: integer
|
|
type: object
|
|
Order:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
type: string
|
|
accountnumber:
|
|
description: Account Number
|
|
type: string
|
|
activatedbyid:
|
|
description: Activated By
|
|
type: string
|
|
activateddate:
|
|
description: Activated Date
|
|
type: string
|
|
amount:
|
|
description: Order Amount
|
|
format: double
|
|
type: number
|
|
billingaddress:
|
|
$ref: "#/definitions/Address"
|
|
billingcontactid:
|
|
type: string
|
|
billingtype:
|
|
description: Billing Type
|
|
type: string
|
|
billtocontactid:
|
|
description: Bill To Contact
|
|
type: string
|
|
cannabistax:
|
|
description: Cannabis Tax
|
|
format: double
|
|
type: number
|
|
companyauthorizedbyid:
|
|
description: Company Authorized By
|
|
type: string
|
|
companyauthorizeddate:
|
|
description: Company Authorized Date
|
|
type: string
|
|
completion:
|
|
description: Completion Status
|
|
type: string
|
|
contract:
|
|
$ref: "#/definitions/ContractBasic"
|
|
contractenddate:
|
|
description: Contract End Date
|
|
type: string
|
|
contractid:
|
|
description: Contract Number
|
|
type: string
|
|
contractname:
|
|
description: Contract Name
|
|
type: string
|
|
coordinate:
|
|
$ref: "#/definitions/Address"
|
|
customerauthorizedbyid:
|
|
description: Customer Authorized By
|
|
type: string
|
|
customerauthorizeddate:
|
|
description: Customer Authorized Date
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
effectivedate:
|
|
description: Order Start Date
|
|
type: string
|
|
enddate:
|
|
description: Order End Date
|
|
type: string
|
|
enduserid:
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
installationdate:
|
|
description: Installation Date
|
|
type: string
|
|
invoice:
|
|
description: Invoice
|
|
type: string
|
|
isreductionorder:
|
|
description: Reduction Order
|
|
type: boolean
|
|
items:
|
|
description: The Order Items
|
|
items:
|
|
$ref: "#/definitions/OrderItem"
|
|
type: array
|
|
lineitemcount:
|
|
description: Line Item Count
|
|
format: int64
|
|
type: number
|
|
monthlyamount:
|
|
description: Monthly Amount
|
|
type: number
|
|
name:
|
|
description: Order Name
|
|
type: string
|
|
open:
|
|
description: Open Order?
|
|
type: boolean
|
|
opportunityid:
|
|
description: Opportunity
|
|
type: string
|
|
ordernumber:
|
|
description: Order Number
|
|
type: string
|
|
orderreferencenumber:
|
|
description: Order Reference Number
|
|
type: string
|
|
originalorderid:
|
|
description: Original Order
|
|
type: string
|
|
ownerid:
|
|
description: Order Owner
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
paymentmethodid:
|
|
description: Payment Method
|
|
type: string
|
|
paymentterms:
|
|
description: Payment Terms
|
|
type: string
|
|
podate:
|
|
description: PO Date
|
|
type: string
|
|
ponumber:
|
|
description: PO Number
|
|
type: string
|
|
provisioningstatus:
|
|
description: Provisioning Status
|
|
type: string
|
|
purchaseamount:
|
|
description: Purchase Amount
|
|
type: number
|
|
quoteid:
|
|
description: Quote
|
|
type: string
|
|
recordtypeid:
|
|
description: Order Record Type
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type
|
|
type: string
|
|
salestax:
|
|
description: Sales Tax
|
|
format: double
|
|
type: number
|
|
serviceterm:
|
|
description: Service Term
|
|
type: string
|
|
shippingaddress:
|
|
$ref: "#/definitions/Address"
|
|
shippingcontactid:
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
type: number
|
|
shiptocontactid:
|
|
description: Ship To Contact
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
taxitems:
|
|
description: The taxes associated with this Order
|
|
items:
|
|
$ref: "#/definitions/TaxTransaction"
|
|
type: array
|
|
telecomtax:
|
|
description: Telecom Tax
|
|
format: double
|
|
type: number
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
totalamount:
|
|
description: Order Amount
|
|
format: int64
|
|
type: number
|
|
type:
|
|
description: Order Type
|
|
type: string
|
|
type: object
|
|
OrderBasic:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
amount:
|
|
description: Order Amount
|
|
format: double
|
|
type: number
|
|
amountdue:
|
|
description: Amount Due
|
|
format: double
|
|
type: number
|
|
coordinate:
|
|
$ref: "#/definitions/Address"
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
items:
|
|
$ref: "#/definitions/ItemBasic"
|
|
orderdate:
|
|
description: Order Date
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type (Medicinal or Recreational)
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
type:
|
|
description: Type
|
|
type: string
|
|
type: object
|
|
OrderBasicRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/OrderBasic"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
OrderItem:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
account:
|
|
description: Account
|
|
type: object
|
|
activated:
|
|
description: Activated?
|
|
type: boolean
|
|
activatedby:
|
|
description: Activated By
|
|
type: string
|
|
availablequantity:
|
|
description: Available Quantity
|
|
format: double
|
|
type: number
|
|
contractid:
|
|
description: Contract Number
|
|
type: string
|
|
createreservation:
|
|
description: Create Reservation?
|
|
type: boolean
|
|
datedelivered:
|
|
description: Date Delivered
|
|
type: string
|
|
dateordered:
|
|
description: Date Ordered
|
|
type: string
|
|
datepromised:
|
|
description: Date Promised
|
|
type: string
|
|
description:
|
|
description: Line Description
|
|
type: string
|
|
discount:
|
|
description: Discount
|
|
format: double
|
|
type: number
|
|
enddate:
|
|
description: End Date
|
|
type: string
|
|
family:
|
|
description: Family
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
inventorytracking:
|
|
description: Inventory Tracking
|
|
type: boolean
|
|
invoiceitemid:
|
|
description: Invoice Item
|
|
type: string
|
|
linegrossamount:
|
|
description: Line Gross Amount
|
|
format: double
|
|
type: number
|
|
lineitemnumber:
|
|
description: Line Item Number
|
|
format: int64
|
|
type: number
|
|
listprice:
|
|
description: List Price
|
|
format: double
|
|
type: number
|
|
locationid:
|
|
description: Location
|
|
type: string
|
|
orderid:
|
|
description: Order
|
|
type: string
|
|
orderitemnumber:
|
|
description: Order Product Number
|
|
type: string
|
|
originalorderitemid:
|
|
description: Original Order Product
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
posted:
|
|
description: Posted?
|
|
type: boolean
|
|
product2id:
|
|
description: Product
|
|
type: string
|
|
productid:
|
|
description: ProductId
|
|
type: string
|
|
productname:
|
|
description: Product Name
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
format: double
|
|
type: number
|
|
quantityonhand:
|
|
description: Quantity On Hand
|
|
format: double
|
|
type: number
|
|
quotelineitemid:
|
|
description: Quote Line Item
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
servicedate:
|
|
description: Start Date
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
format: double
|
|
type: number
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subscriptionid:
|
|
description: Subscription
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
taxnexuscodeid:
|
|
description: Taxnexus Code
|
|
type: string
|
|
totalprice:
|
|
description: Total Price
|
|
format: double
|
|
type: number
|
|
unitprice:
|
|
description: Unit Price
|
|
format: double
|
|
type: number
|
|
type: object
|
|
OrderResponse:
|
|
description: An array of Order Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Order"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Pagination:
|
|
properties:
|
|
NextLink:
|
|
type: string
|
|
PLimit:
|
|
format: int64
|
|
type: integer
|
|
POffset:
|
|
format: int64
|
|
type: integer
|
|
PageSize:
|
|
format: int64
|
|
type: integer
|
|
SetSize:
|
|
format: int64
|
|
type: integer
|
|
type: object
|
|
Period:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account that owns this Period
|
|
type: string
|
|
companyid:
|
|
description: Company
|
|
type: string
|
|
days:
|
|
description: Days
|
|
format: int64
|
|
type: number
|
|
enddate:
|
|
description: End Date
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
month:
|
|
description: Month number
|
|
format: int64
|
|
type: number
|
|
name:
|
|
description: Period Name
|
|
type: string
|
|
quarter:
|
|
description: Quarter number
|
|
format: int64
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
semiannual:
|
|
description: Semiannual number
|
|
format: int64
|
|
type: number
|
|
startdate:
|
|
description: Start Date
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
year:
|
|
description: Year number
|
|
format: int64
|
|
type: number
|
|
type: object
|
|
PeriodRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Period"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
PeriodResponse:
|
|
description: An array of Period objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Period"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Place:
|
|
properties:
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
accountvalidation:
|
|
description: Account Validation
|
|
type: string
|
|
amount:
|
|
description: Rollup Amount
|
|
format: double
|
|
type: number
|
|
latitude:
|
|
type: number
|
|
format: double
|
|
longitude:
|
|
type: number
|
|
format: double
|
|
areadescription:
|
|
description: AreaDescription
|
|
type: string
|
|
contactid:
|
|
description: Contact
|
|
type: string
|
|
countryid:
|
|
description: Taxnexus ID of the Country this places is in
|
|
type: string
|
|
countyid:
|
|
description: County
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Enrollment Status
|
|
type: string
|
|
fips:
|
|
description: FIPS
|
|
type: string
|
|
fipsclass:
|
|
description: FIPS Class
|
|
type: string
|
|
functionalstatus:
|
|
description: Functional Status
|
|
type: string
|
|
geocode:
|
|
description: Geocode
|
|
type: string
|
|
gnis:
|
|
description: GNIS
|
|
format: int64
|
|
type: number
|
|
hasdistricttaxes:
|
|
description: True if this Place has District Sales taxes
|
|
type: boolean
|
|
id:
|
|
description: Salesforce Record Id
|
|
type: string
|
|
interest:
|
|
description: Interest
|
|
format: double
|
|
type: number
|
|
landarea:
|
|
description: Land Area
|
|
format: int64
|
|
type: number
|
|
legalname:
|
|
description: Legal Name
|
|
type: string
|
|
name:
|
|
description: Place Name
|
|
type: string
|
|
penalty:
|
|
description: Penalty
|
|
format: double
|
|
type: number
|
|
polygoncentroid:
|
|
description: Polygon Centroid
|
|
type: object
|
|
ref:
|
|
description: External reference if any
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
type: number
|
|
format: double
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
type: number
|
|
format: double
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
type: number
|
|
format: double
|
|
reportedrate:
|
|
description: Reported Rate
|
|
type: number
|
|
format: double
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
type: number
|
|
format: double
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
type: number
|
|
format: double
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
type: number
|
|
format: double
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
type: number
|
|
format: double
|
|
stateid:
|
|
description: State
|
|
type: string
|
|
status:
|
|
description: Document Status
|
|
type: string
|
|
subtotal:
|
|
description: Reported Tax
|
|
format: double
|
|
type: number
|
|
taxinstances:
|
|
items:
|
|
$ref: "#/definitions/TaxInstance"
|
|
type: array
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount
|
|
format: double
|
|
type: number
|
|
totalarea:
|
|
description: Total Area
|
|
format: int64
|
|
type: number
|
|
unitbase:
|
|
description: Unit Base
|
|
type: number
|
|
waterarea:
|
|
description: Water Area
|
|
format: int64
|
|
type: number
|
|
type: object
|
|
PlaceResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Place"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Pricebook:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
isactive:
|
|
description: Active
|
|
type: boolean
|
|
isstandard:
|
|
description: Is Standard Price Book
|
|
type: boolean
|
|
name:
|
|
description: Price Book Name
|
|
type: string
|
|
type: object
|
|
PricebookEntry:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Active
|
|
type: string
|
|
agentid:
|
|
description: Created By
|
|
type: string
|
|
id:
|
|
description: Record Id
|
|
type: string
|
|
pricebook:
|
|
$ref: "#/definitions/Pricebook"
|
|
procuct:
|
|
$ref: "#/definitions/Product"
|
|
productcode:
|
|
description: Product Code
|
|
type: string
|
|
unitprice:
|
|
description: List Price
|
|
format: double
|
|
type: number
|
|
usestandardprice:
|
|
description: Use Standard Price
|
|
type: boolean
|
|
type: object
|
|
Product:
|
|
properties:
|
|
AccountID:
|
|
description: The ID of the Account that owns this product
|
|
type: string
|
|
AgencyType:
|
|
description: Agency Type
|
|
type: string
|
|
AssetTracking:
|
|
description: Asset Tracking?
|
|
type: boolean
|
|
CreatedByID:
|
|
description: ID of who created this record instance
|
|
type: string
|
|
CreatedDate:
|
|
description: Date of record creation
|
|
type: string
|
|
Description:
|
|
description: Product Description
|
|
type: string
|
|
DescriptionSKU:
|
|
description: DescriptionSKU
|
|
type: string
|
|
DisplayURL:
|
|
description: Display URL
|
|
type: string
|
|
Family:
|
|
description: Product Family
|
|
type: string
|
|
ID:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
Image500:
|
|
description: Image (500)
|
|
type: string
|
|
ImageFull:
|
|
description: Image (Full)
|
|
type: string
|
|
InventoryTracking:
|
|
description: Inventory Tracking?
|
|
type: boolean
|
|
IsActive:
|
|
description: Active
|
|
type: boolean
|
|
IsGeneric:
|
|
description: isGeneric
|
|
type: boolean
|
|
LastModifiedByID:
|
|
description: Last modified by ID
|
|
type: string
|
|
LastModfiedDate:
|
|
type: string
|
|
description: Last Modified Date
|
|
Manufacturer:
|
|
description: Manufacturer
|
|
type: string
|
|
ManufacturerProductCode:
|
|
description: Manufacturer Product Code
|
|
type: string
|
|
MRCInterval:
|
|
description: MRC Interval
|
|
format: int64
|
|
type: number
|
|
MSRP:
|
|
description: MSRP
|
|
format: double
|
|
type: number
|
|
Name:
|
|
description: Product Name
|
|
type: string
|
|
ProductCode:
|
|
description: Product Code
|
|
type: string
|
|
Prorateable:
|
|
description: Prorateable?
|
|
type: boolean
|
|
Publish:
|
|
description: Publish?
|
|
type: boolean
|
|
PublishUPC:
|
|
description: Publish UPC
|
|
type: string
|
|
QuantityUnitOfMeasure:
|
|
description: Quantity Unit Of Measure
|
|
type: string
|
|
Refundable:
|
|
description: Refundable?
|
|
type: boolean
|
|
ShippingWeight:
|
|
description: Shipping Weight
|
|
format: double
|
|
type: number
|
|
SKU:
|
|
description: SKU
|
|
type: string
|
|
Specifications:
|
|
description: Specifications
|
|
type: string
|
|
TaxnexusCodeID:
|
|
description: Taxnexus Code
|
|
type: string
|
|
TaxnexusCode:
|
|
description: Taxnexus Code Name
|
|
type: string
|
|
TenantID:
|
|
description: tenant identifier
|
|
type: string
|
|
Units:
|
|
description: Units
|
|
type: string
|
|
VendorID:
|
|
description: Vendor
|
|
type: string
|
|
VendorName:
|
|
description: Vendor Name
|
|
type: string
|
|
VendorPartNumber:
|
|
description: Vendor Part Number
|
|
type: string
|
|
VendorPrice:
|
|
description: Vendor Price
|
|
format: double
|
|
type: number
|
|
type: object
|
|
ProductRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Product"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
ProductResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Product"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
PurchaseOrder:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
type: string
|
|
creditcardid:
|
|
type: string
|
|
date_expires:
|
|
description: Date Expires
|
|
type: string
|
|
date_promised:
|
|
description: Date Promised
|
|
type: string
|
|
date_requested:
|
|
description: Date Requested
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
duedate:
|
|
description: Due Date
|
|
type: string
|
|
enduserid:
|
|
type: string
|
|
grand_total:
|
|
description: Grand Total
|
|
format: double
|
|
type: number
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
items:
|
|
items:
|
|
$ref: "#/definitions/PurchaseOrderItem"
|
|
type: array
|
|
lineitemcount:
|
|
description: Line Item Count
|
|
format: int64
|
|
type: number
|
|
opportunityid:
|
|
description: Opportunity Name
|
|
type: string
|
|
orderid:
|
|
description: Order Number
|
|
type: string
|
|
parentfk:
|
|
description: The record identifier from the source system
|
|
type: string
|
|
paymentterms:
|
|
description: Payment Terms
|
|
type: string
|
|
podate:
|
|
description: Date
|
|
type: string
|
|
ponumber:
|
|
description: Number
|
|
type: string
|
|
posted:
|
|
description: Posted
|
|
type: boolean
|
|
quoteid:
|
|
description: Quote Name
|
|
type: string
|
|
sales_tax:
|
|
description: Addl Tax
|
|
format: double
|
|
type: number
|
|
salesregulation:
|
|
description: Sales Regulation Type (Medicinal or Recreational)
|
|
type: string
|
|
service_term:
|
|
description: Service Term
|
|
type: string
|
|
ship_date:
|
|
description: Ship Date
|
|
type: string
|
|
shipping_country:
|
|
description: Shipping Country
|
|
type: string
|
|
shipping_special_instructions:
|
|
description: Shipping Special Instructions
|
|
type: string
|
|
shippingaddress:
|
|
description: Shipping Address
|
|
type: string
|
|
shippingcity:
|
|
description: Shipping City
|
|
type: string
|
|
shippingcontactid:
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
format: double
|
|
type: number
|
|
shippingpostalcode:
|
|
description: Shipping Postal Code
|
|
type: string
|
|
shippingstate:
|
|
description: Shipping State
|
|
type: string
|
|
shippingstreet:
|
|
description: Shipping Street
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
taxable:
|
|
description: Taxable?
|
|
type: string
|
|
taxitems:
|
|
description: The taxes associated with this Purchase Order
|
|
items:
|
|
$ref: "#/definitions/TaxTransaction"
|
|
type: array
|
|
totalprice:
|
|
description: Total Price
|
|
format: double
|
|
type: number
|
|
type:
|
|
description: Type
|
|
type: string
|
|
vendorid:
|
|
type: string
|
|
vendorquotenumber:
|
|
description: Vendor Quote Number
|
|
type: string
|
|
type: object
|
|
PurchaseOrderBasic:
|
|
properties:
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
amount:
|
|
description: Purchase Order Amount
|
|
type: number
|
|
amountdue:
|
|
description: Amount Due
|
|
format: double
|
|
type: number
|
|
coordinate:
|
|
$ref: "#/definitions/Address"
|
|
id:
|
|
description: Order Id
|
|
type: string
|
|
items:
|
|
items:
|
|
$ref: "#/definitions/ItemBasic"
|
|
type: array
|
|
podate:
|
|
description: Purcahse Order Date
|
|
type: string
|
|
ponumber:
|
|
description: Purchase Order Number
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type (Medicinal or Recreational)
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
type:
|
|
description: Type
|
|
type: string
|
|
type: object
|
|
PurchaseOrderItem:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
description:
|
|
description: Line Item Description
|
|
type: string
|
|
due_date:
|
|
description: Due Date
|
|
type: string
|
|
enduserid:
|
|
description: End User
|
|
type: string
|
|
id:
|
|
description: Record Id
|
|
type: string
|
|
linenumber:
|
|
description: Line
|
|
format: int64
|
|
type: number
|
|
locationid:
|
|
description: Location
|
|
type: string
|
|
orderitemid:
|
|
description: Order Item
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
The record identifier of the parent record from the source
|
|
system
|
|
type: string
|
|
partneraccountid:
|
|
description: Partner Account
|
|
type: string
|
|
posted:
|
|
description: Posted
|
|
type: boolean
|
|
pricebookentryid:
|
|
description: PricebookEntryID
|
|
type: string
|
|
product:
|
|
description: Product
|
|
type: object
|
|
productcode:
|
|
description: Product Code
|
|
type: string
|
|
purchaseorderid:
|
|
description: Purchase Order
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
format: double
|
|
type: number
|
|
quotelineitemid:
|
|
description: Quote Item
|
|
type: string
|
|
received_qty:
|
|
description: Received Qty
|
|
format: double
|
|
type: number
|
|
rejected_qty:
|
|
description: Rejected Qty
|
|
format: double
|
|
type: number
|
|
seq:
|
|
description: Record ID Name
|
|
type: string
|
|
shipmentitmeid:
|
|
description: Shipment Item
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
stocked_qty:
|
|
description: Stocked Qty
|
|
format: double
|
|
type: number
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
taxable:
|
|
description: Taxable?
|
|
type: string
|
|
taxnexuscode:
|
|
description: Taxnexus Code
|
|
type: string
|
|
totalprice:
|
|
description: Total Price
|
|
format: double
|
|
type: number
|
|
unitprice:
|
|
description: Unit Price
|
|
format: double
|
|
type: number
|
|
type: object
|
|
PurchaseOrderRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/PurchaseOrder"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
PurchaseOrderResponse:
|
|
description: An array of Purchase Order Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/PurchaseOrder"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Quote:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
type: string
|
|
additionaladdress:
|
|
description: Additional To
|
|
type: object
|
|
additionalname:
|
|
description: Additional To Name
|
|
type: string
|
|
billingaddress:
|
|
description: Bill To
|
|
type: object
|
|
billingcontactid:
|
|
type: string
|
|
billingname:
|
|
description: Bill To Name
|
|
type: string
|
|
cannabistax:
|
|
description: Cannabis Tax
|
|
format: double
|
|
type: number
|
|
contactid:
|
|
type: string
|
|
contractid:
|
|
type: string
|
|
coordinateid:
|
|
type: string
|
|
creditterms:
|
|
description: Credit Terms
|
|
type: string
|
|
date:
|
|
description: Quote Date
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
discount:
|
|
description: Discount
|
|
format: double
|
|
type: number
|
|
discountamount:
|
|
description: Discount Amount
|
|
format: double
|
|
type: number
|
|
email:
|
|
description: Email
|
|
type: string
|
|
enduserid:
|
|
type: string
|
|
expirationdate:
|
|
description: Expiration Date
|
|
type: string
|
|
fax:
|
|
description: Fax
|
|
type: string
|
|
grandtotal:
|
|
description: Grand Total
|
|
format: double
|
|
type: number
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
installationdate:
|
|
description: Installation Date
|
|
type: string
|
|
issyncing:
|
|
description: Syncing
|
|
type: boolean
|
|
items:
|
|
items:
|
|
$ref: "#/definitions/QuoteItem"
|
|
type: array
|
|
lineitemcount:
|
|
description: Line Items
|
|
format: int64
|
|
type: number
|
|
monthlyamount:
|
|
description: Monthly Amount
|
|
format: double
|
|
type: number
|
|
name:
|
|
description: Quote Name
|
|
type: string
|
|
opportunityid:
|
|
description: Opportunity Name
|
|
type: string
|
|
ownerid:
|
|
description: Owner Name
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
paymentterms:
|
|
description: Payment Terms
|
|
type: string
|
|
phone:
|
|
description: Phone
|
|
type: string
|
|
purchaseamount:
|
|
description: Purchase Amount
|
|
format: double
|
|
type: number
|
|
quoteamount:
|
|
description: Quote Amount
|
|
format: double
|
|
type: number
|
|
quotenumber:
|
|
description: Quote Number
|
|
type: string
|
|
quotetoaddress:
|
|
description: Quote To
|
|
type: object
|
|
quotetoname:
|
|
description: Quote To Name
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type
|
|
type: string
|
|
serviceterm:
|
|
description: Service Term
|
|
type: string
|
|
shippingaddress:
|
|
description: Ship To
|
|
type: object
|
|
shippingcontactid:
|
|
description: Shipping Contact
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping and Handling
|
|
format: double
|
|
type: number
|
|
shippingname:
|
|
description: Ship To Name
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
suppressworkflow:
|
|
description: Suppress Workflow?
|
|
type: boolean
|
|
tax:
|
|
description: Tax
|
|
format: double
|
|
type: number
|
|
taxitems:
|
|
description: The taxes associated with this Quote
|
|
items:
|
|
$ref: "#/definitions/TaxTransaction"
|
|
type: array
|
|
telecomtax:
|
|
description: Telecom Tax
|
|
format: double
|
|
type: number
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
totalprice:
|
|
description: Total Price
|
|
format: double
|
|
type: number
|
|
type:
|
|
description: Quote Type
|
|
type: string
|
|
type: object
|
|
QuoteBasic:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
amount:
|
|
description: Quote Amount
|
|
type: number
|
|
amountdue:
|
|
description: Amount Due
|
|
type: number
|
|
coordinate:
|
|
$ref: "#/definitions/Address"
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
items:
|
|
items:
|
|
$ref: "#/definitions/QuoteItemBasic"
|
|
type: array
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
quotedate:
|
|
description: Quote Date
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
salesregulation:
|
|
description: Sales Regulation Type (Medicinal or Recreational)
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
type:
|
|
description: Type
|
|
type: string
|
|
type: object
|
|
QuoteItem:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
description:
|
|
description: Line Item Description
|
|
type: string
|
|
discount:
|
|
description: Discount
|
|
format: double
|
|
type: number
|
|
discountamount:
|
|
description: Discount Amount
|
|
format: double
|
|
type: number
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
linegrossamount:
|
|
description: Line Gross Amount
|
|
format: double
|
|
type: number
|
|
linenumber:
|
|
description: Line Item Number
|
|
type: string
|
|
listprice:
|
|
description: List Price
|
|
type: number
|
|
locationid:
|
|
description: Location
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
productid:
|
|
description: Product record ID
|
|
type: string
|
|
productname:
|
|
description: Product Name
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
format: double
|
|
type: number
|
|
quoteid:
|
|
description: Quote Name
|
|
type: string
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
servicedate:
|
|
description: Date
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
format: double
|
|
type: number
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
supplierid:
|
|
description: Supplier
|
|
type: string
|
|
taxable:
|
|
description: Taxable?
|
|
format: double
|
|
type: string
|
|
totalprice:
|
|
description: Total Price
|
|
format: double
|
|
type: number
|
|
unitprice:
|
|
description: Sales Price
|
|
format: double
|
|
type: number
|
|
type: object
|
|
QuoteItemBasic:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
description:
|
|
description: Line Item Description
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
invoiceid:
|
|
description: Invoice
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
productcode:
|
|
description: Product Code
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
format: double
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
shippinghandling:
|
|
description: Shipping & Handling
|
|
format: double
|
|
type: number
|
|
subtotal:
|
|
description: Subtotal
|
|
format: double
|
|
type: number
|
|
taxnexuscode:
|
|
description: Taxnexus Code
|
|
type: string
|
|
unitprice:
|
|
description: Unit Price
|
|
format: double
|
|
type: number
|
|
type: object
|
|
QuoteResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Quote"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
RequestMeta:
|
|
properties:
|
|
TaxnexusAccount:
|
|
description: Taxnexus Account Number of the Reseller or OEM
|
|
type: string
|
|
required:
|
|
- TaxnexusAccount
|
|
type: object
|
|
ResponseMeta:
|
|
properties:
|
|
Contact:
|
|
description: Contact Info
|
|
type: string
|
|
Copyright:
|
|
description: Copyright Info
|
|
type: string
|
|
Info:
|
|
description: API Information
|
|
type: string
|
|
License:
|
|
description: License Info
|
|
type: string
|
|
OperationID:
|
|
type: string
|
|
Pagination:
|
|
$ref: "#/definitions/Pagination"
|
|
RequestIP:
|
|
type: string
|
|
RequestType:
|
|
type: string
|
|
RequestURL:
|
|
type: string
|
|
ServerInfo:
|
|
type: string
|
|
ServerResponseTime:
|
|
type: string
|
|
ServerTimeStamp:
|
|
type: string
|
|
TaxnexusAccount:
|
|
type: string
|
|
UserID:
|
|
type: string
|
|
type: object
|
|
Service:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: Taxnexus Record Id
|
|
active:
|
|
type: boolean
|
|
description: Active?
|
|
clusterid:
|
|
type: string
|
|
description: Cluster
|
|
clusterip:
|
|
type: string
|
|
description: Cluster IP
|
|
clusterurl:
|
|
type: string
|
|
description: Cluster URL
|
|
createdbyid:
|
|
type: string
|
|
description: Created By
|
|
createddate:
|
|
type: string
|
|
description: Created Date
|
|
environment:
|
|
type: string
|
|
description: Environment
|
|
externalurl:
|
|
type: string
|
|
description: External URL
|
|
gelfaddress:
|
|
type: string
|
|
description: GELF Address
|
|
lastmodifiedbyid:
|
|
type: string
|
|
description: Last Modified By
|
|
lastmodifieddate:
|
|
type: string
|
|
description: Last Modified Date
|
|
networkalias:
|
|
type: string
|
|
description: Network Alias
|
|
openapiversion:
|
|
type: string
|
|
description: OpenAPI Version
|
|
ownerid:
|
|
type: string
|
|
description: Owner
|
|
portexternal:
|
|
type: string
|
|
description: Port - External
|
|
porttest:
|
|
type: string
|
|
description: Port - Test
|
|
proxytype:
|
|
type: string
|
|
description: Proxy Type
|
|
replicas:
|
|
type: number
|
|
format: int64
|
|
description: Replicas
|
|
repourl:
|
|
type: string
|
|
description: Repo URL
|
|
servicename:
|
|
type: string
|
|
description: Service Name
|
|
tenantid:
|
|
type: string
|
|
description: tenantid
|
|
version:
|
|
type: string
|
|
description: Version
|
|
ServiceRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Service"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
required:
|
|
- meta
|
|
- data
|
|
type: object
|
|
ServiceResponse:
|
|
description: An array of Service Objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Service"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
State:
|
|
properties:
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
amount:
|
|
description: Rollup Amount
|
|
format: double
|
|
type: number
|
|
code:
|
|
description: State Code
|
|
type: string
|
|
contactid:
|
|
description: Contact
|
|
type: string
|
|
latitude:
|
|
type: number
|
|
format: double
|
|
longitude:
|
|
type: number
|
|
format: double
|
|
contryid:
|
|
description: Country
|
|
type: string
|
|
division:
|
|
description: Division
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Enrollment Status
|
|
type: string
|
|
fips:
|
|
description: FIPS
|
|
type: string
|
|
geocode:
|
|
description: State Geocode
|
|
type: string
|
|
gnis:
|
|
description: GNIS
|
|
type: number
|
|
format: int64
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
interest:
|
|
description: Interest
|
|
type: number
|
|
landarea:
|
|
description: Land Area
|
|
type: number
|
|
format: int64
|
|
name:
|
|
description: State Name
|
|
type: string
|
|
penalty:
|
|
description: Penalty
|
|
type: number
|
|
format: double
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
region:
|
|
description: Region
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
type: number
|
|
format: double
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
type: number
|
|
format: double
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
type: number
|
|
format: double
|
|
reportedrate:
|
|
description: Reported Rate
|
|
type: number
|
|
format: double
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
type: number
|
|
format: double
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
type: number
|
|
format: double
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
type: number
|
|
format: double
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
type: number
|
|
format: double
|
|
sgc:
|
|
description: SGC
|
|
type: string
|
|
status:
|
|
description: Document Status
|
|
type: string
|
|
subtotal:
|
|
description: Reported Tax
|
|
type: number
|
|
format: double
|
|
taxinstances:
|
|
items:
|
|
$ref: "#/definitions/TaxInstance"
|
|
type: array
|
|
templateid:
|
|
description: Template
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount
|
|
type: number
|
|
format: double
|
|
totalarea:
|
|
description: Total Area
|
|
type: number
|
|
format: int64
|
|
unitbase:
|
|
description: Unit Base
|
|
type: number
|
|
format: double
|
|
waterarea:
|
|
description: Water Area
|
|
format: int64
|
|
type: number
|
|
type: object
|
|
StateResponse:
|
|
description: An array of State objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/State"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Statement:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
account:
|
|
description: Account
|
|
type: string
|
|
accountbalance:
|
|
description: Account Balance
|
|
type: number
|
|
accountcity:
|
|
description: Account City
|
|
type: string
|
|
accountcountry:
|
|
description: Account Country
|
|
type: string
|
|
accountname:
|
|
description: Account Name
|
|
type: string
|
|
accountpostalcode:
|
|
description: Account Postal Code
|
|
type: string
|
|
accountstate:
|
|
description: Account State
|
|
type: string
|
|
accountstatecode:
|
|
description: Account State Code
|
|
type: string
|
|
accountstreet:
|
|
description: Account Street
|
|
type: string
|
|
billingcountrycode:
|
|
description: Billing Country Code
|
|
type: string
|
|
contact:
|
|
description: Contact
|
|
type: string
|
|
date:
|
|
description: Statement Date
|
|
type: string
|
|
datefrom:
|
|
description: Date From
|
|
type: string
|
|
dateto:
|
|
description: Date To
|
|
type: string
|
|
deliverymethod:
|
|
description: Delivery Method
|
|
type: string
|
|
name:
|
|
description: Statement Number
|
|
type: string
|
|
recipientemail:
|
|
description: Recipient Email
|
|
type: string
|
|
recipienttype:
|
|
description: Recipient Type
|
|
type: string
|
|
statementid:
|
|
description: Statement Salesforce ID
|
|
type: string
|
|
type: object
|
|
StatementRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Statement"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
StatementResponse:
|
|
description: An array of Statement objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Statement"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Submission:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
companyid:
|
|
description: The Company that did the submission (Taxnexus)
|
|
type: string
|
|
contactid:
|
|
description: Submission Contact
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
notes:
|
|
description: Cover Letter
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
penalty:
|
|
description: Penalty paid
|
|
format: double
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
format: double
|
|
type: number
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
format: double
|
|
type: number
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
format: double
|
|
type: number
|
|
reportedrate:
|
|
description: Reported Rate
|
|
format: double
|
|
type: number
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
format: double
|
|
type: number
|
|
revenuebase:
|
|
description: Revenue Base
|
|
format: double
|
|
type: number
|
|
revenuenet:
|
|
description: Revenue Net
|
|
format: double
|
|
type: number
|
|
revenuenottaxable:
|
|
description: Revenue Not Taxable
|
|
format: double
|
|
type: number
|
|
status:
|
|
description: Status
|
|
type: string
|
|
date:
|
|
description: Submission Date
|
|
type: string
|
|
submissionnumber:
|
|
description: Submission Number
|
|
type: string
|
|
subtotal:
|
|
description: Amount of remittance before penalty
|
|
format: double
|
|
type: number
|
|
taxtypeid:
|
|
description:
|
|
Taxnexus ID of the TaxType for which this submssion is being
|
|
made
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount of remittance
|
|
format: double
|
|
type: number
|
|
type: object
|
|
SubmissionRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Submission"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
SubmissionResponse:
|
|
description: An array of Submission objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Submission"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Subscription:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
type: string
|
|
activateddate:
|
|
description: Activated Date
|
|
type: string
|
|
activateduserid:
|
|
description: Activated By
|
|
type: string
|
|
allowedminutesinbound:
|
|
description: Allowed Minutes Inbound
|
|
format: double
|
|
type: number
|
|
allowedminutesoutbound:
|
|
description: Allowed Minutes Outbound
|
|
format: double
|
|
type: number
|
|
amount:
|
|
description: Amount
|
|
format: double
|
|
type: number
|
|
assetid:
|
|
description: Asset Name
|
|
type: string
|
|
auditmessage:
|
|
description: Audit Trail Message
|
|
type: string
|
|
canceldate:
|
|
description: Cancel Date
|
|
type: string
|
|
contract:
|
|
$ref: "#/definitions/ContractBasic"
|
|
description:
|
|
description: Description
|
|
type: string
|
|
directionsensitive:
|
|
description: Direction Sensitive Rating?
|
|
type: boolean
|
|
effectivedate:
|
|
description: Effective Date
|
|
type: string
|
|
email:
|
|
description: Email
|
|
type: string
|
|
enduserid:
|
|
type: string
|
|
fax_emails:
|
|
description: Fax Emails
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
isactive:
|
|
description: Active?
|
|
type: boolean
|
|
orderdate:
|
|
description: Order Date
|
|
type: string
|
|
orderitemid:
|
|
description: Order Item
|
|
type: string
|
|
overagerateinbound:
|
|
description: Overage Rate Inbound
|
|
format: double
|
|
type: number
|
|
overagerateoutbound:
|
|
description: Overage Rate Outbound
|
|
format: double
|
|
type: number
|
|
password:
|
|
description: Password
|
|
type: string
|
|
paymentterms:
|
|
description: Payment Terms
|
|
type: string
|
|
pricebookid:
|
|
description: Price Book
|
|
type: string
|
|
productid:
|
|
description: Product record ID
|
|
type: string
|
|
productcode:
|
|
description: Product Code
|
|
type: string
|
|
productname:
|
|
description: Product Name
|
|
type: string
|
|
quantity:
|
|
description: Quantity
|
|
type: string
|
|
quoteitemid:
|
|
description: Quote Item
|
|
type: string
|
|
seq:
|
|
description: Subscription ID
|
|
type: string
|
|
status:
|
|
description: Status
|
|
type: string
|
|
suretax:
|
|
description: Suretax Code
|
|
type: string
|
|
tollfreerating:
|
|
description: tollfreeRating
|
|
type: boolean
|
|
type:
|
|
description: Type
|
|
type: string
|
|
unitprice:
|
|
description: Unit Price
|
|
format: double
|
|
type: number
|
|
units:
|
|
description: Units
|
|
type: string
|
|
unlimited:
|
|
description: Unlimited usage?
|
|
type: boolean
|
|
username:
|
|
description: Username
|
|
type: string
|
|
type: object
|
|
SubscriptionRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Subscription"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
SubscriptionResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Subscription"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
TaxInstance:
|
|
properties:
|
|
countryid:
|
|
description:
|
|
The Taxnexus ID of the Country that owns this instance
|
|
type: string
|
|
countyid:
|
|
description:
|
|
The Taxnexus ID of the County that owns this instance
|
|
type: string
|
|
createdbyid:
|
|
type: string
|
|
createddate:
|
|
description: The creation date of this database record
|
|
type: string
|
|
lastmodifiedbyid:
|
|
type: string
|
|
lastmodifieddate:
|
|
type: string
|
|
placeid:
|
|
description:
|
|
The Taxnexus ID of the Place that owns this instance
|
|
type: string
|
|
stateid:
|
|
description:
|
|
The Taxnexus ID of the State that owns this instance
|
|
type: string
|
|
taxtypeid:
|
|
description: The Taxnexus Tax Type ID of this instance
|
|
type: string
|
|
type:
|
|
description:
|
|
"The Type of instance refers to the linking object (place,
|
|
county, state, country)"
|
|
type: string
|
|
type: object
|
|
TaxInvoicesRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/InvoiceBasic"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
TaxOrdersRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/OrderBasic"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
TaxPurchaseOrdersRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/PurchaseOrderBasic"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
TaxQuotesRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/QuoteBasic"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
TaxTransaction:
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
amount:
|
|
description: Amount
|
|
format: double
|
|
type: number
|
|
effectiverate:
|
|
description: Effective Rate
|
|
format: double
|
|
type: number
|
|
filingid:
|
|
description: Filing
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
invoiceid:
|
|
description: Invoice
|
|
type: string
|
|
invoiceitemid:
|
|
description: Invoice Item
|
|
type: string
|
|
issummary:
|
|
description: isSummary
|
|
type: boolean
|
|
journalitemid:
|
|
description:
|
|
"The Id of the GL Journal Item, part of a Journal Entry"
|
|
type: string
|
|
orderid:
|
|
description: Order
|
|
type: string
|
|
orderitemid:
|
|
description: Order Product
|
|
type: string
|
|
percenttaxable:
|
|
description: Percent Taxable
|
|
format: double
|
|
type: number
|
|
periodid:
|
|
description: Period
|
|
type: string
|
|
placeid:
|
|
description: Place
|
|
type: string
|
|
posted:
|
|
description: Posted
|
|
type: boolean
|
|
quoteid:
|
|
description: Quote
|
|
type: string
|
|
quoteitemid:
|
|
description: Quote Line Item
|
|
type: string
|
|
ratingingestid:
|
|
description: Rating Ingest
|
|
type: string
|
|
ratingtype:
|
|
description: Rating Type
|
|
type: string
|
|
revenuebase:
|
|
description: Revenue Base
|
|
format: double
|
|
type: number
|
|
revenuenet:
|
|
description: Revenue Net
|
|
format: double
|
|
type: number
|
|
revenuenottaxable:
|
|
description: Revenue Not Taxable
|
|
format: double
|
|
type: number
|
|
taxexemptrevenue:
|
|
description: Tax Exempt Revenue
|
|
format: double
|
|
type: number
|
|
taxrate:
|
|
description: Tax Rate
|
|
format: double
|
|
type: number
|
|
taxtypeid:
|
|
description: Tax Type
|
|
type: string
|
|
unitbase:
|
|
description: Unit Base
|
|
format: double
|
|
type: number
|
|
unitfeerate:
|
|
description: Unit Fee Rate
|
|
format: double
|
|
type: number
|
|
type: object
|
|
TaxTransactionResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/TaxTransaction"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
TaxType:
|
|
properties:
|
|
accountid:
|
|
description: Authority Account Id
|
|
type: string
|
|
accountingrulecode:
|
|
description: The Accounting Rule Code used for GL Post
|
|
type: string
|
|
active:
|
|
description: Active
|
|
type: boolean
|
|
agencytype:
|
|
description: Agency Type
|
|
type: string
|
|
agentid:
|
|
description: Collection Agent Id
|
|
type: string
|
|
category:
|
|
description: Category
|
|
type: string
|
|
chaintype:
|
|
description: chain type
|
|
type: string
|
|
collectordomainid:
|
|
description: Collector Domain Id
|
|
type: string
|
|
companyid:
|
|
description: Company ID
|
|
type: string
|
|
contactid:
|
|
description: Authority Contact Id
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
effectivedate:
|
|
description: Effective Date
|
|
type: string
|
|
enddate:
|
|
description: End Date
|
|
type: string
|
|
enrollmentstatus:
|
|
description: Enrollment Status
|
|
type: string
|
|
filingcity:
|
|
description: Filing City
|
|
type: string
|
|
filingcountry:
|
|
description: Filing Country
|
|
type: string
|
|
filingemail:
|
|
description: Filing Email
|
|
type: string
|
|
filingmethod:
|
|
description: Filing Method
|
|
type: string
|
|
filingpostalcode:
|
|
description: Filing Postal Code
|
|
type: string
|
|
filingstate:
|
|
description: Filing State
|
|
type: string
|
|
filingstreet:
|
|
description: Filing Street
|
|
type: string
|
|
fractional:
|
|
description:
|
|
Does this Tax Type use a Fractional Basis for calculation?
|
|
type: boolean
|
|
frequency:
|
|
description: Frequency
|
|
type: string
|
|
geocodestring:
|
|
description: Geocode String
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id
|
|
type: string
|
|
interestrate:
|
|
description: Interest Rate
|
|
format: double
|
|
type: number
|
|
ismedicinal:
|
|
description: Business Tax?
|
|
type: boolean
|
|
isrecreational:
|
|
description: Cannabis Tax?
|
|
type: boolean
|
|
itemamount:
|
|
description: Rollup Amount
|
|
format: double
|
|
type: number
|
|
itemcount:
|
|
description: Rollup Tax Items
|
|
format: double
|
|
type: number
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
markuprate:
|
|
description:
|
|
The wholesale markup rate for Excise tax (CA cannabis)
|
|
format: double
|
|
type: number
|
|
name:
|
|
description: Tax Type Name (unique)
|
|
type: string
|
|
passthrough:
|
|
description:
|
|
Is this tax allowed to be passed-through to retail customers?
|
|
type: boolean
|
|
penaltydays:
|
|
description: Number of days until penalty is assessed
|
|
format: int64
|
|
type: number
|
|
penaltyrate:
|
|
description: The percentage rate of a penalty (per month)
|
|
format: double
|
|
type: number
|
|
rate:
|
|
description: Tax Rate
|
|
format: double
|
|
type: number
|
|
reference:
|
|
description: Tax Website Reference
|
|
type: string
|
|
salesregulation:
|
|
description: Salesregulation Code for this TaxType
|
|
type: string
|
|
status:
|
|
description: TaxType Document Status
|
|
type: string
|
|
taxnexuscodeid:
|
|
description: Taxnexus Code Id
|
|
type: string
|
|
taxnexusnumber:
|
|
description: The Tax Type number assigned by Taxnexus
|
|
type: string
|
|
templateid:
|
|
description: Rendering Template Id
|
|
type: string
|
|
unitbase:
|
|
description: Rollup Unit Base
|
|
format: double
|
|
type: number
|
|
units:
|
|
description: Units
|
|
type: string
|
|
type: object
|
|
TaxTypeAccount:
|
|
properties:
|
|
tenantid:
|
|
type: string
|
|
accountid:
|
|
description: Account
|
|
type: string
|
|
accountnumber:
|
|
description: Account Number
|
|
type: string
|
|
active:
|
|
description: Active
|
|
type: boolean
|
|
amount:
|
|
description: Rollup Amount
|
|
format: double
|
|
type: number
|
|
contactid:
|
|
description: Contact ID
|
|
type: string
|
|
createdbyid:
|
|
type: string
|
|
createddate:
|
|
type: string
|
|
description:
|
|
description: Description
|
|
type: string
|
|
enddate:
|
|
description: End Date
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
interest:
|
|
description: Interest
|
|
type: number
|
|
lastmodifiedbyid:
|
|
type: string
|
|
lastmodifieddate:
|
|
type: string
|
|
notes:
|
|
description: Notes
|
|
type: string
|
|
parentfk:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
penalty:
|
|
description: Penalty
|
|
format: double
|
|
type: number
|
|
ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
reportedadjustments:
|
|
description: Reported Adjustments
|
|
format: double
|
|
type: number
|
|
reporteddeductions:
|
|
description: Reported Deductions
|
|
format: double
|
|
type: number
|
|
reportednetrevenue:
|
|
description: Reported Net Revenue
|
|
format: double
|
|
type: number
|
|
reportedrate:
|
|
description: Reported Rate
|
|
format: double
|
|
type: number
|
|
reportedrevenue:
|
|
description: Reported Revenue
|
|
format: double
|
|
type: number
|
|
revenuebase:
|
|
description: Rollup Revenue Base
|
|
format: double
|
|
type: number
|
|
revenuenet:
|
|
description: Rollup Revenue Net
|
|
format: double
|
|
type: number
|
|
revenuenottaxable:
|
|
description: Rollup Revenue Not Taxable
|
|
format: double
|
|
type: number
|
|
startdate:
|
|
description: Start Date
|
|
type: string
|
|
subtotal:
|
|
description: Reported Tax
|
|
format: double
|
|
type: number
|
|
tax:
|
|
description: Rollup Tax
|
|
format: double
|
|
type: number
|
|
taxontax:
|
|
description: Rollup Tax on Tax
|
|
format: double
|
|
type: number
|
|
taxtypeid:
|
|
description: Tax Type
|
|
type: string
|
|
totalamount:
|
|
description: Total Amount
|
|
format: double
|
|
type: number
|
|
unitbase:
|
|
description: Rollup Unit Base
|
|
format: double
|
|
type: number
|
|
type: object
|
|
TaxTypeAccountRequest:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/TaxTypeAccount"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
TaxTypeAccountResponse:
|
|
description: An array of TaxType Account objects with Contacts
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/TaxTypeAccount"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
TaxTypeResponse:
|
|
description: An array of Tax Type objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/TaxType"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
TaxnexusCode:
|
|
properties:
|
|
active:
|
|
description: Is this an active Taxnexus Code?
|
|
type: boolean
|
|
code:
|
|
description: Taxnexus Code
|
|
type: string
|
|
createdbyid:
|
|
description: Created By User ID
|
|
type: string
|
|
createddate:
|
|
description: Created Date
|
|
type: string
|
|
description:
|
|
description: Taxnexus Code Description
|
|
type: string
|
|
domainid:
|
|
description: Domain ID
|
|
type: string
|
|
domainname:
|
|
description: Domain Name
|
|
type: string
|
|
id:
|
|
description: Taxnexus Record Id Only; not used in POST
|
|
type: string
|
|
level:
|
|
description: Level
|
|
type: string
|
|
lastmodifiedbyid:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
lastmodifieddate:
|
|
description: Last Modified Date
|
|
type: string
|
|
part1:
|
|
description: Taxnexus Code Part 1
|
|
type: string
|
|
part2:
|
|
description: Taxnexus Code Part 2
|
|
type: string
|
|
part3:
|
|
description: Taxnexus Code Part 3
|
|
type: string
|
|
part4:
|
|
description: Taxnexus Code Part 4
|
|
type: string
|
|
part5:
|
|
description: Taxnexus Code Part 4
|
|
type: string
|
|
purchasingrulesetcode:
|
|
description: Purchasing Ruleset AccountingRuleset Code
|
|
type: string
|
|
purchasingrulesetid:
|
|
description: Purchasing Ruleset AccountingRuleset ID
|
|
type: string
|
|
ref:
|
|
description: External reference, if any
|
|
type: string
|
|
revenuerulesetcode:
|
|
description: Revenue Ruleset AccountingRuleset Code
|
|
type: string
|
|
revenuerulesetid:
|
|
description: Revenue Ruleset AccountingRuleset ID
|
|
type: string
|
|
type: object
|
|
TaxnexusCodeResponse:
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/TaxnexusCode"
|
|
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
|
|
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
|
|
Notebook:
|
|
description: Defines a Taxnexus Notebook
|
|
type: object
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
id:
|
|
type: string
|
|
description: Record Id
|
|
accountid:
|
|
type: string
|
|
description: Account
|
|
contactid:
|
|
type: string
|
|
description: Contact
|
|
createdbyid:
|
|
type: string
|
|
description: Created By
|
|
createddate:
|
|
type: string
|
|
description: Created Date
|
|
date:
|
|
type: string
|
|
description: Analysis Date
|
|
dateend:
|
|
type: string
|
|
description: End Date
|
|
datestart:
|
|
type: string
|
|
description: Start Date
|
|
description:
|
|
type: string
|
|
description: Description
|
|
lastmodifiedbyid:
|
|
type: string
|
|
description: Last Modified By
|
|
lastmodifieddate:
|
|
type: string
|
|
description: Last Modifed Date
|
|
periodendid:
|
|
type: string
|
|
description: Ending Period
|
|
periodstartid:
|
|
type: string
|
|
description: Starting Period
|
|
preparerid:
|
|
type: string
|
|
description: Preparer
|
|
title:
|
|
type: string
|
|
description: Title
|
|
items:
|
|
type: array
|
|
items:
|
|
$ref: "#/definitions/NotebookItem"
|
|
NotebookRequest:
|
|
description: An array of Notebook objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Notebook"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/RequestMeta"
|
|
type: object
|
|
NotebookResponse:
|
|
description: An array of Notebook objects
|
|
properties:
|
|
data:
|
|
items:
|
|
$ref: "#/definitions/Notebook"
|
|
type: array
|
|
meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
NotebookItem:
|
|
type: object
|
|
description: An analysis item associated with a Notebook
|
|
properties:
|
|
tenantid:
|
|
description: tenant identifier
|
|
type: string
|
|
id:
|
|
type: string
|
|
description: Record Id
|
|
itemname:
|
|
type: string
|
|
description: Developer name of component
|
|
title:
|
|
type: string
|
|
description: Display title
|
|
notebookid:
|
|
type: string
|
|
description: The notebook that owns this Item
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|