lib/swagger/ops-taxnexus.yaml

swagger: "2.0"
info:
  version: 1.3.0
  title: "ops"
  description: "Taxnexus Finance Microservice"
  termsOfService: "http://taxnexus.net/terms/"
  contact:
    email: "noc@taxnexus.net"
  license:
    name: "Proprietary - Copyright (c) 2018-2021 by Taxnexus, Inc."
schemes:
  - "http"
basePath: "/v1"
host: "ops.fabric.tnxs.net:8080"
securityDefinitions:
  ApiKeyAuth:
    type: apiKey
    in: header
    name: X-API-Key
consumes:
  - "application/json"
produces:
  - "application/json"
parameters:
  X-API-Key:
    name: X-API-Key
    in: "header"
    required: true
    type: string
  activeQuery:
    description: Retrieve active records?
    in: query
    name: active
    required: false
    type: boolean
  accountIdQuery:
    description: Taxnexus Record Id of an Account
    in: query
    name: accountId
    required: false
    type: string
  paymentMethodIdQuery:
    description: Taxnexus Record Id of a PaymentMethod
    in: query
    name: paymentMethodId
    required: false
    type: string
  accountIdQueryRequired:
    description: Taxnexus Record Id of an Account
    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
  cashreceiptIdQuery:
    description: Taxnexus Record Id of a Cash Receipt
    in: query
    name: cashReceiptId
    required: false
    type: string
  chargeIdQuery:
    description: Taxnexus Record Id of a Charge
    in: query
    name: chargeId
    required: false
    type: string
  eftIdQuery:
    description: Taxnexus Record Id of a EFT
    in: query
    name: eftId
    required: false
    type: string
  companyIdQuery:
    description: Taxnexus Record Id of a Company
    in: query
    name: companyId
    required: false
    type: string
  purchaseOrderIdQuery:
    description: Taxnexus Record Id of a Company
    in: query
    name: purchaseOrderId
    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
  idQueryRequired:
    description: Taxnexus Id of the record to be retrieved
    in: query
    name: id
    required: false
    type: string
  invoiceIdQuery:
    description: Taxnexus Record Id of an Invoice
    in: query
    name: invoiceId
    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 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 Record Id of an Order
    in: query
    name: orderId
    required: false
    type: string
  orderRequest:
    description: A request with an array of Order Objects
    in: body
    name: orderRequest
    required: true
    schema:
      $ref: "#/definitions/OrderRequest"
  invoiceRequest:
    description: A request with an array of Invoice Objects
    in: body
    name: invoiceRequest
    required: true
    schema:
      $ref: "#/definitions/InvoiceRequest"
  cashReceiptRequest:
    description: A request with an array of Cash Receipot Objects
    in: body
    name: cashReceiptRequest
    required: true
    schema:
      $ref: "#/definitions/CashReceiptRequest"
  chargeRequest:
    description: A request with an array of Charge Objects
    in: body
    name: chargeRequest
    required: true
    schema:
      $ref: "#/definitions/ChargeRequest"
  eftRequest:
    description: A request with an array of EFT Objects
    in: body
    name: eftRequest
    required: true
    schema:
      $ref: "#/definitions/EftRequest"
  productIdQuery:
    description: Taxnexus Record Id of a Product
    in: query
    name: productId
    required: false
    type: string
  productCodeQuery:
    description: Product Code of a Product
    in: query
    name: productCode
    required: false
    type: string
  publishQuery:
    description: Is this product published?
    in: query
    name: publish
    required: false
    type: boolean
  productRequest:
    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: id
    required: false
    type: string
  purchaseOrderRequest:
    description: A request with an array of Purchase Order Objects
    in: body
    name: purchaseOrderRequest
    required: true
    schema:
      $ref: "#/definitions/PurchaseOrderRequest"
  paymentMethodRequest:
    description: A request with an array of Purchase Order Objects
    in: body
    name: paymentMethodRequest
    required: true
    schema:
      $ref: "#/definitions/PaymentMethodRequest"
  quoteIdQuery:
    description: Taxnexus Record Id of a Quote
    in: query
    name: quoteId
    required: false
    type: string
  quoteRequest:
    description: A request with an array of Quote Objects
    in: body
    name: quoteRequest
    required: true
    schema:
      $ref: "#/definitions/QuoteRequest"
  subscriptionIdQuery:
    description: Taxnexus Id of the Subscription to be retrieved
    in: query
    name: subscriptionId
    required: false
    type: string
  subscriptionRequest:
    description: A request with an array of Subscription Objects
    in: body
    name: subscriptionRequest
    required: true
    schema:
      $ref: "#/definitions/SubscriptionRequest"
