diff --git a/Makefile b/Makefile index f2ffa85..5abff95 100644 --- a/Makefile +++ b/Makefile @@ -1,160 +1,108 @@ -TAXNEXUS_VERSION ?= 1.2.7 -TAXNEXUS_REPO_NAME = rules -TAXNEXUS_BUILD_ENV ?= dev -TEST_IP = 10.8.0.205 -TAXNEXUS_REGISTRY_PUB = docker.io -TAXNEXUS_REGISTRY_PRIV = hub.tnxs.net - -.PHONY: build run upload swagger docs apex mysql - -run: - docker run \ - -v /etc/taxnexus:/etc/taxnexus \ - --network=fabric-net \ - --log-driver=gelf --log-opt gelf-address=udp://packrat.noc.tnxs.net:12201 \ - --ip=$(TEST_IP) \ - --publish $(TEST_PORT):8080/tcp \ - taxnexus/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):latest - -upload: - # docker push $(TAXNEXUS_REGISTRY_PUB)/taxnexus/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):$(TAXNEXUS_VERSION) - # docker push $(TAXNEXUS_REGISTRY_PUB)/taxnexus/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):latest - docker push $(TAXNEXUS_REGISTRY_PRIV)/taxnexus/$(TAXNEXUS_REPO_NAME)/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):$(TAXNEXUS_VERSION) - docker push $(TAXNEXUS_REGISTRY_PRIV)/taxnexus/$(TAXNEXUS_REPO_NAME)/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):latest +.PHONY: swagger swagger: # # generate auth # rm -rf ./api - mkdir -p api/auth + mkdir -p api/v0.0.1/auth swagger generate client \ --log-output=./swagger/logs/generate-auth-client.log \ --copyright-file=./build/COPYRIGHT \ --name=auth \ --spec=./swagger/auth-taxnexus.yaml \ - --target=./api/auth \ + --target=./api/v0.0.1/auth \ --client-package=auth-client \ --model-package=auth-models \ --principal=app.User # # generate crm # - mkdir api/crm + mkdir api/v0.0.1/crm swagger generate client \ --log-output=./swagger/logs/generate-crm-client.log \ --copyright-file=./build/COPYRIGHT \ --name=crm \ --spec=./swagger/crm-taxnexus.yaml \ - --target=./api/crm \ + --target=./api/v0.0.1/crm \ --client-package=crm-client \ --model-package=crm-models \ --principal=app.User # # generate devops # - mkdir api/devops + mkdir api/v0.0.1/devops swagger generate client \ --log-output=./swagger/logs/generate-devops-client.log \ --copyright-file=./build/COPYRIGHT \ --name=devops \ --spec=./swagger/devops-taxnexus.yaml \ - --target=./api/devops \ + --target=./api/v0.0.1/devops \ --client-package=devops-client \ --model-package=devops-models \ --principal=app.User # # generate geo # - mkdir api/geo + mkdir api/v0.0.1/geo swagger generate client \ --log-output=./swagger/logs/generate-geo-client.log \ --copyright-file=./build/COPYRIGHT \ --name=geo \ --spec=./swagger/geo-taxnexus.yaml \ - --target=./api/geo \ + --target=./api/v0.0.1/geo \ --client-package=geo-client \ --model-package=geo-models \ --principal=app.User # # generate ledger # - mkdir api/ledger + mkdir api/v0.0.1/ledger swagger generate client \ --log-output=./swagger/logs/generate-ledger-client.log \ --copyright-file=./build/COPYRIGHT \ --name=ledger \ --spec=./swagger/ledger-taxnexus.yaml \ - --target=./api/ledger \ + --target=./api/v0.0.1/ledger \ --client-package=ledger-client \ --model-package=ledger-models \ --principal=app.User # # generate ops # - mkdir api/ops + mkdir api/v0.0.1/ops swagger generate client \ --log-output=./swagger/logs/generate-ops-client.log \ --copyright-file=./build/COPYRIGHT \ --name=ops \ --spec=./swagger/ops-taxnexus.yaml \ - --target=./api/ops \ + --target=./api/v0.0.1/ops \ --client-package=ops-client \ --model-package=ops-models \ --principal=app.User # # generate regs # - mkdir api/regs + mkdir api/v0.0.1/regs swagger generate client \ --log-output=./swagger/logs/generate-regs-client.log \ --copyright-file=./build/COPYRIGHT \ --name=regs \ --spec=./swagger/regs-taxnexus.yaml \ - --target=./api/regs \ + --target=./api/v0.0.1/regs \ --client-package=regs-client \ --model-package=regs-models \ --principal=app.User # # generate workflow # - mkdir api/workflow + mkdir api/v0.0.1/workflow swagger generate client \ --log-output=./swagger/logs/generate-workflow-client.log \ --copyright-file=./build/COPYRIGHT \ --name=workflow \ --spec=./swagger/workflow-taxnexus.yaml \ - --target=./api/workflow \ + --target=./api/v0.0.1/workflow \ --client-package=workflow-client \ --model-package=workflow-models \ --principal=app.User - -avro: - # generate avro stubs - # - rm -rf swagger/avro - mkdir swagger/avro - openapi-generator generate \ - --generator-name avro-schema \ - --input-spec ./swagger/rules-taxnexus.yaml \ - --output ./swagger/avro \ - -build: - # docker build - go mod tidy - docker build \ - --tag $(TAXNEXUS_REGISTRY_PUB)/taxnexus/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):$(TAXNEXUS_VERSION) \ - --tag $(TAXNEXUS_REGISTRY_PUB)/taxnexus/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):latest \ - --tag $(TAXNEXUS_REGISTRY_PRIV)/taxnexus/$(TAXNEXUS_REPO_NAME)/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):$(TAXNEXUS_VERSION) \ - --tag $(TAXNEXUS_REGISTRY_PRIV)/taxnexus/$(TAXNEXUS_REPO_NAME)/$(TAXNEXUS_REPO_NAME)_$(TAXNEXUS_BUILD_ENV):latest \ - --file ./build/Dockerfile \ - . - -mysql: - rm -rf swagger/mysql - mkdir swagger/mysql - docker run --rm \ - -v ${PWD}:/local openapitools/openapi-generator-cli generate \ - -i /local/swagger/rules-taxnexus.yaml \ - -g mysql-schema \ - -o /local/swagger/mysql \ No newline at end of file diff --git a/swagger/auth0.yaml b/swagger/auth0.yaml new file mode 100644 index 0000000..e22032f --- /dev/null +++ b/swagger/auth0.yaml @@ -0,0 +1,494 @@ +swagger: "2.0" +info: + version: "1.2.7" + title: "auth0" + description: "Auth0 Swagger Definition" + termsOfService: "http://taxnexus.net/terms/" + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc." +schemes: + - "https" +host: "taxnexus.auth0.com" +consumes: + - "application/json" +produces: + - "application/json" +parameters: + CredentialsRequest: + name: CredentialsRequest + in: body + required: true + description: Get Authentation Token + schema: + $ref: "#/definitions/CredentialsRequest" + email: + name: email + in: query + type: string + required: true + authHeader: + name: Authorization + in: header + type: string + required: true + UserRequest: + description: An array of User records + in: body + name: UserRequest + required: true + schema: + $ref: "#/definitions/UserRequest" + RoleUsersRequest: + description: An array of User IDs to add to a Role + in: body + name: RoleUsersRequest + required: true + schema: + $ref: "#/definitions/RoleUsersRequest" + UserRolesRequest: + description: An array of User IDs to add to a Role + in: body + name: UserRolesRequest + required: true + schema: + $ref: "#/definitions/UserRolesRequest" + roleId: + name: roleId + description: An Auth0 Role ID + type: string + in: path + required: true + userId: + name: userId + description: An Auth0 User ID + type: string + in: path + required: true +responses: + AccessForbidden: + description: "Access forbidden, account lacks access" + schema: + $ref: "#/definitions/Error" + NotFound: + description: Resource was not found + schema: + $ref: "#/definitions/Error" + ServerError: + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + 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: + items: + $ref: "#/definitions/User" + type: array + RoleResponse: + description: Taxnexus Response with User objects + schema: + $ref: "#/definitions/RoleResponse" + CredentialsResponse: + description: Credentials response from Auth0 + schema: + $ref: "#/definitions/CredentialsResponse" +paths: + /oauth/token: + post: + summary: post to /oauth/token + operationId: postCredentials + description: Get credential token + parameters: + - $ref: "#/parameters/CredentialsRequest" + tags: + - Auth + responses: + "200": + $ref: "#/responses/CredentialsResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + /api/v2/roles: + get: + summary: Get Roles from Auth0 + operationId: getRoles + description: Get Roles from Auth0 + tags: + - Role + parameters: + - $ref: "#/parameters/authHeader" + 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" + /api/v2/roles/{roleId}/users: + post: + summary: Add users to role + operationId: postRoleUsers + description: Add users to role + parameters: + - $ref: "#/parameters/authHeader" + - $ref: "#/parameters/RoleUsersRequest" + - $ref: "#/parameters/roleId" + tags: + - Role + responses: + "200": + description: Role users successfully updated + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /api/v2/users/{userId}/roles: + delete: + parameters: + - $ref: "#/parameters/authHeader" + - $ref: "#/parameters/userId" + - $ref: "#/parameters/UserRolesRequest" + tags: + - User + responses: + "204": + description: User roles successfully removed + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + get: + summary: Get a User's Roles + description: Get a User's Roles + operationId: getUserRoles + parameters: + - $ref: "#/parameters/authHeader" + - $ref: "#/parameters/userId" + tags: + - User + responses: + "200": + $ref: "#/responses/RoleResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /api/v2/users: + get: + summary: Get all users from Auth0 + operationId: getUsers + description: Get all users from Auth0 + parameters: + - $ref: "#/parameters/authHeader" + tags: + - User + responses: + "200": + $ref: "#/responses/UserResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /api/v2/users-by-email: + get: + summary: Get a single user from Auth0 by Email Address + operationId: getUserByEmail + description: Get a single user from Auth0 by Email Address + parameters: + - $ref: "#/parameters/authHeader" + - $ref: "#/parameters/email" + tags: + - User + responses: + "200": + $ref: "#/responses/UserResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + post: + summary: Create new Auth0 user + operationId: postUsers + description: create new Auth0 user + parameters: + - $ref: "#/parameters/authHeader" + - $ref: "#/parameters/UserRequest" + tags: + - User + responses: + "201": + description: New user created + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "409": + description: User already exists + "500": + $ref: "#/responses/ServerError" +definitions: + Error: + properties: + code: + format: int32 + type: integer + fields: + type: string + message: + type: string + type: object + Role: + properties: + id: + type: "string" + example: "rol_oWVoMn2Zx2qDSGUL" + name: + type: "string" + example: "Developer" + description: + type: "string" + example: "Taxnexus API Developer" + type: "object" + RoleResponse: + type: object + properties: + roles: + type: array + items: + $ref: "#/definitions/Role" + RoleUsersRequest: + properties: + users: + type: array + items: + type: string + UserRolesRequest: + properties: + roles: + type: array + items: + type: string + CredentialsRequest: + type: object + properties: + client_id: + type: string + client_secret: + type: string + audience: + type: string + grant_type: + type: string + CredentialsResponse: + type: object + properties: + access_token: + type: string + scope: + type: string + expires_in: + type: number + format: int64 + token_type: + format: string + NewUser: + type: object + properties: + email: + type: "string" + example: "john.doe@gmail.com" + phone_number: + type: "string" + example: "+199999999999999" + blocked: + type: "boolean" + example: false + email_verified: + type: "boolean" + example: false + phone_verified: + type: "boolean" + example: false + given_name: + type: "string" + example: "John" + family_name: + type: "string" + example: "Doe" + name: + type: "string" + example: "John Doe" + nickname: + type: "string" + example: "Johnny" + picture: + type: "string" + example: "https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png" + user_id: + type: "string" + example: "abc" + connection: + type: "string" + example: "Initial-Connection" + password: + type: "string" + example: "secret" + verify_email: + type: "boolean" + example: false + username: + type: "string" + example: "johndoe" + User: + properties: + email: + type: "string" + example: "vern@taxnexus.net" + email_verified: + type: "boolean" + example: true + user_id: + type: "string" + example: "auth0|5b180537157859716f2c9df5" + picture: + type: "string" + example: "https://s.gravatar.com/avatar/a08710b8d49416c729a0da8a9c34cdb0?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fve.png" + nickname: + type: "string" + example: "vern" + identities: + type: "array" + items: + type: "object" + properties: + connection: + type: "string" + example: "Username-Password-Authentication" + provider: + type: "string" + example: "auth0" + user_id: + type: "string" + example: "5b180537157859716f2c9df5" + isSocial: + type: "boolean" + example: false + updated_at: + type: "string" + example: "2020-09-22T19:19:02.706Z" + created_at: + type: "string" + example: "2018-06-06T16:00:55.930Z" + name: + type: "string" + example: "Vernon Keenan" + last_password_reset: + type: "string" + example: "2020-09-21T00:11:47.397Z" + multifactor_last_modified: + type: "string" + example: "2020-09-21T00:30:34.081Z" + family_name: + type: "string" + example: "Keenan" + given_name: + type: "string" + example: "Vernon" + user_metadata: + properties: + taxnexus_email: + type: "string" + example: "vern@taxnexus.net" + taxnexus_firstname: + type: "string" + example: "Vernon" + taxnexus_fullname: + type: "string" + example: "Vernon Keenan" + taxnexus_lastname: + type: "string" + example: "Keenan" + taxnexus_phone: + type: "string" + example: "+15106791900" + type: "object" + app_metadata: + properties: + taxnexus_account_id: + type: "string" + example: "7f661ca6-ae4a-486f-9c3c-cd292685a46d" + taxnexus_contact_id: + type: "string" + example: "9f79dca8-e875-4e2b-a5ad-001a3d32e83d" + taxnexus_user_id: + type: "string" + example: "f04da03d-70ad-46df-a46c-a676388aadd7" + roles: + type: "array" + items: + type: "string" + example: + - "login" + type: "object" + last_ip: + type: "string" + example: "67.188.106.161" + last_login: + type: "string" + example: "2020-09-22T19:19:02.706Z" + logins_count: + type: "number" + example: 178 + format: int64 + UserRequest: + description: An array Auth0 new user objects + properties: + users: + items: + $ref: "#/definitions/NewUser" + type: array + type: object diff --git a/swagger/blaze-taxnexus.yaml b/swagger/blaze-taxnexus.yaml new file mode 100644 index 0000000..7698373 --- /dev/null +++ b/swagger/blaze-taxnexus.yaml @@ -0,0 +1,8798 @@ +swagger: "2.0" +info: + version: 1.2.7 + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary" + termsOfService: "https://www.taxnexus.com/terms/" + title: "vendor-gw-blaze" + description: + "Taxnexus Gateway Client API for Blaze.me Cannabis Management System" +host: "api.blaze.me" +basePath: "/api/v1" +schemes: + - "https" +securityDefinitions: + ApiKeyAuth: + type: "apiKey" + in: "header" + name: "X-API-Key" +security: + - ApiKeyAuth: [] +consumes: + - "application/json" +produces: + - "application/json" +parameters: + activeStatusQuery: + description: "Get Active objects?" + in: "query" + name: "Active" + type: boolean + required: false + startDateQueryRequired: + description: "The start date of transaction query" + in: "query" + type: string + name: "startDate" + required: true + endDateQueryRequired: + description: "The end date of transaction query" + in: "query" + type: string + name: "endDate" + required: true + productionQuery: + description: "Use Production API?" + in: "query" + type: boolean + name: "production" + required: false + stateCodeQuery: + description: "The 2-character State Code" + in: "query" + type: string + name: "state" + required: true + paginationStartQuery: + description: "The starting record in multi-record retrievals" + type: number + in: "query" + name: "start" + required: false + paginationLimitQuery: + description: "The number of records to retrieve" + type: number + in: "query" + name: "limit" + required: false + itemNumberPathRequired: + description: "The Blaze Transaction Number" + in: "path" + type: string + name: "itemNumber" + required: true + productIdPathRequired: + description: "The Blaze Product Object Id" + in: "path" + type: string + name: "productId" + required: true + vendorIdPathRequired: + description: "The Blaze Vendor Object Id" + in: "path" + type: string + name: "vendorId" + required: true + memberIdPathRequired: + description: "The Blaze Member Object Id" + in: "path" + type: string + name: "memberId" + required: true +responses: + Unauthorized: + description: "Access unauthorized, invalid API-KEY was used" + schema: + $ref: "#/definitions/Error" + AccessForbidden: + description: "Access forbidden, account lacks access" + schema: + $ref: "#/definitions/Error" + Conflict: + description: "Conflict" + schema: + $ref: "#/definitions/Error" + InvalidDataError: + description: "Invalid data was sent" + schema: + $ref: "#/definitions/InvalidError" + ServerError: + description: "Server Internal Error" + schema: + $ref: "#/definitions/Error" + NotFound: + description: "Resource was not found" + schema: + $ref: "#/definitions/Error" + ServerMessage: + description: "A server message" + schema: + $ref: "#/definitions/Message" +paths: + "/partner/members/{memberId}": + get: + tags: + - Members + operationId: "getMember" + description: "Get A Member (contact)" + parameters: + - $ref: "#/parameters/memberIdPathRequired" + responses: + "200": + description: "Product was successfully retrieved" + schema: + $ref: "#/definitions/MemberResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/products": + get: + tags: + - Products + operationId: "getProducts" + description: "Get All Products" + responses: + "200": + description: "Products were successfully retrieved" + schema: + $ref: "#/definitions/ProductsResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/products/{productId}": + get: + tags: + - Products + operationId: "getProduct" + description: "Get A Product" + parameters: + - $ref: "#/parameters/productIdPathRequired" + responses: + "200": + description: "Product was successfully retrieved" + schema: + $ref: "#/definitions/ProductResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/store": + get: + tags: + - Shop + operationId: "getShop" + description: "Get basic Shop parameters" + responses: + "200": + description: "Shop was successfully retrieved" + schema: + $ref: "#/definitions/ShopResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/store/purchaseOrder/list": + get: + tags: + - Purchase Orders + operationId: "getPurchaseOrderList" + description: "Get a list of purchase orders" + parameters: + - $ref: "#/parameters/startDateQueryRequired" + - $ref: "#/parameters/endDateQueryRequired" + - $ref: "#/parameters/paginationLimitQuery" + - $ref: "#/parameters/paginationStartQuery" + responses: + "200": + description: "Shop was successfully retrieved" + schema: + $ref: "#/definitions/PurchaseOrderListResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/transactions": + get: + tags: + - Transactions + operationId: "getTransactions" + description: "Get a Range of Transactions" + parameters: + - $ref: "#/parameters/startDateQueryRequired" + - $ref: "#/parameters/endDateQueryRequired" + - $ref: "#/parameters/paginationLimitQuery" + - $ref: "#/parameters/paginationStartQuery" + responses: + "200": + description: "Transactions were successfully retrieved" + schema: + $ref: "#/definitions/TransactionsResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/transactions/{itemNumber}": + get: + tags: + - Transactions + operationId: "getTransactionById" + description: "Get a single transaction by ID" + parameters: + - $ref: "#/parameters/itemNumberPathRequired" + responses: + "200": + description: "A Transaction was successfully retrieved" + schema: + $ref: "#/definitions/TransactionByIdResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + "/partner/vendors/{vendorId}": + get: + tags: + - Vendors + operationId: "getVendor" + description: "Get A Vendor" + parameters: + - $ref: "#/parameters/vendorIdPathRequired" + responses: + "200": + description: "Product was successfully retrieved" + schema: + $ref: "#/definitions/VendorResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" +definitions: + Error: + properties: + error: + type: string + status: + maximum: 600 + minimum: 100 + type: integer + type: object + InvalidError: + allOf: + - $ref: "#/definitions/Error" + - properties: + details: + items: + type: string + type: array + type: object + MemberResponse: + properties: + activeTransaction: + example: 0 + type: number + address: + properties: + address: + example: 5125 Miles Ave + type: string + city: + example: Oakland + type: string + companyId: + example: string + type: string + country: + example: US + type: string + created: + example: 1554826014782 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cacc31e6218d174d3f17b6d + type: string + modified: + example: 1554826014782 + format: int64 + type: number + state: + example: CA + type: string + updated: + example: false + type: boolean + zipCode: + example: "94618" + type: string + type: object + addresses: + example: + - string + items: + type: string + type: array + agreementExpired: + example: false + type: boolean + anonymous: + example: false + type: boolean + banPatient: + example: false + type: boolean + cannabisResult: + example: string + type: string + careGiverList: + example: + - string + items: + type: string + type: array + careGivers: + example: + - string + items: + type: string + type: array + companyId: + example: 5cabd4ba6218d148395b402c + type: string + consumerType: + example: AdultUse + type: string + consumerUserId: + example: string + type: string + contracts: + example: + - string + items: + type: string + type: array + created: + example: 1554826014780 + format: int64 + type: number + currentCannabisLimit: + example: string + type: string + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + dlExpired: + example: false + type: boolean + dob: + example: 631180800000 + type: number + email: + example: hokus@taxnexus.net + type: string + emailOptIn: + example: true + type: boolean + emailVerified: + example: false + type: boolean + enableLoyalty: + example: true + type: boolean + enabledCareGiver: + example: false + type: boolean + expStatuses: + example: + - string + items: + type: string + type: array + firstName: + example: Hokus + type: string + id: + example: 5cacc31e6218d174d3f17b70 + type: string + identifications: + items: + properties: + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + format: int64 + type: number + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554826014782 + format: int64 + type: number + deleted: + example: false + type: boolean + expirationDate: + example: 1577779200000 + format: int64 + type: number + frontPhoto: + example: string + type: string + id: + example: 5cacc31e6218d174d3f17b6e + type: string + licenseNumber: + example: MYLICENSENUM + type: string + modified: + example: 1554826014782 + format: int64 + type: number + state: + example: string + type: string + type: + example: string + type: string + updated: + example: false + type: boolean + type: object + type: array + importId: + example: string + type: string + inQueue: + example: false + type: boolean + lastName: + example: Pokus + type: string + lastVisitDate: + example: 1554826633661 + format: int64 + type: number + lifetimePoints: + example: 0 + type: number + loyaltyPoints: + example: 0 + type: number + marketingSource: + example: "" + type: string + medical: + example: false + type: boolean + memberActivities: + example: + - string + items: + type: string + type: array + memberGroup: + properties: + active: + example: true + type: boolean + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554746451740 + format: int64 + type: number + defaultGroup: + example: true + type: boolean + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + discount: + example: 0 + type: number + discountType: + example: Percentage + type: string + enablePromotion: + example: false + type: boolean + id: + example: 5cabd4ba6218d148395b404b + type: string + memberCount: + example: 0 + type: number + memberCountEmailOptIn: + example: 0 + type: number + memberCountTextOptIn: + example: 0 + type: number + modified: + example: 1554824536062 + format: int64 + type: number + name: + example: Delivery + type: string + promotionId: + example: string + type: string + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + updated: + example: false + type: boolean + type: object + memberGroupId: + example: 5cabd4ba6218d148395b404b + type: string + middleName: + example: string + type: string + modified: + example: 1554826633661 + format: int64 + type: number + notes: + example: + - string + items: + type: string + type: array + preferences: + example: + - string + items: + type: string + type: array + primaryPhone: + example: (510) 859-7000 + type: string + qbCustomerRef: + example: + - string + items: + type: string + type: array + qbDesktopCustomerRef: + example: string + type: string + recentProducts: + example: + - Binsky Flower + - Tommy's Bong + items: + type: string + type: array + recommendationExpired: + example: true + type: boolean + recommendationExpiryLeft: + example: 0 + type: number + recommendations: + items: + properties: + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + type: number + format: int64 + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554826014782 + format: int64 + type: number + deleted: + example: false + type: boolean + doctor: + example: string + type: string + doctorId: + example: string + type: string + expirationDate: + example: string + type: string + frontPhoto: + example: string + type: string + id: + example: 5cacc31e6218d174d3f17b6f + type: string + issueDate: + example: string + type: string + modified: + example: 1554826014782 + format: int64 + type: number + recommendationNumber: + example: string + type: string + state: + example: string + type: string + updated: + example: false + type: boolean + verified: + example: false + type: boolean + verifyMethod: + example: MANUAL + type: string + verifyPhoneNumber: + example: string + type: string + verifyWebsite: + example: string + type: string + type: object + type: array + regionId: + example: string + type: string + searchText: + example: + hokus pokus 5125 miles ave hokus@taxnexus.net (510) 859-7000 + delivery + type: string + sex: + example: 0 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + startDate: + example: 1554826014781 + format: int64 + type: number + stateCannabisLimit: + example: string + type: string + status: + example: Active + type: string + tags: + example: + - string + items: + type: string + type: array + textOptIn: + example: true + type: boolean + updated: + example: false + type: boolean + type: object + Message: + properties: + code: + example: 200 + type: number + message: + example: successful operation + type: string + type: object + ProductResponse: + properties: + active: + example: true + type: boolean + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1555828648113 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbc0fa83f8de507ff768bfd + type: string + key: + example: 99556cc6-6820-425c-8620-f4ba5a8d601f.jpg + type: string + largeURL: + example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-800x800.jpg" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-1600x1600.jpg" + type: string + mediumURL: + example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-500x500.jpg" + type: string + modified: + example: 1555828648113 + type: number + format: int64 + name: + example: Lowell 3 5g.jpg + type: string + origURL: + example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f.jpg" + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f.jpg" + type: string + secured: + example: false + type: boolean + thumbURL: + example: "https://connect-files-public.s3.amazonaws.com/99556cc6-6820-425c-8620-f4ba5a8d601f-200x200.jpg" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + automaticReOrder: + example: false + type: boolean + brand: + example: string + type: string + brandId: + example: 5cba942502aeca080e3b11e3 + type: string + brandName: + example: Lowell Herb Co + type: string + bundleItemResults: + items: + type: string + type: array + bundleItems: + items: + properties: + productId: + type: string + quantity: + format: double + type: number + type: object + type: array + byGram: + example: true + type: boolean + byPrepackage: + example: false + type: boolean + cannabisType: + example: DEFAULT + type: string + category: + properties: + active: + example: true + type: boolean + cannabis: + example: true + type: boolean + cannabisType: + example: DEFAULT + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1553982501834 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5c9fe425e0faca07db94b986 + type: string + lowThreshold: + example: 0 + type: number + modified: + example: 1553982501834 + format: int64 + type: number + name: + example: Preroll + type: string + photo: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1553982501834 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5c9fe425e0faca07db94b97a + type: string + key: + example: 420default-Preroll.jpg + type: string + largeURL: + example: string + type: string + largeX2URL: + example: string + type: string + mediumURL: + example: string + type: string + modified: + example: 1553982501834 + format: int64 + type: number + name: + example: Preroll.jpg + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://s3.amazonaws.com/connect-files-public/420default-Preroll.jpg" + type: string + secured: + example: false + type: boolean + thumbURL: + example: string + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + priority: + example: 0 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + unitType: + example: units + type: string + updated: + example: false + type: boolean + type: object + categoryId: + example: 5c9fe425e0faca07db94b986 + type: string + cbd: + example: 0 + type: number + cbda: + example: 0 + type: number + cbn: + example: 0 + type: number + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + companyLinkId: + example: MTkwNjFTMDE= + type: string + created: + example: 1555533419406 + type: number + format: int64 + customGramType: + example: GRAM + type: string + customTaxInfo: + example: string + type: string + customWeight: + example: 0 + type: number + deleted: + example: false + type: boolean + description: + example: + "In this pack: A curated, effect based blend of sativa + strains, pre-rolled into seven premium all flower smokes (3.5 + grams per pack). All of our products are lab tested, we grow + our flowers with only organic fertilizer, and we never use + synthetic pesticides. Matches included for your convenience." + type: string + dirty: + example: false + type: boolean + discountable: + example: true + type: boolean + enableExciseTax: + example: false + type: boolean + enableMixMatch: + example: false + type: boolean + enableWeedmap: + example: false + type: boolean + flowerType: + example: Sativa + type: string + genetics: + example: string + type: string + id: + example: 5cb78e6b829a5f0834444825 + type: string + importId: + example: string + type: string + importSrc: + example: string + type: string + lowInventoryNotification: + example: false + type: boolean + lowThreshold: + example: 0 + type: number + medicalConditions: + items: + type: string + type: array + medicinal: + example: true + type: boolean + modified: + example: 1556695451723 + format: int64 + type: number + name: + example: Lowell - 3.5g Preroll Pack - Uplifting (S) + type: string + notes: + items: + type: string + type: array + potency: + example: false + type: boolean + potencyAmount: + properties: + cbd: + example: 0 + type: number + cbda: + example: 0 + type: number + cbn: + example: 0 + type: number + thc: + example: 0 + type: number + thca: + example: 0 + type: number + type: object + priceBreaks: + items: + properties: + active: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1555533419417 + type: number + format: int64 + deleted: + example: false + type: boolean + displayName: + example: string + type: string + id: + example: 5cb78e6b829a5f0834444827 + type: string + modified: + example: 1555533419417 + format: int64 + type: number + name: + example: 1 each + type: string + price: + example: 40 + type: number + priceBreakType: + example: OneGramUnit + type: string + priority: + example: 0 + type: number + quantity: + example: 1 + type: number + updated: + example: false + type: boolean + type: object + type: array + priceIncludesALExcise: + example: false + type: boolean + priceIncludesExcise: + example: false + type: boolean + priceRanges: + items: + type: string + type: array + pricingTemplateId: + example: "" + type: string + productSaleType: + example: Both + type: string + productType: + example: REGULAR + type: string + qbDesktopItemRef: + example: string + type: string + qbItemRef: + example: string + type: string + quantities: + items: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1555633414363 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb91506819d9e04973cc7c2 + type: string + inventoryId: + example: 5c9fe425e0faca07db94b992 + type: string + modified: + example: 1555633414363 + format: int64 + type: number + quantity: + example: 0 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + updated: + example: false + type: boolean + type: object + type: array + quantityAvailable: + example: 0 + type: number + reOrderLevel: + example: 0 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + showInWidget: + example: true + type: boolean + sku: + example: 19061S01 + type: string + tags: + items: + type: string + type: array + taxOrder: + example: PostTaxed + type: string + taxTables: + items: + properties: + active: + example: false + type: boolean + cityTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1555609033636 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb8b5c99c57ec083d307a94 + type: string + modified: + example: 1555609033636 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: City + type: string + updated: + example: false + type: boolean + type: object + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: AdultUse + type: string + countyTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1555609033636 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb8b5c99c57ec083d307a95 + type: string + modified: + example: 1555609033636 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: County + type: string + updated: + example: false + type: boolean + type: object + created: + example: 1555609033636 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + federalTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1555609033636 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb8b5c99c57ec083d307a97 + type: string + modified: + example: 1555609033636 + type: number + format: int64 + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: Federal + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5cb8b5c99c57ec083d307a93 + type: string + modified: + example: 1555609033636 + format: int64 + type: number + name: + example: Adult Use + type: string + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + stateTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1555609033636 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb8b5c99c57ec083d307a96 + type: string + modified: + example: 1555609033636 + type: number + format: int64 + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: State + type: string + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxType: + example: Custom + type: string + updated: + example: false + type: boolean + type: object + type: array + taxType: + example: Inherit + type: string + thc: + example: 15 + type: number + thca: + example: 0 + type: number + unitPrice: + example: 40 + type: number + unitValue: + example: 1 + type: number + updated: + example: false + type: boolean + vendor: + properties: + active: + example: true + type: boolean + additionalAddressList: + items: + type: string + type: array + address: + properties: + address: + example: "" + type: string + city: + example: "" + type: string + companyId: + example: string + type: string + country: + example: US + type: string + created: + example: 1552071418457 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5c82bafa4442190831bcd512 + type: string + modified: + example: 1552071418457 + type: number + format: int64 + state: + example: "" + type: string + updated: + example: false + type: boolean + zipCode: + example: "" + type: string + type: object + armsLengthType: + example: ARMS_LENGTH + type: string + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + type: number + format: int64 + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + backOrderEnabled: + example: false + type: boolean + brands: + example: + - 5cba942502aeca080e3b11e3 + items: + type: string + type: array + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + companyLicenses: + items: + properties: + companyType: + example: RETAILER + type: string + created: + example: 1556175123774 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cc159132a77f44828c02d8b + type: string + licenseExpirationDate: + example: 0 + type: number + licenseNumber: + example: "" + type: string + licenseType: + example: string + type: string + modified: + example: 1556175123774 + type: number + format: int64 + toDefault: + example: true + type: boolean + updated: + example: false + type: boolean + type: object + type: array + companyType: + example: string + type: string + created: + example: 1552071418457 + format: int64 + type: number + credits: + example: 0 + type: number + dbaName: + example: string + type: string + deleted: + example: false + type: boolean + description: + example: "" + type: string + email: + example: "" + type: string + fax: + example: "" + type: string + firstName: + example: Dom + type: string + id: + example: 5c82bafa4442190831bcd513 + type: string + importId: + example: string + type: string + lastName: + example: "" + type: string + licenceType: + example: string + type: string + licenseExpirationDate: + example: 0 + type: number + licenseNumber: + example: "" + type: string + mobileNumber: + example: string + type: string + modified: + example: 1556175123774 + type: number + format: int64 + name: + example: Lowell Herb Co / The Hacienda Co LLC + type: string + notes: + items: + type: string + type: array + phone: + example: "" + type: string + qbDesktopRef: + example: string + type: string + qbVendorRef: + items: + type: string + type: array + relatedEntity: + example: false + type: boolean + updated: + example: false + type: boolean + vendorKey: + example: NWM3ZThjN2I3MjJlZDYwN2U2MWVkYjA2X2xvd2VsbCBoZXJiIGNvIC8gdGhlIGhhY2llbmRhIGNvIGxsYw== + type: string + vendorType: + example: VENDOR + type: string + website: + example: "" + type: string + type: object + vendorId: + example: 5c82bafa4442190831bcd513 + type: string + weightPerUnit: + example: EIGHTH + type: string + type: object + ProductsResponse: + properties: + limit: + example: 200 + type: number + skip: + example: 0 + type: number + total: + example: 2 + type: number + values: + items: + properties: + active: + example: true + type: boolean + assets: + example: + - string + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + type: number + format: int64 + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + automaticReOrder: + example: false + type: boolean + brand: + example: string + type: string + brandId: + example: string + type: string + bundleItems: + example: + - string + items: + type: string + type: array + byGram: + example: true + type: boolean + byPrepackage: + example: false + type: boolean + cannabisType: + example: DEFAULT + type: string + category: + properties: + active: + example: true + type: boolean + cannabis: + example: true + type: boolean + cannabisType: + example: DEFAULT + type: string + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554764986388 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cabd4ba6218d148395b405b + type: string + lowThreshold: + example: string + type: string + modified: + example: 1554764986388 + format: int64 + type: number + name: + example: Flowers + type: string + photo: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554764986388 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cabd4ba6218d148395b404f + type: string + key: + example: 420default-Flower.jpg + type: string + largeURL: + example: string + type: string + largeX2URL: + example: string + type: string + mediumURL: + example: string + type: string + modified: + example: 1554764986388 + format: int64 + type: number + name: + example: Flower.jpg + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://s3.amazonaws.com/connect-files-public/420default-Flower.jpg" + type: string + secured: + example: false + type: boolean + thumbURL: + example: string + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + priority: + example: 0 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + unitType: + example: grams + type: string + updated: + example: false + type: boolean + type: object + categoryId: + example: 5cabd4ba6218d148395b405b + type: string + cbd: + example: 0 + type: number + cbda: + example: 0 + type: number + cbn: + example: 0 + type: number + companyId: + example: 5cabd4ba6218d148395b402c + type: string + companyLinkId: + example: VEIxMFBSTzE= + type: string + created: + example: 1554825555219 + format: int64 + type: number + customGramType: + example: GRAM + type: string + customTaxInfo: + example: string + type: string + customWeight: + example: 0 + type: number + deleted: + example: false + type: boolean + description: + example: "" + type: string + dirty: + example: false + type: boolean + discountable: + example: true + type: boolean + enableExciseTax: + example: false + type: boolean + enableMixMatch: + example: false + type: boolean + enableWeedmap: + example: false + type: boolean + flowerType: + example: Sativa + type: string + genetics: + example: string + type: string + id: + example: 5cacc1536218d174d3f17b10 + type: string + importId: + example: string + type: string + importSrc: + example: string + type: string + lowInventoryNotification: + example: false + type: boolean + lowThreshold: + example: 0 + type: number + medicalConditions: + example: + - string + items: + type: string + type: array + medicinal: + example: true + type: boolean + modified: + example: 1554942857511 + format: int64 + type: number + name: + example: Binsky Flower + type: string + notes: + example: + - string + items: + type: string + type: array + potency: + example: false + type: boolean + potencyAmount: + example: string + type: string + priceBreaks: + example: + - "1234" + items: + type: string + type: array + priceIncludesALExcise: + example: false + type: boolean + priceIncludesExcise: + example: false + type: boolean + priceRanges: + items: + properties: + id: + example: 5cacc1536218d174d3f17b10_5cabd4ba6218d148395b402e + type: string + price: + example: 10 + type: number + priority: + example: 0 + type: number + weightTolerance: + properties: + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554746451739 + format: int64 + type: number + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 0.6 + type: number + id: + example: 5cabd4ba6218d148395b402e + type: string + modified: + example: 1554746451739 + format: int64 + type: number + name: + example: .5 Gram + type: string + priority: + example: 0 + type: number + startWeight: + example: 0.5 + type: number + unitValue: + example: 0.5 + type: number + updated: + example: false + type: boolean + weightKey: + example: HALF_GRAM + type: string + weightValue: + example: 0.5 + type: number + type: object + weightToleranceId: + example: 5cabd4ba6218d148395b402e + type: string + type: object + type: array + pricingTemplateId: + example: string + type: string + productSaleType: + example: Both + type: string + productType: + example: REGULAR + type: string + qbDesktopItemRef: + example: string + type: string + qbItemRef: + example: string + type: string + quantities: + items: + properties: + companyId: + example: 5cabd4ba6218d148395b402c + type: string + created: + example: 1554825661504 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cacc1bd6218d174d3f17b38 + type: string + inventoryId: + example: 5cabd4ba6218d148395b4067 + type: string + modified: + example: 1554825661504 + format: int64 + type: number + quantity: + example: 890 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + updated: + example: false + type: boolean + type: object + type: array + reOrderLevel: + example: 0 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + showInWidget: + example: true + type: boolean + sku: + example: TB10PRO1 + type: string + tags: + example: + - string + items: + type: string + type: array + taxOrder: + example: PostTaxed + type: string + taxTables: + example: + - string + items: + type: string + type: array + taxType: + example: Inherit + type: string + thc: + example: 0 + type: number + thca: + example: 0 + type: number + unitPrice: + example: 0 + type: number + unitValue: + example: 1 + type: number + updated: + example: false + type: boolean + vendor: + example: string + type: string + vendorId: + example: 5cacc0c66218d174d3f17b0d + type: string + weightPerUnit: + example: EACH + type: string + type: object + type: array + type: object + PurchaseOrderListResponse: + properties: + afterDate: + example: 0 + type: number + beforeDate: + example: 1554944967088 + format: int64 + type: number + limit: + example: 200 + type: number + skip: + example: 0 + type: number + total: + example: 2 + type: number + values: + items: + properties: + amountPaid: + example: 0 + type: number + approvedBy: + example: 5cabd6e96218d148395b408b + type: string + approvedByMember: + properties: + address: + properties: + address: + example: 2342 Shattuck Ave Ste 182 + type: string + city: + example: Berkeley + type: string + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + country: + example: US + type: string + created: + example: 1554765545438 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cabd6e96218d148395b408a + type: string + modified: + example: 1554765545438 + format: int64 + type: number + state: + example: CA + type: string + updated: + example: false + type: boolean + zipCode: + example: "94704" + type: string + type: object + appAccessList: + example: + - AuthenticationApp + - Distribution + - Retail + items: + type: string + type: array + assignedInventoryId: + example: string + type: string + assignedTerminalId: + example: string + type: string + canApplyCustomDiscount: + example: false + type: boolean + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554765545438 + format: int64 + type: number + deleted: + example: false + type: boolean + disabled: + example: false + type: boolean + dlExpirationDate: + example: string + type: string + driversLicense: + example: string + type: string + email: + example: vern@taxnexus.net + type: string + employeeOnFleetInfoList: + example: string + type: string + firstName: + example: Vernon + type: string + id: + example: 5cabd6e96218d148395b408b + type: string + insuranceCompanyName: + example: string + type: string + insuranceExpireDate: + example: 0 + type: number + lastLoggedInShopId: + example: 5cabd4ba6218d148395b4043 + type: string + lastName: + example: Keenan + type: string + modified: + example: 1554942481145 + format: int64 + type: number + notes: + example: + - string + items: + type: string + type: array + password: + example: UbMkbvcx9ui2Bjhu3M/eoPyvJCo5VGBj + type: string + phoneNumber: + example: (510) 679-1900 + type: string + pin: + example: "1234" + type: string + policyNumber: + example: string + type: string + recentLocation: + example: string + type: string + registrationExpireDate: + example: 0 + type: number + role: + example: string + type: string + roleId: + example: 5cabd4ba6218d148395b403b + type: string + shops: + example: + - 5cabd4ba6218d148395b4043 + items: + type: string + type: array + timeCard: + example: string + type: string + timecardId: + example: 5cae8a116218d13275d36c45 + type: string + tookanInfoList: + example: string + type: string + updated: + example: false + type: boolean + vehicleLicensePlate: + example: string + type: string + vehicleMake: + example: string + type: string + vehicleModel: + example: string + type: string + vehiclePin: + example: string + type: string + vinNo: + example: string + type: string + type: object + approvedDate: + example: 1554942803672 + format: int64 + type: number + approvedSignature: + example: string + type: string + archive: + example: false + type: boolean + archiveDate: + example: string + type: string + companyAssetList: + example: + - string + items: + type: string + type: array + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + companyLogo: + example: "https://connect-assets.s3.amazonaws.com/email/logo.jpg" + type: string + completedByEmployeeId: + example: 5cabd6e96218d148395b408b + type: string + completedDate: + example: 1554942856343 + format: int64 + type: number + created: + example: 1554938213635 + format: int64 + type: number + createdByEmployeeId: + example: 5cabd6e96218d148395b408b + type: string + customTermDate: + example: 1554938121828 + format: int64 + type: number + customerType: + example: VENDOR + type: string + declineDate: + example: string + type: string + declineReason: + example: string + type: string + deleted: + example: false + type: boolean + deliveredBy: + example: string + type: string + deliveryAddress: + example: string + type: string + deliveryCharge: + example: 0 + type: number + deliveryDate: + example: 0 + type: number + deliveryTime: + example: string + type: string + dirty: + example: false + type: boolean + discount: + example: 0 + type: number + dueDate: + example: 1557530213629 + type: number + enableDeliveryCharge: + example: false + type: boolean + fees: + example: 0 + type: number + flowerSourceType: + example: CULTIVATOR_DIRECT + type: string + grandTotal: + example: 7936 + type: number + id: + example: 5cae79656218d13275d36bf4 + type: string + licenseId: + example: string + type: string + managerReceiveSignature: + example: string + type: string + manualClose: + example: false + type: boolean + modified: + example: 1554942856353 + format: int64 + type: number + notes: + example: string + type: string + parentPOId: + example: string + type: string + parentPONumber: + example: string + type: string + poActivityLog: + items: + properties: + activityType: + example: NORMAL_LOG + type: string + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554938213660 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + employeeId: + example: 5cabd6e96218d148395b408b + type: string + id: + example: 5cae79656218d13275d36bf5 + type: string + log: + example: Created PO + type: string + modified: + example: 1554938213660 + format: int64 + type: number + purchaseOrderId: + example: 5cae79656218d13275d36bf4 + type: string + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + updated: + example: false + type: boolean + type: object + type: array + poNumber: + example: 2-N + type: string + poPaymentOptions: + example: CASH + type: string + poPaymentTerms: + example: NET_30 + type: string + poProductRequestList: + example: string + type: string + poProductRequestResultList: + items: + properties: + batchAddDetails: + example: string + type: string + batchQuantityMap: + example: object + type: string + cannabis: + example: false + type: boolean + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554938213630 + format: int64 + type: number + declineReason: + example: string + type: string + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + exciseTax: + example: 1.92 + type: number + id: + example: 5cae79656218d13275d36bf2 + type: string + modified: + example: 1554938213630 + format: int64 + type: number + notes: + example: string + type: string + product: + properties: + active: + example: true + type: boolean + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + type: number + format: int64 + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + automaticReOrder: + example: false + type: boolean + brand: + example: string + type: string + brandId: + example: string + type: string + bundleItems: + example: + - string + items: + type: string + type: array + byGram: + example: true + type: boolean + byPrepackage: + example: false + type: boolean + cannabisType: + example: string + type: string + category: + properties: + active: + example: true + type: boolean + cannabis: + example: true + type: boolean + cannabisType: + example: DEFAULT + type: string + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554764986388 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cabd4ba6218d148395b405b + type: string + lowThreshold: + example: string + type: string + modified: + example: 1554764986388 + format: int64 + type: number + name: + example: Flowers + type: string + photo: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554764986388 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cabd4ba6218d148395b404f + type: string + key: + example: 420default-Flower.jpg + type: string + largeURL: + example: string + type: string + largeX2URL: + example: string + type: string + mediumURL: + example: string + type: string + modified: + example: 1554764986388 + format: int64 + type: number + name: + example: Flower.jpg + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://s3.amazonaws.com/connect-files-public/420default-Flower.jpg" + type: string + secured: + example: false + type: boolean + thumbURL: + example: string + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + priority: + example: 0 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + unitType: + example: grams + type: string + updated: + example: false + type: boolean + type: object + categoryId: + example: 5cabd4ba6218d148395b405b + type: string + cbd: + example: 0 + type: number + cbda: + example: 0 + type: number + cbn: + example: 0 + type: number + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + companyLinkId: + example: string + type: string + created: + example: 1554825555219 + format: int64 + type: number + customGramType: + example: string + type: string + customTaxInfo: + example: string + type: string + customWeight: + example: 0 + type: number + deleted: + example: false + type: boolean + description: + example: string + type: string + dirty: + example: false + type: boolean + discountable: + example: true + type: boolean + enableExciseTax: + example: false + type: boolean + enableMixMatch: + example: false + type: boolean + enableWeedmap: + example: false + type: boolean + flowerType: + example: Sativa + type: string + genetics: + example: string + type: string + id: + example: 5cacc1536218d174d3f17b10 + type: string + importId: + example: string + type: string + importSrc: + example: string + type: string + lowInventoryNotification: + example: false + type: boolean + lowThreshold: + example: 0 + type: number + medicalConditions: + example: + - string + items: + type: string + type: array + medicinal: + example: true + type: boolean + modified: + example: 1554942857511 + format: int64 + type: number + name: + example: Binsky Flower + type: string + notes: + example: + - string + items: + type: string + type: array + potency: + example: false + type: boolean + potencyAmount: + example: string + type: string + priceBreaks: + example: + - string + items: + type: string + type: array + priceIncludesALExcise: + example: false + type: boolean + priceIncludesExcise: + example: false + type: boolean + priceRanges: + items: + properties: + id: + example: 5cacc1536218d174d3f17b10_5cabd4ba6218d148395b402e + type: string + price: + example: 10 + type: number + priority: + example: 0 + type: number + weightTolerance: + properties: + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554746451739 + format: int64 + type: number + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 0.6 + type: number + id: + example: 5cabd4ba6218d148395b402e + type: string + modified: + example: 1554746451739 + format: int64 + type: number + name: + example: .5 Gram + type: string + priority: + example: 0 + type: number + startWeight: + example: 0.5 + type: number + unitValue: + example: 0.5 + type: number + updated: + example: false + type: boolean + weightKey: + example: HALF_GRAM + type: string + weightValue: + example: 0.5 + type: number + type: object + weightToleranceId: + example: 5cabd4ba6218d148395b402e + type: string + type: object + type: array + pricingTemplateId: + example: string + type: string + productSaleType: + example: Both + type: string + productType: + example: string + type: string + qbDesktopItemRef: + example: string + type: string + qbItemRef: + example: string + type: string + quantities: + items: + properties: + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554825661504 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cacc1bd6218d174d3f17b38 + type: string + inventoryId: + example: 5cabd4ba6218d148395b4067 + type: string + modified: + example: 1554825661504 + format: int64 + type: number + quantity: + example: 890 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + updated: + example: false + type: boolean + type: object + type: array + reOrderLevel: + example: 0 + type: number + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + showInWidget: + example: true + type: boolean + sku: + example: TB10PRO1 + type: string + tags: + example: + - string + items: + type: string + type: array + taxOrder: + example: PostTaxed + type: string + taxTables: + example: + - string + items: + type: string + type: array + taxType: + example: Inherit + type: string + thc: + example: 0 + type: number + thca: + example: 0 + type: number + unitPrice: + example: 0 + type: number + unitValue: + example: 1 + type: number + updated: + example: false + type: boolean + vendor: + example: string + type: string + vendorId: + example: 5cacc0c66218d174d3f17b0d + type: string + weightPerUnit: + example: EACH + type: string + type: object + productId: + example: 5cacc1536218d174d3f17b10 + type: string + productName: + example: Binsky Flower + type: string + receiveBatchStatus: + example: READY_FOR_SALE + type: string + receivedQuantity: + example: 800 + type: number + requestQuantity: + example: 800 + type: number + requestStatus: + example: ACCEPTED + type: string + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + totalCost: + example: 6400 + type: number + totalCultivationTax: + example: 0 + type: number + totalExciseTax: + example: 1536 + type: number + trackTraceSystem: + example: string + type: string + trackingPackagesList: + example: + - string + items: + type: string + type: array + unitPrice: + example: 8 + type: number + updated: + example: false + type: boolean + type: object + type: array + poQrCodeAsset: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + created: + example: 1554938213885 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cae79656218d13275d36bf6 + type: string + key: + example: 5cae79656218d13275d36bf4-2-N.png + type: string + largeURL: + example: string + type: string + largeX2URL: + example: string + type: string + mediumURL: + example: string + type: string + modified: + example: 1554938213885 + format: int64 + type: number + name: + example: Invoice + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://connect-files-public.s3.amazonaws.com/5cae79656218d13275d36bf4-2-N.png" + type: string + secured: + example: false + type: boolean + thumbURL: + example: string + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + poQrCodeUrl: + example: "https://connect-files-public.s3.amazonaws.com/5cae79656218d13275d36bf4-2-N.png" + type: string + poType: + example: Normal + type: string + podueDate: + example: 1557530213635 + format: int64 + type: number + purchaseOrderDate: + example: 0 + type: number + purchaseOrderStatus: + example: Closed + type: string + qbPurchaseOrderRef: + example: string + type: string + receivedByEmployeeId: + example: 5cabd6e96218d148395b408b + type: string + receivedDate: + example: 1554942839629 + format: int64 + type: number + reference: + example: string + type: string + shipmentBillId: + example: 5cae8b886218d13275d36c59 + type: string + shopId: + example: 5cabd4ba6218d148395b4043 + type: string + submitForApprovalDate: + example: 1554938214072 + format: int64 + type: number + taxResult: + properties: + created: + example: 1554942856352 + format: int64 + type: number + cultivationTaxResult: + properties: + flowerTaxOz: + example: 0 + type: number + leafTaxOz: + example: 0 + type: number + totalCultivationTax: + example: 0 + type: number + totalFlowerOz: + example: 0 + type: number + totalFlowerTax: + example: 0 + type: number + totalLeafOz: + example: 0 + type: number + totalLeafTax: + example: 0 + type: number + type: object + deleted: + example: false + type: boolean + id: + example: 5cae8b886218d13275d36c5a + type: string + modified: + example: 1554942856352 + format: int64 + type: number + totalALExciseTax: + example: 0 + type: number + totalALPostExciseTax: + example: 0 + type: number + totalCityPreTax: + example: 0 + type: number + totalCityTax: + example: 0 + type: number + totalCountyPreTax: + example: 0 + type: number + totalCountyTax: + example: 0 + type: number + totalExciseTax: + example: 1536 + type: number + totalFedPreTax: + example: 0 + type: number + totalFedTax: + example: 0 + type: number + totalNALPreExciseTax: + example: 0 + type: number + totalPostCalcTax: + example: 0 + type: number + totalPreCalcTax: + example: 0 + type: number + totalStatePreTax: + example: 0 + type: number + totalStateTax: + example: 0 + type: number + updated: + example: false + type: boolean + type: object + termsAndCondition: + example: string + type: string + totalCalcTax: + example: 0 + type: number + totalCost: + example: 6400 + type: number + totalPreCalcTax: + example: 0 + type: number + totalTax: + example: 1536 + type: number + transactionType: + example: ARMS_LENGTH + type: string + updated: + example: false + type: boolean + vendor: + properties: + active: + example: true + type: boolean + additionalAddressList: + example: + - string + items: + type: string + type: array + address: + properties: + address: + example: string + type: string + city: + example: string + type: string + companyId: + example: string + type: string + country: + example: US + type: string + created: + example: 1554825414778 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cacc0c66218d174d3f17b0c + type: string + modified: + example: 1554825414778 + format: int64 + type: number + state: + example: string + type: string + updated: + example: false + type: boolean + zipCode: + example: string + type: string + type: object + armsLengthType: + example: ARMS_LENGTH + type: string + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + type: number + format: int64 + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + backOrderEnabled: + example: false + type: boolean + brands: + example: + - string + items: + type: string + type: array + companyId: + example: 5cabd4ba6218d148395b4043 + type: string + companyLicenses: + items: + type: string + type: array + companyType: + example: string + type: string + created: + example: 1554825414778 + format: int64 + type: number + credits: + example: 0 + type: number + dbaName: + example: string + type: string + deleted: + example: false + type: boolean + description: + example: string + type: string + email: + example: string + type: string + fax: + example: string + type: string + firstName: + example: string + type: string + id: + example: 5cacc0c66218d174d3f17b0d + type: string + importId: + example: string + type: string + lastName: + example: string + type: string + licenceType: + example: string + type: string + licenseExpirationDate: + example: 0 + type: number + licenseNumber: + example: string + type: string + mobileNumber: + example: string + type: string + modified: + example: 1554825414778 + format: int64 + type: number + name: + example: Binsky + type: string + notes: + example: + - string + items: + type: string + type: array + phone: + example: string + type: string + qbDesktopRef: + example: string + type: string + qbVendorRef: + example: + - string + items: + type: string + type: array + relatedEntity: + example: false + type: boolean + updated: + example: false + type: boolean + vendorKey: + example: NWNhYmQ0YmE2MjE4ZDE0ODM5NWI0MDJjX2JpbnNreQ== + type: string + vendorType: + example: VENDOR + type: string + website: + example: string + type: string + type: object + vendorId: + example: 5cacc0c66218d174d3f17b0d + type: string + type: object + type: array + type: object + ShopResponse: + properties: + companyLogoURL: + example: "https://connect-files-public.s3.amazonaws.com/1d405589-9408-4f00-8b00-b30bfbc636d1.png" + type: string + shop: + properties: + active: + example: true + type: boolean + address: + properties: + address: + example: 695 Williams Rd + type: string + addressLine1: + example: "" + type: string + city: + example: Palm Springs + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + country: + example: US + type: string + created: + example: 1553982501824 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5c9fe425e0faca07db94b971 + type: string + modified: + example: 1553982501824 + type: number + format: int64 + state: + example: CA + type: string + updated: + example: false + type: boolean + zipCode: + example: "92264" + type: string + type: object + ageLimit: + example: 21 + type: number + alExciseOnZeroPrice: + example: true + type: boolean + allowAnonymousOrders: + example: false + type: boolean + appTarget: + example: Retail + type: string + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Document + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1558145178150 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cdf689a59ded8080e03c06a + type: string + key: + example: f5777926-e5cd-48c3-a026-a527bfaa930f.pdf + type: string + largeURL: + example: string + type: string + largeX2URL: + example: string + type: string + mediumURL: + example: string + type: string + modified: + example: 1558145178150 + type: number + format: int64 + name: + example: CGI Sellers Permit 247130880 - 00001.pdf + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: string + type: string + secured: + example: true + type: boolean + thumbURL: + example: string + type: string + type: + example: Document + type: string + updated: + example: false + type: boolean + type: object + type: array + autoCashDrawer: + example: false + type: boolean + bccEmailAddress: + example: info@pineappleexpress.com + type: string + cartMinimums: + properties: + cartMinimumDetails: + items: + properties: + enabled: + example: true + type: boolean + minimum: + example: 40 + type: number + type: object + type: array + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1553984069346 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5c9fea45b8bccf07fc47d5cc + type: string + minimumsType: + example: SIMPLE + type: string + modified: + example: 1553984069346 + type: number + format: int64 + updated: + example: false + type: boolean + type: object + checkoutType: + example: Direct + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1553982501824 + type: number + format: int64 + creditFefundType: + example: NONE + type: string + defaultCountry: + example: US + type: string + defaultPinTimeout: + example: 5 + type: number + deleted: + example: false + type: boolean + deliveryFee: + example: 0 + type: number + deliveryRefundType: + example: NONE + type: string + emailAdress: + example: support@pineappleexpress.com + type: string + emailMessage: + example: string + type: string + enableAgeLimit: + example: true + type: boolean + enableBCCReceipt: + example: true + type: boolean + enableCannabisLimit: + example: true + type: boolean + enableCashInOut: + example: false + type: boolean + enableDailySummaryEmail: + example: false + type: boolean + enableDeliveryFee: + example: false + type: boolean + enableDeliverySignature: + example: true + type: boolean + enableExciseTax: + example: true + type: boolean + enableGPSTracking: + example: true + type: boolean + enableHarvestTax: + example: false + type: boolean + enableLowInventoryEmail: + example: true + type: boolean + enableMedicinalAge: + example: true + type: boolean + enableOnFleet: + example: true + type: boolean + enablePinForCashDrawer: + example: false + type: boolean + enableSaleLogout: + example: false + type: boolean + enableSpringBig: + example: false + type: boolean + enableTookan: + example: false + type: boolean + enableWooCommerce: + example: false + type: boolean + enforceCashDrawers: + example: true + type: boolean + exciseTaxType: + example: TOTAL_AMOUNT + type: string + hubId: + example: JPowoWy*p6zFD5D*y9t77DNJ + type: string + hubName: + example: Palm Springs + type: string + id: + example: 5c9fe425e0faca07db94b970 + type: string + invoiceNote: + example: string + type: string + invoiceTermCondition: + example: string + type: string + latitude: + example: 0 + type: number + legalLanguage: + example: + "WARNING: This product can expose you to marijuana smoke + and myrcene, which are known to the State of California to + cause cancer. For more information, go to + www.P65Warnings.ca.gov." + type: string + license: + example: C9-18-0000102-TEMP + type: string + logo: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1555870891770 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cbcb4ab85c8ac07ed72aac0 + type: string + key: + example: 5d145b98-e563-40ec-bf50-189fa275888d.jpg + type: string + largeURL: + example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-800x800.jpg" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-1600x1600.jpg" + type: string + mediumURL: + example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-500x500.jpg" + type: string + modified: + example: 1555870891770 + type: number + format: int64 + name: + example: PE New.jpg + type: string + origURL: + example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d.jpg" + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d.jpg" + type: string + secured: + example: false + type: boolean + thumbURL: + example: "https://connect-files-public.s3.amazonaws.com/5d145b98-e563-40ec-bf50-189fa275888d-200x200.jpg" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + longitude: + example: 0 + type: number + marketingSources: + example: + - On Deck + - Weed Maps + - Google + - Personal Referral + - Billboard + - Social Media + - Print Media + - Other + items: + type: string + type: array + medicinalAge: + example: 18 + type: number + membersCountSyncDate: + example: 1558372668851 + type: number + membersTag: + example: + - Disabled + items: + type: string + type: array + modified: + example: 1558372668851 + type: number + format: int64 + nalExciseFromRetailCost: + example: false + type: boolean + name: + example: Pineapple Express Palm Springs + type: string + nextSnapshotTime: + example: 1558422300000 + type: number + format: int64 + numAllowActiveTrans: + example: 1 + type: number + onFleetApiKey: + example: d3ba42b1b557f703910d53d1a45be8ed + type: string + onFleetOrganizationId: + example: ziXWVNJiLeB2IeMUN5kSdIkX + type: string + onFleetOrganizationName: + example: Pineapple Express + type: string + onlineStoreInfo: + properties: + activeInventoryId: + example: string + type: string + cartMinType: + example: SubtotalWithDiscount + type: string + cartMinimum: + example: 0 + type: number + colorTheme: + example: Light + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1553984069346 + type: number + format: int64 + customMessageETA: + example: string + type: string + defaultETA: + example: 90 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + enableDelivery: + example: true + type: boolean + enableDeliveryAreaRestrictions: + example: true + type: boolean + enableHtmlText: + example: false + type: boolean + enableInventory: + example: false + type: boolean + enableInventoryType: + example: Custom + type: string + enableOnlinePOS: + example: true + type: boolean + enableOnlineShipment: + example: false + type: boolean + enableOtherMarketingSource: + example: false + type: boolean + enableProductReviews: + example: true + type: boolean + enableStorePickup: + example: false + type: boolean + enabled: + example: true + type: boolean + htmlText: + example: string + type: string + id: + example: 5c9fea45b8bccf07fc47d5cd + type: string + modified: + example: 1553984069346 + type: number + format: int64 + pageOneMessageBody: + example: string + type: string + pageOneMessageTitle: + example: string + type: string + restrictedZipCodes: + example: + - "90895" + - "91001" + - "91006" + - "91007" + - "93063" + items: + type: string + type: array + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + storeHexColor: + example: string + type: string + submissionMessage: + example: string + type: string + supportEmail: + example: support@pineappleexpress.com + type: string + updated: + example: false + type: boolean + useCustomETA: + example: false + type: boolean + viewType: + example: List + type: string + websiteOrigins: + example: "" + type: string + websiteUrl: + example: "https://pineappleexpress.com" + type: string + type: object + orderTags: + example: + - Appointment + - Early Bird + - Late Gift + items: + type: string + type: array + phoneNumber: + example: (877) 933-3548 + type: string + poNote: + example: string + type: string + poTermCondition: + example: string + type: string + productPriceIncludeExciseTax: + example: false + type: boolean + productsTag: + example: + - Flower + - Concentrate + - Edibles + - Vegan + - vegan + - Preroll + - Vape Pens + - Topical + - Wraps + items: + type: string + type: array + receiptInfo: + items: + properties: + aboveFreeText: + example: TOP OF RECEIPT TEXT GOES HERE. + type: string + companyId: + example: string + type: string + created: + example: 1557103750658 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + enableBrand: + example: false + type: boolean + enableEmployeeName: + example: true + type: boolean + enableExciseTaxAsItem: + example: true + type: boolean + enableIncludeItemInSKU: + example: false + type: boolean + enableMemberAddress: + example: false + type: boolean + enableMemberId: + example: false + type: boolean + enableMemberLoyaltyPoints: + example: true + type: boolean + enableMemberName: + example: true + type: boolean + enableNotes: + example: false + type: boolean + enableShopAddress: + example: false + type: boolean + enableShopPhoneNo: + example: true + type: boolean + enabledBottomFreeText: + example: false + type: boolean + enabledFreeText: + example: false + type: boolean + freeText: + example: BOTTOM OF RECEIPT TEXT GOES HERE. + type: string + id: + example: string + type: string + modified: + example: 1557103750658 + type: number + format: int64 + receiptType: + example: SALES + type: string + shopId: + example: string + type: string + updated: + example: false + type: boolean + type: object + type: array + receivingInventoryId: + example: 5c9fe425e0faca07db94b990 + type: string + requireValidRecDate: + example: true + type: boolean + restrictIncomingOrderNotifications: + example: true + type: boolean + restrictedNotificationTerminals: + example: + - 5c82b36db4ab160827412e62 + - 5c82b3944442190831bca731 + - 5cb7d5f54cd84907f647b6cd + items: + type: string + type: array + restrictedViews: + example: true + type: boolean + roundOffType: + example: NONE + type: string + roundUpMessage: + example: string + type: string + shopType: + example: Both + type: string + shortIdentifier: + example: string + type: string + showDeliveryQueue: + example: true + type: boolean + showOnlineQueue: + example: false + type: boolean + showProductByAvailableQuantity: + example: true + type: boolean + showSpecialQueue: + example: false + type: boolean + showWalkInQueue: + example: false + type: boolean + snapshopTime: + example: 1558336185744 + type: number + format: int64 + taxInfo: + properties: + cityTax: + example: 0 + type: number + created: + example: 1553984069346 + type: number + format: int64 + deleted: + example: false + type: boolean + federalTax: + example: 0 + type: number + id: + example: 5c9fea45b8bccf07fc47d5ce + type: string + modified: + example: 1553984069346 + type: number + format: int64 + stateTax: + example: 0.08 + type: number + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxRoundOffType: + example: ONE_CENT + type: string + taxTables: + items: + properties: + active: + example: false + type: boolean + cityTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: string + type: string + compound: + example: false + type: boolean + created: + example: 1555534297286 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb791d92f7a85083f3638ad + type: string + modified: + example: 1555534297286 + type: number + format: int64 + shopId: + example: string + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: City + type: string + updated: + example: false + type: boolean + type: object + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: AdultUse + type: string + countyTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: string + type: string + compound: + example: true + type: boolean + created: + example: 1555534297286 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb791d92f7a85083f3638ae + type: string + modified: + example: 1555534297286 + type: number + format: int64 + shopId: + example: string + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0.25 + type: number + territory: + example: County + type: string + updated: + example: false + type: boolean + type: object + created: + example: 1553984069346 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + federalTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: string + type: string + compound: + example: false + type: boolean + created: + example: 1555534297286 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb791d92f7a85083f3638b0 + type: string + modified: + example: 1555534297286 + type: number + format: int64 + shopId: + example: string + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: Federal + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5c9fea45b8bccf07fc47d5c9 + type: string + modified: + example: 1553984069346 + type: number + format: int64 + name: + example: Adult Use + type: string + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + stateTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: string + type: string + compound: + example: true + type: boolean + created: + example: 1555534297286 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cb791d92f7a85083f3638af + type: string + modified: + example: 1555534297286 + type: number + format: int64 + shopId: + example: string + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 9.25 + type: number + territory: + example: State + type: string + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxType: + example: Inherit + type: string + updated: + example: false + type: boolean + type: object + type: array + timeZone: + example: America/Los_Angeles + type: string + timezoneOffsetInMinutes: + example: -420 + type: number + twilioNumber: + example: string + type: string + updated: + example: false + type: boolean + useAssignedEmployee: + example: false + type: boolean + useComplexTax: + example: true + type: boolean + type: object + toleranceMap: + properties: + GRAM: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486903 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 1.35 + type: number + id: + example: 5c7e8c7b722ed607e61edb09 + type: string + modified: + example: 1551488486903 + type: number + format: int64 + name: + example: Gram + type: string + priority: + example: 1 + type: number + startWeight: + example: 0.85 + type: number + unitValue: + example: 1 + type: number + updated: + example: false + type: boolean + weightKey: + example: GRAM + type: string + weightValue: + example: 1 + type: number + type: object + HALF: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486905 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 14.5 + type: number + id: + example: 5c7e8c7b722ed607e61edb0e + type: string + modified: + example: 1551488486905 + type: number + format: int64 + name: + example: 1/2 + type: string + priority: + example: 6 + type: number + startWeight: + example: 14 + type: number + unitValue: + example: 14 + type: number + updated: + example: false + type: boolean + weightKey: + example: HALF + type: string + weightValue: + example: 14.17476 + type: number + type: object + HALF_GRAM: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486902 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 0.6 + type: number + id: + example: 5c7e8c7b722ed607e61edb08 + type: string + modified: + example: 1551488486902 + type: number + format: int64 + name: + example: .5 Gram + type: string + priority: + example: 0 + type: number + startWeight: + example: 0.5 + type: number + unitValue: + example: 0.5 + type: number + updated: + example: false + type: boolean + weightKey: + example: HALF_GRAM + type: string + weightValue: + example: 0.5 + type: number + type: object + ONE_EIGHTTH: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486905 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 3.85 + type: number + id: + example: 5c7e8c7b722ed607e61edb0c + type: string + modified: + example: 1551488486905 + type: number + format: int64 + name: + example: 1/8th + type: string + priority: + example: 4 + type: number + startWeight: + example: 3.45 + type: number + unitValue: + example: 3.5 + type: number + updated: + example: false + type: boolean + weightKey: + example: ONE_EIGHTTH + type: string + weightValue: + example: 3.54369 + type: number + type: object + OUNCE: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486905 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 28.5 + type: number + id: + example: 5c7e8c7b722ed607e61edb0f + type: string + modified: + example: 1551488486905 + type: number + format: int64 + name: + example: 1 Oz + type: string + priority: + example: 7 + type: number + startWeight: + example: 28 + type: number + unitValue: + example: 28 + type: number + updated: + example: false + type: boolean + weightKey: + example: OUNCE + type: string + weightValue: + example: 28.34952 + type: number + type: object + QUARTER: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486905 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 7.5 + type: number + id: + example: 5c7e8c7b722ed607e61edb0d + type: string + modified: + example: 1551488486905 + format: int64 + type: number + name: + example: 1/4th + type: string + priority: + example: 5 + type: number + startWeight: + example: 7 + type: number + unitValue: + example: 7 + type: number + updated: + example: false + type: boolean + weightKey: + example: QUARTER + type: string + weightValue: + example: 7.087381 + type: number + type: object + THREE_GRAMS: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486904 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 3.1 + type: number + id: + example: 5c7e8c7b722ed607e61edb0b + type: string + modified: + example: 1551488486904 + format: int64 + type: number + name: + example: 3 Grams + type: string + priority: + example: 3 + type: number + startWeight: + example: 3 + type: number + unitValue: + example: 3 + type: number + updated: + example: false + type: boolean + weightKey: + example: THREE_GRAMS + type: string + weightValue: + example: 3 + type: number + type: object + TWO_GRAMS: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486903 + type: number + format: int64 + deleted: + example: false + type: boolean + enabled: + example: true + type: boolean + endWeight: + example: 2.1 + type: number + id: + example: 5c7e8c7b722ed607e61edb0a + type: string + modified: + example: 1551488486903 + format: int64 + type: number + name: + example: 2 Grams + type: string + priority: + example: 2 + type: number + startWeight: + example: 2 + type: number + unitValue: + example: 2 + type: number + updated: + example: false + type: boolean + weightKey: + example: TWO_GRAMS + type: string + weightValue: + example: 2 + type: number + type: object + type: object + type: object + TransactionByIdResponse: + properties: + active: + example: false + type: boolean + addressUpdate: + example: false + type: boolean + assigned: + example: true + type: boolean + assignedEmployeeId: + example: 5cabd4ba6218d148395b406f + type: string + cart: + properties: + adjustmentAmount: + example: 0 + type: number + afterTaxDiscount: + example: 0 + type: number + afterTaxDiscountNotes: + example: "" + type: string + appliedAfterTaxDiscount: + example: 0 + type: number + balanceDue: + example: 0 + type: number + calcCartDiscount: + example: 5.4 + type: number + cartDiscountNotes: + example: "" + type: string + cashReceived: + example: 0 + type: number + changeDue: + example: 0 + type: number + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: MedicinalThirdParty + type: string + created: + example: 1585432659695 + type: number + format: int64 + creditCardFee: + example: 0 + type: number + deleted: + example: false + type: boolean + deliveryDiscount: + example: 0 + type: number + deliveryDiscountType: + example: Cash + type: string + deliveryFee: + example: 0 + type: number + discount: + example: 5.4 + type: number + discountType: + example: Cash + type: string + enableCreditCardFee: + example: false + type: boolean + enableDeliveryFee: + example: false + type: boolean + finalRefundAmt: + example: 0 + type: number + id: + example: 5e7fc85343383208d7fbac3f + type: string + items: + items: + properties: + availableDiscountQty: + example: 0 + type: number + calcCultivationTax: + example: 0 + type: number + calcDiscount: + example: 0 + type: number + calcPreTax: + example: 0 + type: number + calcTax: + example: 4.0522 + type: number + cogs: + example: 7 + type: number + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + cost: + example: 20.99 + type: number + created: + example: 1585432681221 + type: number + format: int64 + deleted: + example: false + type: boolean + discount: + example: 0 + type: number + discountNotes: + example: "" + type: string + discountType: + example: Cash + type: string + discountedQty: + example: 0 + type: number + exciseTax: + example: 0.3686 + type: number + finalPrice: + example: 20.99 + type: number + finalized: + example: false + type: boolean + fulfilled: + example: true + type: boolean + id: + example: 5e7fc86913d34108c8fc6e6d + type: string + ignoreMixMatch: + example: false + type: boolean + mixMatched: + example: false + type: boolean + modified: + example: 1585440891572 + type: number + format: int64 + orderItemId: + example: 2022a978-4995-415d-9d8f-2cbf22766028 + type: string + origQuantity: + example: 1 + type: number + overridePrice: + example: 0 + type: number + perUnitRefundAmt: + example: 0 + type: number + preparedQty: + example: 0 + type: number + productId: + example: 5de977fafe67a6082e6f2b26 + type: string + promotionReqs: + items: + type: number + type: array + quantity: + example: 10 + type: number + quantityLogs: + items: + properties: + batchId: + example: 5cacc1bb6218d174d3f17b31 + type: string + id: + example: 1a7002e4-ac24-43a3-a84e-2c8af39aaa2a_5cabd4ba6218d148395b4067_5cacc1bb6218d174d3f17b31 + type: string + inventoryId: + example: 5cabd4ba6218d148395b4067 + type: string + quantity: + example: 10 + type: number + type: object + type: array + status: + example: Active + type: string + taxOrder: + example: PostTaxed + type: string + taxResult: + properties: + created: + example: 1554826473345 + format: int64 + type: number + cultivationTaxResult: + properties: + flowerTaxOz: + example: 0 + type: number + leafTaxOz: + example: 0 + type: number + totalCultivationTax: + example: 0 + type: number + totalFlowerOz: + example: 0 + type: number + totalFlowerTax: + example: 0 + type: number + totalLeafOz: + example: 0 + type: number + totalLeafTax: + example: 0 + type: number + type: object + deleted: + example: false + type: boolean + id: + example: 5cacc4e96218d174d3f17c3a + type: string + modified: + example: 1554826473345 + format: int64 + type: number + totalALExciseTax: + example: 96 + type: number + totalALPostExciseTax: + example: 96 + type: number + totalCityPreTax: + example: 0 + type: number + totalCityTax: + example: 0 + type: number + totalCountyPreTax: + example: 0 + type: number + totalCountyTax: + example: 0 + type: number + totalExciseTax: + example: 0 + type: number + totalFedPreTax: + example: 0 + type: number + totalFedTax: + example: 0 + type: number + totalNALPreExciseTax: + example: 0 + type: number + totalPostCalcTax: + example: 0 + type: number + totalPreCalcTax: + example: 0 + type: number + totalStatePreTax: + example: 0 + type: number + totalStateTax: + example: 0 + type: number + updated: + example: false + type: boolean + type: object + taxTable: + properties: + active: + example: false + type: boolean + cityTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891598 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: City + type: string + id: + example: 5e7fe87be26bf108c9d189e2 + type: string + modified: + example: 1585440891598 + type: number + format: int64 + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 10 + type: number + territory: + example: City + type: string + updated: + example: false + type: boolean + type: object + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: MedicinalThirdParty + type: string + countyTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891598 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: County + type: string + id: + example: 5e7fe87be26bf108c9d189e3 + type: string + modified: + example: 1585440891598 + type: number + format: int64 + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: County + type: string + updated: + example: false + type: boolean + type: object + created: + example: 1585440891598 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + federalTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891598 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: Federal + type: string + id: + example: 5e7fe87be26bf108c9d189e5 + type: string + modified: + example: 1585440891598 + type: number + format: int64 + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: Federal + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5e7fe87be26bf108c9d189e1 + type: string + modified: + example: 1585440891598 + type: number + format: int64 + name: + example: Medicinal - Third Party + type: string + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + stateTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891598 + type: number + format: int64 + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: State + type: string + id: + example: 5e7fe87be26bf108c9d189e4 + type: string + modified: + example: 1585440891598 + type: number + format: int64 + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 9.5 + type: number + territory: + example: State + type: string + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxType: + example: Custom + type: string + updated: + example: false + type: boolean + type: object + taxType: + example: Inherit + type: string + totalRefundAmount: + example: 0 + type: number + totalRefundQty: + example: 0 + type: number + unitPrice: + example: 20.99 + type: number + unitQty: + example: 0 + type: number + updated: + example: false + type: boolean + useUnitQty: + example: false + type: boolean + weightKey: + example: UNIT + type: string + type: object + type: array + modified: + example: 1585440891476 + type: number + format: int64 + paymentOption: + example: Credit + type: string + paymentType: + example: Full + type: string + pointSpent: + example: 0 + type: number + promoCode: + example: "" + type: string + promotionReqLogs: + items: + properties: + amount: + example: 5.4 + type: number + assigned: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1585440891535 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5e7fe87be26bf108c9d189d9 + type: string + modified: + example: 1585440891535 + type: number + format: int64 + promotionId: + example: 5da25bd344ce2e084b72fe31 + type: string + promotionType: + example: Cart + type: string + stackable: + example: false + type: boolean + updated: + example: false + type: boolean + type: object + type: array + promotionReqs: + items: + properties: + assigned: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1585440891508 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5e7fe87be26bf108c9d189d4 + type: string + modified: + example: 1585440891508 + format: int64 + type: number + promotionId: + example: 5da25bd344ce2e084b72fe31 + type: string + updated: + example: false + type: boolean + type: object + type: array + refundAmount: + example: 0 + type: number + refundOption: + example: Void + type: string + refundOrderItemRequests: + items: + type: string + type: array + requestRefundAmt: + example: 0 + type: number + roundAmt: + example: 0 + type: number + storageLocation: + example: CashDrawer + type: string + subTotal: + example: 334 + type: number + subTotalDiscount: + example: 334 + type: number + tax: + example: 0.08 + type: number + taxResult: + properties: + created: + example: 1585440891598 + type: number + format: int64 + cultivationTaxResult: + properties: + flowerTaxOz: + example: 0 + type: number + leafTaxOz: + example: 0 + type: number + plantTaxOz: + example: 0 + type: number + totalCultivationTax: + example: 0 + type: number + totalFlowerOz: + example: 0 + type: number + totalFlowerTax: + example: 0 + type: number + totalLeafOz: + example: 0 + type: number + totalLeafTax: + example: 0 + type: number + totalPlantOz: + example: 0 + type: number + totalPlantTax: + example: 0 + type: number + type: object + deleted: + example: false + type: boolean + id: + example: 5e7fe87be26bf108c9d189ec + type: string + modified: + example: 1585440891598 + format: int64 + type: number + taxMappingInfo: + properties: + City: + example: City + type: string + County: + example: County + type: string + Federal: + example: Federal + type: string + State: + example: State + type: string + type: object + totalALExciseTax: + example: 0 + type: number + totalALPostExciseTax: + example: 4.05 + type: number + totalCityPreTax: + example: 0 + type: number + totalCityTax: + example: 5.26 + type: number + totalCountyPreTax: + example: 0 + type: number + totalCountyTax: + example: 0 + type: number + totalExciseTax: + example: 0 + type: number + totalFedPreTax: + example: 0 + type: number + totalFedTax: + example: 0 + type: number + totalNALPreExciseTax: + example: 0 + type: number + totalPostCalcTax: + example: 14.31 + type: number + totalPreCalcTax: + example: 0 + type: number + totalStatePreTax: + example: 0 + type: number + totalStateTax: + example: 5 + type: number + updated: + example: false + type: boolean + type: object + taxRoundOffType: + example: ONE_CENT + type: string + taxTable: + properties: + active: + example: false + type: boolean + cityTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891480 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: City + type: string + id: + example: 5e7fe87be26bf108c9d189d0 + type: string + modified: + example: 1585440891480 + format: int64 + type: number + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 10 + type: number + territory: + example: City + type: string + updated: + example: false + type: boolean + type: object + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: MedicinalThirdParty + type: string + countyTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891480 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: County + type: string + id: + example: 5e7fe87be26bf108c9d189d1 + type: string + modified: + example: 1585440891480 + format: int64 + type: number + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: County + type: string + updated: + example: false + type: boolean + type: object + created: + example: 1585440891480 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + federalTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891480 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: Federal + type: string + id: + example: 5e7fe87be26bf108c9d189d3 + type: string + modified: + example: 1585440891480 + format: int64 + type: number + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: Federal + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5e7fe87be26bf108c9d189cf + type: string + modified: + example: 1585440891480 + type: number + format: int64 + name: + example: Medicinal - Third Party + type: string + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + stateTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1585440891480 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + displayName: + example: State + type: string + id: + example: 5e7fe87be26bf108c9d189d2 + type: string + modified: + example: 1585440891480 + format: int64 + type: number + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 9.5 + type: number + territory: + example: State + type: string + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxType: + example: Custom + type: string + updated: + example: false + type: boolean + type: object + tipAmount: + example: 0 + type: number + total: + example: 430 + type: number + totalALExciseTax: + example: 0 + type: number + totalCalcTax: + example: 96 + type: number + totalDiscount: + example: 0 + type: number + totalExciseTax: + example: 0 + type: number + totalPreCalcTax: + example: 0 + type: number + updated: + example: false + type: boolean + type: object + checkinTime: + example: 1585432659695 + format: int64 + type: number + checkoutType: + example: Direct + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + completeAfter: + example: 1585441800000 + type: number + format: int64 + completedTime: + example: 1585440892887 + format: int64 + type: number + createOnfleetTask: + example: true + type: boolean + createTookanTask: + example: false + type: boolean + created: + example: 1585432659695 + format: int64 + type: number + createdById: + example: 5d1109b9874b44081f07df8f + type: string + deleted: + example: false + type: boolean + deliveryAddress: + properties: + address: + example: "4331 Green Avenue " + type: string + addressLine2: + example: "" + type: string + city: + example: Los Alamitos + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + country: + example: US + type: string + created: + example: 1585432659695 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5e7fc85343383208d7fbac40 + type: string + modified: + example: 1585432659695 + type: number + format: int64 + state: + example: CA + type: string + updated: + example: false + type: boolean + zipCode: + example: "90720" + type: string + type: object + deliveryDate: + example: 1585443600000 + format: int64 + type: number + dirty: + example: false + type: boolean + endRouteDate: + example: 1585440891404 + format: int64 + type: number + endTime: + example: 1585440891404 + format: int64 + type: number + eta: + example: 0 + type: number + fulfillingFulfillment: + example: false + type: boolean + fulfillmentStep: + example: Prepare + type: string + id: + example: 5e7fc85343383208d7fbac3e + type: string + loc: + example: + - -118.05688211705355 + - 33.80187413192708 + items: + type: number + type: array + locked: + example: false + type: boolean + memberId: + example: 5e7fc80143383208d7fba673 + type: string + memberSignature: + properties: + active: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1585440877379 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5e7fe86dcdabfe08de901539 + type: string + key: + example: e3ccaa24-63db-410b-b3aa-205259a04f52.png + type: string + largeURL: + example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52-800x800.png" + type: string + mediumURL: + example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52-500x500.png" + type: string + modified: + example: 1585440877379 + type: number + format: int64 + name: + example: file + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52.png" + type: string + secured: + example: false + type: boolean + thumbURL: + example: "https://connect-files-public.s3.amazonaws.com/e3ccaa24-63db-410b-b3aa-205259a04f52-200x200.png" + type: string + updated: + example: false + type: boolean + type: object + memo: + example: "" + type: string + metrcDeliverySubmitStatus: + example: None + type: string + metrcDeliverySubmitTime: + example: 0 + type: number + format: int64 + metrcId: + example: 17281252 + type: number + metrcSaleTime: + example: "2020-03-29T00:14:52.887Z" + type: string + metrcSubmissionCompleteTime: + example: 0 + type: number + format: int64 + metrcSubmissionDeleteTime: + example: 0 + type: number + format: int64 + mileage: + example: 0 + type: number + mileageCalculated: + example: true + type: boolean + modified: + example: 1585440893789 + type: number + format: int64 + onFleetError: + example: "" + type: string + onFleetTaskId: + example: o7XchVifXLXF40qHK1LnVijP + type: string + orderTags: + example: + - REC Verified + - Delivery + items: + type: string + type: array + overrideInventoryId: + example: 5c7e8c7b722ed607e61edb41 + type: string + packedBy: + example: 5d9384eca660c70822e3b1d0 + type: string + packedDate: + example: 1585432972448 + type: number + paid: + example: true + type: boolean + payingWithPaymentCard: + example: false + type: boolean + paymentEditedTime: + example: 0 + type: number + format: int64 + pointsEarned: + example: 0 + type: number + preparedBy: + example: 5d1109b9874b44081f07df8f + type: string + preparingFulfillment: + example: false + type: boolean + priority: + example: 14309 + type: number + processedTime: + example: 1585440892887 + type: number + format: int64 + queueType: + example: Delivery + type: string + refundPaymentOptions: + example: + - Credit + - StoreCredit + items: + type: string + type: array + routing: + example: false + type: boolean + sellerId: + example: 5d1655750f9c6f07f744a78a + type: string + sellerTerminalId: + example: 5d291e02bd20bf0800b3e816 + type: string + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + shortId: + example: 457d176d + type: string + startRouteDate: + example: 1585432659695 + type: number + startTime: + example: 1585440863815 + type: number + format: int64 + state: + example: 1 + type: number + status: + example: Completed + type: string + terminalId: + example: "" + type: string + timeZone: + example: America/Los_Angeles + type: string + traceSubmitStatus: + example: Completed + type: string + trackingStatus: + example: NotStarted + type: string + transNo: + example: "14309" + type: string + transType: + example: Sale + type: string + transactionRefundStatus: + example: None + type: string + updated: + example: false + type: boolean + type: object + TransactionsResponse: + properties: + limit: + example: 200 + type: number + skip: + example: 0 + type: number + total: + example: 138 + type: number + values: + items: + properties: + active: + example: false + type: boolean + assignedEmployeeId: + example: 5cba1d65e7198807f4ba7163 + type: string + cart: + properties: + adjustmentAmount: + example: 0 + type: number + afterTaxDiscount: + example: 0 + type: number + appliedAfterTaxDiscount: + example: 0 + type: number + balanceDue: + example: 0 + type: number + calcCartDiscount: + example: 0 + type: number + cashReceived: + example: 120 + type: number + changeDue: + example: -4.92 + type: number + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: MedicinalThirdParty + type: string + created: + example: 1556055323017 + type: number + format: int64 + creditCardFee: + example: 0 + type: number + deleted: + example: false + type: boolean + deliveryDiscount: + example: 0 + type: number + deliveryDiscountType: + example: Cash + type: string + deliveryFee: + example: 0 + type: number + deliveryPromotionId: + example: string + type: string + discount: + example: 0 + type: number + discountType: + example: Percentage + type: string + enableCreditCardFee: + example: false + type: boolean + enableDeliveryFee: + example: false + type: boolean + finalRefundAmt: + example: 0 + type: number + id: + example: 5cbf851b33b485082543b7a2 + type: string + items: + items: + properties: + availableDiscountQty: + example: 0 + type: number + batchId: + example: 5c9fe425e0faca07db94b990 + type: string + batchSku: + example: 0 + type: number + calcCultivationTax: + example: 0 + type: number + calcDiscount: + example: 0 + format: double + type: number + calcPreTax: + example: 0 + type: number + calcTax: + example: 8.3147 + format: double + type: number + cogs: + example: 69.1 + type: number + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + cost: + example: 45 + format: double + type: number + created: + example: 1556055338248 + format: int64 + type: number + deleted: + example: false + type: boolean + discount: + example: 0 + format: double + type: number + discountType: + example: Cash + type: string + discountedQty: + example: 0 + format: double + type: number + exchangeAmount: + example: 0 + type: number + exchangeQty: + example: 0 + type: number + exciseTax: + example: 0.7135 + format: double + type: number + finalPrice: + example: 45 + format: double + type: number + finalized: + example: false + type: boolean + fulfilled: + example: true + type: boolean + id: + example: 5cbf852a1d5dbc081de754fa + type: string + ignoreMixMatch: + example: false + type: boolean + mixMatched: + example: false + type: boolean + modified: + example: 1556066737723 + format: int64 + type: number + orderItemId: + example: 6c569a3e-1641-46ed-a0cd-7a5eed7064a7 + type: string + origQuantity: + example: 1 + format: double + type: number + overridePrice: + example: 0 + type: number + perUnitRefundAmt: + example: 0 + type: number + prepackage: + example: 5c9fe425e0faca07db94b990 + type: string + prepackageId: + example: 5c9fe425e0faca07db94b990 + type: string + prepackageItemId: + example: 5c9fe425e0faca07db94b990 + type: string + prepackageProductItem: + example: 5c9fe425e0faca07db94b990 + type: string + preparedQty: + example: 0 + type: number + product: + example: 0 + type: number + productId: + example: 5cbb4dec90427708240820c3 + type: string + promotionReqs: + items: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556440873514 + type: number + format: int64 + deleted: + example: false + type: boolean + id: + example: 5cc567291d31b9081bed54fa + type: string + modified: + example: 1556440873514 + type: number + format: int64 + promotionId: + example: 5cc521e25fecd30808bc1c97 + type: string + rewardId: + example: 5c9fe425e0faca07db94b990 + type: string + updated: + example: false + type: boolean + type: object + type: array + quantity: + example: 1 + format: double + type: number + quantityLogs: + items: + properties: + batchId: + example: 5cbea8d5f3a077080f237ce3 + type: string + id: + example: 6c569a3e-1641-46ed-a0cd-7a5eed7064a7_5c9fe425e0faca07db94b990_5cbea8d5f3a077080f237ce3 + type: string + inventoryId: + example: 5c9fe425e0faca07db94b990 + type: string + prepackageItemId: + example: 5c9fe425e0faca07db94b990 + type: string + quantity: + example: 1 + type: number + type: object + type: array + status: + example: Active + type: string + taxOrder: + example: PostTaxed + type: string + taxResult: + properties: + created: + example: 1556066737751 + type: number + format: int64 + cultivationTaxResult: + properties: + flowerTaxOz: + example: 0 + type: number + leafTaxOz: + example: 0 + type: number + totalCultivationTax: + example: 0 + type: number + totalFlowerOz: + example: 0 + type: number + totalFlowerTax: + example: 0 + type: number + totalLeafOz: + example: 0 + type: number + totalLeafTax: + example: 0 + type: number + type: object + deleted: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111a8 + type: string + modified: + example: 1556066737751 + format: int64 + type: number + totalALExciseTax: + example: 4.224 + type: number + totalALPostExciseTax: + example: 4.224 + type: number + totalCityPreTax: + example: 0 + type: number + totalCityTax: + example: 4.9224 + type: number + totalCountyPreTax: + example: 0 + type: number + totalCountyTax: + example: 0.1354 + type: number + totalExciseTax: + example: 0 + type: number + totalFedPreTax: + example: 0 + type: number + totalFedTax: + example: 0 + type: number + totalNALPreExciseTax: + example: 0 + type: number + totalPostCalcTax: + example: 8.3147 + type: number + totalPreCalcTax: + example: 0 + type: number + totalStatePreTax: + example: 0 + type: number + totalStateTax: + example: 3.2569 + type: number + updated: + example: false + type: boolean + type: object + taxTable: + properties: + active: + example: false + type: boolean + cityTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: true + type: boolean + created: + example: 1556066737751 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111aa + type: string + modified: + example: 1556066737751 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 10 + type: number + territory: + example: City + type: string + updated: + example: false + type: boolean + type: object + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: MedicinalThirdParty + type: string + countyTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: true + type: boolean + created: + example: 1556066737751 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111ab + type: string + modified: + example: 1556066737751 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0.25 + type: number + territory: + example: County + type: string + updated: + example: false + type: boolean + type: object + created: + example: 1556066737751 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + federalTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1556066737751 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111ad + type: string + modified: + example: 1556066737751 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: Federal + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5cbfb1b176dded08124111a9 + type: string + modified: + example: 1556066737751 + format: int64 + type: number + name: + example: Medicinal - Third Party + type: string + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + stateTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: true + type: boolean + created: + example: 1556066737751 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111ac + type: string + modified: + example: 1556066737751 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 6 + type: number + territory: + example: State + type: string + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxType: + example: Custom + type: string + updated: + example: false + type: boolean + type: object + taxType: + example: Inherit + type: string + totalRefundAmount: + example: 0 + type: number + totalRefundQty: + example: 1 + type: number + txnLineID: + example: 0 + type: number + unitPrice: + example: 45 + format: double + type: number + unitQty: + example: 0 + format: double + type: number + updated: + example: false + type: boolean + useUnitQty: + example: false + type: boolean + weightKey: + example: UNIT + type: string + type: object + type: array + modified: + example: 1556066737710 + type: number + format: int64 + paymentOption: + example: Cash + type: string + paymentType: + example: Full + type: string + pointSpent: + example: 0 + type: number + promoCode: + example: string + type: string + promotionReqLogs: + items: + properties: + amount: + example: 12 + type: number + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556233486913 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cc23d0efbbb0e08264c3cc7 + type: string + modified: + example: 1556233486913 + format: int64 + type: number + promotionId: + example: 5cbf6612e0faca07f6364ed1 + type: string + promotionType: + example: Cart + type: string + rewardId: + example: string + type: string + updated: + example: false + type: boolean + type: object + type: array + promotionReqs: + items: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556233486896 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cc23d0efbbb0e08264c3cc2 + type: string + modified: + example: 1556233486896 + format: int64 + type: number + promotionId: + example: 5cbf6612e0faca07f6364ed1 + type: string + rewardId: + example: string + type: string + updated: + example: false + type: boolean + type: object + type: array + refundAmount: + example: 0 + type: number + refundOption: + example: Void + type: string + refundOrderItemRequests: + items: + properties: + orderItemId: + example: 6c569a3e-1641-46ed-a0cd-7a5eed7064a7 + type: string + quantity: + example: 1 + type: number + refundAmt: + example: 45 + type: number + type: object + type: array + requestRefundAmt: + example: 0 + type: number + roundAmt: + example: 0 + type: number + storageLocation: + example: CashDrawer + type: string + subTotal: + example: 90 + type: number + subTotalDiscount: + example: 90 + type: number + tax: + example: 0.08 + type: number + taxResult: + properties: + created: + example: 1556066737751 + format: int64 + type: number + cultivationTaxResult: + properties: + flowerTaxOz: + example: 0 + type: number + leafTaxOz: + example: 0 + type: number + totalCultivationTax: + example: 0 + type: number + totalFlowerOz: + example: 0 + type: number + totalFlowerTax: + example: 0 + type: number + totalLeafOz: + example: 0 + type: number + totalLeafTax: + example: 0 + type: number + type: object + deleted: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111b4 + type: string + modified: + example: 1556066737751 + type: number + format: int64 + totalALExciseTax: + example: 0 + type: number + totalALPostExciseTax: + example: 8.45 + type: number + totalCityPreTax: + example: 0 + type: number + totalCityTax: + example: 9.84 + type: number + totalCountyPreTax: + example: 0 + type: number + totalCountyTax: + example: 0.27 + type: number + totalExciseTax: + example: 0 + type: number + totalFedPreTax: + example: 0 + type: number + totalFedTax: + example: 0 + type: number + totalNALPreExciseTax: + example: 0 + type: number + totalPostCalcTax: + example: 25.08 + type: number + totalPreCalcTax: + example: 0 + type: number + totalStatePreTax: + example: 0 + type: number + totalStateTax: + example: 6.51 + type: number + updated: + example: false + type: boolean + type: object + taxTable: + properties: + active: + example: false + type: boolean + cityTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: true + type: boolean + created: + example: 1556066737713 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111a2 + type: string + modified: + example: 1556066737713 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 10 + type: number + territory: + example: City + type: string + updated: + example: false + type: boolean + type: object + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: MedicinalThirdParty + type: string + countyTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: true + type: boolean + created: + example: 1556066737713 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111a3 + type: string + modified: + example: 1556066737713 + format: int64 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0.25 + type: number + territory: + example: County + type: string + updated: + example: false + type: boolean + type: object + created: + example: 1556066737713 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + federalTax: + properties: + active: + example: false + type: boolean + activeExciseTax: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: false + type: boolean + created: + example: 1556066737713 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111a5 + type: string + modified: + example: 1556066737713 + type: number + format: int64 + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 0 + type: number + territory: + example: Federal + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5cbfb1b176dded08124111a1 + type: string + modified: + example: 1556066737713 + type: number + format: int64 + name: + example: Medicinal - Third Party + type: string + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + stateTax: + properties: + active: + example: true + type: boolean + activeExciseTax: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + compound: + example: true + type: boolean + created: + example: 1556066737713 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + id: + example: 5cbfb1b176dded08124111a4 + type: string + modified: + example: 1556066737713 + type: number + format: int64 + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + taxOrder: + example: PostTaxed + type: string + taxRate: + example: 6 + type: number + territory: + example: State + type: string + updated: + example: false + type: boolean + type: object + taxOrder: + example: PostTaxed + type: string + taxType: + example: Custom + type: string + updated: + example: false + type: boolean + type: object + total: + example: 115.08 + type: number + totalALExciseTax: + example: 0 + type: number + totalCalcTax: + example: 25.08 + type: number + totalDiscount: + example: 0 + type: number + totalExciseTax: + example: 0 + type: number + totalPreCalcTax: + example: 0 + type: number + updated: + example: false + type: boolean + type: object + checkinTime: + example: 1556055323017 + type: number + format: int64 + checkoutType: + example: Direct + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + completedTime: + example: 1556066738522 + type: number + format: int64 + consumerCartId: + example: string + type: string + created: + example: 1556055323017 + format: int64 + type: number + createdById: + example: 5cb7b8a94cd84907f646e851 + type: string + deleteNote: + properties: + created: + example: 1557363743758 + format: int64 + type: number + deleted: + example: false + type: boolean + enableOnFleet: + example: false + type: boolean + id: + example: 5cd37c1f819d9e27ca3ed854 + type: string + message: + example: Duplicate Transaction + type: string + modified: + example: 1557363743758 + format: int64 + type: number + updated: + example: false + type: boolean + writerId: + example: string + type: string + writerName: + example: string + type: string + type: object + deleted: + example: false + type: boolean + deliveryAddress: + properties: + address: + example: "25016 River Walk Ln. " + type: string + addressLine1: + example: "" + type: string + city: + example: Santa Clarita + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + country: + example: US + type: string + created: + example: 1556066737667 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cbfb1b176dded081241118e + type: string + modified: + example: 1556066737667 + format: int64 + type: number + state: + example: CA + type: string + updated: + example: false + type: boolean + zipCode: + example: "91383" + type: string + type: object + dirty: + example: false + type: boolean + endRouteDate: + example: 1556056021575 + type: number + endRouteLocation: + example: + - 33.81258146840503 + - -116.49588659416557 + items: + type: number + type: array + endTime: + example: 1556066737667 + type: number + format: int64 + eta: + example: 0 + type: number + fulfillmentStep: + example: Prepare + type: string + id: + example: 5cbf851b33b485082543b7a1 + type: string + loc: + example: + - -118.58774266216771 + - 34.37550086531264 + items: + type: number + type: array + locked: + example: false + type: boolean + member: + properties: + address: + properties: + address: + example: 23708 Via Andorra + type: string + addressLine1: + example: "" + type: string + city: + example: "Santa Clarita " + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + country: + example: US + type: string + created: + example: 1557335083553 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cd30c2be0faca07d28264a2 + type: string + modified: + example: 1557335083553 + format: int64 + type: number + state: + example: CA + type: string + updated: + example: false + type: boolean + zipCode: + example: "91355" + type: string + type: object + agreementExpired: + example: false + type: boolean + anonymous: + example: false + type: boolean + banPatient: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + consumerType: + example: AdultUse + type: string + consumerUserId: + example: 5cd30b53c3226a084423f9ad + type: string + created: + example: 1557334153111 + format: int64 + type: number + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + dlExpired: + example: false + type: boolean + dob: + example: 391158000000 + type: number + email: + example: rachel_witmer@yahoo.com + type: string + emailOptIn: + example: true + type: boolean + emailVerified: + example: false + type: boolean + enableLoyalty: + example: true + type: boolean + enabledCareGiver: + example: false + type: boolean + firstName: + example: Rachel + type: string + id: + example: 5cd30889e0faca07d2824d83 + type: string + identifications: + items: + properties: + assets: + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1557334147632 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cd308830c9ccc081b8a271d + type: string + key: + example: 187ea16f-92cb-44e8-92f9-364efd4a6bff.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-500x500.png" + type: string + modified: + example: 1557334147632 + format: int64 + type: number + name: + example: + Screen Shot 2019-05-08 at 9.46.57 AM.png + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: string + type: string + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1557334153113 + format: int64 + type: number + deleted: + example: false + type: boolean + expirationDate: + example: 1653462000000 + type: number + frontPhoto: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1557334147632 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cd308830c9ccc081b8a271d + type: string + key: + example: 187ea16f-92cb-44e8-92f9-364efd4a6bff.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-500x500.png" + type: string + modified: + example: 1557334147632 + format: int64 + type: number + name: + example: + Screen Shot 2019-05-08 at 9.46.57 AM.png + type: string + origURL: + example: string + type: string + priority: + example: 0 + type: number + publicURL: + example: string + type: string + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/187ea16f-92cb-44e8-92f9-364efd4a6bff-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + id: + example: 5cd30889e0faca07d2824d81 + type: string + licenseNumber: + example: B8669788 + type: string + modified: + example: 1557334153113 + format: int64 + type: number + state: + example: string + type: string + type: + example: string + type: string + updated: + example: false + type: boolean + verified: + example: false + type: boolean + type: object + type: array + importId: + example: string + type: string + lastName: + example: Whitmer + type: string + lastVisitDate: + example: 1557334153112 + type: number + lifetimePoints: + example: 0 + type: number + loyaltyPoints: + example: 0 + type: number + marketingSource: + example: On Deck + type: string + medical: + example: false + type: boolean + memberGroup: + properties: + active: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1551488486906 + format: int64 + type: number + defaultGroup: + example: true + type: boolean + deleted: + example: false + type: boolean + dirty: + example: false + type: boolean + discount: + example: 0 + type: number + discountType: + example: Percentage + type: string + enablePromotion: + example: false + type: boolean + id: + example: 5c7e8c7b722ed607e61edb25 + type: string + memberCount: + example: 144 + type: number + memberCountEmailOptIn: + example: 114 + type: number + memberCountTextOptIn: + example: 109 + type: number + modified: + example: 1557333838706 + type: number + format: int64 + name: + example: Delivery + type: string + promotionId: + example: 5cc6938d18c8a8081ff8dd0e + type: string + shopId: + example: 5c7e8c7b722ed607e61edb1d + type: string + updated: + example: false + type: boolean + type: object + memberGroupId: + example: 5c7e8c7b722ed607e61edb25 + type: string + middleName: + example: string + type: string + modified: + example: 1557335083796 + format: int64 + type: number + primaryPhone: + example: (630) 294-0678 + type: string + qbMapping: + example: string + type: string + recommendationExpired: + example: true + type: boolean + recommendationExpiryLeft: + example: 0 + type: number + recommendations: + items: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1557334153113 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cd30889e0faca07d2824d82 + type: string + modified: + example: 1557334153113 + format: int64 + type: number + updated: + example: false + type: boolean + verifyMethod: + example: MANUAL + type: string + type: object + type: array + regionId: + example: string + type: string + searchText: + example: + rachel whitmer 23708 vía + andorra rachel_witmer@yahoo.com (630) 294-0678 + delivery + type: string + sex: + example: 1 + type: number + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + startDate: + example: 1557334153112 + type: number + status: + example: Active + type: string + textOptIn: + example: true + type: boolean + updated: + example: false + type: boolean + type: object + memberId: + example: 5cbf84e233b485082543b67d + type: string + memberSignature: + properties: + active: + example: true + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556066699832 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cbfb18ba71c2f082fa6661a + type: string + key: + example: 6efbf882-f4d3-4acb-8723-6da45ef87edf.png + type: string + largeURL: + example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf-800x800.png" + type: string + mediumURL: + example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf-500x500.png" + type: string + modified: + example: 1556066699832 + format: int64 + type: number + name: + example: file + type: string + priority: + example: 0 + type: number + publicURL: + example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf.png" + type: string + secured: + example: false + type: boolean + thumbURL: + example: "https://connect-files-public.s3.amazonaws.com/6efbf882-f4d3-4acb-8723-6da45ef87edf-200x200.png" + type: string + updated: + example: false + type: boolean + type: object + memo: + example: string + type: string + metrcId: + example: string + format: int64 + type: number + metrcSaleTime: + example: "2019-04-24T00:45:38.522Z" + type: string + mileage: + example: 0 + type: number + mileageCalculated: + example: true + type: boolean + modified: + example: 1556503061612 + type: number + format: int64 + note: + properties: + created: + example: 1557363743758 + format: int64 + type: number + deleted: + example: false + type: boolean + enableOnFleet: + example: false + type: boolean + id: + example: 5cd37c1f819d9e27ca3ed854 + type: string + message: + example: Duplicate Transaction + type: string + modified: + example: 1557363743758 + format: int64 + type: number + updated: + example: false + type: boolean + writerId: + example: string + type: string + writerName: + example: string + type: string + type: object + overrideInventoryId: + example: 5c9fe425e0faca07db94b990 + type: string + paid: + example: false + type: boolean + paidTime: + example: 1556066738522 + type: number + format: int64 + parentitemNumber: + example: 5cd329d5e0faca07d2832c88 + type: string + paymentCardPayments: + items: + properties: + amount: + example: 130.92 + type: number + balance: + example: 19.08 + type: number + created: + example: 0 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 000ae300b23000dd6000fbc5 + type: string + modified: + example: 0 + type: number + format: int64 + paymentCardNumber: + example: "6058690074011822" + type: string + processedTime: + example: 1556311867003 + type: number + format: int64 + status: + example: Paid + type: string + statusMessage: + example: string + type: string + type: + example: Linx + type: string + updated: + example: false + type: boolean + type: object + type: array + pointsEarned: + example: 90 + type: number + priority: + example: 71 + type: number + processedTime: + example: 1556066738522 + type: number + format: int64 + queueType: + example: Delivery + type: string + routing: + example: false + type: boolean + seller: + properties: + address: + properties: + address: + example: "" + type: string + addressLine1: + example: "" + type: string + city: + example: "" + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + country: + example: US + type: string + created: + example: 1555699043038 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cba1563e7198807f4ba3ce2 + type: string + modified: + example: 1555699043038 + format: int64 + type: number + state: + example: "" + type: string + updated: + example: false + type: boolean + zipCode: + example: "" + type: string + type: object + assigned: + example: true + type: boolean + assignedEmployee: + example: string + type: string + assignedTerminalId: + example: 5c82b3944442190831bca731 + type: string + canApplyCustomDiscount: + example: false + type: boolean + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + createOnfleetTask: + example: false + type: boolean + createTookanTask: + example: false + type: boolean + created: + example: 1555698469092 + format: int64 + type: number + deleted: + example: false + type: boolean + deliveryDate: + example: 0 + type: number + disabled: + example: false + type: boolean + dlExpirationDate: + example: "2019-06-11" + type: string + driversLicense: + example: Y3467802 + type: string + email: + example: ruben.luna7496@gmail.com + type: string + errorRefundTime: + example: 0 + type: number + format: int64 + errorTime: + example: 0 + type: number + format: int64 + firstName: + example: Ruben + type: string + fulfillingFulfillment: + example: false + type: boolean + id: + example: 5cba1325e7198807f4ba2a01 + type: string + insuranceCompanyName: + example: Progressive + type: string + insuranceExpireDate: + example: 0 + type: number + lastName: + example: Luna + type: string + modified: + example: 1556502543146 + format: int64 + type: number + onFleetTaskId: + example: string + type: string + onFleetTaskStatus: + example: string + type: string + orderTags: + example: + - Delivery + items: + type: string + type: array + packedBy: + example: 5cb7b8a94cd84907f646e851 + type: string + packedDate: + example: 1556055414943 + type: number + password: + example: 1Rheg0qew4Y/sOmTJIn7O9RwhFjCQV4i + type: string + payingWithPaymentCard: + example: false + type: boolean + phoneNumber: + example: (951) 392-6663 + type: string + pickUpDate: + example: 1556055414943 + type: number + pin: + example: "8035" + type: string + preparedBy: + example: 5cb7b8a94cd84907f646e851 + type: string + preparedDate: + example: 1556055414943 + type: number + preparingFulfillment: + example: false + type: boolean + qbDesktopJournalEntryRef: + example: string + type: string + qbDesktopRefundReceipt: + example: string + type: string + qbDesktopSalesRef: + example: string + type: string + qbErrored: + example: false + type: boolean + qbJournalEntryRef: + example: string + type: string + qbRefundErrored: + example: false + type: boolean + qbRefundReceipt: + example: string + type: string + qbSalesReceiptRef: + example: string + type: string + recentLocation: + properties: + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1557337109403 + format: int64 + type: number + deleted: + example: false + type: boolean + deviceId: + example: A2D5B987-95F4-479F-83F0-A752A5214EC8 + type: string + dirty: + example: false + type: boolean + employeeId: + example: 5cba1632c3cb8e0812d4c12f + type: string + id: + example: 5cd3141535f310083897685c + type: string + loc: + example: + - -118.54924441326274 + - 34.38270112968458 + items: + type: number + type: array + modified: + example: 1557337109403 + type: number + format: int64 + name: + example: Pineapple’s iPhone + type: string + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + terminalId: + example: 5c9fe47ae8df3f080d33aa09 + type: string + timeCardId: + example: 5cd2d7b80c9ccc081b8999ca + type: string + updated: + example: false + type: boolean + type: object + refundPaymentOptions: + example: + - Cash + - Cash + - StoreCredit + items: + type: string + type: array + refundVersion: + example: string + type: string + registrationExpireDate: + example: 0 + type: number + roleId: + example: 5c7e8c7b722ed607e61edb13 + type: string + shops: + example: + - 5c9fe425e0faca07db94b970 + items: + type: string + type: array + shortId: + example: string + type: string + state: + example: 0 + type: number + timeCardId: + example: 5cd2d7b80c9ccc081b8999ca + type: string + tookanTaskId: + example: string + type: string + transactionRefundStatus: + example: Partial_Refund + type: string + updated: + example: false + type: boolean + vehicleLicensePlate: + example: string + type: string + vehicleMake: + example: Mercedes + type: string + vehicleModel: + example: string + type: string + vehiclePin: + example: string + type: string + vinNo: + example: string + type: string + type: object + sellerId: + example: 5cba1d65e7198807f4ba7163 + type: string + sellerTerminalId: + example: 5c82b3944442190831bca731 + type: string + shopId: + example: 5c9fe425e0faca07db94b970 + type: string + source: + example: string + type: string + startRouteDate: + example: 1556056023752 + type: number + startRouteLocation: + example: + - 33.81258146840503 + - -116.49588659416557 + items: + type: number + type: array + startTime: + example: 1556066674249 + type: number + format: int64 + status: + example: Completed + type: string + terminalId: + example: "" + type: string + timeZone: + example: America/Los_Angeles + type: string + traceMessage: + example: string + type: string + traceSubmitStatus: + example: None + type: string + trackingStatus: + example: NotStarted + type: string + transNo: + example: "71" + type: string + transType: + example: Sale + type: string + transferShopId: + example: string + type: string + updated: + example: false + type: boolean + type: object + type: array + type: object + VendorResponse: + properties: + active: + example: true + type: boolean + additionalAddressList: + example: + - string + items: + type: string + type: array + address: + properties: + address: + example: "" + type: string + city: + example: "" + type: string + companyId: + example: string + type: string + country: + example: US + type: string + created: + example: 1554825414778 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cacc0c66218d174d3f17b0c + type: string + modified: + example: 1554825414778 + format: int64 + type: number + state: + example: "" + type: string + updated: + example: false + type: boolean + zipCode: + example: "" + type: string + type: object + armsLengthType: + example: ARMS_LENGTH + type: string + assets: + example: + - string + items: + properties: + active: + example: true + type: boolean + assetType: + example: Photo + type: string + companyId: + example: 5c7e8c7b722ed607e61edb06 + type: string + created: + example: 1556052368662 + format: int64 + type: number + deleted: + example: false + type: boolean + id: + example: 5cbf79908a29f808183540e7 + type: string + key: + example: c71adc95-bb07-47f2-b9f6-cc4db7936686.png + type: string + largeURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-800x800.png" + type: string + largeX2URL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-1600x1600.png" + type: string + mediumURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-500x500.png" + type: string + modified: + example: 1556052368662 + format: int64 + type: number + name: + example: Brian Main DL.png + type: string + priority: + example: 0 + type: number + secured: + example: true + type: boolean + thumbURL: + example: "https://connect-files-p1.s3.amazonaws.com/c71adc95-bb07-47f2-b9f6-cc4db7936686-200x200.png" + type: string + type: + example: Photo + type: string + updated: + example: false + type: boolean + type: object + type: array + backOrderEnabled: + example: false + type: boolean + brandList: + example: + - string + items: + type: string + type: array + brands: + example: + - string + items: + type: string + type: array + companyId: + example: 5cabd4ba6218d148395b402c + type: string + companyLicenses: + example: + - string + items: + type: string + type: array + companyType: + example: string + type: string + created: + example: 1554825414778 + format: int64 + type: number + credits: + example: 0 + type: number + dbaName: + example: string + type: string + deleted: + example: false + type: boolean + description: + example: "" + type: string + email: + example: "" + type: string + fax: + example: "" + type: string + firstName: + example: "" + type: string + id: + example: 5cacc0c66218d174d3f17b0d + type: string + importId: + example: string + type: string + lastName: + example: "" + type: string + licenceType: + example: string + type: string + licenseExpirationDate: + example: 0 + type: number + licenseNumber: + example: "" + type: string + mobileNumber: + example: string + type: string + modified: + example: 1554825414778 + format: int64 + type: number + name: + example: Binsky + type: string + notes: + example: + - string + items: + type: string + type: array + phone: + example: "" + type: string + qbDesktopRef: + example: string + type: string + qbVendorRef: + example: + - string + items: + type: string + type: array + relatedEntity: + example: false + type: boolean + updated: + example: false + type: boolean + vendorKey: + example: NWNhYmQ0YmE2MjE4ZDE0ODM5NWI0MDJjX2JpbnNreQ== + type: string + vendorType: + example: VENDOR + type: string + website: + example: "" + type: string + type: object diff --git a/swagger/board-taxnexus.yaml b/swagger/board-taxnexus.yaml new file mode 100644 index 0000000..112f61f --- /dev/null +++ b/swagger/board-taxnexus.yaml @@ -0,0 +1,1856 @@ +swagger: "2.0" +info: + description: Taxnexus Onboarding Service + title: board + termsOfService: "http://taxnexus.net/terms/" + contact: + email: noc@taxnexus.net + license: + name: "Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc." + version: 1.2.7 +schemes: + - http +host: "board.fabric.tnxs.net:8080" +basePath: /v1 +produces: + - application/json +paths: + /accounts: + delete: + description: Delete Taxnexus Account record + operationId: deleteAccount + parameters: + - $ref: "#/parameters/accountIdQuery" + responses: + "200": + $ref: "#/responses/DeleteResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Delete An Account + tags: + - Accounts + get: + description: Return a list of all available Accounts + operationId: getAccounts + parameters: + - $ref: "#/parameters/limitQuery" + - $ref: "#/parameters/nameQuery" + - $ref: "#/parameters/offsetQuery" + - $ref: "#/parameters/activeQuery" + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/emailQuery" + responses: + "200": + $ref: "#/responses/AccountResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Get a list of accounts + tags: + - Accounts + options: + description: CORS support + operationId: accountOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + description: Account record to be added + operationId: postAccounts + parameters: + - $ref: "#/parameters/accountRequest" + responses: + "200": + $ref: "#/responses/AccountResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Add a new account to Taxnexus + tags: + - Accounts + put: + description: Update a single account specified by accountId + operationId: putAccount + parameters: + - $ref: "#/parameters/accountRequest" + responses: + "200": + $ref: "#/responses/AccountResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Update a single account + tags: + - Accounts + /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" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Delete a Contact + tags: + - Contacts + get: + description: Return a list of all available Contacts + operationId: getContacts + parameters: + - $ref: "#/parameters/limitQuery" + - $ref: "#/parameters/offsetQuery" + - $ref: "#/parameters/contactIdQuery" + - $ref: "#/parameters/activeQuery" + - $ref: "#/parameters/emailQuery" + - $ref: "#/parameters/nameQuery" + responses: + "200": + $ref: "#/responses/ContactResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Get a list of contacts + tags: + - Contacts + options: + description: CORS support + operationId: contactOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + 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" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + 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" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Update Contact + tags: + - Contacts + /developers: + options: + description: CORS support + operationId: developerOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + security: + - ApiKeyAuth: [] + consumes: + - application/json + description: Register new developers with POST + operationId: postDevelopers + parameters: + - $ref: "#/parameters/developerRequest" + responses: + "200": + $ref: "#/responses/DeveloperResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Onboard new developer + tags: + - Developers + /iqs: + options: + description: CORS support + operationId: iqOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + security: + - ApiKeyAuth: [] + consumes: + - application/json + description: Register new Taxnexus IQ Customer with POST + operationId: postIQ + parameters: + - $ref: "#/parameters/iqRequest" + responses: + "200": + $ref: "#/responses/IqResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Onboard new new Taxnexus IQ Customer + tags: + - Iq + /leads: + options: + description: CORS support + operationId: leadsOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + consumes: + - application/json + description: Add a new full Lead Record + operationId: postLeads + parameters: + - $ref: "#/parameters/leadRequest" + responses: + "200": + $ref: "#/responses/LeadResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Add a new Lead record + tags: + - Leads + put: + description: Update Lead records + operationId: putLeads + parameters: + - $ref: "#/parameters/leadRequest" + responses: + "200": + $ref: "#/responses/LeadResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Update Leads + tags: + - Leads + /userauths: + options: + description: CORS support + operationId: userAuthOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + "/userauths/{usernamePath}": + get: + description: + Return a single UserAuth object from datastore as a Singleton + operationId: getUserAuth + parameters: + - $ref: "#/parameters/usernamePath" + responses: + "200": + $ref: "#/responses/UserAuthResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Get a single UserAuth object + tags: + - UserAuth + /users: + get: + description: Get a clean user record + operationId: getUsers + parameters: + - $ref: "#/parameters/emailQueryRequired" + 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" + security: + - ApiKeyAuth: [] + tags: + - Users + options: + description: CORS support + operationId: userOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors +definitions: + Account: + properties: + 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 + format: double + type: number + AmountInvoiced: + description: Amount Invoiced + format: double + type: number + AmountPaid: + description: Amount Paid + format: double + type: number + AnnualRevenue: + description: Annual Revenue Estimate + format: double + type: number + Balance: + description: Account Balance + format: double + type: number + BillingAddress: + $ref: "#/definitions/Address" + BillingContactID: + description: Contact ID + type: string + BillingPreference: + description: Billing Preference + type: string + BusinessAddress: + $ref: "#/definitions/Address" + CannabisCustomer: + description: Is this a cannabis customer? + type: boolean + 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 + DBA: + description: This Account's 'Doing Business As' name + type: string + DUNSNumber: + description: D-U-N-S Number + type: string + DandBCompanyID: + description: D-n-B Company + 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 + 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 + ISPCustomer: + description: ISP Customer? + type: boolean + Industry: + description: Industry + type: string + IsCustomerPortal: + description: Customer Portal Account + type: boolean + IsPartner: + description: Partner Account + 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 + format: int64 + type: number + NumberOfLocations: + description: Number of Locations Estimate + format: int64 + type: number + OpenCharges: + description: Open Charges + format: double + 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 + format: double + type: number + RevenueNet: + description: Rollup Revenue Net + format: double + type: number + RevenueNotTaxable: + description: Rollup Revenue Not Taxable + format: double + type: number + SIC: + description: SIC Code + type: string + SICDesc: + description: SIC Description + type: string + ShippingAddress: + $ref: "#/definitions/Address" + ShippingCensusTract: + description: Shipping Census Tract + type: string + ShippingConactID: + description: Shipping Contact ID + type: string + ShippingCounty: + description: Shipping County + 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 + format: double + 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 + format: double + type: number + UnitBase: + description: Rollup Unit Base + type: number + UpsellOpportunity: + description: Upsell Opportunity + type: string + WHMCSClientID: + description: WHMCS Client ID + format: int64 + type: number + Website: + description: Website + type: string + XeroContactID: + description: Xero Contact ID + type: string + YearStarted: + description: Year Started + type: string + type: object + AccountBasic: + properties: + AccountNumber: + description: "Taxnexus Account Number of the OEM/Reseller " + type: string + BillingAddress: + $ref: "#/definitions/Address" + BillingContactID: + description: Contact ID + type: string + CompanyID: + description: Taxnexus OEM/Reseller Record Id + type: string + CoordinateID: + description: + The id of the Coordinate of the business establishment + type: string + CustomerID: + description: Taxpayer Customer Id designated by OEM/Reseller + type: string + DefaultAddress: + $ref: "#/definitions/Address" + type: string + DefaultBackendID: + description: Default Backend ID + type: string + DefaultDeliveryContactID: + description: Default Delivery Address Contact ID + type: string + DefaultEndUserID: + description: Contact ID + type: string + Email: + description: Taxpayer Public Email Address + type: string + Fax: + description: Taxpayer Fax Number + type: string + ID: + description: Taxpayer Account Record Id + type: string + Name: + description: Taxpayer Account Name (ignored for Tax Processing) + type: string + ParentFK: + description: + UUID Reference the master record that owns this item + type: string + Phone: + description: Taxpayer Public Phone Number + type: string + PreparerID: + description: Contact ID + type: string + Ref: + description: "Source System identifier for this record, if any" + type: string + ShippingAddress: + $ref: "#/definitions/Address" + description: Shipping Address + ShippingConactID: + description: Contact ID + type: string + Site: + description: Taxpayer Location Designation + type: string + Type: + description: Account Type + type: string + Website: + description: Taxpayer Website + type: string + 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 + type: object + Contact: + properties: + AccountID: + description: The primary account ID of this contact + type: string + AssistantName: + description: Assistant Name + type: string + AssistantPhone: + description: Asst. Phone + type: string + BirthDate: + description: Birthdate + type: string + CreatedByID: + description: Created By User ID + type: string + CreatedDate: + description: Created Date + type: string + Department: + description: Department + type: string + Description: + description: Description + type: string + DoNotCall: + description: Do Not Call? + type: boolean + Email: + description: Email address + type: string + EmailBounceDate: + description: Email Bounce Date + type: string + 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 + ID: + description: Taxnexus Record Id + 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 + TenantID: + description: Tenant Identifier + type: string + Title: + description: Contact Title + type: string + Type: + description: Contact Type + type: string + type: object + Database: + 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 + DSN: + description: Database connection string + type: string + DatabaseName: + description: The name of the physical database in the cluster + 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 + type: object + Developer: + properties: + Account: + $ref: "#/definitions/Account" + Contact: + $ref: "#/definitions/Contact" + Lead: + $ref: "#/definitions/Lead" + PaymentMethod: + $ref: "#/definitions/PaymentMethod" + Tenant: + $ref: "#/definitions/Tenant" + User: + $ref: "#/definitions/User" + type: object + IQ: + properties: + Account: + $ref: "#/definitions/Account" + Contact: + $ref: "#/definitions/Contact" + Lead: + $ref: "#/definitions/Lead" + PaymentMethod: + $ref: "#/definitions/PaymentMethod" + Tenant: + $ref: "#/definitions/Tenant" + User: + $ref: "#/definitions/User" + type: object + Error: + properties: + code: + format: int64 + type: integer + fields: + type: string + message: + type: string + type: object + Lead: + properties: + Address: + $ref: "#/definitions/Address" + Company: + description: Company + type: string + Description: + description: Description + type: string + Email: + description: Email + type: string + FirstName: + description: First Name + type: string + ID: + description: Taxnexus Record Id + type: string + LastName: + description: Last Name + type: string + MobilePhone: + description: Mobile + type: string + Name: + description: Name + type: string + OwnerId: + description: LeadBasic Owner + type: string + PartnerAccountId: + description: Partner Account + type: string + Phone: + description: Phone + type: string + ProductID: + description: Product + type: string + RefererURL: + description: referer_url + type: string + Status: + description: LeadBasic Status + type: string + Title: + description: Title + type: string + Type: + description: Type + type: string + UTMCampaign: + description: utm_campaign + type: string + UTMContent: + description: utm_content + type: string + UTMMedium: + description: utm_medium + type: string + UTMSource: + description: utm_source + type: string + UTMTerm: + description: utm_term + type: string + Website: + description: Website + type: string + type: object + Message: + properties: + message: + type: string + ref: + type: string + status: + format: int64 + type: number + type: object + Pagination: + properties: + Limit: + format: int64 + type: number + POffset: + format: int64 + type: number + PageSize: + format: int64 + type: number + SetSize: + format: int64 + type: number + type: object + PaymentMethod: + description: + Describes the EFT or other payment information for an account and + billing contact + properties: + AccountID: + description: Account + type: string + AchAccountType: + description: ACH Account Type + type: string + AchBankAccount: + description: ACH Bank Account + type: string + AchRouting: + description: ACH Routing + type: string + Active: + description: Active? + type: boolean + Autopay: + description: Autopay? + type: boolean + BankName: + description: Bank Name + type: string + BillingContactID: + description: Billing Contact + type: string + CCnumber: + description: Credit Card Number + type: string + CCtype: + description: CC Type + type: string + CompanyID: + description: Company + type: string + ContractID: + description: Contract + type: string + CreatedByID: + description: Created By + type: string + CreatedDate: + description: Created Date + type: string + Default: + description: Default Payment Method? + type: boolean + ExpirationDate: + description: Expiration Date + type: string + ExpirationMonth: + description: Expiration Month + type: string + ExpirationYear: + description: Expiration Year + type: string + Gateway: + description: Gateway + type: string + GatewayKey: + description: Gateway Key + type: string + ID: + description: Telnexus Record Id + type: string + LastModifiedByID: + description: Last Modified By + type: string + LastModifiedDate: + description: Last Modified Date + type: string + Nickname: + description: Nickname + type: string + RecordType: + description: Record Type + type: string + Ref: + description: External Reference + type: string + type: object + Role: + description: A functional role within a Tenant + properties: + Auth0RoleID: + description: The corresponding Auth0 Role + type: string + CreatedByID: + description: Created By + type: string + CreatedDate: + description: Created Date + type: string + Description: + description: Role Description + type: string + ID: + description: Record Id + type: string + LastModifiedByID: + description: Last Modified By + type: string + LastModifiedDate: + description: Last Modifed Date + type: string + RoleName: + description: The name of this role + type: string + TenantID: + description: The ID of the Tenant that owns this Role + type: string + type: object + Tenant: + description: Taxnexus Account Tenant + properties: + AccountID: + description: The Account that owns this Tenant + type: string + Active: + description: Is this Tenant currently active? + type: boolean + CreatedByID: + description: Created By + type: string + CreatedDate: + description: Created Date + type: string + Databases: + items: + $ref: "#/definitions/Database" + type: array + ID: + description: Record Id + type: string + LastModifiedByID: + description: Last Modified By + type: string + LastModifiedDate: + description: Last Modifed Date + type: string + Roles: + items: + $ref: "#/definitions/Role" + type: array + Status: + description: The current status of this Tenant + type: string + TenantName: + description: Name of the Tenant Resource + type: string + TenantUsers: + items: + $ref: "#/definitions/TenantUser" + type: array + Type: + description: The type of Tenant + type: string + Version: + description: + The version number of the Tenant Onboarding system used to + create this tenant + type: string + type: object + TenantUser: + description: Relationship object that connects users to a tenant + properties: + AccessLevel: + description: The makeTenantUser access level for this User + type: string + AccountID: + description: Account ID + type: string + Auth0UserID: + description: Auth0 User ID + type: string + CompanyName: + description: Account Name + type: string + ContactID: + description: Contact ID + type: string + TaxnexusAccount: + description: Taxnexus Account + type: string + TenantActive: + description: Tenant active? + type: boolean + TenantID: + description: The Tenant ID + type: string + TenantName: + description: Tenant Name + type: string + TenantStatus: + description: Tenant Status + type: string + TenantType: + description: Tenant type + type: string + TenantVersion: + description: Tenant Version + type: string + UserEmail: + description: User Email Address + type: string + UserFullName: + description: User Full Name + type: string + UserID: + description: The User ID + type: string + Username: + description: Username + type: string + User: + properties: + APIKey: + description: API Key + type: string + AboutMe: + description: About Me + type: string + AccountID: + description: Account ID + type: string + Address: + $ref: "#/definitions/Address" + Alias: + description: Alias + 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 + EndOfDay: + 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 + IsProphilePhotoActive: + 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 + ReceivesAdminEmails: + description: Info Emails + type: boolean + ReceivesAdminInfoEmails: + description: Admin 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 + StartOfDay: + description: The time day starts + type: string + TaxnexusAccount: + description: Taxnexus Account + type: string + TenantID: + description: Tenant ID + type: string + TenantUsers: + items: + $ref: "#/definitions/TenantUser" + type: array + TimeZone: + description: Time Zone + type: string + Title: + description: Title + type: string + UserRoleID: + description: Role + type: string + UserRoles: + items: + $ref: "#/definitions/UserRole" + type: array + UserType: + description: User Type + type: string + Username: + description: Username + type: string + type: object + UserAuth: + properties: + APIKey: + description: API Key + type: string + AccountID: + description: Account ID + type: string + ContactID: + description: Contact + type: string + Email: + description: Email address + type: string + Roles: + description: Valid Roles for all tenants + items: + type: string + type: array + Tenants: + description: Valid Tenants + items: + type: string + type: array + UserID: + description: Taxneuxs User ID + type: string + UserRole: + description: Relationship object to connect a user to a role + properties: + AccountID: + description: Account Id + type: string + Auth0RoleID: + description: Linked role ID + type: string + Auth0UserID: + description: Auth0 User ID + type: string + CompanyName: + description: Company Name + type: string + ContactID: + description: Contact ID + type: string + RoleDescription: + description: Role description + type: string + RoleID: + description: The Role ID + type: string + RoleName: + description: Role Name + type: string + TaxnexusAccount: + description: Taxnexus Account Number + type: string + UserEmail: + description: User Email Address + type: string + UserFullName: + description: User Full Name + type: string + UserID: + description: The User ID + type: string + Username: + description: Username + type: string + type: object +parameters: + accountIdQuery: + description: Taxnexus Record Id of an Account + in: query + name: accountId + required: false + type: string + accountRequest: + description: An array of new Account records + in: body + name: accountRequest + required: true + schema: + $ref: "#/definitions/Account" + activeQuery: + description: Only retrieve active records? + in: query + name: active + required: false + type: boolean + companyIdQuery: + description: Taxnexus Company record ID + in: query + name: companyId + required: false + type: string + contactIdQuery: + description: Taxnexus Contact record ID + 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/Contact" + descriptionForm: + description: Lead description in an encoded form + in: formData + name: Description + type: string + developerRequest: + description: A single Developer struct for onboarding + in: body + name: developerRequest + required: true + schema: + $ref: "#/definitions/Developer" + iqRequest: + description: A single Taxnexus IQ Customer struct for onboarding + in: body + name: iqRequest + required: true + schema: + $ref: "#/definitions/IQ" + emailForm: + description: Lead email in an encoded form + in: formData + name: Email + required: true + type: string + emailPath: + description: Email address in the query path + in: path + name: emailPath + required: true + type: string + usernamePath: + description: Username in the query path + in: path + name: usernamePath + required: true + type: string + emailQuery: + description: Email address used for identity lookup + in: query + name: email + required: false + type: string + emailQueryRequired: + description: Email address + in: query + name: email + required: true + type: string + firstNameForm: + description: Lead first name in an encoded form + in: formData + name: FirstName + required: true + type: string + lastNameForm: + description: Lead last name in an encoded form + in: formData + name: LastName + required: true + type: string + leadIdQuery: + description: Taxnexus Record Id of a Lead + in: query + name: leadId + required: true + type: string + leadRequest: + description: A new Lead record as a single JSON object + in: body + name: leadRequest + required: true + schema: + $ref: "#/definitions/Lead" + limitQuery: + description: How many objects to return at one time + format: int64 + in: query + name: limit + required: false + type: integer + nameQuery: + description: The Name of this Object + in: query + name: name + required: false + type: string + offsetQuery: + description: How many objects to skip? + format: int64 + in: query + name: offset + required: false + type: integer + paymentMethodIdQuery: + description: Taxnexus Record Id of a PaymentMethod + in: query + name: paymentMethodId + required: false + type: string +responses: + AccessForbidden: + description: "Access forbidden, account lacks access" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + AccountResponse: + description: Taxnexus Response with Account objects with Contacts + headers: + Access-Control-Allow-Origin: + type: string + Cache-Control: + type: string + schema: + $ref: "#/definitions/Account" + CORSResponse: + description: CORS OPTIONS response + headers: + Access-Control-Allow-Credentials: + type: string + Access-Control-Allow-Headers: + type: string + Access-Control-Allow-Methods: + type: string + Access-Control-Allow-Origin: + type: string + Access-Control-Expose-Headers: + type: string + Access-Control-Max-Age: + type: string + Cache-Control: + type: string + Conflict: + description: Conflict + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + ContactResponse: + description: Taxnexus Response with a Contact object + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Contact" + DeleteResponse: + description: + Taxnexus Response with Message Objects with Delete Status + headers: + Access-Control-Allow-Origin: + type: string + DeveloperResponse: + description: Taxnexus Response with a Developer object + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Developer" + IqResponse: + description: Taxnexus Response with an IQ object + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/IQ" + InvalidDataError: + description: Invalid data was sent + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + LeadResponse: + description: Taxnexus Response with an array of Lead objects + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Lead" + NotFound: + description: Resource was not found + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + PaymentMethodResponse: + description: + Taxnexus Response with an array of Payment Method objects + headers: + Access-Control-Allow-Origin: + type: string + Cache-Control: + type: string + schema: + items: + $ref: "#/definitions/PaymentMethod" + type: array + ServerError: + description: Server Internal Error + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + Unauthorized: + description: "Access unauthorized, invalid API-KEY was used" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + UnprocessableEntity: + description: "Unprocessable Entity, likely a bad parameter" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + UserAuthResponse: + description: Taxneuxs User Authentication Response + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/UserAuth" + UserResponse: + description: User Response + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/User" +securityDefinitions: + ApiKeyAuth: + type: apiKey + name: X-API-Key + in: header diff --git a/swagger/gov-gw-taxnexus.yaml b/swagger/gov-gw-taxnexus.yaml new file mode 100644 index 0000000..0ecd727 --- /dev/null +++ b/swagger/gov-gw-taxnexus.yaml @@ -0,0 +1,323 @@ +swagger: "2.0" +info: + version: 1.2.7 + title: "gov-gw" + description: "Goverment Services Gateway" + termsOfService: "http://taxnexus.net/terms/" + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc." +securityDefinitions: + ApiKeyAuth: + type: apiKey + in: header + name: X-API-Key +schemes: + - "http" +basePath: "/v1" +host: "localhost" +consumes: + - "application/json" +produces: + - "application/json" +parameters: + addressQuery: + name: address + in: query + description: Postal Address URL encoded; partial addresses allowed + required: false + type: string + countryQuery: + name: country + in: query + description: The Country abbreviation (2 char) + required: false + type: string + limitQuery: + description: How many objects to return at one time + in: query + name: limit + type: number + format: int32 + required: false + offsetQuery: + description: How many objects to skip? (default 0) + in: query + name: offset + type: number + format: int32 + required: false + placeQuery: + name: place + in: query + description: The City name (must be accompanied by State) + required: false + type: string + stateQuery: + name: state + in: query + description: The State or Province abbreviation (2 char) + required: false + type: string +responses: + AccessForbidden: + description: "Access forbidden, account lacks access" + schema: + $ref: "#/definitions/Error" + Conflict: + description: Conflict + schema: + $ref: "#/definitions/Error" + InvalidDataError: + description: Invalid data was sent + schema: + $ref: "#/definitions/InvalidError" + NotFound: + description: Resource was not found + schema: + $ref: "#/definitions/Error" + ServerError: + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + CoordinateResponse: + description: Taxnexus Response + schema: + $ref: "#/definitions/CoordinateResponse" + 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" + +paths: + /coordinates: + get: + security: + - ApiKeyAuth: [] + summary: Get current tax rates for a coordinate + operationId: getCoordinates + description: + Returns full tax information for a specific point on the map + (tax situs). Uses existing Taxnexus Situs for lookup + information. + tags: + - Tax Rates + parameters: + - $ref: "#/parameters/limitQuery" + - $ref: "#/parameters/offsetQuery" + - $ref: "#/parameters/addressQuery" + - $ref: "#/parameters/placeQuery" + - $ref: "#/parameters/stateQuery" + - $ref: "#/parameters/countryQuery" + responses: + "200": + $ref: "#/responses/CoordinateResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" +definitions: + Coordinate: + properties: + country: + description: Geocoder Country + type: string + countryid: + description: Taxnexus Country ID + type: string + county: + description: Geocoder County + type: string + countyid: + description: Taxnexus County ID + type: string + focus: + description: Situs Focus for tax determination + type: string + formattedaddress: + description: Formatted Address from Geocoder + type: string + id: + description: Taxnexus Coordinate Record Id + type: string + isdistrict: + description: Situs Incorporated District? + type: boolean + latitude: + description: Latitude of coordinate + type: number + longitude: + description: Longitude of coordinate + type: number + name: + description: Coordinate Name from Search Text + type: string + neighborhood: + description: Geocoder Neighborhood + type: string + place: + description: Geocoder Place + type: string + placegeocode: + description: + The Taxnexus Geocode for this rated location (place or county) + type: string + placeid: + description: Taxnexus Place ID + type: string + postalcode: + description: Geocoder Postal Code + type: string + ref: + description: External System reference ID + type: string + state: + description: Geocoder State/Province name + type: string + stateid: + description: Taxnexus State ID + type: string + status: + description: The status of the coordinate in Taxnexus + type: string + street: + description: Geocoder Street Name (only) + type: string + streetnumber: + description: Geocoder Streen number + type: string + taxtypes: + items: + $ref: "#/definitions/TaxTypeID" + type: array + uuid: + description: Unique identifier assigned at creation + type: string + type: object + CoordinateRequest: + description: An array of Coordinate Request Items + properties: + data: + items: + $ref: "#/definitions/CoordinateRequestItem" + type: array + meta: + $ref: "#/definitions/RequestMeta" + required: + - meta + - data + type: object + CoordinateRequestItem: + description: A single Coordinate Request item + properties: + address: + description: The address to be translated + type: string + ref: + description: Source record reference + type: string + type: object + CoordinateResponse: + description: An array of Coordinate objects + properties: + data: + items: + $ref: "#/definitions/Coordinate" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Error: + properties: + code: + format: int32 + type: integer + message: + type: string + type: object + InvalidError: + allOf: + - $ref: "#/definitions/Error" + - properties: + details: + items: + type: string + type: array + type: object + Pagination: + properties: + limit: + format: int32 + type: integer + pagesize: + format: int32 + type: integer + poffset: + format: int32 + type: integer + setsize: + format: int32 + type: integer + type: object + RequestMeta: + properties: + TaxnexusAccount: + description: Taxnexus Account Number of the Reseller or OEM + type: string + required: + - TaxnexusAccount + type: object + ResponseMeta: + properties: + contact: + description: Microservice Contact Info + type: string + copyright: + description: Copyright Info + type: string + license: + description: License Information and Restrictions + type: string + operationid: + description: Operation ID + type: string + pagination: + $ref: "#/definitions/Pagination" + requestip: + description: Request IP Address + type: string + requesttype: + description: Request Type + type: string + requesturl: + description: Request URL + type: string + serverinfo: + description: Data Server Info + type: string + serverresponsetime: + description: Data Server Response Time (ms) + type: string + servertimestamp: + description: Backend Server Timestamp + type: string + TaxnexusAccount: + description: + Taxnexus Account Number used for recording transactions + type: string + type: object + TaxTypeID: + properties: + taxtypeid: + type: string diff --git a/swagger/metrc-gw-taxnexus.yaml b/swagger/metrc-gw-taxnexus.yaml new file mode 100644 index 0000000..c5ee7b8 --- /dev/null +++ b/swagger/metrc-gw-taxnexus.yaml @@ -0,0 +1,3057 @@ +swagger: "2.0" +securityDefinitions: + ApiKeyAuth: + type: "apiKey" + in: "header" + name: "X-API-Key" +security: + - ApiKeyAuth: [] +schemes: + - "http" +host: "metrc-gw.fabric.tnxs.net:8080" +basePath: "/v1" +info: + contact: + email: "support@taxnexus.net" + name: "Taxnexus Support" + url: "https://www.taxnexus.net/contact-us/" + description: Metrc Gateway Microservice + license: + name: "Proprietary" + termsOfService: "https://www.taxnexus.com/terms/" + title: metrc-gw + version: 1.2.7 +consumes: + - "application/json" +produces: + - "application/json" +parameters: + activeStatusQuery: + description: Get Active objects? + in: query + name: active + required: false + type: boolean + itemNumberPath: + description: The Item Number + in: path + name: itemId + required: true + type: number + itemNumberQuery: + description: The Item Number + in: query + name: itemId + required: false + type: number + itemNumberQueryRequired: + description: The Item Number + in: query + name: itemId + required: true + type: number + lastModifiedEndQuery: + description: The last modified end timestamp + in: query + name: lastModifiedEnd + required: false + type: string + lastModifiedStartQuery: + description: The last modified start timestamp + in: query + name: lastModifiedStart + required: false + type: string + licenseNumberQuery: + description: The Licnese Number for the query + in: query + name: license + required: true + type: string + mediaType: + default: application/json + description: The response media type + enum: + - application/json + in: header + name: Accept + type: string + onholdStatusQuery: + description: Get On Hold objects? + in: query + name: onhold + required: false + type: boolean + packageLabelQuery: + description: The METRC Package Label + in: query + name: label + required: false + type: string + packageNumberQuery: + description: The METRC Package Number + in: query + name: packageId + required: false + type: string + productionQuery: + description: Use Production API? + in: query + name: production + required: false + type: boolean + resellerKeyQuery: + description: The METRC Reseller Key + in: query + name: reseller + required: true + type: string + roomNumberQueryRequired: + description: The Room ID number + in: query + name: roomNumber + required: true + type: string + salesDeliveryNumberQuery: + description: The Sales Delivery Number + in: query + name: deliveryId + required: false + type: string + salesDeliveryNumberQueryRequired: + description: The Sales Delivery Number + in: query + name: salesDeliveryId + required: true + type: string + salesReceiptNumberQuery: + description: The Sales Receipt Number + in: query + name: salesReceiptId + required: false + type: string + salesReceiptNumberQueryRequired: + description: The Sales Receipt Number + in: query + name: salesReceiptId + required: true + type: string + salesTransactionNumberQueryRequired: + description: The Sales Transaction Number + in: query + name: transactionId + required: true + type: string + stateCodeQuery: + description: The 2-character State Code + in: query + name: state + required: true + type: string + userKeyQuery: + description: The METRC User Key + in: query + name: user + required: true + type: string +responses: + Unauthorized: + description: "Access unauthorized, invalid API-KEY was used" + schema: + $ref: "#/definitions/Error" + AccessForbidden: + description: "Access forbidden, account lacks access" + schema: + $ref: "#/definitions/Error" + Conflict: + description: Conflict + schema: + $ref: "#/definitions/Error" + InvalidDataError: + description: Invalid data was sent + schema: + $ref: "#/definitions/InvalidError" + ServerError: + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + NotFound: + description: Resource was not found + schema: + $ref: "#/definitions/Error" +tags: + - description: | + METRC functions related to getting Facility information + name: Facilities + - description: | + METRC functions related to Harvests + name: Harvests + - description: | + METRC functions related to Items + name: Items + - description: | + METRC functions related to Packages + name: Packages + - description: | + METRC functions related to Lab Tests + name: Lab Tests + - description: | + METRC functions related to Plants + name: Plants + - description: | + METRC functions related to Plant Batches + name: Plant Batches + - description: | + METRC functions related to Rooms + name: Rooms + - description: | + METRC functions related to Strains + name: Strains + - description: | + METRC functions related to Sales + name: Sales + - description: | + METRC functions related to Transfers + name: Transfers + - description: | + METRC functions related to Units of Measure + name: Units of Measure +paths: + /metrics: + get: + summary: Metrics Scraper Endpoint + operationId: getMetrics + description: + Provides application metrics to Prometheuus logging system + tags: + - Sys + responses: + "200": + description: OK + /facilities: + get: + tags: + - Facilities + operationId: getFacilities + description: | + Facilities for this User + parameters: + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: A list of Facilities was retrieved successfully + schema: + $ref: "#/definitions/FacilityResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Facilities for this User + /harvests: + get: + tags: + - Harvests + operationId: getHarvests + description: | + Get a Harvest for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/onholdStatusQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: A Harvest was successfully retrieved + schema: + $ref: "#/definitions/HarvestResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Harvest for this User-License + put: + tags: + - Harvests + description: Update Harvest Records + operationId: putHarvests + parameters: + - in: body + name: harvestUpdateRequest + description: The Harvest Update records + schema: + $ref: "#/definitions/HarvestUpdateRequest" + responses: + "200": + description: An array of Harvest Update records + schema: + $ref: "#/definitions/HarvestUpdateResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /harvests/wastetypes: + get: + tags: + - Harvests + operationId: getHarvestWasteTypes + description: | + Harvest Waste Types for this User + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of Harvest Waste Types was succefully retrieved + schema: + $ref: "#/definitions/HarvestWasteTypeResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Harvest Waste Types for User + /harvestpackages: + post: + tags: + - Harvests + summary: Create new Harvest Packages + operationId: postHarvestPackages + description: Create new Plants + parameters: + - in: body + name: harvestPackageRequest + description: The New HarvestPackages + schema: + $ref: "#/definitions/HarvestPackageRequest" + responses: + "200": + description: + An array of HarvestPackage records with the new IDs + schema: + $ref: "#/definitions/PlantResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /items: + get: + tags: + - Items + operationId: getItems + description: | + Get one or more Items for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/onholdStatusQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: An item was successfully retrieved + schema: + $ref: "#/definitions/ItemResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Items for this User-License + post: + tags: + - Items + summary: Create new Items + operationId: postItems + description: Create new Items + parameters: + - in: body + name: itemRequest + description: The New Items + schema: + $ref: "#/definitions/ItemRequest" + responses: + "200": + description: An array of Items records with the new IDs + schema: + $ref: "#/definitions/ItemResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Items + summary: Update existing Items + operationId: putItems + description: Update existing Items + parameters: + - in: body + name: itemRequest + description: The Existing Items with Ids + schema: + $ref: "#/definitions/ItemRequest" + responses: + "200": + description: An array of Items records + schema: + $ref: "#/definitions/ItemResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Items + operationId: Delete Item + description: | + Delete a Item for this User-License + parameters: + - $ref: "#/parameters/itemNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Item were successfully Deleted + schema: + $ref: "#/definitions/ItemResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Item for this User-License + /items/brands: + get: + tags: + - Items + operationId: getBrands + description: | + Get Item Brands for this User + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Items Brands for User + /items/productcategories: + get: + tags: + - Items + operationId: getItemProductCategories + description: | + Item Product Categories for this User + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of Item Product Categories was succefully retrieved + schema: + $ref: "#/definitions/ProductCategoryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Item Product Categories for User + /labtests/states: + get: + tags: + - Lab Tests + operationId: getLabtestStates + description: | + Get The Lab Test States + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of Item Product Categories was succefully retrieved + schema: + $ref: "#/definitions/LabTestStateResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Item Product Categories for User + /labtests/types: + get: + tags: + - Lab Tests + operationId: getLabtestTypes + description: | + Get The Lab Test States + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of Item Product Categories was succefully retrieved + schema: + $ref: "#/definitions/LabTestTypeResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Item Product Categories for User + /packages: + get: + tags: + - Packages + operationId: getPackages + description: | + Get a single Item for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/onholdStatusQuery" + - $ref: "#/parameters/packageLabelQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: A list of Packages was retrieved + schema: + $ref: "#/definitions/PackageResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Get Packages + post: + tags: + - Packages + summary: Create new Packages + operationId: postPackages + description: Create new Packages + parameters: + - in: body + name: packageRequest + description: The New Packages + schema: + $ref: "#/definitions/PackageRequest" + responses: + "200": + description: An array of Items records with the new IDs + schema: + $ref: "#/definitions/PackageResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Packages + summary: Update existing Packages + operationId: putPackages + description: Update existing Packages + parameters: + - in: body + name: packageRequest + description: The Existing Items with Ids + schema: + $ref: "#/definitions/PackageRequest" + responses: + "200": + description: An array of Package records + schema: + $ref: "#/definitions/PackageResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /packages/types: + get: + tags: + - Packages + operationId: getPackageTypes + description: | + Get Package Types + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: A list of Package Types was succefully retrieved + schema: + $ref: "#/definitions/PackageTypeResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Package Types + /packages/adjustmentreasons: + get: + tags: + - Packages + operationId: getPackageAdjustmentReasons + description: | + Get Package Types + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: A list of Package Types was succefully retrieved + schema: + $ref: "#/definitions/PackageAdjustmentReasonResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Package Types + /plants: + get: + tags: + - Plants + operationId: getPlants + description: | + Get Plants for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plants were successfully retrieved + schema: + $ref: "#/definitions/PlantResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plants for this User-License + post: + tags: + - Plants + summary: Create new Plants + operationId: postPlants + description: Create new Plants + parameters: + - in: body + name: plantRequest + description: The New Plants + schema: + $ref: "#/definitions/PlantRequest" + responses: + "200": + description: An array of Plants records with the new IDs + schema: + $ref: "#/definitions/PlantResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Plants + summary: Update existing Plants + operationId: putPlants + description: Update existing Plants + parameters: + - in: body + name: plantRequest + description: The Existing Plants with Ids + schema: + $ref: "#/definitions/PlantRequest" + responses: + "200": + description: An array of Plants records + schema: + $ref: "#/definitions/PlantResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Plants + operationId: deletePlant + description: | + Delete a plant for this User-License + parameters: + - $ref: "#/parameters/itemNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plants were successfully Deleted + schema: + $ref: "#/definitions/PlantResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plants for this User-License + /plants/growthphases: + get: + tags: + - Plants + operationId: getPlantGrowthPhases + description: + Get available Plant Growth Phases for this User-License + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plant Growth Phases were successfully retrieved + schema: + $ref: "#/definitions/PlantGrowthPhaseResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plant Growth Phases for this User-License + /plants/wastemethods: + get: + tags: + - Plants + operationId: getPlantWasteMethods + description: + Get available Plant Waste Methods for this User-License + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plant Waste Methods were successfully retrieved + schema: + $ref: "#/definitions/PlantWasteMethodResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plant Waste Methods for this User-License + /plants/wastereasons: + get: + tags: + - Plants + operationId: getPlantWasteReasons + description: + Get available Plant Waste Reasons for this User-License + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plant Waste Reasons were successfully retrieved + schema: + $ref: "#/definitions/PlantWasteReasonResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plant Waste Methods for this User-License + /plantbatches: + get: + tags: + - Plant Batches + operationId: getPlantBatches + description: | + Get Plant Batches for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plant Batches were successfully retrieved + schema: + $ref: "#/definitions/PlantBatchResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plant Batches for this User-License + post: + tags: + - Plant Batches + summary: Create new Plant Batches + operationId: postPlantBatches + description: Create new Plant Batches + parameters: + - in: body + name: plantBatchRequest + description: The New Plant Batches + schema: + $ref: "#/definitions/PlantBatchRequest" + responses: + "200": + description: + An array of Plant Batches records with the new IDs + schema: + $ref: "#/definitions/PlantBatchResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Plant Batches + summary: Update existing Plant Batches + operationId: putPlantBatches + description: Update existing Plant Batches + parameters: + - in: body + name: plantBatchRequest + description: The Existing Plant Batches with Ids + schema: + $ref: "#/definitions/PlantBatchRequest" + responses: + "200": + description: An array of Plant Batches records + schema: + $ref: "#/definitions/PlantBatchResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Plant Batches + operationId: deletePlantBatch + description: | + Delete a plant for this User-License + parameters: + - $ref: "#/parameters/itemNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Plants were successfully Deleted + schema: + $ref: "#/definitions/PlantBatchResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Plants for this User-License + /rooms: + get: + tags: + - Rooms + operationId: getRooms + description: | + Get Rooms for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Rooms were successfully retrieved + schema: + $ref: "#/definitions/RoomResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Rooms for this User-License + post: + tags: + - Rooms + summary: Create new Rooms + operationId: postRooms + description: Create new Rooms + parameters: + - in: body + name: roomRequest + description: The New Rooms + schema: + $ref: "#/definitions/RoomRequest" + responses: + "200": + description: An array of Room records with the new IDs + schema: + $ref: "#/definitions/RoomResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Rooms + summary: Update existing Rooms + operationId: putRooms + description: Update existing Rooms + parameters: + - in: body + name: roomRequest + description: The Existing Rooms with Ids + schema: + $ref: "#/definitions/RoomRequest" + responses: + "200": + description: An array of Room records + schema: + $ref: "#/definitions/RoomResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Rooms + operationId: deleteRoom + description: | + Delete a Room for this User-License + parameters: + - $ref: "#/parameters/roomNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Rooms were successfully deleted + schema: + $ref: "#/definitions/RoomResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Rooms for this User-License + /strains: + get: + tags: + - Strains + operationId: getStrains + description: | + Get Strains for this User-License + parameters: + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/onholdStatusQuery" + - $ref: "#/parameters/packageLabelQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Strains were successfully retrieved + schema: + $ref: "#/definitions/StrainResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Strains for this User-License + post: + tags: + - Strains + summary: Create new Strains + operationId: postStrains + description: Create new Strains + parameters: + - in: body + name: strainRequest + description: The New Strains + schema: + $ref: "#/definitions/StrainRequest" + responses: + "200": + description: An array of Strain records with the new IDs + schema: + $ref: "#/definitions/StrainResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Strains + summary: Update existing Strains + operationId: putStrains + description: Update existing Strains + parameters: + - in: body + name: strainRequest + description: The Existing Strains with Ids + schema: + $ref: "#/definitions/StrainRequest" + responses: + "200": + description: An array of Strain records + schema: + $ref: "#/definitions/StrainResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Strains + operationId: deleteStrain + description: | + Delete a Strain for this User-License + parameters: + - $ref: "#/parameters/itemNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Strains were successfully retrieved + schema: + $ref: "#/definitions/StrainResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Strains for this User-License + /sales/customertypes: + get: + tags: + - Sales + operationId: getCustomerTypes + description: | + Get Customer Types for this User + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of active Customer Types was succefully retrieved + schema: + $ref: "#/definitions/CustomerTypeResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Customer Types for User + /sales/deliveries: + get: + tags: + - Sales + operationId: getSalesDeliveries + description: | + Deliveries for this User-License + parameters: + - $ref: "#/parameters/salesDeliveryNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: A list of Deliveries was succefully retrieved + schema: + $ref: "#/definitions/SalesDeliveryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Deliveries for User-License + post: + tags: + - Sales + summary: Create new Sales Deliveries + operationId: postSalesDeliveries + description: Create new Sales Deliveries + parameters: + - in: body + name: salesDeliveryRequest + description: The New Sales Deliveries + schema: + $ref: "#/definitions/SalesDeliveryRequest" + responses: + "200": + description: + An array of Sales Delivery records with the new IDs + schema: + $ref: "#/definitions/SalesDeliveryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Sales + summary: Create new Sales Deliveries + operationId: putSalesDeliveries + description: Create new Sales Deliveries + parameters: + - in: body + name: salesDeliveryRequest + description: The New Sales Deliveries + schema: + $ref: "#/definitions/SalesDeliveryRequest" + responses: + "200": + description: + An array of Sales Delivery records with the new IDs + schema: + $ref: "#/definitions/SalesDeliveryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Sales + operationId: deleteSalesDelivery + description: | + Delete a Sales Delivery for this User-License + parameters: + - $ref: "#/parameters/salesDeliveryNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Sales Delivery was successfully deleted + schema: + $ref: "#/definitions/SalesDeliveryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Sales Delivery deleted for this User-License + /sales/deliveries/returnreasons: + get: + tags: + - Sales + operationId: getSalesDeliveryReturnReasons + description: | + Delivery Return Reasons for this User-License + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of active Sales Delivery Return Reasons was + succefully retrieved + schema: + $ref: "#/definitions/SalesDeliveryReturnReasonResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Delivery Return Reasons for User-License + /sales/receipts: + get: + tags: + - Sales + operationId: getSalesReceipts + description: | + Sales Receipts for this User-License + parameters: + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/salesReceiptNumberQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of active Sales Receipts was succefully retrieved + schema: + $ref: "#/definitions/SalesReceiptResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Sales Receipts for User-License + post: + tags: + - Sales + summary: Create new Sales Receipts + operationId: postSalesReceipts + description: Create new Sales Receipts + parameters: + - in: body + name: salesReceiptRequest + description: The New Sales Receipts + schema: + $ref: "#/definitions/SalesReceiptRequest" + responses: + "200": + description: + An array of Sales Receipt records with the new IDs + schema: + $ref: "#/definitions/SalesReceiptResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Sales + summary: Create new Sales Receipts + operationId: putSalesReceipts + description: Create new Sales Receipts + parameters: + - in: body + name: salesReceiptRequest + description: The Existing Sales Receipts + schema: + $ref: "#/definitions/SalesReceiptRequest" + responses: + "200": + description: + An array of Sales Receipt records with the existing IDs + schema: + $ref: "#/definitions/SalesReceiptResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + delete: + tags: + - Sales + operationId: deleteSalesReceipts + description: | + Delete a Sales Receipt for this User-License + parameters: + - $ref: "#/parameters/salesReceiptNumberQueryRequired" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Sales Receipt was successfully deleted + schema: + $ref: "#/definitions/SalesReceiptResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Sales Receipts for this User-License + /sales/transactions: + get: + tags: + - Sales + operationId: getSalesTransactions + description: | + Sales Transactions for this User-License + parameters: + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/salesReceiptNumberQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of active Sales Receipts was succefully retrieved + schema: + $ref: "#/definitions/TransactionResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Sales Receipts for User-License + post: + tags: + - Sales + summary: Create new Sales Transactions + operationId: postSalesTransactions + description: Create new Sales Transactions + parameters: + - in: body + name: salesTransactionRequest + description: The New Sales Transactions + schema: + $ref: "#/definitions/TransactionRequest" + responses: + "200": + description: + An array of Sales Transaction records with the new IDs + schema: + $ref: "#/definitions/TransactionResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + put: + tags: + - Sales + summary: Create new Sales Transactions + operationId: putSalesTransactions + description: Create new Sales Transactions + parameters: + - in: body + name: salesTransactionRequest + description: The New Sales Transactions + schema: + $ref: "#/definitions/TransactionRequest" + responses: + "200": + description: + An array of Sales Transaction records with the existing IDs + schema: + $ref: "#/definitions/TransactionResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + /sales/transactiondates: + get: + tags: + - Sales + operationId: getSalesTransactionDates + description: | + Get A list of Sales Transaction Dates for this User-License + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of Sales Transaction Dates was succefully retrieved + schema: + $ref: "#/definitions/SalesTransactionDateResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: A list of Sales Transaction Dates for this User-License + /transfers: + get: + tags: + - Transfers + operationId: getTransfers + description: | + Get Transfers for this User-License + parameters: + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/activeStatusQuery" + - $ref: "#/parameters/salesDeliveryNumberQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/onholdStatusQuery" + - $ref: "#/parameters/packageNumberQuery" + - $ref: "#/parameters/packageLabelQuery" + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: Transfers were successfully retrieved + schema: + $ref: "#/definitions/TransferResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Transfers for this User-License + /unitsofmeasure: + get: + tags: + - Units of Measure + operationId: getUnitsOfMeasure + description: | + Units of Measure + parameters: + - $ref: "#/parameters/resellerKeyQuery" + - $ref: "#/parameters/productionQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + responses: + "200": + description: + A list of Units of Measure was succefully retrieved + schema: + $ref: "#/definitions/UnitsOfMeasureResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "500": + $ref: "#/responses/ServerError" + summary: Units of Measure +definitions: + CustomerType: + properties: + name: + type: string + type: object + CustomerTypeResponse: + properties: + data: + items: + $ref: "#/definitions/CustomerType" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Error: + properties: + error: + type: string + status: + maximum: 600 + minimum: 100 + type: integer + type: object + Facility: + properties: + Alias: + example: OR Larger Rec-WHSLR 1 + type: string + CredentialedDate: + example: "2017-08-13" + type: string + DisplayName: + example: OR Larger Rec-WHSLR 1 + type: string + FacilityType: + properties: + AdvancedSales: + example: false + type: boolean + CanAssignRoomsToPackages: + example: false + type: boolean + CanAssignRoomsToPlantBatches: + example: false + type: boolean + CanCreateDerivedPackages: + example: true + type: boolean + CanCreateOpeningBalancePackages: + example: true + type: boolean + CanCreateProcessValidationPackages: + example: true + type: boolean + CanDeliverSalesToConsumers: + example: false + type: boolean + CanDeliverSalesToPatients: + example: false + type: boolean + CanGrowPlants: + example: false + type: boolean + CanHaveMemberPatients: + example: false + type: boolean + CanInfuseProducts: + example: false + type: boolean + CanPackageVegetativePlants: + example: false + type: boolean + CanRemediatePackagesWithFailedLabResults: + example: false + type: boolean + CanReportHarvestSchedules: + example: false + type: boolean + CanReportPatientsAdverseResponses: + example: false + type: boolean + CanRequestProductRemediation: + example: false + type: boolean + CanRequireHarvestSampleLabTestBatches: + example: false + type: boolean + CanRequirePackageSampleLabTestBatches: + example: false + type: boolean + CanSellToCaregivers: + example: false + type: boolean + CanSellToConsumers: + example: false + type: boolean + CanSellToExternalPatients: + example: false + type: boolean + CanSellToPatients: + example: false + type: boolean + CanSubmitHarvestsForTesting: + example: false + type: boolean + CanSubmitPackagesForTesting: + example: true + type: boolean + CanTagPlantBatches: + example: false + type: boolean + CanTestPackages: + example: false + type: boolean + CanTrackVegetativePlants: + example: true + type: boolean + CanTransferFromExternalFacilities: + example: true + type: boolean + CanUpdatePlantStrains: + example: false + type: boolean + IsMedical: + example: false + type: boolean + IsRetail: + example: true + type: boolean + PackagesRequirePatientAffiliation: + example: false + type: boolean + PlantsRequirePatientAffiliation: + example: false + type: boolean + SalesDeliveryRequirePatientNumber: + example: false + type: boolean + SalesRequireCaregiverNumber: + example: false + type: boolean + SalesRequireCaregiverPatientNumber: + example: false + type: boolean + SalesRequireExternalPatientIdentificationMethod: + example: false + type: boolean + SalesRequireExternalPatientNumber: + example: false + type: boolean + SalesRequirePatientNumber: + example: false + type: boolean + type: object + HireDate: + example: "2017-08-14" + type: string + IsManager: + example: true + type: boolean + IsOwner: + example: true + type: boolean + License: + $ref: "#/definitions/License" + Name: + example: "OR LARGER THAN SALES, LLC" + type: string + Occupations: + example: [] + items: + type: string + type: array + FacilityResponse: + properties: + data: + items: + $ref: "#/definitions/Facility" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Harvest: + properties: + CurrentWeight: + example: 0 + type: number + DryingRoomId: + example: 1 + type: number + DryingRoomName: + example: Harvest Room + type: string + HarvestStartDate: + example: "2014-11-19" + type: string + HarvestType: + example: WholePlant + type: string + Id: + example: 2 + type: number + IsOnHold: + example: false + type: boolean + LastModified: + example: "0001-01-01T00:00:00+00:00" + type: string + Name: + example: 2014-11-19-Harvest Room-H + type: string + PackageCount: + example: 0 + type: number + PlantCount: + example: 70 + type: number + SourceStrainCount: + example: 0 + type: number + TotalPackagedWeight: + example: 0 + type: number + TotalRestoredWeight: + example: 0 + type: number + TotalWasteWeight: + example: 0 + type: number + TotalWetWeight: + example: 40 + type: number + UnitOfWeightName: + example: Ounces + type: string + HarvestPackage: + properties: + ActualDate: + example: "2015-12-15" + type: string + Ingredients: + items: + $ref: "#/definitions/HarvestPackageIngredient" + type: array + IsProductionBatch: + example: false + type: boolean + Item: + example: Buds + type: string + PatientLicenseNumber: + example: X00001 + type: string + ProductRequiresRemediation: + example: false + type: boolean + ProductionBatchNumber: + example: _string_ + type: string + RemediateProduct: + example: false + type: boolean + RemediationDate: + example: "2015-12-15" + type: string + RemediationMethodId: + example: _string_ + type: string + RemediationSteps: + example: _string_ + type: string + Room: + example: _string_ + type: string + Tag: + example: ABCDEF012345670000020201 + type: string + UnitOfWeight: + example: Grams + type: string + type: object + HarvestPackageIngredient: + properties: + HarvestId: + example: 2 + type: number + HarvestName: + example: _string_ + type: string + UnitOfWeight: + example: Grams + type: string + Weight: + example: 100.23 + type: number + type: object + HarvestPackageRequest: + properties: + data: + items: + $ref: "#/definitions/HarvestPackage" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + HarvestResponse: + properties: + data: + items: + $ref: "#/definitions/Harvest" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + HarvestUpdate: + properties: + ActualDate: + example: "2015-12-15" + type: string + Id: + example: 34904 + type: number + UnitOfWeight: + example: Grams + type: string + WasteType: + example: Plant Material + type: string + WasteWeight: + example: 10.05 + type: number + operationId: + example: removeWaste + type: string + type: object + HarvestUpdateRequest: + properties: + data: + items: + $ref: "#/definitions/HarvestUpdate" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + HarvestUpdateResponse: + properties: + data: + items: + $ref: "#/definitions/HarvestUpdate" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + HarvestWasteType: + properties: + Name: + example: Plant Material + type: string + HarvestWasteTypeResponse: + properties: + data: + items: + $ref: "#/definitions/HarvestWasteType" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + InvalidError: + allOf: + - $ref: "#/definitions/Error" + - properties: + details: + items: + type: string + type: array + type: object + Item: + properties: + AdministrationMethod: + example: "" + type: string + ApprovalStatus: + example: Approved + type: string + DefaultLabTestingState: + example: NotSubmitted + type: string + Id: + example: 34904 + type: number + Ingredients: + example: "" + type: string + Name: + example: Ak-47 Shatter 2 + type: string + ProductCategoryName: + example: Extracts (each) + type: string + ProductCategoryType: + example: Concentrate + type: string + QuantityType: + example: CountBased + type: string + ServingSize: + example: "" + type: string + UnitOfMeasureName: + example: Each + type: string + UnitWeight: + example: 50 + type: number + UnitWeightUnitOfMeasureName: + example: Milligrams + type: string + ItemRequest: + properties: + data: + items: + $ref: "#/definitions/Item" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + ItemResponse: + properties: + data: + items: + $ref: "#/definitions/Item" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + LabTestState: + properties: + name: + type: string + type: object + LabTestStateResponse: + properties: + data: + items: + $ref: "#/definitions/LabTestState" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + LabTestType: + properties: + AlwaysPasses: + example: false + type: boolean + DependencyMode: + example: 0 + type: number + Id: + example: 1 + type: number + Name: + example: THC + type: string + RequiresTestResult: + example: false + type: boolean + type: object + LabTestTypeResponse: + properties: + data: + items: + $ref: "#/definitions/LabTestType" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + License: + properties: + EndDate: + example: "2020-09-28" + type: string + LicenseType: + example: Recreational Wholesaler + type: string + Number: + example: 060-X0001 + type: string + StartDate: + example: "2013-01-28" + type: string + required: + - Number + - StartDate + - EndDate + - LicenseType + type: object + Package: + properties: + ArchivedDate: + example: "2014-11-29" + type: string + ContainsRemediatedProduct: + example: false + type: boolean + FinishedDate: + example: "2014-11-29" + type: string + Id: + example: 2 + type: number + InitialLabTestingState: + example: NotSubmitted + type: string + IsOnHold: + example: false + type: boolean + IsProcessValidationTestingSample: + example: false + type: boolean + IsProductionBatch: + example: false + type: boolean + IsTestingSample: + example: false + type: boolean + LabTestingState: + example: NotSubmitted + type: string + LabTestingStateDate: + example: "2014-11-29" + type: string + Label: + example: ABCDEF012345670000010042 + type: string + LastModified: + example: "2019-01-30T02:52:15.0599079+00:00" + type: string + PackageType: + example: Product + type: string + PackagedDate: + example: "2014-11-29" + type: string + PatientLicenseNumber: + example: _string_ + type: string + ProductCategoryName: + example: Buds + type: string + ProductId: + example: 1 + type: number + ProductName: + example: Buds + type: string + ProductRequiresRemediation: + example: false + type: boolean + ProductionBatchNumber: + example: _string_ + type: string + Quantity: + example: 1 + format: double + type: number + ReceivedDateTime: + example: _string_ + type: string + ReceivedFromFacilityLicenseNumber: + example: _string_ + type: string + ReceivedFromFacilityName: + example: _string_ + type: string + ReceivedFromManifestNumber: + example: _string_ + type: string + RemediationDate: + example: "2014-11-29" + type: string + RoomId: + example: _string_ + type: string + RoomName: + example: _string_ + type: string + SourceHarvestNames: + example: _string_ + type: string + UnitOfMeasureAbbreviation: + example: oz + type: string + UnitOfMeasureName: + example: Ounces + type: string + type: object + PackageAdjustmentReason: + properties: + Name: + type: string + RequiresNote: + type: boolean + type: object + PackageAdjustmentReasonResponse: + properties: + data: + items: + $ref: "#/definitions/PackageAdjustmentReason" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + PackageRequest: + properties: + data: + items: + $ref: "#/definitions/Package" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + PackageResponse: + properties: + data: + items: + $ref: "#/definitions/Package" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + PackageType: + properties: + name: + type: string + type: object + PackageTypeResponse: + properties: + data: + items: + $ref: "#/definitions/PackageType" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Pagination: + properties: + next_link: + type: string + p_limit: + description: The Limit for a Request + format: int64 + type: integer + p_offset: + description: The Offset for a Request + format: int64 + type: integer + page_size: + description: The number of records in a Response + format: int64 + type: integer + set_size: + description: + The total number of records available for a Response + format: int64 + type: integer + type: object + Plant: + properties: + GrowthPhase: + type: string + HarvestCount: + type: number + Id: + type: number + IsOnHold: + type: boolean + Label: + type: string + LastModified: + type: string + PlantBatchId: + type: number + PlantBatchName: + type: string + PlantBatchTypeName: + type: string + PlantedDate: + type: string + RoomId: + type: number + RoomName: + type: string + State: + type: string + StrainId: + type: number + StrainName: + type: string + VegetativeDate: + type: string + type: object + PlantBatch: + properties: + Count: + example: 80 + type: number + DestroyedCount: + example: 40 + type: number + HarvestedCount: + example: 0 + type: number + Id: + example: 5 + type: number + LastModified: + example: "0001-01-01T00:00:00+00:00" + type: string + LiveCount: + example: 10 + type: number + Name: + example: Demo Plant Batch 1 + type: string + PackagedCount: + example: 0 + type: number + PatientLicenseNumber: + example: _string_ + type: string + PlantedDate: + example: "2014-10-10" + type: string + RoomId: + example: _string_ + type: string + RoomName: + example: _string_ + type: string + SourcePackageId: + example: 0 + type: number + SourcePackageLabel: + example: _string_ + type: string + SourcePlantId: + example: 0 + type: number + SourcePlantLabel: + example: _string_ + type: string + StrainId: + example: 1 + type: number + StrainName: + example: Spring Hill Kush + type: string + TrackedCount: + example: 10 + type: number + Type: + example: Seed + type: string + UntrackedCount: + example: 80 + type: number + type: object + PlantBatchRequest: + properties: + data: + items: + $ref: "#/definitions/PlantBatch" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + PlantBatchResponse: + properties: + data: + items: + $ref: "#/definitions/PlantBatch" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + PlantGrowthPhase: + properties: + name: + type: string + type: object + PlantGrowthPhaseResponse: + properties: + data: + items: + $ref: "#/definitions/PlantGrowthPhase" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + PlantRequest: + properties: + data: + items: + $ref: "#/definitions/Plant" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + PlantResponse: + properties: + data: + items: + $ref: "#/definitions/Plant" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + PlantWasteMethod: + properties: + name: + type: string + type: object + PlantWasteMethodResponse: + properties: + data: + items: + $ref: "#/definitions/PlantWasteMethod" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + PlantWasteReasonResponse: + properties: + data: + items: + $ref: "#/definitions/PlantWasteMethod" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + ProductCategory: + properties: + CanBeRemediated: + example: true + type: boolean + CanContainSeeds: + example: true + type: boolean + Name: + example: Buds + type: string + ProductCategoryType: + example: Buds + type: string + QuantityType: + example: WeightBased + type: string + RequiresAdministrationMethod: + example: false + type: boolean + RequiresIngredients: + example: false + type: boolean + RequiresItemBrand: + example: false + type: boolean + RequiresProductPhoto: + example: false + type: boolean + RequiresServingSize: + example: false + type: boolean + RequiresStrain: + example: false + type: boolean + RequiresSupplyDurationDays: + example: false + type: boolean + RequiresUnitCbdContent: + example: false + type: boolean + RequiresUnitCbdPercent: + example: false + type: boolean + RequiresUnitThcContent: + example: false + type: boolean + RequiresUnitThcPercent: + example: false + type: boolean + RequiresUnitVolume: + example: false + type: boolean + RequiresUnitWeight: + example: false + type: boolean + type: object + ProductCategoryResponse: + properties: + data: + items: + $ref: "#/definitions/ProductCategory" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + RequestMeta: + properties: + license: + example: A12-0000015-LIC + type: string + operation_id: + description: Operation ID + type: string + production: + type: boolean + reseller: + example: <> + type: string + state: + example: CA + type: string + taxnexus_account: + description: Taxnexus Account Number for recording transactions + example: T0000001 + type: string + test_only: + example: true + type: boolean + transaction_date: + example: "2019-01-01" + type: string + user: + example: <> + type: string + required: + - license + - production + - reseller + - state + - user + type: object + ResponseMeta: + properties: + contact: + description: Microservice Contact Info + type: string + copyright: + description: Copyright Info + type: string + license: + description: License Information and Restrictions + type: string + operationid: + description: Operation ID + type: string + requestip: + description: Request IP Address + type: string + requesttype: + description: Request Type + type: string + requesturl: + description: Request URL + type: string + serverinfo: + description: Data Server Info + type: string + serverresponsetime: + description: Data Server Response Time (ms) + type: string + servertimestamp: + description: Backend Server Timestamp + type: string + taxnexusaccount: + description: + Taxnexus Account Number used for recording transactions + type: string + type: object + Room: + properties: + Id: + type: number + Name: + type: string + type: object + RoomRequest: + properties: + data: + items: + $ref: "#/definitions/Room" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + RoomResponse: + properties: + data: + items: + $ref: "#/definitions/Room" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + SalesDelivery: + properties: + DriverName: + example: John Doe + type: string + DriverOccupationalLicenseNumber: + example: "1" + type: string + DriverVehicleLicenseNumber: + example: "1" + type: string + EstimatedArrivalDateTime: + example: "2017-04-04T13:00:00.000" + type: string + EstimatedDepartureDateTime: + example: "2017-04-04T11:00:00.000" + type: string + Id: + example: 51 + type: number + PhoneNumberForQuestions: + example: +1-123-456-7890 + type: string + PlannedRoute: + example: Drive to destination. + type: string + RecipientAddressCity: + example: Denver + type: string + RecipientAddressPostalCode: + example: "11111" + type: string + RecipientAddressState: + example: CO + type: string + RecipientAddressStreet1: + example: 1 Someplace Road + type: string + RecipientAddressStreet2: + example: Ste 9 + type: string + SalesCustomerType: + example: Consumer + type: string + SalesDateTime: + example: "2017-04-04T10:10:19.000" + type: string + Transactions: + items: + $ref: "#/definitions/Transaction" + type: array + VehicleLicensePlateNumber: + example: "000000" + type: string + VehicleMake: + example: Car + type: string + VehicleModel: + example: Small + type: string + type: object + SalesDeliveryRequest: + properties: + data: + items: + $ref: "#/definitions/SalesDelivery" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + SalesDeliveryResponse: + properties: + data: + items: + $ref: "#/definitions/SalesDelivery" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + SalesDeliveryReturnReason: + properties: + Name: + type: string + RequiresNote: + type: boolean + type: object + SalesDeliveryReturnReasonResponse: + properties: + data: + items: + $ref: "#/definitions/SalesDeliveryReturnReason" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + SalesReceipt: + properties: + ArchivedDate: + example: string + type: string + CaregiverLicenseNumber: + example: "" + type: string + Id: + example: 38304110 + type: number + IdentificationMethod: + example: "" + type: string + IsFinal: + example: false + type: boolean + LastModified: + example: "2019-02-14T23:52:31+00:00" + type: string + PatientLicenseNumber: + example: "" + type: string + ReceiptNumber: + example: 0038304110 + type: string + SalesCustomerType: + example: Consumer + type: string + SalesDateTime: + example: "2019-02-14T15:50:45.000" + type: string + TotalPackages: + example: 3 + type: number + TotalPrice: + example: 60.83 + type: number + Transactions: + items: + $ref: "#/definitions/Transaction" + type: array + type: object + SalesReceiptRequest: + properties: + data: + items: + $ref: "#/definitions/SalesReceipt" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + SalesReceiptResponse: + properties: + data: + items: + $ref: "#/definitions/SalesReceipt" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + SalesTransactionDateResponse: + properties: + data: + items: + $ref: "#/definitions/Room" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Strain: + properties: + Genetics: + example: 100% Sativa + type: string + Id: + example: 2426 + type: number + IndicaPercentage: + example: 0 + type: number + Name: + example: 0 Test + type: string + SativaPercentage: + example: 100 + type: number + TestingStatus: + example: None + type: string + type: object + StrainRequest: + properties: + data: + items: + $ref: "#/definitions/Strain" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + StrainResponse: + properties: + data: + items: + $ref: "#/definitions/Strain" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Transaction: + properties: + ArchivedDate: + example: string + type: string + LastModified: + example: "2019-02-14T23:52:31+00:00" + type: string + PackageId: + example: 4081625 + type: number + PackageLabel: + example: 1A401030001AD55000000426 + type: string + ProductName: + example: Platinum Yeti + type: string + QuantitySold: + example: 4 + type: number + SalesDeliveryState: + example: string + type: string + TotalPrice: + example: 20 + type: number + UnitOfMeasureAbbreviation: + example: g + type: string + UnitOfMeasureName: + example: Grams + type: string + type: object + TransactionRequest: + properties: + data: + items: + $ref: "#/definitions/Transaction" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + TransactionResponse: + properties: + data: + items: + $ref: "#/definitions/Transaction" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Transfer: + properties: + ActualArrivalDateTime: + example: _string_ + type: string + ActualDepartureDateTime: + example: _string_ + type: string + ContainsPlantPackage: + example: false + type: boolean + ContainsProductPackage: + example: false + type: boolean + ContainsProductRequiresRemediation: + example: false + type: boolean + ContainsRemediatedProductPackage: + example: false + type: boolean + ContainsTestingSample: + example: false + type: boolean + CreatedByUserName: + example: _string_ + type: string + CreatedDateTime: + example: "2016-10-10T08:20:45-07:00" + type: string + DeliveryCount: + example: 0 + type: number + DeliveryId: + example: 1 + type: number + DeliveryPackageCount: + example: 7 + type: number + DeliveryReceivedPackageCount: + example: 0 + type: number + DriverName: + example: _string_ + type: string + DriverOccupationalLicenseNumber: + example: _string_ + type: string + DriverVehicleLicenseNumber: + example: _string_ + type: string + EstimatedArrivalDateTime: + example: "2016-10-11T16:50:00.000" + type: string + EstimatedDepartureDateTime: + example: "2016-10-11T14:48:30.000" + type: string + Id: + example: 1 + type: number + LastModified: + example: "0001-01-01T00:00:00+00:00" + type: string + ManifestNumber: + example: "0000000001" + type: string + Name: + example: _string_ + type: string + PackageCount: + example: 7 + type: number + ReceivedDateTime: + example: "2016-10-11T16:42:19-07:00" + type: string + ReceivedDeliveryCount: + example: 0 + type: number + ReceivedPackageCount: + example: 0 + type: number + RecipientFacilityLicenseNumber: + example: 123-ABC + type: string + RecipientFacilityName: + example: Lofty Med-Cultivation A + type: string + ShipmentLicenseType: + example: 0 + type: number + ShipmentTransactionType: + example: Standard + type: string + ShipmentTypeName: + example: Transfer + type: string + ShipperFacilityLicenseNumber: + example: 123-ABC + type: string + ShipperFacilityName: + example: Lofty Med-Cultivation B + type: string + TransporterFacilityLicenseNumber: + example: 123-BCD + type: string + TransporterFacilityName: + example: Lofty Med-Dispensary + type: string + VehicleLicensePlateNumber: + example: _string_ + type: string + VehicleMake: + example: _string_ + type: string + VehicleModel: + example: _string_ + type: string + type: object + TransferResponse: + properties: + data: + items: + $ref: "#/definitions/Transfer" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + UnitsOfMeasure: + properties: + Abbreviation: + example: ea + type: string + Name: + example: Each + type: string + QuantityType: + example: CountBased + type: string + UnitsOfMeasureResponse: + properties: + data: + items: + $ref: "#/definitions/UnitsOfMeasure" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object diff --git a/swagger/pdf-taxnexus.yaml b/swagger/pdf-taxnexus.yaml new file mode 100644 index 0000000..b091d69 --- /dev/null +++ b/swagger/pdf-taxnexus.yaml @@ -0,0 +1,92 @@ +swagger: "2.0" +info: + version: 1.2.7 + title: "pdf" + description: "PDF Delivery" + termsOfService: "http://taxnexus.net/terms/" + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc." +schemes: + - "http" +basePath: "/v1" +host: "pdf.fabric.tnxs.net:8080" +consumes: + - "application/json" +produces: + - "application/json" +responses: + AccessForbidden: + description: "Access forbidden, account lacks access" + schema: + $ref: "#/definitions/Error" + NotFound: + description: Resource was not found + schema: + $ref: "#/definitions/Error" + ServerError: + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + 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" +paths: + /pdfs/{pdfId}: + get: + description: Return a PDF from the datastore + operationId: getPDF + parameters: + - name: pdfId + in: path + description: Taxnexus Record ID + required: true + type: string + produces: + - application/pdf + responses: + "200": + headers: + Content-Disposition: + type: string + description: Specifies download file name + Content-Length: + type: number + format: int32 + description: The size of the file + Content-Location: + type: string + description: The URL of the document + description: A PDF file + schema: + type: file + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Send a PDF in response to an identifier + tags: + - Pdf +definitions: + Error: + properties: + Code: + format: int64 + type: integer + Fields: + type: string + Message: + type: string + type: object diff --git a/swagger/plex-taxnexus.yaml b/swagger/plex-taxnexus.yaml new file mode 100644 index 0000000..345311d --- /dev/null +++ b/swagger/plex-taxnexus.yaml @@ -0,0 +1,766 @@ +swagger: "2.0" +info: + version: 1.2.7 + title: "plex" + description: "System Operations Microservice" + termsOfService: "http://taxnexus.net/terms/" + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc." +securityDefinitions: + ApiKeyAuth: + type: "apiKey" + in: "header" + name: "X-API-Key" +security: + - ApiKeyAuth: [] +schemes: + - "http" +basePath: "/v1" +host: "plex.fabric.tnxs.net:8080" +consumes: + - "application/json" +produces: + - "application/json" +parameters: + accountIdQuery: + description: Taxnexus Record Id of an Account + in: query + name: accountId + required: false + type: string + accountIdQueryRequired: + description: Taxnexus Record Id of an Account + in: query + name: accountId + required: true + type: string + monthQuery: + description: "The Month Number (1,2, ..., 12) of the report" + format: int64 + in: query + name: month + required: false + type: number + quarterQuery: + description: "The Quarter Number (1,2,3,4) of the report" + format: int64 + in: query + name: quarter + required: false + type: number + semiannualQuery: + description: The Semiannual Number (1,2) of the report + format: int64 + in: query + name: semiannual + required: false + type: number + yearQuery: + description: The year of the report + format: int64 + in: query + name: year + required: false + type: number +responses: + AccessForbidden: + description: "Access forbidden, account lacks access" + schema: + $ref: "#/definitions/Error" + NotFound: + description: Resource was not found + schema: + $ref: "#/definitions/Error" + ServerError: + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + TaxSummaryResponse: + description: Taxnexus Response with TaxSummaryResponse Objects + schema: + $ref: "#/definitions/TaxSummaryResponse" + InvoiceSummaryResponse: + description: Taxnexus Response with TaxSummaryResponse Objects + schema: + $ref: "#/definitions/InvoiceSummaryResponse" + InvoiceItemSummaryResponse: + description: Taxnexus Response with TaxSummaryResponse Objects + schema: + $ref: "#/definitions/InvoiceItemSummaryResponse" + TaxReturnResponse: + description: The California CDTFA Sales and Use Tax Return + schema: + $ref: "#/definitions/TaxReturnResponse" + 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" + UseTaxResponse: + description: Taxnexus Response with TaxSummaryResponse Objects + schema: + $ref: "#/definitions/UseTaxResponse" +paths: + /invoices: + get: + description: Return invoice summaries by month for an Account + operationId: getInvoices + parameters: + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + - $ref: "#/parameters/semiannualQuery" + responses: + "200": + $ref: "#/responses/InvoiceSummaryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Return invoice summaries by month + tags: + - Invoice + /invoices/medicinal: + get: + description: Return medicinal revenue summary by period specified + operationId: getMedicinal + parameters: + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + - $ref: "#/parameters/semiannualQuery" + responses: + "200": + $ref: "#/responses/InvoiceSummaryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Return medicinal revenue summary by period specified + tags: + - Invoice + /invoiceitems: + get: + description: Return invoiceitem summaries by month for an Account + operationId: getInvoiceitems + parameters: + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + - $ref: "#/parameters/semiannualQuery" + responses: + "200": + $ref: "#/responses/InvoiceItemSummaryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Return invoice item summaries by month + tags: + - InvoiceItem + /taxes/districts: + get: + description: Return district summary tax reports for an Account + operationId: getDistrictTaxes + parameters: + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + - $ref: "#/parameters/semiannualQuery" + responses: + "200": + $ref: "#/responses/TaxSummaryResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Return summary tax reports for an Account + tags: + - Tax + /taxes/usetax: + get: + description: Return use tax summaries for an Account + operationId: getUseTax + parameters: + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + - $ref: "#/parameters/semiannualQuery" + responses: + "200": + $ref: "#/responses/UseTaxResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: Return use tax summaries for an Account + tags: + - Tax + /taxreturns/salesanduse: + get: + description: Return CDTFA Sales & Use Tax Return + operationId: getSalesAndUseTaxReturn + parameters: + - $ref: "#/parameters/accountIdQuery" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + - $ref: "#/parameters/semiannualQuery" + responses: + "200": + $ref: "#/responses/TaxReturnResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + summary: TaxReturn use tax summaries for an Account + tags: + - Tax +definitions: + AdditionalDeductions: + properties: + Amount: + type: number + Description: + type: string + NonTaxableAmount: + type: number + type: object + DistrictTaxes: + properties: + Adjustments: + type: number + format: double + County: + type: string + District: + type: string + DistrictTaxDue: + type: number + format: double + NetTaxableAmount: + type: number + Rate: + type: number + format: double + TaxableAmount: + type: number + format: double + type: object + Error: + properties: + Code: + format: int64 + type: number + Fields: + type: string + Message: + type: string + type: object + InvoiceItemSummary: + properties: + COGS: + format: double + type: number + PeriodName: + description: The Period Name of the summary line + type: string + PlaceGeocode: + description: Taxnexus Geocode for this group of item summaries + type: string + ShippingHandling: + format: double + type: number + Subtotal: + format: double + type: number + TaxnexusCode: + type: string + type: object + InvoiceItemSummaryResponse: + description: An array of Invoice Item Summary Reporting Objects + properties: + Data: + items: + $ref: "#/definitions/InvoiceItemSummary" + type: array + Meta: + $ref: "#/definitions/ResponseMeta" + type: object + InvoiceSummary: + properties: + Amount: + format: double + type: number + BusinessTax: + format: double + type: number + CannabisTax: + format: double + type: number + EstimatedAmount: + format: double + type: number + EstimatedBusinessTax: + format: double + type: number + EstimatedCOGS: + format: double + type: number + EstimatedCannabisTax: + format: double + type: number + EstimatedDiscount: + format: double + type: number + EstimatedSalesTax: + format: double + type: number + EstimatedSubtotal: + format: double + type: number + PeriodName: + description: The Period Name of the summary line + type: string + PlaceGeocode: + description: Taxnexus Geocode for this group of item summaries + format: string + SalesRegulation: + type: string + SalesTax: + format: double + type: number + Subtotal: + format: double + type: number + type: object + InvoiceSummaryResponse: + description: An array of Invoice Summary Reporting Objects + properties: + Data: + items: + $ref: "#/definitions/InvoiceSummary" + type: array + Meta: + $ref: "#/definitions/ResponseMeta" + type: object + Pagination: + properties: + Limit: + format: int64 + type: integer + Offset: + format: int64 + type: integer + PageSize: + format: int64 + type: integer + SetSize: + format: int64 + type: integer + type: object + RequestMeta: + properties: + TaxnexusAccount: + description: Taxnexus Account Number of the Reseller or OEM + type: string + required: + - TaxnexusAccount + type: object + ResponseMeta: + properties: + Contact: + description: Microservice Contact Info + type: string + Copyright: + description: Copyright Info + type: string + License: + description: License Information and Restrictions + type: string + OperationID: + description: Operation ID + type: string + Pagination: + $ref: "#/definitions/Pagination" + RequestIP: + description: Request IP Address + type: string + RequestType: + description: Request Type + type: string + RequestURL: + description: Request URL + type: string + ServerInfo: + description: Data Server Info + type: string + ServerResponseTime: + description: Data Server Response Time (ms) + type: string + ServerTimestamp: + description: Backend Server Timestamp + type: string + TaxnexusAccount: + description: + Taxnexus Account Number used for recording transactions + type: string + type: object + TaxReturn: + properties: + AdditionalDeductions: + items: + $ref: "#/definitions/AdditionalDeductions" + type: array + AdditionalDeductionsAmount: + format: double + type: number + AssetSales: + type: number + format: double + SummaryReport: + $ref: "#/definitions/TaxReturnPanel" + EstimatedReport: + $ref: "#/definitions/TaxReturnPanel" + CountyReports: + items: + $ref: "#/definitions/TaxReturnPanel" + type: array + DistrictReports: + items: + $ref: "#/definitions/TaxReturnPanel" + type: array + DistrictTaxes: + items: + $ref: "#/definitions/DistrictTaxes" + type: array + ExcessTaxCollected: + type: number + format: double + FixturesAndEquipment: + type: number + format: double + FoodSales: + type: number + format: double + GovSales: + type: number + format: double + Interest: + type: number + format: double + InterstateSales: + type: number + format: double + Name: + type: string + Code: + type: string + Month: + type: number + format: int64 + Year: + type: number + format: int64 + Quarter: + type: number + format: int64 + PeriodHeaders: + type: array + items: + type: string + NetTaxableAmountToBeReported: + type: number + format: double + NonTaxableLabor: + type: number + format: double + Penalty: + type: number + format: double + RemainingTax: + type: number + format: double + ResaleSales: + type: number + format: double + SalesTaxIncluded: + type: number + format: double + TaxDue: + type: number + format: double + TotalSales: + format: double + type: number + TotalSalesAndPurchases: + type: number + format: double + TotalTax: + type: number + format: double + TotalTaxDueBeforeCredits: + type: number + format: double + TotalTaxPrepayments: + type: number + format: double + UseTaxSales: + format: double + type: number + type: object + TaxReturnPanel: + properties: + BusinessTaxes: + items: + type: number + type: array + BusinessTaxesTotal: + format: double + type: number + COGS: + items: + type: number + format: double + type: array + COGSTotal: + type: number + format: double + CannabisRevenue: + items: + type: number + format: double + type: array + CannabisRevenueTotal: + format: double + type: number + ColumnHeaders: + items: + type: string + type: array + CountyName: + type: string + CountySalesTaxRate: + format: double + type: number + DistrictCombinedRate: + format: double + type: number + DistrictSalesTaxRate: + format: double + type: number + DistrictType: + type: string + ExciseTaxes: + items: + format: double + type: number + type: array + ExciseTaxesTotal: + type: number + format: double + Geocode: + type: string + HasDistrictTaxes: + type: boolean + MerchRevenue: + items: + format: double + type: number + type: array + MerchRevenueTotal: + format: double + type: number + PreTaxRevenue: + items: + type: number + format: double + type: array + PreTaxRevenueTotal: + type: number + format: double + SalesTaxBasis: + items: + format: double + type: number + type: array + SalesTaxBasisTotal: + type: number + format: double + SalesTaxTotal: + type: number + format: double + SalesTaxes: + items: + type: number + format: double + type: array + StateSalesTaxRate: + type: number + format: double + TaxExemptRevenue: + items: + type: number + format: double + type: array + TaxExemptRevenueTotal: + format: double + type: number + Title: + type: string + type: object + TaxReturnResponse: + description: An array of Tax Return Objects + properties: + Data: + items: + $ref: "#/definitions/TaxReturn" + type: array + Meta: + $ref: "#/definitions/ResponseMeta" + type: object + TaxSummary: + properties: + Amount: + format: double + type: number + Category: + description: Tax Type Category + type: string + EffectiveRate: + format: double + type: number + Month: + description: Month Number + format: int64 + type: number + PeriodName: + description: The Period Name of the summary line + type: string + PlaceGeocode: + description: The Taxnexus Geocode of the summary line + type: string + Quarter: + description: Quarter Number + format: int64 + type: number + RevenueBase: + format: double + type: number + RevenueNet: + format: double + type: number + RevenueNotTaxable: + format: double + type: number + TaxExemptRevenue: + format: double + type: number + TaxOnTax: + format: double + type: number + TaxRate: + format: double + type: number + TaxTypeID: + description: + Taxnexus ID of the TaxType for which this transaction is made + type: string + TaxTypeName: + description: Tax or Fee Name + type: string + Year: + description: Year Number + format: int64 + type: number + type: object + TaxSummaryResponse: + description: An array of Tax Summary Reporting Objects + properties: + Data: + items: + $ref: "#/definitions/TaxSummary" + type: array + Meta: + $ref: "#/definitions/ResponseMeta" + type: object + UseTax: + properties: + Amount: + format: double + type: number + RevenueBase: + format: double + type: number + RevenueNet: + format: double + type: number + RevenueNotTaxable: + format: double + type: number + TaxExemptRevenue: + format: double + type: number + TaxOnTax: + format: double + type: number + TaxRate: + format: double + type: number + type: object + UseTaxResponse: + description: An array of Use Tax Reporting Objects + properties: + Data: + items: + $ref: "#/definitions/UseTax" + type: array + Meta: + $ref: "#/definitions/ResponseMeta" + type: object diff --git a/swagger/render-taxnexus.yaml b/swagger/render-taxnexus.yaml new file mode 100644 index 0000000..ab4af6c --- /dev/null +++ b/swagger/render-taxnexus.yaml @@ -0,0 +1,470 @@ +swagger: "2.0" +info: + version: 1.2.7 + title: render + description: Print Rendering Microservice + termsOfService: http://taxnexus.net/terms/ + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc." + x-apisguru-categories: + - "compliance" + - "cannabis" + - "tax" + x-origin: + - format: "swagger" + url: "https://docs.taxnexus.net/taxnexus-swagger.json" + version: "2.0" + x-providerName: "taxnexus.net" +securityDefinitions: + ApiKeyAuth: + type: "apiKey" + in: "header" + name: "X-API-Key" +schemes: + - "http" +basePath: "/v1" +host: "render.fabric.tnxs.net:8080" +consumes: + - "application/json" +produces: + - "application/json" +parameters: + X-API-Key: + name: X-API-Key + in: "header" + required: true + type: string + 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 + countyIdRequiredQuery: + description: The County ID + in: query + name: countyId + required: true + type: string + yearQuery: + description: The year of the report + in: query + name: year + required: false + type: number + format: int64 + quarterQuery: + description: The Quarter Number (1,2,3,4) of the report + in: query + name: quarter + required: false + type: number + format: int64 + monthQuery: + description: The Month Number (1,2, ..., 12) of the report + in: query + name: month + required: false + type: number + format: int64 + dateToQuery: + description: The Ending Date for an object retrieval + in: query + name: dateTo + required: false + type: string + invoiceIdQueryRequired: + description: Taxnexus Id of the Invoice to be retrieved + in: query + name: invoiceId + required: true + type: string + ingestIdQueryRequired: + description: Taxnexus Id of the Invoice to be retrieved + in: query + name: ingestId + required: true + type: string +responses: + AccessForbidden: + description: "Access forbidden, account lacks access" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + Conflict: + description: Conflict + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + DocumentResponse: + headers: + Access-Control-Allow-Origin: + type: string + description: Rendered documents response + schema: + $ref: "#/definitions/DocumentResponse" + InvalidDataError: + headers: + Access-Control-Allow-Origin: + type: string + description: Invalid data was sent + schema: + $ref: "#/definitions/InvalidError" + NotFound: + headers: + Access-Control-Allow-Origin: + type: string + description: Resource was not found + schema: + $ref: "#/definitions/Error" + ServerError: + headers: + Access-Control-Allow-Origin: + type: string + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + Unauthorized: + headers: + Access-Control-Allow-Origin: + type: string + description: "Access unauthorized, invalid API-KEY was used" + schema: + $ref: "#/definitions/Error" + UnprocessableEntity: + headers: + Access-Control-Allow-Origin: + type: string + description: "Unprocessable Entity, likely a bad parameter" + schema: + $ref: "#/definitions/Error" + CORSResponse: + description: CORS OPTIONS response + headers: + Access-Control-Allow-Origin: + type: string + Access-Control-Allow-Headers: + type: string + Access-Control-Allow-Methods: + type: string + Access-Control-Expose-Headers: + type: string + Access-Control-Max-Age: + type: string + Access-Control-Allow-Credentials: + type: string + Cache-Control: + type: string +paths: + /accounts: + get: + description: Generate PDF from an Account ID + operationId: getRenderAccount + parameters: + - $ref: "#/parameters/accountIdQueryRequired" + responses: + "200": + $ref: "#/responses/DocumentResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Generate PDF from an Account ID + tags: + - Account + options: + description: CORS support + operationId: accountOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + /counties: + get: + description: Generate a County Report PDF + operationId: getRenderCounty + parameters: + - $ref: "#/parameters/countyIdRequiredQuery" + responses: + "200": + $ref: "#/responses/DocumentResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Generate PDF from a County ID + tags: + - County + options: + description: CORS support + operationId: countyOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + /ingests: + get: + description: Generate PDF from a Ingest ID + operationId: getRenderIngests + parameters: + - $ref: "#/parameters/ingestIdQueryRequired" + responses: + "200": + $ref: "#/responses/DocumentResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Generate PDF from an Ingest ID + tags: + - Ingest + options: + description: CORS support + operationId: ingestOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + /invoices: + get: + description: Generate PDF from an Invoice ID + operationId: getRenderInvoice + parameters: + - $ref: "#/parameters/invoiceIdQueryRequired" + responses: + "200": + $ref: "#/responses/DocumentResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Generate PDF from an Invoice ID + tags: + - Invoice + options: + description: CORS support + operationId: invoiceOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + /reports: + get: + description: + Return a month-by-month summary financial report for an Account + operationId: getRenderReports + parameters: + - $ref: "#/parameters/accountIdQueryRequired" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + responses: + "200": + $ref: "#/responses/DocumentResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Financial Summary by Account + tags: + - Report + options: + description: CORS support + operationId: reportOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + /taxes: + get: + description: Return a summary tax report for an Account + operationId: getRenderTaxes + parameters: + - $ref: "#/parameters/accountIdQueryRequired" + - $ref: "#/parameters/yearQuery" + - $ref: "#/parameters/quarterQuery" + - $ref: "#/parameters/monthQuery" + responses: + "200": + $ref: "#/responses/DocumentResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + security: + - ApiKeyAuth: [] + summary: Tax Summary by Account + tags: + - Tax + options: + description: CORS support + operationId: taxOptions + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors +definitions: + Document: + properties: + Filename: + type: string + ID: + type: string + ParentID: + type: string + SagaType: + type: string + Title: + type: string + URI: + type: string + type: object + DocumentResponse: + description: An array of reendered documents + properties: + Data: + items: + $ref: "#/definitions/Document" + type: array + Meta: + $ref: "#/definitions/ResponseMeta" + type: object + Error: + properties: + Code: + format: int64 + type: integer + Fields: + type: string + Message: + type: string + type: object + InvalidError: + allOf: + - $ref: "#/definitions/Error" + - properties: + details: + items: + type: string + type: array + type: object + Pagination: + properties: + Limit: + format: int64 + type: integer + POffset: + format: int64 + type: integer + PageSize: + format: int64 + type: integer + SetSize: + format: int64 + type: integer + type: object + ResponseMeta: + properties: + Contact: + description: Microservice Contact Info + type: string + Copyright: + description: Copyright Info + type: string + License: + description: License Information and Restrictions + type: string + OperationID: + description: Operation ID + type: string + Pagination: + $ref: "#/definitions/Pagination" + RequestIP: + description: Request IP Address + type: string + RequestType: + description: Request Type + type: string + RequestURL: + description: Request URL + type: string + ServerInfo: + description: Data Server Info + type: string + ServerResponseTime: + description: Data Server Response Time (ms) + type: string + ServerTimestamp: + description: Backend Server Timestamp + type: string + TaxnexusAccount: + description: + Taxnexus Account Number used for recording transactions + type: string + type: object diff --git a/swagger/sf-gate-taxnexus.yaml b/swagger/sf-gate-taxnexus.yaml new file mode 100644 index 0000000..075857f --- /dev/null +++ b/swagger/sf-gate-taxnexus.yaml @@ -0,0 +1,9169 @@ +swagger: "2.0" +info: + title: "sf-gate" + version: 1.2.7 + description: "Salesforce Gateway Microservice" + termsOfService: "http://taxnexus.net/terms/" + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary - Copyright (c) 2018-2020 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 + 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 diff --git a/swagger/vendor-gw-taxnexus.yaml b/swagger/vendor-gw-taxnexus.yaml new file mode 100644 index 0000000..db0ead2 --- /dev/null +++ b/swagger/vendor-gw-taxnexus.yaml @@ -0,0 +1,720 @@ +swagger: "2.0" +host: "vendor-gw.fabric.tnxs.net:8080" +securityDefinitions: + ApiKeyAuth: + type: apiKey + in: header + name: X-API-Key +security: + - ApiKeyAuth: [] +basePath: "/v1" +schemes: + - "http" +info: + version: 1.2.7 + title: "vendor-gw" + contact: + email: "noc@taxnexus.net" + license: + name: "Proprietary" + termsOfService: "https://www.taxnexus.com/terms/" + description: | + # Taxnexus Vendor Gateway +consumes: + - "application/json" +produces: + - "application/json" +parameters: + itemNumberPath: + description: The Item Number + in: path + name: item + required: true + type: string + itemNumberQuery: + description: The Item Number + in: query + name: item + required: false + type: string + lastModifiedEndQuery: + description: The last modified end timestamp + in: query + name: endDate + required: false + type: string + lastModifiedStartQuery: + description: The last modified start timestamp + in: query + name: startDate + required: false + type: string + licenseNumberQuery: + description: The Licnese Number for the query + in: query + name: license + required: false + type: string + limitQuery: + description: "How many objects to return at one time" + format: int64 + in: query + name: limit + required: false + type: integer + nameQuery: + description: The Name of the Object + in: query + name: name + required: false + type: string + offsetQuery: + description: How many objects to skip + format: int64 + in: query + name: offset + required: false + type: integer + partnerKeyQuery: + description: The Partner Key + in: query + name: partner + required: false + type: string + poIdQuery: + description: The ID Purchase Order to be retrieved + in: query + name: poId + required: false + type: string + stateCodeQuery: + description: The 2-character State Code + in: query + name: state + required: true + type: string + taxnexusUserQuery: + description: Taxnexus User Account Number (T0000001) + in: query + name: user + required: true + type: string + userKeyQuery: + description: The Taxnexus User's Key on the Vendor API + in: query + name: user + required: true + type: string + vendorQuery: + description: The name of the Vendor Gateway to be used + enum: + - blaze + - metrc + in: query + name: vendor + required: false + type: string +responses: + AccessForbidden: + description: Access forbidden, account lacks access + schema: + $ref: "#/definitions/Error" + Conflict: + description: Conflict + schema: + $ref: "#/definitions/Error" + InvalidDataError: + description: Invalid data was sent + schema: + $ref: "#/definitions/InvalidError" + InvoiceResponse: + description: An array of Invoice (full) objects + schema: + $ref: "#/definitions/InvoiceResponse" + AccountResponse: + description: An array of AccountBasic objects + schema: + $ref: "#/definitions/AccountResponse" + NotFound: + description: Resource was not found + schema: + $ref: "#/definitions/Error" + PurchaseOrderResponse: + description: An array of Purchase Order objects + schema: + $ref: "#/definitions/PurchaseOrderResponse" + ServerError: + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + 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" +paths: + /accounts: + get: + tags: + - Accounts + operationId: getAccounts + description: + Get the Stores, Accounts or other entities that correspond to + locations + parameters: + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/partnerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + - $ref: "#/parameters/vendorQuery" + 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 Accounts for this User + /invoices: + get: + summary: Get a list of Invoices + operationId: getInvoices + description: Return a list of available Taxnexus Invoices + tags: + - Invoices + parameters: + - $ref: "#/parameters/itemNumberQuery" + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/limitQuery" + - $ref: "#/parameters/offsetQuery" + - $ref: "#/parameters/partnerKeyQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + - $ref: "#/parameters/vendorQuery" + responses: + "200": + description: + A list of Invoices for this User was retrieved successfully + schema: + $ref: "#/definitions/InvoiceResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + /pos: + get: + summary: Get a list of Purchase Orders + operationId: getPos + description: Return a list of available Purchase Orders + tags: + - PurchaseOrders + parameters: + - $ref: "#/parameters/lastModifiedEndQuery" + - $ref: "#/parameters/lastModifiedStartQuery" + - $ref: "#/parameters/licenseNumberQuery" + - $ref: "#/parameters/limitQuery" + - $ref: "#/parameters/offsetQuery" + - $ref: "#/parameters/partnerKeyQuery" + - $ref: "#/parameters/poIdQuery" + - $ref: "#/parameters/stateCodeQuery" + - $ref: "#/parameters/userKeyQuery" + - $ref: "#/parameters/vendorQuery" + 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" +definitions: + AccountBasic: + properties: + AccountNumber: + description: Account Number + type: string + BillingAddress: + $ref: "#/definitions/Address" + BillingContact: + $ref: "#/definitions/ContactBasic" + ID: + description: Taxnexus Record Id Only; not used in POST + type: string + License: + $ref: "#/definitions/LicenseBasic" + Name: + description: Account Name + type: string + ParentFK: + description: + UUID Reference the master record that owns this item + type: string + Phone: + description: Phone number + type: string + Ref: + description: "Source System identifier for this record, if any" + type: string + ShippingAddress: + $ref: "#/definitions/Address" + ShippingContact: + $ref: "#/definitions/ContactBasic" + Type: + description: Account Type + type: string + UUID: + description: Unique Taxnexus ID + type: string + Website: + description: Account Website + type: string + type: object + AccountResponse: + properties: + data: + items: + $ref: "#/definitions/AccountBasic" + 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 + type: object + ContactBasic: + properties: + AccountID: + description: Contact Account Id + type: string + Email: + description: Email + type: string + ID: + description: Taxnexus Record Id Only; not used in POST + type: string + MailingAddress: + $ref: "#/definitions/Address" + MobilePhone: + description: Mobile + type: string + Name: + description: Name + 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 + UUID: + description: Unique Taxnexus ID + type: string + type: object + Error: + properties: + error: + type: string + status: + maximum: 600 + minimum: 100 + type: integer + type: object + InvalidError: + allOf: + - $ref: "#/definitions/Error" + - properties: + details: + items: + type: string + type: array + type: object + InvoiceBasic: + properties: + AccountID: + description: + Account Identifier from Source System; copied to the Tax + Transaction result records + type: string + AccountName: + description: + Account Name from source system (not used 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 + BusinessAddress: + $ref: "#/definitions/Address" + CustomerID: + description: + The Customer ID linked to this invoice from the source system + type: string + EstimatedAmount: + description: Invoice Total from source system + format: double + type: number + EstimatedCannabisTax: + description: Cannabis Tax from source system + format: double + type: number + EstimatedCOGS: + description: Cost of Goods Sold from source system + type: number + format: double + EstimatedDiscount: + description: + An amount the Invoice is discounted in source Invoice + format: double + type: number + EstimatedBusinessTax: + description: Business Tax from source system + format: double + type: number + EstimatedSalesTax: + description: Sales Tax from source system + format: double + type: number + EstimatedSubtotal: + description: Subtotal from source system + format: double + type: number + JobID: + description: Taxnexus Job ID + type: string + 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 to a master record that owns this item + type: string + Ref: + description: + Source System identifier for this record, if any; copied to + invoiceid in Tax Transaction result records + type: string + SalesRegulation: + description: + Sales Regulation Type; must be one of the listed values + type: string + ShippingHandling: + description: + The total amount of shipping and delivery charges on this + invoice from the source system + format: double + type: number + Status: + description: + Status used by for Billing Balances; ignored in tax + calculation + type: string + Subtotal: + description: Subtotal (not used in tax calculation) + format: double + type: number + Type: + description: Invoice Type (not used in tax calculation) + type: string + UUID: + description: Unique Taxnexus Id assigned during ingest + type: string + type: object + InvoiceResponse: + properties: + data: + items: + $ref: "#/definitions/InvoiceBasic" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + ItemBasic: + properties: + COGS: + description: Cost of Goods Sold for this Item + example: 0 + type: number + Description: + description: Line Item Description (not used in tax calculation) + example: string + type: string + ID: + description: Taxnexus Record Id Only; not used in POST + example: string + type: string + InvoiceID: + description: Source System Parent Foreign Key to Invoice + example: string + type: string + ListPrice: + description: The pre-discount price of the item + example: 0 + type: number + MRCInterval: + description: The pre-discount price of the item + example: 0 + format: int64 + type: number + ParentFK: + description: + UUID Reference the master record that owns this item + example: string + type: string + ProductCode: + description: Product Code (not used in tax calculation) + example: string + type: string + Quantity: + description: Quantity + example: 0 + type: number + Ref: + description: + "Source System identifier for this record, if any; copied to + invoiceitemid in Tax Transaction result records" + example: string + type: string + SalesRegulation: + description: Sales Regulation Type + example: string + type: string + ShippingHandling: + description: Shipping & Handling and Delivery Fees for this Item + example: 0 + type: number + Subtotal: + description: Subtotal (not used in tax calculation) + example: 0 + type: number + TaxnexusCode: + description: Taxnexus Code + example: string + type: string + UnitPrice: + description: Unit Price + example: 0 + type: number + Units: + description: The Unit of Measure for this item + type: string + UUID: + description: Unique Taxnexus ID + example: string + type: string + type: object + LicenseBasic: + properties: + DateIssued: + description: Date Issued + type: string + ExpirationDate: + description: Expiration Date + type: string + ID: + description: Taxnexus Record Id + type: string + IsCanceled: + description: Is Canceled? + type: boolean + IsRevoked: + description: Is Revoked? + type: boolean + LicenseType: + description: License State and Type + type: string + Name: + description: License Number + 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 + Status: + description: License Status + type: string + UUID: + description: Unique Taxnexus ID + type: string + type: object + Pagination: + properties: + next_link: + type: string + p_limit: + format: int64 + type: integer + p_offset: + format: int64 + type: integer + page_size: + format: int64 + type: integer + set_size: + format: int64 + type: integer + type: object + PurchaseOrderBasic: + properties: + AccountID: + description: Account ID + type: string + Amount: + description: Purchase Order Amount + format: float64 + type: number + AmountDue: + description: Amount Due + type: number + BusinessAddress: + $ref: "#/definitions/Address" + ID: + description: Order Id + type: string + Items: + items: + $ref: "#/definitions/ItemBasic" + type: array + ParentFK: + description: + UUID Reference the master record that owns this item + type: string + PODate: + description: Purcahse Order Date + type: string + PONumber: + description: Purchase Order Number + type: string + Ref: + description: Source System identifier for this record, if any + type: string + SalesRegulation: + description: Sales Regulation Type + type: string + Status: + description: Status + type: string + Subtotal: + description: Subtotal + format: float64 + type: number + Type: + description: Type + type: string + UUID: + description: Unique Taxnexus ID + type: string + type: object + PurchaseOrderResponse: + properties: + data: + items: + $ref: "#/definitions/PurchaseOrderBasic" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + ResponseMeta: + properties: + Contact: + description: Microservice Contact Info + type: string + Copyright: + description: Copyright Info + type: string + License: + description: License Information and Restrictions + type: string + OperationID: + description: Operation ID + type: string + Pagination: + $ref: "#/definitions/Pagination" + RequestIP: + description: Request IP Address + type: string + RequestType: + description: Request Type + type: string + RequestURL: + description: Request URL + type: string + ServerInfo: + description: Data Server Info + type: string + ServerResponseTime: + description: Data Server Response Time (ms) + type: string + ServerTimeStamp: + description: Backend Server Timestamp + type: string + TaxnexusAccount: + description: + Taxnexus Account Number used for recording transactions + type: string + type: object