responses:
  AccessForbidden:
    description: "Access forbidden, account lacks access"
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/Error"
  CashReceiptResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with Cash Receipt objects
    schema:
      $ref: "#/definitions/CashReceiptResponse"
  ChargeResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with Charge objects
    schema:
      $ref: "#/definitions/ChargeResponse"
  EftResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with EFT objects
    schema:
      $ref: "#/definitions/EftResponse"
  Conflict:
    description: Conflict
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/Error"
  DeleteResponse:
    description:
      Taxnexus Response with Message Objects with Delete Status
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/DeleteResponse"
  InvalidDataError:
    description: Invalid data was sent
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/InvalidError"
  InvoiceResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description:
      Taxnexus Response with an array of Invoice (full) objects
    schema:
      $ref: "#/definitions/InvoiceResponse"
  NotFound:
    description: Resource was not found
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/Error"
  OrderResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with an array of Order objects
    schema:
      $ref: "#/definitions/OrderResponse"
  ProductResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with an array of Product objects
    schema:
      $ref: "#/definitions/ProductResponse"
  ProductObservableResponse:
    description: Simple array of products
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    schema:
      items:
        $ref: "#/definitions/Product"
      type: array
  PaymentMethodResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description:
      Taxnexus Response with an array of Payment Method objects
    schema:
      $ref: "#/definitions/PaymentMethodResponse"
  PurchaseOrderResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description:
      Taxnexus Response with an array of Purchase Order objects
    schema:
      $ref: "#/definitions/PurchaseOrderResponse"
  PutResponse:
    description:
      Taxnexus Response with an array of Message objects in response to
      a PUT
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/PutResponse"
  QuoteResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with an array of Quote objects
    schema:
      $ref: "#/definitions/QuoteResponse"
  ServerError:
    description: Server Internal Error
    headers:
      Access-Control-Allow-Origin:
        type: string
    schema:
      $ref: "#/definitions/Error"
  SubscriptionResponse:
    description: Taxnexus Response with an array of Subscription Objects
    schema:
      $ref: "#/definitions/SubscriptionResponse"
  TaxTransactionResponse:
    headers:
      Access-Control-Allow-Origin:
        type: string
      Cache-Control:
        type: string
    description: Taxnexus Response with Tax Transaction Objects
    schema:
      $ref: "#/definitions/TaxTransactionResponse"
  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"
  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:
  /cashreceipts:
    delete:
      description: Delete cash receipt by ID
      operationId: deleteCashReceipt
      parameters:
        - $ref: "#/parameters/idQueryRequired"
      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 cash receipt
      tags:
        - CashReceipt
    get:
      description: Return a list of available Taxnexus Cash Receipts
      operationId: getCashReceipts
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/cashreceiptIdQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Get a list of Cash Receipts
      tags:
        - CashReceipt
    options:
      description: CORS support
      operationId: cashReceiptOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New Cash Receipts
      operationId: postCashReceipts
      parameters:
        - $ref: "#/parameters/cashReceiptRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Create new Cash Receipts
      tags:
        - CashReceipt
    put:
      consumes:
        - application/json
      description: Put a list of Cash Receipts
      operationId: putCashReceipts
      parameters:
        - $ref: "#/parameters/cashReceiptRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Put a list of Cash Receipts
      tags:
        - CashReceipt
  /charges:
    delete:
      description: Delete a Charge by ID
      operationId: deleteCharge
      parameters:
        - $ref: "#/parameters/idQueryRequired"
      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 Charge
      tags:
        - Charge
    get:
      description: Return a list of available Taxnexus Charges
      operationId: getCharges
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/chargeIdQuery"
      responses:
        "200":
          $ref: "#/responses/ChargeResponse"
        "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 Charges
      tags:
        - Charge
    options:
      description: CORS support
      operationId: chargeOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New Charges
      operationId: postCharges
      parameters:
        - $ref: "#/parameters/chargeRequest"
      responses:
        "200":
          $ref: "#/responses/ChargeResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Create new Charges
      tags:
        - Charge
    put:
      consumes:
        - application/json
      description: Put a list of Charges
      operationId: putCharges
      parameters:
        - $ref: "#/parameters/chargeRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Put a list of Charges
      tags:
        - Charge
  /efts:
    get:
      description: Return a list of available Taxnexus Efts
      operationId: getEfts
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/eftIdQuery"
      responses:
        "200":
          $ref: "#/responses/EftResponse"
        "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 Efts
      tags:
        - Eft
    options:
      description: CORS support
      operationId: eftOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New Efts
      operationId: postEfts
      parameters:
        - $ref: "#/parameters/eftRequest"
      responses:
        "200":
          $ref: "#/responses/EftResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Create new Efts
      tags:
        - Eft
    put:
      consumes:
        - application/json
      description: Put a list of Efts
      operationId: putEfts
      parameters:
        - $ref: "#/parameters/eftRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Put a list of Efts
      tags:
        - Eft
  /invoices:
    delete:
      description: Delete an invoice by ID
      operationId: deleteInvoice
      parameters:
        - $ref: "#/parameters/idQueryRequired"
      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 invoice
      tags:
        - Invoice
    get:
      description: Return a list of available Taxnexus Invoices
      operationId: getInvoices
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/invoiceIdQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Get a list of Invoices
      tags:
        - Invoice
    options:
      description: CORS support
      operationId: invoiceOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New Invoices
      operationId: postInvoices
      parameters:
        - $ref: "#/parameters/invoiceRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Create a new Invoice
      tags:
        - Invoice
    put:
      consumes:
        - application/json
      description: Put a list of Invoices
      operationId: putInvoices
      parameters:
        - $ref: "#/parameters/invoiceRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Put a list of Invoices
      tags:
        - Invoice
  /orders:
    delete:
      description: Delete an order by ID
      operationId: deleteOrder
      parameters:
        - $ref: "#/parameters/idQueryRequired"
      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 Order
      tags:
        - Order
    get:
      description: Return a list of Orders
      operationId: getOrders
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/orderIdQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Get a list of Orders
      tags:
        - Order
    options:
      description: CORS support
      operationId: ordersOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create new Orders
      operationId: postOrders
      parameters:
        - $ref: "#/parameters/orderRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Create new Orders
      tags:
        - Order
    put:
      consumes:
        - application/json
      description: Update orders
      operationId: putOrders
      parameters:
        - $ref: "#/parameters/orderRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Update Orders
      tags:
        - Order
  /paymentmethods:
    delete:
      description: Delete a PaymentMethod by ID
      operationId: deletePaymentMethod
      parameters:
        - $ref: "#/parameters/paymentMethodIdQuery"
      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 PaymentMethod
      tags:
        - PaymentMethod
    get:
      description: Return a list of available Taxnexus PaymentMethods
      operationId: getPaymentMethods
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/paymentMethodIdQuery"
      responses:
        "200":
          $ref: "#/responses/PaymentMethodResponse"
        "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 PaymentMethods
      tags:
        - PaymentMethod
    options:
      description: CORS support
      operationId: paymentMethodOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New PaymentMethods
      operationId: postPaymentMethods
      parameters:
        - $ref: "#/parameters/paymentMethodRequest"
      responses:
        "200":
          $ref: "#/responses/PaymentMethodResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Create new PaymentMethods
      tags:
        - PaymentMethod
    put:
      consumes:
        - application/json
      description: Put a list of PaymentMethods
      operationId: putPaymentMethods
      parameters:
        - $ref: "#/parameters/paymentMethodRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Put a list of PaymentMethods
      tags:
        - PaymentMethod
  /pos:
    delete:
      description: Delete a PO by ID
      operationId: deletePurchaseOrder
      parameters:
        - $ref: "#/parameters/idQueryRequired"
      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 PO
      tags:
        - PurchaseOrder
    get:
      description: Return a list of available Purchase Orders
      operationId: getPurchaseOrders
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/purchaseOrderIdQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Get a list of Purchase Orders
      tags:
        - PurchaseOrder
    options:
      description: CORS support
      operationId: poOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New Purchase Order
      operationId: postPurchaseOrders
      parameters:
        - $ref: "#/parameters/purchaseOrderRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Create a new Purchase Order
      tags:
        - PurchaseOrder
    put:
      consumes:
        - application/json
      description: Upsert a list of Purchase Order
      operationId: putPurchaseOrders
      parameters:
        - $ref: "#/parameters/purchaseOrderRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Upsert a list of Purchase Order
      tags:
        - PurchaseOrder
  /products:
    delete:
      description: Delete Taxnexus Product record
      operationId: deleteProduct
      parameters:
        - $ref: "#/parameters/productIdQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Delete a Product
      tags:
        - Product
    get:
      description: Return a list of all available Products
      operationId: getProducts
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/activeQuery"
        - $ref: "#/parameters/productIdQuery"
        - $ref: "#/parameters/productCodeQuery"
        - $ref: "#/parameters/publishQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Get a list of Products
      tags:
        - Product
    options:
      description: CORS support
      operationId: productOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      description: Product records to be added
      operationId: postProducts
      parameters:
        - $ref: "#/parameters/productRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Add new Products
      tags:
        - Product
    put:
      description: Update Product records
      operationId: putProducts
      parameters:
        - $ref: "#/parameters/productRequest"
      responses:
        "200":
          $ref: "#/responses/PutResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Update Products
      tags:
        - Product
  /products/observable:
    get:
      description: Return a simplified list of all available Products
      operationId: getProductsObservable
      parameters:
        - $ref: "#/parameters/activeQuery"
        - $ref: "#/parameters/productIdQuery"
        - $ref: "#/parameters/productCodeQuery"
        - $ref: "#/parameters/publishQuery"
      responses:
        "200":
          $ref: "#/responses/ProductObservableResponse"
        "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 Products
      tags:
        - Product
    options:
      description: CORS support
      operationId: productOptionsObservable
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
  /quotes:
    delete:
      description: Delete quote by ID
      operationId: deleteQuote
      parameters:
        - $ref: "#/parameters/idQueryRequired"
      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 quote
      tags:
        - Quote
    get:
      description: Return a list of available quotes
      operationId: getQuotes
      parameters:
        - $ref: "#/parameters/limitQuery"
        - $ref: "#/parameters/offsetQuery"
        - $ref: "#/parameters/quoteIdQuery"
      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"
      security:
        - ApiKeyAuth: []
      summary: Get a list of Quotes
      tags:
        - Quote
    options:
      description: CORS support
      operationId: quoteOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      consumes:
        - application/json
      description: Create New Quotes
      operationId: postQuotes
      parameters:
        - $ref: "#/parameters/quoteRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Create a new Quotes
      tags:
        - Quote
    put:
      consumes:
        - application/json
      description: Put a list of Quotes
      operationId: putQuotes
      parameters:
        - $ref: "#/parameters/quoteRequest"
      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"
      security:
        - ApiKeyAuth: []
      summary: Put a list of Quotes
      tags:
        - Quote
  /taxes/invoices:
    options:
      description: CORS support
      operationId: taxInvoiceOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      description: Rate a list of invoices
      operationId: postTaxesInvoices
      parameters:
        - $ref: "#/parameters/invoiceRequest"
      responses:
        "200":
          $ref: "#/responses/TaxTransactionResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Rate a list of invoices
      tags:
        - Tax
  /taxes/orders:
    options:
      description: CORS support
      operationId: taxOrderOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      description: Rate a list of invoices
      operationId: postTaxesOrders
      parameters:
        - $ref: "#/parameters/orderRequest"
      responses:
        "200":
          $ref: "#/responses/TaxTransactionResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Rate a list of orders
      tags:
        - Tax
  /taxes/pos:
    options:
      description: CORS support
      operationId: taxPoOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      description: Rate a list of purchase orders
      operationId: postTaxesPos
      parameters:
        - $ref: "#/parameters/purchaseOrderRequest"
      responses:
        "200":
          $ref: "#/responses/TaxTransactionResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Rate a list of purchase orders
      tags:
        - Tax
  /taxes/quotes:
    options:
      description: CORS support
      operationId: taxQuoteOptions
      responses:
        "200":
          $ref: "#/responses/CORSResponse"
      tags:
        - cors
    post:
      description: Rate a list of quotes
      operationId: postTaxesQuotes
      parameters:
        - $ref: "#/parameters/quoteRequest"
      responses:
        "200":
          $ref: "#/responses/TaxTransactionResponse"
        "401":
          $ref: "#/responses/Unauthorized"
        "403":
          $ref: "#/responses/AccessForbidden"
        "404":
          $ref: "#/responses/NotFound"
        "422":
          $ref: "#/responses/UnprocessableEntity"
        "500":
          $ref: "#/responses/ServerError"
      security:
        - ApiKeyAuth: []
      summary: Rate a list of quotes
      tags:
        - Tax
definitions:
  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
  CashReceipt:
    properties:
      ID:
        description: Taxnexus Record Id
        type: string
      AccountID:
        description: Account Name
        type: string
      Amount:
        description: Amount
        type: number
      AppliedAmount:
        description: Applied Amount
        type: number
      BillingContactID:
        description: Billing Contact
        type: string
      BillingRunID:
        description:
          The ID of the Billing Run that generated this Cash Receipt
        type: string
      CashReceiptDate:
        description: Journal Date
        type: string
      CashReceiptNumber:
        description: Journal Date
        type: string
      CustomerID:
        description: Account CustomerID, if any
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created 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
      GatewayTransaction:
        description: GatewayTxn?
        type: boolean
      InvoiceID:
        description: Invoice paid by this cash receipt
        type: string
      IsValid:
        description: Is Valid?
        type: boolean
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      PartnerAccountID:
        description: Partner Account
        type: string
      PaymentMethodID:
        description: ID of the Payment Method used for this Cash Receipt
        type: string
      PeriodID:
        description: Period
        type: string
      Posted:
        description: Posted to external system?
        type: boolean
      RecordType:
        description: Record Type
        type: string
      Ref:
        description: Reference
        type: string
      Rejected:
        description: Rejected?
        type: boolean
      Source:
        description: Source Payment Method
        type: string
      Status:
        description: Payment Status
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TemplateID:
        description:
          ID of the Template to be used for rendering this cashreceipt
        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
    type: object
  CashReceiptResponse:
    description: An array of Account objects with Contacts
    properties:
      Data:
        items:
          $ref: "#/definitions/CashReceipt"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  Charge:
    properties:
      ID:
        description: Taxnexus Record Id
        type: string
      AccountID:
        description: Account
        type: string
      AccountingRulesetCode:
        description: The Accounting Ruleset Code
        type: string
      Amount:
        description: Amount
        type: number
      BillingContactID:
        description: Billing Contact ID
        type: string
      BillingEmail:
        description: The Email Address to send this charge notification
        type: string
      BillingRunID:
        description: The ID of the BillingRun that generated this Charge
        type: string
      ContractHourlyRate:
        description: The Contract Hourly Rate
        format: double
        type: number
      ContractID:
        description: Contract
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      Description:
        description: Description
        type: string
      EmailMessage:
        description: Email Message
        type: string
      JournalDate:
        description: Journal Date
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      PartnerAccountID:
        description: Partner Account
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      PeriodID:
        description: Period
        type: string
      Posted:
        description: Posted to external system?
        type: boolean
      ProductID:
        description: Product
        type: string
      Quantity:
        description: Quantity
        type: number
        format: double
      Ref:
        description: "external reference, if any"
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TemplateID:
        description: The ID of the Template used to render this object
        type: string
      Type:
        description: Charge Type
        type: string
      UnitPrice:
        description: Unit Price
        type: number
        format: double
    type: object
  ChargeRequest:
    properties:
      Data:
        items:
          $ref: "#/definitions/Charge"
        type: array
    type: object
  ChargeResponse:
    description: An array of ChargeObject objects
    properties:
      Data:
        items:
          $ref: "#/definitions/Charge"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  Contract:
    properties:
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        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
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      Name:
        description: Contract Name
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      PriceBookID:
        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
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Type:
        description: Contract Type
        type: string
    type: object
  CreditCard:
    properties:
      Active:
        description: Active
        type: boolean
      BillingCity:
        description: Billing City
        type: string
      BillingPostalcode:
        description: Billing Postal Code
        type: string
      BillingState:
        description: Billing State
        type: string
      BillingStreet:
        description: Billing Street
        type: string
      CCType:
        description: CC Type
        type: string
      CcNumber:
        description: CC Number
        type: string
      CompanyID:
        description: Company
        type: string
      ExpMonth:
        description: Exp Month
        type: string
      ExpYear:
        description: Exp Year
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      Name:
        description: CC Name
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
    type: object
  DeleteResponse:
    properties:
      Data:
        items:
          $ref: "#/definitions/Message"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  Eft:
    description:
      A group of Electronic Fund Transfer Items posted to a payment
      gateway
    properties:
      AccountID:
        description: Account
        type: string
      Amount:
        description: Amount
        type: number
      AttemptNumber:
        description: Attempt Number
        type: number
      BackendID:
        description: Backend
        type: string
      BillingRunID:
        description: Billing Run
        type: string
      CashReceiptID:
        description: Cash Receipt
        type: string
      CreatedByID:
        description: Created By
        type: string
      CreatedDate:
        description: Created Date
        type: string
      Executed:
        description: Executed At
        type: string
      Fee:
        description: Fee
        type: number
      Gateway:
        description: Gateway
        type: string
      GatewayKey:
        description: Gateway Key
        type: string
      GatewayMessage:
        description: Gateway Message
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      Items:
        description: The items associated with this EFT
        items:
          $ref: "#/definitions/EftItem"
        type: array
      JournalDate:
        description: Journal Date
        type: string
      LastModifiedByID:
        description: Last Modified By
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      ParentFK:
        description: Parent Foreign Key
        type: string
      PaymentMethodID:
        description: Payment Method
        type: string
      Ref:
        description: External Reference
        type: string
      Status:
        description: Status
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TransactionID:
        description: Transaction ID
        type: string
    type: object
  EftItem:
    description: An invoice reference that is batched in a single Eft
    properties:
      Amount:
        description: Amount
        type: number
      CreatedByID:
        description: Created By
        type: string
      CreatedDate:
        description: Created Date
        type: string
      EftID:
        description: EFT
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      InvoiceID:
        description: Invoice
        type: string
      LastModifiedByID:
        description: Last Modified By
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
    type: object
  EftRequest:
    properties:
      Data:
        items:
          $ref: "#/definitions/Eft"
        type: array
    type: object
  EftResponse:
    properties:
      Data:
        items:
          $ref: "#/definitions/Eft"
        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
  Invoice:
    properties:
      AccountID:
        description: Account ID
        type: string
      Advance:
        description: Advance?
        type: boolean
      Amount:
        description: Invoice Amount
        format: double
        type: number
      AmountAdjustment:
        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
      BillingAddress:
        $ref: "#/definitions/Address"
      BillingContactID:
        description: Billing Contact ID
        type: string
      BillingRunID:
        description: Billing Run
        type: string
      BusinessAddress:
        $ref: "#/definitions/Address"
      BusinessTax:
        description:
          The amount of Deferred Tax incurred with this invoice
        format: double
        type: number
      CannabisTax:
        description: Cannabis Tax
        format: double
        type: number
      ContractID:
        description: Contract
        type: string
      CoordinateID:
        description: The ID of the Coordinate used to rate this item
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      CustomerID:
        description: Customer ID
        type: string
      DateIssued:
        description: Date Issued
        type: string
      DaysDue:
        description: Days Due
        format: int64
        type: number
      DepositAmount:
        description: Deposit Amount
        format: double
        type: number
      Description:
        description: Description
        type: string
      Discount:
        description: Discount
        format: double
        type: number
      EstimatedAmount:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedBusinessTax:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedCOGS:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedCannabisTax:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedDiscount:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedSalesTax:
        description: Sales Tax from source system
        format: double
        type: number
      EstimatedSubtotal:
        description: Invoice Subtotal from source system
        format: double
        type: number
      ID:
        description: Taxnexus Record Id
        type: string
      IngestID:
        description: ID of the Ingest which created this Invoice
        type: string
      InvoiceDate:
        description: Invoice Date
        type: string
      InvoiceNumber:
        description: Invoice Number
        type: string
      IsInternational:
        description: Is International?
        type: boolean
      IsValid:
        description: Is Valid?
        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
      Items:
        description: The items associated with this Invoice
        items:
          $ref: "#/definitions/InvoiceItem"
        type: array
      JobID:
        description: ID of the Job which created this Invoice
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      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: Reference the master record that owns this item
        type: string
      PartnerAccountID:
        description: Partner Account
        type: string
      PaymentDue:
        description: Payment Due
        type: string
      PaymentMethod:
        description: Payment Method
        type: string
      PaymentMethodID:
        description: Payment Method
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      PeriodID:
        description: Period
        type: string
      PlaceGeocode:
        description: The Taxnexus Geocode of the Place used for Situs
        type: string
      Posted:
        description: Posted to external system?
        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
        format: double
        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
      ProtratedDays:
        description: Prorated Days
        format: double
        type: number
      PurchaseAmount:
        description: Purchase Amount
        format: double
        type: number
      QuoteID:
        description: Quote
        type: string
      RatingEngineID:
        description: The ID of the Rating Engine that rated this invoice
        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
      ServiceTerm:
        description: Service Term
        type: string
      ShippingAddress:
        $ref: "#/definitions/Address"
      ShippingHandling:
        description: Shipping & Handling
        format: double
        type: number
      Status:
        description: Status
        type: string
      Subtotal:
        description: Subtotal
        type: number
      TaxTransactions:
        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
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Total:
        $ref: "#/definitions/Total"
      Type:
        description: Type
        type: string
    type: object
  InvoiceBasic:
    properties:
      AccountID:
        description: Account Identifier from Source System
        type: string
      Amount:
        description: Invoice Amount
        type: number
      AmountDue:
        description: Amount Due
        type: number
      BusinessAddress:
        $ref: "#/definitions/Address"
      CustomerID:
        description: OEM Customer Identifier
        type: string
      EstimatedAmount:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedBusinessTax:
        description: Business tax from source system
        format: double
        type: number
      EstimatedCOGS:
        description: Cost of Goods Sold from source system
        format: double
        type: number
      EstimatedCannabisTax:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedDiscount:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedSalesTax:
        description: Sales Tax from source system
        format: double
        type: number
      EstimatedSubtotal:
        description: Invoice Subtotal from source system
        format: double
        type: number
      ID:
        description: Taxnexus ID
        type: string
      IngestID:
        description: ID of the Ingest which created this Invoice
        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
      JobID:
        description: ID of the Job which created this Invoice
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      PeriodID:
        description: Taxnexus Period ID
        type: string
      PlaceGeocode:
        description: The Taxnexus Geocode of the Place used for Situs
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      SalesRegulation:
        description: Sales Regulation Type
        type: string
      ShippingHandling:
        description: Shipping and Handling fees for this document
        type: number
      Status:
        description:
          Status used by for Billing Balances; ignored in tax
          calculation
        type: string
      Subtotal:
        description: Subtotal of items
        type: number
      TaxTransactions:
        description:
          'The Tax Transactions "Source System identifier for this
          record, if any; copied to invoiceitemid in Tax Transaction
          result records"'
        items:
          $ref: "#/definitions/TaxTransaction"
        type: array
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Total:
        $ref: "#/definitions/Total"
      Type:
        description: Invoice Type
        type: string
  InvoiceItem:
    properties:
      COGS:
        description: Cost of Goods Sold
        format: double
        type: number
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      Description:
        description: Line Item Description
        type: string
      Family:
        description: Family
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      InvoiceID:
        description: Invoice
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      ListPrice:
        description: List Price
        type: number
      MRCInterval:
        description: Quantity
        format: int64
        type: number
      OrderItemID:
        description: Order Item
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      ProductCode:
        description: Product Code
        type: string
      ProductID:
        description: Product
        type: string
      Quantity:
        description: Quantity
        format: double
        type: number
      QuoteItemID:
        description: Quote Line Item
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      RejectedQuantity:
        description: Rejected Quantity
        format: double
        type: number
      SKU:
        description: SKU
        type: string
      ShippedQuantity:
        description: Shipped Quantity
        format: double
        type: number
      ShippingHandling:
        description: Shipping & Handling
        format: double
        type: number
      SubscriptionID:
        description: Subscription
        type: string
      Subtotal:
        description: Subtotal
        format: double
        type: number
      TaxnexusCode:
        description: Taxnexus Code
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TotalPrice:
        description: Total Price
        type: number
      UnitPrice:
        description: Unit Price
        type: number
      Units:
        description: The Unit of Measure for this item
        type: string
    type: object
  InvoiceRequest:
    properties:
      Data:
        items:
          $ref: "#/definitions/InvoiceBasic"
        type: array
    type: object
  InvoiceResponse:
    properties:
      Data:
        items:
          $ref: "#/definitions/Invoice"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  ItemBasic:
    properties:
      COGS:
        description: Cost of Goods Sold
        format: double
        type: number
      Description:
        description: Line Item Description
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      MRCInterval:
        description: Monthly Recurring Charge Indicator
        format: int64
        type: number
      ParentFK:
        description: 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 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
        type: string
    type: object
  Message:
    properties:
      message:
        type: string
      ref:
        type: string
    type: object
  Order:
    properties:
      AccountID:
        description: Account ID
        type: string
      ActivatedByID:
        description: Activated By ID
        type: string
      ActivatedDate:
        description: Activated Date
        type: string
      Amount:
        description: Order Amount
        format: double
        type: number
      AmountDue:
        description: Order Amount Due
        format: double
        type: number
      BillingAddress:
        $ref: "#/definitions/Address"
      BillingContactID:
        description: Billing Contact ID
        type: string
      BusinessAddress:
        $ref: "#/definitions/Address"
      BusinessTax:
        description:
          The amount of Deferred Tax incurred with this invoice
        format: double
        type: number
      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
      ContractEndDate:
        description: Contract End Date
        type: string
      ContractID:
        description: Contract Number
        type: string
      CoordinateID:
        description: The ID of the Tax Nexus Coordinate record
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      CustomerAuthorizedBy:
        description: Customer Authorized By
        type: string
      CustomerAuthorizedDate:
        description: Customer Authorized Date
        type: string
      CustomerID:
        description: "Partner customer ID, if any"
        type: string
      Description:
        description: Description
        type: string
      Discount:
        description: Discount Percentage
        format: double
        type: number
      DiscountAmount:
        description: Discount Amount
        format: double
        type: number
      EffectiveDate:
        description: Order Start Date
        type: string
      EndDate:
        description: Order End Date
        type: string
      EndUserID:
        description: End User Contact ID
        type: string
      EstimatedAmount:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedBusinessTax:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedCOGS:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedCannabisTax:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedDiscount:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedSalesTax:
        description: Sales Tax from source system
        format: double
        type: number
      EstimatedSubtotal:
        description: Invoice Subtotal from source system
        format: double
        type: number
      ID:
        description: Taxnexus Record Id
        type: string
      IngestID:
        description: The ID of the Ingest generated by this order
        type: string
      InstallationDate:
        description: Installation Date
        type: string
      InvoiceID:
        description: Invoice ID
        type: string
      IsReductionOrder:
        description: Reduction Order
        type: boolean
      Items:
        description: The Order Items
        items:
          $ref: "#/definitions/OrderItem"
        type: array
      JobID:
        description:
          "The ID of the Job that generated this order, if any"
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      MonthlyAmount:
        description: Monthly Amount
        format: double
        type: number
      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
      PODate:
        description: PO Date
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      PaymentMethodID:
        description: Payment Method ID
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      PeriodID:
        description: The ID of the Period in which this Order was made
        type: string
      PlaceGeoCode:
        description: Place GeoCode
        type: string
      Posted:
        description: Posted to external system?
        type: boolean
      ProvisioningStatus:
        description: Provisioning Status
        type: string
      PurchaseAmount:
        description: Purchase Amount
        format: double
        type: number
      PurchaseOrderID:
        description: PO ID
        type: string
      QuoteID:
        description: Quote
        type: string
      RatingEngineID:
        description: The ID of the Rating Engine that rated this invoice
        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:
        description: Shipping Contact ID
        type: string
      ShippingHandling:
        description: Shipping & Handling
        format: double
        type: number
      Status:
        description: Status
        type: string
      Subtotal:
        description: Subtotal
        type: number
      TaxTransactions:
        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
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Total:
        $ref: "#/definitions/Total"
      Type:
        description: Order Type
        type: string
    type: object
  OrderItem:
    properties:
      ID:
        description: Taxnexus Record Id
        type: string
      Activated:
        description: Activated?
        type: boolean
      ActiveatedByID:
        description: Activated By
        type: string
      AvailableQuantity:
        description: Available Quantity
        format: double
        type: number
      COGS:
        description: Cost of Goods Sold
        format: double
        type: number
      CreateReservation:
        description: Create Reservation?
        type: boolean
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      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
      Family:
        description: Family
        type: string
      InvoiceItemID:
        description: Invoice Item
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      ListPrice:
        description: List Price
        format: double
        type: number
      LocationID:
        description: Location
        type: string
      MRCInterval:
        description: Monthly Recurring Charge Indicator
        format: int64
        type: number
      OrderID:
        description: Order
        type: string
      OriginalOrderItemID:
        description: Original Order Product
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      Posted:
        description: Posted to external system?
        type: boolean
      ProductCode:
        description: Product Code
        type: string
      ProductID:
        description: Product
        type: string
      ProductName:
        description: Product Name
        type: string
      Quantity:
        description: Quantity
        format: double
        type: number
      QuantityOnHand:
        description: Quantity On Hand
        format: double
        type: number
      QuoteItemID:
        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
      TaxnexusCodeDisplay:
        description: Taxnexus Code Display
        type: string
      TaxnexusCodeID:
        description: Taxnexus Code
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TotalPrice:
        description: Total Price
        format: double
        type: number
      UnitPrice:
        description: Unit Price
        format: double
        type: number
      Units:
        description: Units
        type: string
    type: object
  OrderRequest:
    description: An array of Order objects
    properties:
      Data:
        items:
          $ref: "#/definitions/Order"
        type: array
    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:
      Limit:
        format: int64
        type: integer
      Offset:
        format: int64
        type: integer
      PageSize:
        format: int64
        type: integer
      SetSize:
        format: int64
        type: integer
    type: object
  PaymentMethod:
    description:
      Describes the EFT or other payment information for an account and
      billing contact
    properties:
      ID:
        description: Telnexus Record Id
        type: string
      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
      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
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
    type: object
  PaymentMethodRequest:
    properties:
      Data:
        items:
          $ref: "#/definitions/PaymentMethod"
        type: array
    type: object
  PaymentMethodResponse:
    description: An array of Payment Method objects
    properties:
      Data:
        items:
          $ref: "#/definitions/PaymentMethod"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  Pricebook:
    properties:
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        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
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      Name:
        description: Price Book Name
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
    type: object
  PricebookEntry:
    properties:
      AccountID:
        description: Active
        type: string
      AgentID:
        description: Created By
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      ID:
        description: Record Id
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      PricebookID:
        type: string
      ProductCode:
        description: Product Code
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      UnitPrice:
        description: List Price
        format: double
        type: number
      UseStandardPrice:
        description: Use Standard Price
        type: boolean
      procuctID:
        type: string
    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
      LastModifiedDate:
        description: Last Modified Date
        type: string
      LastModifiedByID:
        description: Last modified by ID
        type: string
      MRCInterval:
        description: MRC Interval
        format: int64
        type: number
      MSRP:
        description: MSRP
        format: double
        type: number
      Manufacturer:
        description: Manufacturer
        type: string
      ManufacturerProductCode:
        description: Manufacturer Product Code
        type: string
      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
      SKU:
        description: SKU
        type: string
      ShippingWeight:
        description: Shipping Weight
        format: double
        type: number
      Specifications:
        description: Specifications
        type: string
      TaxnexusCode:
        description: Taxnexus Code Name
        type: string
      TaxnexusCodeID:
        description: Taxnexus Code
        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
    type: object
  ProductResponse:
    description: An array of Product objects
    properties:
      Data:
        items:
          $ref: "#/definitions/Product"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  PurchaseOrder:
    properties:
      ID:
        description: Taxnexus Record Id
        type: string
      AccountID:
        description: Account ID
        type: string
      Amount:
        description: PO Amount
        format: double
        type: number
      BillingAddress:
        $ref: "#/definitions/Address"
      BillingContactID:
        description: Billing Contact ID
        type: string
      BusinessAddress:
        $ref: "#/definitions/Address"
      BusinessTax:
        description:
          The amount of Deferred Tax incurred with this invoice
        format: double
        type: number
      CannabisTax:
        description: Cannabis Tax
        format: double
        type: number
      ContractID:
        description: Contract
        type: string
      CoordinateID:
        description: The ID of the Coordinate used to rate this item
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      CreditCardID:
        description: CC used for payment to vendor
        type: string
      CustomerID:
        description: Customer ID
        type: string
      DateExpires:
        description: Date Expires
        type: string
      DatePromised:
        description: Date Promised
        type: string
      DateRequested:
        description: Date Requested
        type: string
      ExpirationDate:
        description: Expiration Date
        type: string
      Description:
        description: Description
        type: string
      Discount:
        description: Discount Percentage
        format: double
        type: number
      DiscountAmount:
        description: Discount Amount
        format: double
        type: number
      DueDate:
        description: Due Date
        type: string
      EndUserID:
        description: End User Contact ID
        type: string
      EstimatedAmount:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedBusinessTax:
        description: Business tax from source system
        format: double
        type: number
      EstimatedCannabisTax:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedDiscount:
        description: Discount from source system
        format: double
        type: number
      EstimatedSalesTax:
        description: Sales Tax from source system
        format: double
        type: number
      EstimatedSubtotal:
        description: Invoice Subtotal from source system
        format: double
        type: number
      IngestID:
        description: The ID of the Ingest generated by this PO
        type: string
      Items:
        items:
          $ref: "#/definitions/PurchaseOrderItem"
        type: array
      JobID:
        description: ID of the Job which created this PO
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      OpportunityID:
        description: Opportunity Name
        type: string
      OrderID:
        description: Order Number
        type: string
      PODate:
        description: Date
        type: string
      PONumber:
        description: Number
        type: string
      ParentFK:
        description: The record identifier from the source system
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      PeriodID:
        description: Taxnexus Period ID
        type: string
      PlaceGeoCode:
        description: Place GeoCode
        type: string
      Posted:
        description: Posted to external system?
        type: boolean
      QuoteID:
        description: Quote Name
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      SalesRegulation:
        description: Sales Regulation Type (Medicinal or Recreational)
        type: string
      SalesTax:
        description: Sales Tax
        type: number
      ServiceTerm:
        description: Service Term
        type: string
      ShipDate:
        description: Ship Date
        type: string
      ShippingAddress:
        $ref: "#/definitions/Address"
      ShippingContactID:
        description: Shipping Contact ID
        type: string
      ShippingHandling:
        description: Shipping & Handling
        format: double
        type: number
      ShippingSpecialInstructions:
        description: Shipping Special Instructions
        type: string
      Status:
        description: Status
        type: string
      Subtotal:
        description: Subtotal
        format: double
        type: number
      TaxTransactions:
        description: The taxes associated with this Purchase Order
        items:
          $ref: "#/definitions/TaxTransaction"
        type: array
      TelecomTax:
        description: Telecom Tax
        format: double
        type: number
      TemplateID:
        description: ID of the Template used to render this object
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Total:
        $ref: "#/definitions/Total"
      TotalID:
        description: The ID of the totaling struct for this object
        type: string
      Type:
        description: Type
        type: string
      VendorID:
        description: Vendor Account ID
        type: string
      VendorQuoteNumber:
        description: Vendor Quote Number
        type: string
    type: object
  PurchaseOrderItem:
    properties:
      ID:
        description: Record Id
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      Description:
        description: Line Item Description
        type: string
      DueDate:
        description: Due Date
        type: string
      Family:
        description: Product Family
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      LocationID:
        description: Location
        type: string
      MRCInterval:
        description: Monthly Recurring Cost Interval
        format: int64
        type: number
      OrderItemID:
        description: Order Item
        type: string
      ParentFK:
        description:
          The record identifier of the parent record from the source
          system
        type: string
      ProductCode:
        description: Product Code
        type: string
      ProductID:
        description: Product ID
        type: string
      ProductName:
        description: Product Name
        type: string
      PurchaseOrderID:
        description: Purchase Order
        type: string
      Quantity:
        description: Quantity
        format: double
        type: number
      QuoteItemID:
        description: Quote Item
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      ShippingHandling:
        description: Shipping costs for this item
        format: double
        type: number
      ReceivedQuantity:
        description: Received Quantity
        format: double
        type: number
      RejectedQuantity:
        description: Rejected Quantity
        format: double
        type: number
      ShippmentItemID:
        description: Shipment Item ID
        type: string
      Status:
        description: Status
        type: string
      StockedQuantity:
        description: Stocked Quantity
        format: double
        type: number
      Subtotal:
        description: Subtotal
        format: double
        type: number
      TaxnexusCodeDisplay:
        description: Taxnexus Code
        type: string
      TaxnexusCodeID:
        description: Taxnexus Code
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      UnitPrice:
        description: Unit Price
        format: double
        type: number
      Units:
        description: Units
        type: string
    type: object
  PurchaseOrderRequest:
    properties:
      Data:
        items:
          $ref: "#/definitions/PurchaseOrder"
        type: array
    type: object
  PurchaseOrderResponse:
    description: An array of Purchase Order objects
    properties:
      Data:
        items:
          $ref: "#/definitions/PurchaseOrder"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  PutResponse:
    properties:
      Data:
        items:
          $ref: "#/definitions/Message"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  Quote:
    properties:
      AccountID:
        description: Account ID
        type: string
      AdditionalAddress:
        $ref: "#/definitions/Address"
      AdditionalName:
        description: Additional To Name
        type: string
      Amount:
        description: The Quote Amount
        type: number
        format: double
      BusinessTax:
        description: Business Tax Amount
        type: number
        format: double
      SalesTax:
        description: Sales Tax Amount
        type: number
        format: double
      BillingAddress:
        $ref: "#/definitions/Address"
      BillingContactID:
        description: Billing Contact ID
        type: string
      BillingName:
        description: Bill To Name
        type: string
      BusinessAddress:
        $ref: "#/definitions/Address"
      CannabisTax:
        description: Cannabis Tax
        format: double
        type: number
      CoordinateID:
        description: Contact ID
        type: string
      ContactID:
        description: Contact ID
        type: string
      ContractID:
        description: Contract ID
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      CreditTerms:
        description: Credit Terms
        type: string
      CustomerID:
        description: OEM Customer Identifier
        type: string
      QuoteDate:
        description: Quote Date
        type: string
      Description:
        description: Description
        type: string
      Discount:
        description: Discount Percentage
        format: double
        type: number
      DiscountAmount:
        description: Discount Amount
        format: double
        type: number
      Email:
        description: Email
        type: string
      EndUserID:
        description: End User Contact ID
        type: string
      EstimatedAmount:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedBusinessTax:
        description: Business tax 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
        format: double
        type: number
      EstimatedDiscount:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedSalesTax:
        description: Sales Tax from source system
        format: double
        type: number
      EstimatedSubtotal:
        description: Invoice Subtotal from source system
        format: double
        type: number
      ExpirationDate:
        description: Expiration Date
        type: string
      Fax:
        description: Fax
        type: string
      GrandTotal:
        description: Grand Total
        format: double
        type: number
      ID:
        description: Taxnexus Record Id
        type: string
      IngestID:
        description: ID of the Ingest which created this Invoice
        type: string
      InstallationDate:
        description: Installation Date
        type: string
      Items:
        items:
          $ref: "#/definitions/QuoteItem"
        type: array
      JobID:
        description: ID of the Job which created this Invoice
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      MonthlyAmount:
        description: Monthly Amount quoted
        format: double
        type: number
      Name:
        description: Quote Name
        type: string
      OpportunityID:
        description: Opportunity Name
        type: string
      OwnerID:
        description: Owner Name
        type: string
      PeriodID:
        description: Period ID
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      Phone:
        description: Phone
        type: string
      PlaceGeoCode:
        description: Place GeoCode
        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:
        $ref: "#/definitions/Address"
      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:
        $ref: "#/definitions/Address"
      ShippingContactID:
        description: Shipping Contact ID
        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
        type: number
      Tax:
        description: Tax
        format: double
        type: number
      TaxTransactions:
        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
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Total:
        $ref: "#/definitions/Total"
      TotalPrice:
        description: Total Price
        format: double
        type: number
      Type:
        description: Quote Type
        type: string
    type: object
  QuoteBasic:
    properties:
      AccountID:
        description:
          Account Identifier from Source System; ignored in tax
          calculations
        type: string
      Amount:
        description: Invoice Amount
        type: number
      BusinessAddress:
        $ref: "#/definitions/Address"
      CustomerID:
        description: OEM Customer Identifier
        type: string
      EstimatedAmount:
        description: Invoice Total from source system
        format: double
        type: number
      EstimatedBusinessTax:
        description: Business tax 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
        format: double
        type: number
      EstimatedDiscount:
        description: Cannabis Tax from source system
        format: double
        type: number
      EstimatedSalesTax:
        description: Sales Tax from source system
        format: double
        type: number
      EstimatedSubtotal:
        description: Invoice Subtotal from source system
        format: double
        type: number
      ID:
        description: Taxnexus ID
        type: string
      IngestID:
        description: ID of the Ingest which created this Invoice
        type: string
      Items:
        description: The items associated with this Invoice
        items:
          $ref: "#/definitions/ItemBasic"
        type: array
      JobID:
        description: ID of the Job which created this Invoice
        type: string
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      PeriodID:
        description: Taxnexus Period ID
        type: string
      QuoteDate:
        description:
          Invoice Date; should be date only or correct time zone if in
          time notation
        type: string
      QuoteNumber:
        description:
          Source System Customer-Facing Invoice Number; ignored in tax
          calculation
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      SalesRegulation:
        description: Sales Regulation Type
        type: string
      ShippingHandling:
        description: Shipping and Handling fees for this document
        type: number
      Status:
        description:
          Status used by for Billing Balances; ignored in tax
          calculation
        type: string
      Subtotal:
        description: Subtotal of items
        type: number
      TaxTransactions:
        description:
          'The Tax Transactions "Source System identifier for this
          record, if any; copied to quoteitemid in Tax Transaction
          result records"'
        items:
          $ref: "#/definitions/TaxTransaction"
        type: array
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      Total:
        $ref: "#/definitions/Total"
      Type:
        description: Invoice Type
        type: string
  QuoteItem:
    properties:
      COGS:
        description: Cost of Goods Sold
        format: double
        type: number
      CountyID:
        description: County
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      Description:
        description: Line Item Description
        type: string
      Discount:
        description: Discount Percentage
        format: double
        type: number
      DiscountAmount:
        description: Discount Amount
        format: double
        type: number
      ID:
        description: Taxnexus Record Id
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      ListPrice:
        description: List Price
        type: number
      MRCInterval:
        description: Quantity
        format: int64
        type: number
      ParentFK:
        description: Reference the master record that owns this item
        type: string
      ProductCode:
        description: Product Code
        type: string
      ProductID:
        description: Product 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
      TaxnexusCode:
        description: Taxnexus Code
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TotalPrice:
        description: Total Price
        format: double
        type: number
      UnitPrice:
        description: Sales Price
        format: double
        type: number
      Units:
        description: The Unit of Measure for this item
        type: string
    type: object
  QuoteRequest:
    description: An array of Quote objects
    properties:
      Data:
        items:
          $ref: "#/definitions/QuoteBasic"
        type: array
    type: object
  QuoteResponse:
    description: An array of Quote objects
    properties:
      Data:
        items:
          $ref: "#/definitions/Quote"
        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
  Subscription:
    properties:
      AccountID:
        description: Account ID
        type: string
      ActivatedDate:
        description: Activated Date
        type: string
      ActivatedUserID:
        description: Activated By
        type: string
      Amount:
        description: Amount
        format: double
        type: number
      AssetID:
        description: Asset Name
        type: string
      CancelDate:
        description: Cancel Date
        type: string
      ContractID:
        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
      Email:
        description: Email
        type: string
      EndUserID:
        description: End User Contact ID
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      IsActive:
        description: Active?
        type: boolean
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      OrderDate:
        description: Order Date
        type: string
      OrderItemID:
        description: Order Item
        type: string
      Password:
        description: Password
        type: string
      PaymentTerms:
        description: Payment Terms
        type: string
      PriceBookID:
        description: Price Book
        type: string
      ProductCode:
        description: Product Code
        type: string
      ProductID:
        type: string
      ProductName:
        description: Product Name
        type: string
      Quantity:
        description: Quantity
        type: string
      QuoteItemID:
        description: Quote Item
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      Status:
        description: Status
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      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
    type: object
  SubscriptionResponse:
    description: An array of Subscription Objects
    properties:
      Data:
        items:
          $ref: "#/definitions/Subscription"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  TaxTransaction:
    properties:
      AccountID:
        description: Account ID
        type: string
      AccountingRuleCode:
        description: Accounting Rule code
        type: string
      Amount:
        description: Total Amount Due (same as Tax)
        format: double
        type: number
      CoordinateID:
        description: Coordinate ID
        type: string
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      CustomerID:
        description: Customer ID
        type: string
      DisplayName:
        description: Tax or Fee Name
        type: string
      EffectiveRate:
        description: Effective Rate
        format: double
        type: number
      FilingID:
        description: Filing ID
        type: string
      ID:
        description: Taxnexus Record Id
        type: string
      IngestID:
        description: Ingest ID
        type: string
      InvoiceID:
        description: Invoice ID
        type: string
      InvoiceItemID:
        description: Invoiceitem ID
        type: string
      IsSummary:
        description: Is this a summary record?
        type: boolean
      JobID:
        description: Job ID
        type: string
      JournalItemID:
        description: Journal Item ID
        type: string
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      OrderID:
        description: Order ID
        type: string
      OrderItemID:
        description: Order Item ID
        type: string
      POID:
        description: PO ID
        type: string
      POItemID:
        description: PO Item ID
        type: string
      ParentRef:
        description: Parent Ref copied from source
        type: string
      PercentTaxable:
        description: Percent Taxable
        format: double
        type: number
      PeriodID:
        description: Period ID
        type: string
      PlaceGeocode:
        description: The Taxnexus Geocode of the Place used for Situs
        type: string
      PlaceID:
        description: Place ID
        type: string
      Posted:
        description: Posted to external system?
        type: boolean
      QuoteID:
        description: Order ID
        type: string
      QuoteItemID:
        description: Order Item ID
        type: string
      RatingType:
        description: The Type of Object that was rated
        type: string
      Ref:
        description: "Source System identifier for this record, if any"
        type: string
      RevenueBase:
        description:
          The Revenue Amount that was taxed before any adjustments
        format: double
        type: number
      RevenueNet:
        description:
          The Revenue Amount that was taxed after any adjustments
        format: double
        type: number
      RevenueNotTaxable:
        description: The Revenue Amount that was not taxed
        format: double
        type: number
      TaxExemptRevenue:
        description: Tax Exempt Revenue
        format: double
        type: number
      TaxOnTax:
        description:
          Additional Tax calculated due to regulatory requirements
        format: double
        type: number
      TaxRate:
        description: The Tax Rate used for calculation
        format: double
        type: number
      TaxTypeAccountID:
        description: TaxType Account ID
        type: string
      TaxTypeID:
        description: TaxType ID
        type: string
      TaxnexusCodeDisplay:
        description: The Taxnexus Code for the Tax Type
        type: string
      TaxnexusCodeID:
        description: Taxnexus Code ID
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      UnitBase:
        description: Unit Base
        format: double
        type: number
      UnitFeeRate:
        description: Unit Fee Rate
        format: double
        type: number
    type: object
  TaxTransactionResponse:
    description: An array of Tax Transaction Objects
    properties:
      Data:
        items:
          $ref: "#/definitions/TaxTransaction"
        type: array
      Meta:
        $ref: "#/definitions/ResponseMeta"
    type: object
  Total:
    properties:
      Amount:
        description: The total amount for this object
        format: double
        type: number
      BusinessTax:
        description:
          The amount of Deferred Tax incurred with this invoice
        format: double
        type: number
      BusinessTaxRate:
        description: The Percentage of Deffered Tax from the Total
        format: double
        type: number
      CannabisTax:
        description:
          The total amount of Cannabis Tax charged on this object
        format: double
        type: number
      CannabisTaxRate:
        description: The percentage of Cannabis Tax from the Total
        format: double
        type: number
      CreatedByID:
        description: Created By User ID
        type: string
      CreatedDate:
        description: Created Date
        type: string
      ID:
        description: Unique Taxnexus ID
        type: string
      Items:
        items:
          $ref: "#/definitions/TotalItem"
        type: array
      LastModifiedByID:
        description: Last Modified By User ID
        type: string
      LastModifiedDate:
        description: Last Modified Date
        type: string
      MonthlyAmount:
        description:
          "The monthly, pre-tax estimate of quoted and ordered periodic
          services"
        format: double
        type: number
      ObjectType:
        description:
          The type of Object for which this Total has been constructed
        type: string
      PurchaseAmount:
        format: double
        type: number
      SalesTax:
        description: The amount of Sales Tax charged on this object
        format: double
        type: number
      SalesTaxRate:
        description: The percentage of Sales Tax from the Total
        format: double
        type: number
      ShippingHandling:
        description:
          The shipping and delivery charges charged on this object
        format: double
        type: number
      Subtotal:
        description:
          The sum of all the items on the object prior to tax rating and
          shipping & handling
        format: double
        type: number
      TelecomTax:
        description: The amount of Telecom Tax charged on this invoice
        format: double
        type: number
      TelecomTaxRate:
        description: The percentage of Telecom Tax from the Total
        format: double
        type: number
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
    type: object
  TotalItem:
    description: Tabulates Tax Transactions on this object
    properties:
      Amount:
        description: The amount of this total item
        format: double
        type: number
      Count:
        description: The number of taxtransactions totaled
        format: int64
        type: number
      DisplayName:
        description:
          Total Item description to be used in bill presentment
        type: string
      ID:
        description: Unique Taxnexus ID
        type: string
      TaxItems:
        items:
          $ref: "#/definitions/TotalTaxItem"
        type: array
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
    type: object
  TotalTaxItem:
    description: Links the tax items totals in the TotalItem struct
    properties:
      ID:
        type: string
      TaxTransactionID:
        type: string
      TenantID:
        description: ID of the Tenant that owns this object
        type: string
      TotalItemID:
        type: string
    type: object