spectacle/test/fixtures/billing.yaml

---
swagger: "2.0"
info:
  description: "An API to retrieve and store TRACT objects for core operations.\n\
    JSON looks like this:  \n```JSON\n{\n  \"key\": \"value\",\n  \"anotherKey\":\
    \ \"anotherValue\"\n}\n```\n"
  version: "2"
  title: "TRACT Billing API"
  termsOfService: "http://www.gotransverse.com/terms-of-service"
  contact:
    name: "TRACT Support"
    url: "http://www.gotransverse.com/support"
    email: "support@gotransverse.com"
  license:
    name: "TRACT License"
    url: "http://www.gotransverse.com/license"
basePath: "/billing/2"
tags:
- name: "BillingAccount"
  description: "Customer billing accounts in TRACT"
  externalDocs:
    description: "More *TRACT* BillingAccount API Documentation here"
    url: "http://www.gotransverse.com/docs/api/billing-accounts"
- name: "BillCycle"
  description: "A period during which usage is collected to charge a billing account"
  externalDocs:
    description: "More *TRACT* BillCycle API Documentation here"
    url: "http://www.gotransverse.com/docs/api/bill-cycles"
- name: "BillingAccountCategory"
  description: "Categories used to separate and control groups of billing accounts."
  externalDocs:
    description: "More *TRACT* BillingAccountCategory API Documentation here"
    url: "http://www.gotransverse.com/docs/api/billing-account-categories"
- name: "Chart of Accounts"
  description: "Chart of Accounts"
- name: "Order"
  description: "Customer orders in TRACT"
  externalDocs:
    description: "More *TRACT* Order API Documentation here"
    url: "http://www.gotransverse.com/docs/api/orders"
- name: "OrderItem"
  description: "Individual items that make up an order"
  externalDocs:
    description: "More *TRACT* OrderItem API Documentation here"
    url: "http://www.gotransverse.com/docs/api/order-items"
- name: "Product"
  description: "The product catalog in TRACT"
  externalDocs:
    description: "More *TRACT* Product API Documentation here"
    url: "http://www.gotransverse.com/docs/api/products"
- name: "ProductTag"
  description: "Used to group products"
  externalDocs:
    description: "More *TRACT* ProductTag API Documentation here"
    url: "http://www.gotransverse.com/docs/api/product-tags"
- name: "ProductPrice"
  description: "The prices associated with a product"
  externalDocs:
    description: "More *TRACT* ProductPrice API Documentation here"
    url: "http://www.gotransverse.com/docs/api/product-prices"
- name: "Service"
  description: "A service is product that has been sold to a billing account"
  externalDocs:
    description: "More *TRACT* Service API Documentation here"
    url: "http://www.gotransverse.com/docs/api/services"
- name: "Payment"
  description: "A payment received from a billing account"
  externalDocs:
    description: "More *TRACT* Payment API Documentation here"
    url: "http://www.gotransverse.com/docs/api/payments"
- name: "Person"
  description: "An individual contact on a billing account"
  externalDocs:
    description: "More *TRACT* Person API Documentation here"
    url: "http://www.gotransverse.com/docs/api/people"
- name: "Organization"
  description: "A responsibility party for a billing account"
  externalDocs:
    description: "More *TRACT* Organization API Documentation here"
    url: "http://www.gotransverse.com/docs/api/organizations"
- name: "BillingAccountCustomField"
  description: "Custom fields for billing accounts defined by the user"
  externalDocs:
    description: "More *TRACT* Billing Account Custom Field API Documentation here"
    url: "http://www.gotransverse.com/docs/api/billing-account-custom-field"
- name: "OrderCustomField"
  description: "Custom fields for orders defined by the user"
  externalDocs:
    description: "More *TRACT* Order Custom Field API Documentation here"
    url: "http://www.gotransverse.com/docs/api/order-custom-field"
- name: "PaymentMethodCustomField"
  description: "Custom fields for pyment methods defined by the user"
  externalDocs:
    description: "More *TRACT* Payment Method Custom Field API Documentation here"
    url: "http://www.gotransverse.com/docs/api/payment-method-custom-field"
- name: "ServiceCustomField"
  description: "Custom fields for services defined by the user"
  externalDocs:
    description: "More *TRACT* Service Custom Field API Documentation here"
    url: "http://www.gotransverse.com/docs/api/service-custom-field"
- name: "BillingAccountCustomFieldValue"
  description: "Custom field values for billing accounts defined by the user"
  externalDocs:
    description: "More *TRACT* Billing Account Custom Field Value API Documentation\
      \ here"
    url: "http://www.gotransverse.com/docs/api/billing-account-custom-field-value"
- name: "OrderCustomFieldValue"
  description: "Custom field values for orders defined by the user"
  externalDocs:
    description: "More *TRACT* Order Custom Field Value API Documentation here"
    url: "http://www.gotransverse.com/docs/api/order-custom-field-value"
- name: "PaymentMethodCustomFieldValue"
  description: "Custom field values for payment methods defined by the user"
  externalDocs:
    description: "More *TRACT* Payment Method Custom Field Value API Documentation\
      \ here"
    url: "http://www.gotransverse.com/docs/api/payment-method-custom-field-value"
- name: "ServiceCustomFieldValue"
  description: "Custom field values for services defined by the user"
  externalDocs:
    description: "More *TRACT* Service Custom Field Value API Documentation here"
    url: "http://www.gotransverse.com/docs/api/service-custom-field-value"
- name: "UsageEvent"
  description: "Measurable events which can be billed"
  externalDocs:
    description: "More *TRACT* UsageEvent API Documentation here"
    url: "http://www.gotransverse.com/docs/api/usage-event"
- name: "DiscountCodeService"
  description: "Used to organize discounts"
  externalDocs:
    description: "More *TRACT* DiscountCodeService API Documentation here"
    url: "http://www.gotransverse.com/docs/api/discount-code-service"
- name: "ServiceResource"
  description: "A service resource identifier used to track usage to a service"
  externalDocs:
    description: "More *TRACT* ServiceResource API Documentation here"
    url: "http://www.gotransverse.com/docs/api/resource-category"
- name: "ResourceCategory"
  description: "Used to categorize products with type Service Device"
  externalDocs:
    description: "More *TRACT* ResourceCategory API Documentation here"
    url: "http://www.gotransverse.com/docs/api/resource-category"
- name: "AdjustmentCategory"
  description: "The charge category used for agreement termination fees"
  externalDocs:
    description: "More *TRACT* AdjustmentCategory API Documentation here"
    url: "http://www.gotransverse.com/docs/api/adjustment-category"
- name: "DiscountResource"
  description: "The discount resource used to manage discounts"
  externalDocs:
    description: "More *TRACT* DiscountResource API Documentation here"
    url: "http://www.gotransverse.com/docs/api/discount-resource"
- name: "PaymentTerm"
  description: "The terms used to determine when invoice payment is due"
  externalDocs:
    description: "More *TRACT* PaymentTerm API Documentation here"
    url: "http://www.gotransverse.com/docs/api/payment-term"
- name: "AdjustmentApplication"
  description: "The application of an adjustment"
  externalDocs:
    description: "More *TRACT* AdjustmentApplication API Documentation here"
    url: "http://www.gotransverse.com/docs/api/adjustment-application"
- name: "PaymentApplication"
  description: "Used to apply a payment to an invoice"
  externalDocs:
    description: "More *TRACT* PaymentApplication API Documentation here"
    url: "http://www.gotransverse.com/docs/api/payment-application"
- name: "Invoice"
  description: "Detailed list of charges to a billing account generated by bill cycles"
  externalDocs:
    description: "More *TRACT* Invoice API Documentation here"
    url: "http://www.gotransverse.com/docs/api/invoice"
- name: "Agreement"
  description: "The terms through which a product is offered"
  externalDocs:
    description: "More *TRACT* Agreement API Documentation here"
    url: "http://www.gotransverse.com/docs/api/agreement"
- name: "AgreementService"
  description: "Agreement Service tag description"
  externalDocs:
    description: "More *TRACT* Agreement Service API Documentation here"
    url: "http://www.gotransverse.com/docs/api/agreement-service"
- name: "Reason"
  description: "A reason to document changes in TRACT"
  externalDocs:
    description: "More *TRACT* Reason API Documentation here"
    url: "http://www.gotransverse.com/docs/api/reason"
- name: "PriceList"
  description: "Defines multiple prices for the same product being sold to different\
    \ markets"
  externalDocs:
    description: "More *TRACT* PriceList API Documentation here"
    url: "http://www.gotransverse.com/docs/api/price-list"
- name: "Adjustment"
  description: "Credit and debit adjustments to accounts"
  externalDocs:
    description: "More *TRACT* Adjustment API Documentation here"
    url: "http://www.gotransverse.com/docs/api/adjustment"
- name: "Operation"
  description: "Credit and debit operations to accounts"
  externalDocs:
    description: "More *TRACT* Operation API Documentation here"
    url: "http://www.gotransverse.com/docs/api/Operation"
- name: "Action"
  description: "Credit and debit actions to accounts"
  externalDocs:
    description: "More *TRACT* Action API Documentation here"
    url: "http://www.gotransverse.com/docs/api/Action"
schemes:
- "http"
- "https"
consumes:
- "application/json"
produces:
- "application/json"
security:
- api_key: []
- bearer: []
paths:
  /billing-accounts:
    get:
      tags:
      - "BillingAccount"
      summary: "Query for billing accounts with the specified query"
      description: "Query TRACT billing accounts"
      operationId: "queryBillingAccounts"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "status"
        in: "query"
        description: "The billing account status"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "PENDING"
        - "COLLECTION"
        - "DEACTIVATED"
        - "FINAL_BILL"
        - "CLOSED"
      - name: "billing_account_category_id"
        in: "query"
        description: "The id of a TRACT billing account category"
        required: false
        type: "string"
      - name: "party_id"
        in: "query"
        description: "The id of a TRACT party"
        required: false
        type: "string"
      - name: "email_address"
        in: "query"
        description: "An email address"
        required: false
        type: "string"
        format: "email"
      - name: "purchase_order_number"
        in: "query"
        description: "An purchase order number"
        required: false
        type: "string"
      - name: "order_num"
        in: "query"
        description: "(unique_key) An order number"
        required: false
        type: "string"
      - name: "order_id"
        in: "query"
        description: "The id of a TRACT order"
        required: false
        type: "string"
      - name: "bill_type"
        in: "query"
        description: "the bill type"
        required: false
        type: "string"
        enum:
        - "PAPER"
        - "EMAIL"
        - "PAPER_EMAIL"
        - "NONE"
      - name: "referral"
        in: "query"
        description: "the order referral"
        required: false
        type: "string"
      - name: "billing_account_segment_id"
        in: "query"
        description: "The id of a TRACT billing account segment"
        required: false
        type: "string"
      - name: "currency_code"
        in: "query"
        description: "The currency_code for the amount."
        required: false
        type: "string"
        enum:
        - "USD"
        - "GBP"
        - "EUR"
        - "SEK"
        - "NOK"
        - "DKK"
        - "CAD"
        - "AUD"
        - "ZAR"
        - "NZD"
        - "MXN"
        - "INR"
        - "JPY"
        - "SAR"
        - "QAR"
        - "EGP"
        - "AED"
        - "BHD"
        - "KWD"
        - "OMR"
        - "HKD"
        - "CHF"
        - "ILS"
        - "CNY"
        - "BRL"
        - "PLN"
        - "COP"
        - "PEN"
        - "RUB"
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "service_id"
        in: "query"
        description: "The id of a TRACT service"
        required: false
        type: "string"
      - name: "parent_id"
        in: "query"
        description: "The id of a TRACT parent billing account segment"
        required: false
        type: "string"
      - name: "bill_cycle_id"
        in: "query"
        description: "The id of a TRACT bill cycle"
        required: false
        type: "string"
      - name: "custom_field_value"
        in: "query"
        description: "A custom field value"
        required: false
        type: "string"
      - name: "custom_field_value_id"
        in: "query"
        description: "The id of a TRACT custom field value"
        required: false
        type: "string"
      - name: "custom_field_id"
        in: "query"
        description: "The id of a TRACT custom field"
        required: false
        type: "string"
      - name: "service_custom_field_value"
        in: "query"
        description: "An service custom field value"
        required: false
        type: "string"
      - name: "service_custom_field_id"
        in: "query"
        description: "The id of a TRACT service custom field"
        required: false
        type: "string"
      - name: "order_custom_field_value"
        in: "query"
        description: "An order custom field value"
        required: false
        type: "string"
      - name: "order_custom_field_id"
        in: "query"
        description: "The id of a TRACT order custom field"
        required: false
        type: "string"
      - name: "usage_pool_id"
        in: "query"
        description: "The id of a TRACT usage_pool"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            title: "billing-accounts"
            items:
              $ref: "#/definitions/BillingAccount"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      summary: "Create a new TRACT BillingAccount"
      description: "Create a new account"
      operationId: "createBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "billing_account"
        description: "The TRACT billing account in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateBillingAccount"
        x-examples:
          default: "{\n    \"auto_payment_authorized\": false,\n    \"bill_cycle\"\
            : {\n        \"bill_cycle_type\": \"daily\",\n        \"id\": 6\n    },\
            \ \n    \"bill_type\": \"NONE\", \n    \"billing_account_category\": {\n\
            \        \"id\": 4\n    }, \n    \"responsible_party\": {\n      \"party_type\"\
            : \"person\",\n        \"addresses\": [\n            {\n             \
            \   \"purpose\": \"BILLING\", \n                \"city\": \"Austin\",\
            \ \n                \"line1\": \"620 Congress Ave.\",\n              \
            \  \"line2\": \"Suite 100\", \n                \"postal_code\": \"78701\"\
            , \n                \"region_or_state\": \"TX\",\n                \"address_type\"\
            : \"postal\"\n            }\n        ], \n        \"first_name\": \"Johnny\"\
            , \n        \"last_name\": \"Goode\", \n        \"middle_name\": \"Be\"\
            \n    },\n    \"order\": {\n        \"note\": \"Order Note\",\n      \
            \  \"email_receipt\": true,\n        \"purchase_order_number\": \"PO Number\
            \ 1234\",\n        \"referral\": \"Johnny Cash\",\n        \"order_items\"\
            : [\n          {\n                \"order_item_type\": \"product\",\n\
            \                \"product\": {\n                    \"default_quantity\"\
            : 1.0,\n                    \"id\": \"15\",\n                    \"product_type\"\
            : \"customer-subscription\"\n                },\n                \"quantity\"\
            : 1,\n                \"order_items\": [\n                  {\n      \
            \              \"order_item_type\": \"addon\",\n                    \"\
            quantity\": 1,\n                    \"product\": {\n                 \
            \       \"default_quantity\": 1.0,\n                        \"id\": \"\
            14\",\n                        \"product_type\": \"customer-subscription\"\
            \n                    },\n                    \"service_resources\": [\n\
            \                      {\n                        \"resource_type\": \"\
            service\",\n                        \"identifier\": \"API-NG-008\",\n\
            \                        \"category\": {\n                          \"\
            id\": 6\n                        }\n                      }\n        \
            \            ]\n                  }\n              ]\n              }\n\
            \          ]\n    }\n}\n"
      responses:
        201:
          description: "Creation of a billing account was successful"
          schema:
            $ref: "#/definitions/BillingAccount"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 0
  /billing-accounts/{id}:
    get:
      tags:
      - "BillingAccount"
      summary: "Get the billing account specified by the id"
      description: "Get an account"
      operationId: "getBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccount"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "BillingAccount"
      summary: "Update the billing account specified by the id"
      description: "Update an account"
      operationId: "updateBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "billing_account"
        description: "The TRACT billing account in JSON format"
        required: true
        schema:
          $ref: "#/definitions/BillingAccount"
        x-examples:
          default: "{\n    \"auto_payment_authorized\": false,\n    \"external_account_num\"\
            : \"098763554\",\n    \"tax_exempt\": true,\n    \"billing_account_category\"\
            : {\"id\": 123},\n    \"bill_type\": \"EMAIL\",\n    \"payment_term\"\
            : {\"id\": 12}\n}\n"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccount"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 1
  /billing-accounts/{id}/recurring-payments:
    get:
      tags:
      - "BillingAccount"
      - "RecurringPayment"
      summary: "Query current recurring payments. Currently there is only one per\
        \ billing account"
      description: "Query for Recurring Payment"
      operationId: "queryRecurringPaymentsByBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "token"
        in: "query"
        description: "The payment token"
        required: false
        type: "string"
      - name: "valid_from"
        in: "query"
        description: "The valid from date time"
        required: false
        type: "string"
        format: "date-time"
      - name: "valid_to"
        in: "query"
        description: "The valid to date time"
        required: false
        type: "string"
        format: "date-time"
      - name: "auto_payment"
        in: "query"
        description: "Is the payment an auto payment?"
        required: false
        type: "boolean"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            title: "recurring-payments"
            items:
              $ref: "#/definitions/RecurringPayment"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      - "RecurringPayment"
      summary: "Create Recurring Payment"
      description: "Create Recurring Payment"
      operationId: "createRecurringPayment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "recurring_payment"
        description: "The TRACT recurring payment in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateRecurringPayment"
        x-examples:
          default: "{\n    \"payment_method\": {\n        \"card_type\": \"VISA\"\
            , \n        \"custom_field_values\": [], \n        \"expiration_date\"\
            : \"12/2020\", \n        \"first_name\": \"Recurring\", \n        \"identifier_number\"\
            : \"4111111111111111\", \n        \"last_name\": \"Payment\", \n     \
            \   \"payment_method_type\": \"credit-card\", \n        \"verification_number\"\
            : \"123\"\n    }\n}\n"
      responses:
        201:
          description: "Creation of a billing account recurring payment was successful"
          schema:
            $ref: "#/definitions/RecurringPayment"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 2
  /billing-accounts/{id}/recurring-payments/{recurring_payment_id}:
    get:
      tags:
      - "BillingAccount"
      - "RecurringPayment"
      summary: "Query current recurring payments. Currently there is only one per\
        \ billing account"
      description: "Query for a Recurring Payment"
      operationId: "getRecurringPaymentByBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "recurring_payment_id"
        in: "path"
        description: "The id of a TRACT recurring payment"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/RecurringPayment"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 3
  /billing-accounts/{id}/payments:
    get:
      tags:
      - "BillingAccount"
      - "Payment"
      operationId: "queryPaymentsByBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "occurred_on"
        in: "query"
        description: "The date that the payment occurred"
        required: false
        type: "string"
        format: "date-time"
      - name: "reference"
        in: "query"
        description: "The payment reference"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The payment status"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "DRAFT"
        - "PROCESSING"
        - "COMPLETED"
        - "VOID"
        - "PROCESSING_ERROR"
        - "MERCHANT_VERIFICATION"
        - "MERCHANT_VERIFICATION_FAILED"
        - "CANCELED"
        - "ALLOCATION_ERROR"
      - name: "authorization"
        in: "query"
        description: "The payment authorization"
        required: false
        type: "string"
      - name: "unapplied_amount"
        in: "query"
        description: "The unapplied payment amount"
        required: false
        type: "number"
      - name: "token"
        in: "query"
        description: "The payment token"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            title: "payments"
            items:
              $ref: "#/definitions/Payment"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      - "Payment"
      summary: "Create a payment"
      description: "Create payment"
      operationId: "createPayment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "payment"
        description: "The TRACT payment in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreatePayment"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      responses:
        201:
          description: "Creation of a payment was successful"
          schema:
            $ref: "#/definitions/Payment"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 4
  /billing-accounts/{id}/payments/{payment_id}:
    get:
      tags:
      - "BillingAccount"
      - "Payment"
      summary: "Get an existing payment associated with this account"
      description: "Get an existing payment associated with this account"
      operationId: "getPaymentByBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "payment_id"
        in: "path"
        description: "The id of a TRACT payment"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Payment"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 5
  /billing-accounts/{id}/orders:
    get:
      tags:
      - "BillingAccount"
      summary: "Query Orders by BillingAccount"
      description: "Query Orders by BillingAccount"
      operationId: "queryOrdersByBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "order_id"
        in: "query"
        description: "The id of a TRACT order"
        required: false
        type: "string"
      - name: "order_type"
        in: "query"
        description: "The order type"
        required: false
        type: "string"
        enum:
        - "sales"
        - "renewal"
        - "change"
      - name: "order_num"
        in: "query"
        description: "(unique_key) An order number"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The order status"
        required: false
        type: "string"
        enum:
        - "APPROVED"
        - "COMPLETED"
        - "DRAFT"
        - "CANCELED"
        - "ERROR"
        - "IN_PROGRESS"
      - name: "order_date"
        in: "query"
        description: "The date that the order takes place"
        required: false
        type: "string"
        format: "date-time"
      - name: "referral"
        in: "query"
        description: "the order referral"
        required: false
        type: "string"
      - name: "purchase_order_number"
        in: "query"
        description: "An purchase order number"
        required: false
        type: "string"
      - name: "renewal_date"
        in: "query"
        description: "The reneal date for a renewal order"
        required: false
        type: "string"
        format: "date-time"
      - name: "custom_field_id"
        in: "query"
        description: "The id of a TRACT custom field"
        required: false
        type: "string"
      - name: "custom_field_value"
        in: "query"
        description: "A custom field value"
        required: false
        type: "string"
      - name: "custom_field_value_id"
        in: "query"
        description: "The id of a TRACT custom field value"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Order"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      - "Order"
      summary: "Create Order"
      description: "Create Order"
      operationId: "createOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "order"
        description: "The TRACT order in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateSalesOrder"
        x-examples:
          default: "{\n    \"billing_account\": {\n        \"id\": 123456\n    },\n\
            \    \"order_items\": [\n        {\n            \"order_item_type\": \"\
            product\", \n            \"product\": {\n                \"default_quantity\"\
            : 1.0, \n                \"id\": \"15\", \n                \"product_type\"\
            : \"customer-subscription\"\n            }, \n            \"quantity\"\
            : 1\n        }\n    ], \n    \"order_type\": \"sales\"\n}\n"
      responses:
        201:
          description: "Creation of the order was successful"
          schema:
            $ref: "#/definitions/Order"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 6
  /billing-accounts/{id}/orders/{order_id}:
    get:
      tags:
      - "BillingAccount"
      - "Order"
      summary: "Get Order"
      description: "Get Order"
      operationId: "getOrderByBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "order_id"
        in: "path"
        description: "The id of a TRACT order"
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Order"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 7
  /billing-accounts/{id}/custom-field-values:
    get:
      tags:
      - "BillingAccount"
      - "BillingAccountCustomFieldValue"
      summary: "Query for custom field values"
      description: "Query for custom field values"
      operationId: "queryBillingAccountCustomFieldValues"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "custom_field_value"
        in: "query"
        description: "A custom field value"
        required: false
        type: "string"
      - name: "custom_field_name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "custom_field_id"
        in: "query"
        description: "The id of a TRACT custom field"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/BillingAccountCustomFieldValue"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      - "BillingAccountCustomFieldValue"
      summary: "Create a custom field value"
      description: "Create a custom field value and add it to the billing account"
      operationId: "createBillingAccountCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "billing_account_custom_field_value"
        description: "The TRACT billing account custom field value in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateBillingAccountCustomFieldValue"
        x-examples:
          default: "{\n  \"custom_field_value_type\":\"billing-account\",\n  \"value\"\
            : \"value 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
            : \"Test 3\",\n    \"custom_field_type\": \"billing-account\"\n  }\n}\n"
      responses:
        201:
          description: "Creation of a billing account custom field value was successful"
          schema:
            $ref: "#/definitions/BillingAccountCustomFieldValue"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 8
  /billing-accounts/{id}/custom-field-values/{custom_field_value_id}:
    get:
      tags:
      - "BillingAccount"
      - "BillingAccountCustomFieldValue"
      summary: "Get an existing custom field value associated with this account"
      description: "Get an existing custom field value associated with this account"
      operationId: "getBillingAccountCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccountCustomFieldValue"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "BillingAccount"
      - "BillingAccountCustomFieldValue"
      summary: "Update an existing custom field value associated with this account"
      description: "Update an existing custom field value associated with this account"
      operationId: "updateBillingAccountCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      - in: "body"
        name: "billing_account_custom_field_value"
        description: "The TRACT billing account custom field value in JSON format"
        required: true
        schema:
          $ref: "#/definitions/UpdateBillingAccountCustomFieldValue"
        x-examples:
          default: "{\n  \"custom_field_value_type\":\"billing-account\",\n  \"value\"\
            : \"value 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
            : \"Test 3\",\n    \"custom_field_type\": \"billing-account\"\n  }\n}\n"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccountCustomFieldValue"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    delete:
      tags:
      - "BillingAccount"
      - "BillingAccountCustomFieldValue"
      summary: "Remove an existing custom field value associated with this account"
      description: "Remove an existing custom field value associated with this account"
      operationId: "removeBillingAccountCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 2
    x-reprezen-normalization:
      position: 9
  /billing-accounts/{id}/parent:
    get:
      tags:
      - "BillingAccount"
      summary: "Get an existing parent account associated with this account"
      description: "Get an existing parent account associated with this account"
      operationId: "getParentBillingAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccount"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 10
  /billing-accounts/{id}/parent-account-relations:
    get:
      tags:
      - "BillingAccount"
      summary: "Get an existing parent account relations associated with this account"
      description: "Get an existing parent account relations associated with this\
        \ account"
      operationId: "queryParentAccountRelations"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ParentAccountRelation"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      summary: "Add a ParentAccountRelation to the specified BillingAccount"
      description: "Add a ParentAccountRelation to the specified BillingAccount"
      operationId: "createParentAccountRelation"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "create_parent_account_relation"
        description: "The payload for adding a parent billing account relation"
        required: true
        schema:
          $ref: "#/definitions/CreateParentAccountRelation"
        x-examples:
          default: "{\n   \"parent_account\": {\n      \"id\": \"18\"\n   }\n}\n"
      responses:
        201:
          schema:
            $ref: "#/definitions/ParentAccountRelation"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 11
  /billing-accounts/{id}/parent-account-relations/{parent_account_relation_id}:
    get:
      tags:
      - "BillingAccount"
      summary: "Get an specified ParentAccountRelation associated with this account"
      description: "Get an specified ParentAccountRelation associated with this account"
      operationId: "getParentAccountRelation"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "parent_account_relation_id"
        in: "path"
        description: "The id of a TRACT parent billing account relation"
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ParentAccountRelation"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 12
  /billing-accounts/{id}/parent-account-relations/{parent_account_relation_id}/deactivate:
    post:
      tags:
      - "BillingAccount"
      summary: "Set the valid_to property of specified ParentAccountRelation."
      description: "Set the valid_to property of specified ParentAccountRelation.\
        \ In case if payload isn't spesified, valid_to is set to current date."
      operationId: "deactivateParentAccountRelation"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "parent_account_relation_id"
        in: "path"
        description: "The id of a TRACT parent billing account relation"
        required: true
        type: "string"
      - in: "body"
        name: "deactivate_parent_account_relation"
        description: "The payload for deactivation of a parent billing account relation"
        required: false
        schema:
          $ref: "#/definitions/DeactivateParentAccountRelation"
        x-examples:
          default: "{}\n"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 13
  /billing-accounts/{id}/responsible-account:
    get:
      tags:
      - "BillingAccount"
      summary: "Get an existing responsible account associated with this account"
      description: "Get an existing responsible account associated with this account"
      operationId: "getResponsibleAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccount"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "BillingAccount"
      summary: "Add a responsible BillingAccount to the specified BillingAccount"
      description: "Add a responsible BillingAccount to the specified BillingAccount"
      operationId: "addResponsibleAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "change_responsible_account"
        description: "The payload for changing a responsible account"
        required: true
        schema:
          $ref: "#/definitions/ChangeResponsibleAccount"
      responses:
        204:
          description: "Success"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 1
    put:
      tags:
      - "BillingAccount"
      summary: "Change a responsible BillingAccount to the specified BillingAccount"
      description: "Change a responsible BillingAccount to the specified BillingAccount"
      operationId: "changeResponsibleAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "change_responsible_account"
        description: "The payload for changing a responsible account"
        required: true
        schema:
          $ref: "#/definitions/ChangeResponsibleAccount"
      responses:
        204:
          description: "Success"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 2
    delete:
      tags:
      - "BillingAccount"
      summary: "Remove an existing responsible account associated with this account"
      description: "Remove an existing responsible account associated with this account"
      operationId: "removeResponsibleAccount"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountsController"
      x-reprezen-normalization:
        position: 3
    x-reprezen-normalization:
      position: 14
  /recurring-payments:
    get:
      tags:
      - "RecurringPayment"
      operationId: "queryRecurringPayments"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "token"
        in: "query"
        description: "The payment token"
        required: false
        type: "string"
      - name: "valid_from"
        in: "query"
        description: "The valid from date time"
        required: false
        type: "string"
        format: "date-time"
      - name: "valid_to"
        in: "query"
        description: "The valid to date time"
        required: false
        type: "string"
        format: "date-time"
      - name: "auto_payment"
        in: "query"
        description: "Is the payment an auto payment?"
        required: false
        type: "boolean"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/RecurringPayment"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "RecurringPaymentsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 15
  /recurring-payments/{id}:
    get:
      tags:
      - "RecurringPayment"
      summary: "Get an existing recurring payment"
      description: "Get an existing recurring payment"
      operationId: "getRecurringPayment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/RecurringPayment"
          headers:
            PreferenceApplied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "RecurringPaymentsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 16
  /organizations:
    get:
      tags:
      - "Organization"
      operationId: "queryOrganizations"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "organization_name"
        in: "query"
        description: "The name of a TRACT organization"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Organization"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PartiesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 17
  /organizations/{id}:
    get:
      tags:
      - "Organization"
      summary: "Get an existing organization"
      description: "Get an existing organization"
      operationId: "getOrganization"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Organization"
          headers:
            PreferenceApplied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PartiesController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "Organization"
      summary: "Update an existing organization"
      description: "Update an existing organization"
      operationId: "updateOrganization"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "organization"
        description: "The TRACT organization in JSON format"
        required: true
        schema:
          $ref: "#/definitions/UpdateOrganization"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Organization"
          headers:
            PreferenceApplied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PartiesController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 18
  /organizations/{id}/addresses:
    get:
      tags:
      - "Organization"
      summary: "Get organization addresses"
      description: "Get organization addresses"
      operationId: "getOrganizationAddresses"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        201:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Address"
          examples:
            application/json:
            - id: "1438752"
              address_type: "postal"
              purpose: "BILLING"
              country: "USA"
              city: "Kalamazoo"
              region_or_state: "TN"
              attention: "Joe"
              postal_code: "55555"
              line1: "123 Avenue A"
              line2: "Suite 100"
              p_code: 0
              p_code_overridden: true
            - address_type: "email"
              purpose: "PRIMARY"
              email: "some@email.com"
            - address_type: "telecom"
              purpose: "OFFICE"
              dialing_prefix: "+1"
              area_code: "210"
              number: "1234567"
              extension: "89"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrganizationsController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Organization"
      summary: "Add an address to an existing organization."
      description: "Add an address to an existing organization. The payload can be\
        \ any address type email, postal, telecom."
      operationId: "addOrganizationAddress"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "add_address"
        description: "A payload used to add an address"
        required: false
        schema:
          $ref: "#/definitions/CreateAddress"
        x-examples:
          default: "{\n   \"id\": \"1438752\",\n   \"address_type\": \"postal\",\n\
            \   \"purpose\": \"BILLING\",\n   \"country\": \"USA\",\n   \"city\":\
            \ \"Kalamazoo\",\n   \"region_or_state\": \"TN\",\n   \"attention\": \"\
            Joe\",\n   \"postal_code\": \"55555\",\n   \"line1\": \"123 Avenue A\"\
            ,\n   \"line2\": \"Suite 100\",\n   \"p_code\": 0,\n   \"p_code_overridden\"\
            : true\n }"
      responses:
        201:
          description: "Addition of a new address was successful"
          schema:
            $ref: "#/definitions/Address"
          examples:
            id: "1438752"
            address_type: "postal"
            purpose: "BILLING"
            country: "USA"
            city: "Kalamazoo"
            region_or_state: "TN"
            attention: "Joe"
            postal_code: "55555"
            line1: "123 Avenue A"
            line2: "Suite 100"
            p_code: 0
            p_code_overridden: true
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrganizationsController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 19
  /people:
    get:
      tags:
      - "Person"
      operationId: "queryPeople"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "first_name"
        in: "query"
        description: "The first name of a TRACT person"
        required: false
        type: "string"
      - name: "last_name"
        in: "query"
        description: "The last name of a TRACT person"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Person"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PartiesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 20
  /people/{id}:
    get:
      tags:
      - "Person"
      summary: "Get an existing person"
      description: "Get an existing person"
      operationId: "getPerson"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Person"
          headers:
            PreferenceApplied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PartiesController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "Person"
      summary: "Update an existing person"
      description: "Update an existing person"
      operationId: "updatePerson"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "person"
        description: "The TRACT person in JSON format"
        required: true
        schema:
          $ref: "#/definitions/UpdatePerson"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Person"
          headers:
            PreferenceApplied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PartiesController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 21
  /people/{id}/addresses:
    get:
      tags:
      - "Person"
      summary: "Get person addresses"
      description: "Get person addresses"
      operationId: "getPersonAddresses"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        201:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Address"
          examples:
            application/json:
            - id: "1438752"
              address_type: "postal"
              purpose: "BILLING"
              country: "USA"
              city: "Kalamazoo"
              region_or_state: "TN"
              attention: "Joe"
              postal_code: "55555"
              line1: "123 Avenue A"
              line2: "Suite 100"
              p_code: 0
              p_code_overridden: true
            - address_type: "email"
              purpose: "PRIMARY"
              email: "some@email.com"
            - address_type: "telecom"
              purpose: "HOME"
              dialing_prefix: "+1"
              area_code: "210"
              number: "1234567"
              extension: "89"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PersonController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Person"
      summary: "Add an address to an existing person"
      description: "Add an address to an existing person. The payload can be any address\
        \ type email, postal, telecom."
      operationId: "addPersonAddress"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "add_address"
        description: "A payload used to add an address"
        required: false
        schema:
          $ref: "#/definitions/CreateAddress"
        x-examples:
          default: "{\n   \"id\": \"1438752\",\n   \"address_type\": \"postal\",\n\
            \   \"purpose\": \"BILLING\",\n   \"country\": \"USA\",\n   \"city\":\
            \ \"Kalamazoo\",\n   \"region_or_state\": \"TN\",\n   \"attention\": \"\
            Joe\",\n   \"postal_code\": \"55555\",\n   \"line1\": \"123 Avenue A\"\
            ,\n   \"line2\": \"Suite 100\",\n   \"p_code\": 0,\n   \"p_code_overridden\"\
            : true\n }"
      responses:
        201:
          description: "Addition of a new address was successful"
          schema:
            $ref: "#/definitions/Address"
          examples:
            id: "1438752"
            address_type: "postal"
            purpose: "BILLING"
            country: "USA"
            city: "Kalamazoo"
            region_or_state: "TN"
            attention: "Joe"
            postal_code: "55555"
            line1: "123 Avenue A"
            line2: "Suite 100"
            p_code: 0
            p_code_overridden: true
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PersonController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 22
  /bill-cycles:
    get:
      tags:
      - "BillCycle"
      operationId: "queryBillCycles"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "name"
        in: "query"
        description: "The name of a TRACT bill cycle"
        required: false
        type: "string"
      - name: "bill_cycle_type"
        in: "query"
        description: "bill cycle type"
        required: false
        type: "string"
        default: "monthly"
        enum:
        - "daily"
        - "monthly"
        - "quarterly"
        - "yearly"
        - "segmented-monthly"
      - name: "status"
        in: "query"
        description: "Accounting Status"
        required: false
        type: "string"
        default: "ACTIVE"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "CANCELED"
      - name: "currency_code"
        in: "query"
        description: "The currency_code for the amount."
        required: false
        type: "string"
        enum:
        - "USD"
        - "GBP"
        - "EUR"
        - "SEK"
        - "NOK"
        - "DKK"
        - "CAD"
        - "AUD"
        - "ZAR"
        - "NZD"
        - "MXN"
        - "INR"
        - "JPY"
        - "SAR"
        - "QAR"
        - "EGP"
        - "AED"
        - "BHD"
        - "KWD"
        - "OMR"
        - "HKD"
        - "CHF"
        - "ILS"
        - "CNY"
        - "BRL"
        - "PLN"
        - "COP"
        - "PEN"
        - "RUB"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            title: "bill-cycles"
            items:
              $ref: "#/definitions/BillCycle"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillCyclesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 23
  /bill-cycles/{id}:
    get:
      tags:
      - "BillCycle"
      summary: "Get an existing bill cycle"
      description: "Get an existing bill cycle"
      operationId: "getBillCycle"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillCycle"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillCyclesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 24
  /billing-account-categories:
    get:
      tags:
      - "BillingAccountCategory"
      operationId: "queryBillingAccountCategories"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "category_name"
        in: "query"
        description: "Billing Account Category Name"
        required: false
        type: "string"
      - name: "category_description"
        in: "query"
        description: "Billing Account Category Description"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "Billing Account Category Status"
        required: false
        type: "string"
        default: "ACTIVE"
        allowEmptyValue: true
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "CANCELED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/BillingAccountCategory"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountCategoriesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 25
  /billing-account-categories/{id}:
    get:
      tags:
      - "BillingAccountCategory"
      summary: "Get an existing billing account category"
      description: "Get an existing billing account category"
      operationId: "getBillingAccountCategory"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccountCategory"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountCategoriesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 26
  /orders:
    get:
      tags:
      - "Order"
      summary: "Query for orders with the specified query"
      description: "Query TRACT orders"
      operationId: "queryOrders"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "order_type"
        in: "query"
        description: "The order type"
        required: false
        type: "string"
        enum:
        - "sales"
        - "renewal"
        - "change"
      - name: "order_num"
        in: "query"
        description: "(unique_key) An order number"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The order status"
        required: false
        type: "string"
        enum:
        - "APPROVED"
        - "COMPLETED"
        - "DRAFT"
        - "CANCELED"
        - "ERROR"
        - "IN_PROGRESS"
      - name: "order_date"
        in: "query"
        description: "The date that the order takes place"
        required: false
        type: "string"
        format: "date-time"
      - name: "referral"
        in: "query"
        description: "the order referral"
        required: false
        type: "string"
      - name: "purchase_order_number"
        in: "query"
        description: "An purchase order number"
        required: false
        type: "string"
      - name: "renewal_date"
        in: "query"
        description: "The reneal date for a renewal order"
        required: false
        type: "string"
        format: "date-time"
      - name: "custom_field_id"
        in: "query"
        description: "The id of a TRACT custom field"
        required: false
        type: "string"
      - name: "custom_field_value"
        in: "query"
        description: "A custom field value"
        required: false
        type: "string"
      - name: "custom_field_value_id"
        in: "query"
        description: "The id of a TRACT custom field value"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Order"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 27
  /orders/{id}:
    get:
      tags:
      - "Order"
      summary: "Get the order specified by the id"
      description: "Get an account"
      operationId: "getOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Order"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "Order"
      summary: "Update the order specified by the id"
      description: "Update an account"
      operationId: "updateOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "order"
        description: "The TRACT order in JSON format"
        required: true
        schema:
          $ref: "#/definitions/UpdateSalesOrder"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Order"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 1
    delete:
      tags:
      - "Order"
      summary: "Delete Draft Order"
      description: "Delete Draft Order"
      operationId: "voidDraftOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 2
    x-reprezen-normalization:
      position: 28
  /orders/{id}/confirm:
    post:
      tags:
      - "Order"
      summary: "Confirm a Draft Order"
      description: "Confirm a Draft Order"
      operationId: "confirmOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "order"
        description: "Payload used for confirming a DRAFT order"
        required: true
        schema:
          $ref: "#/definitions/ConfirmDraftOrder"
        x-examples:
          default: "{\n    \"payment\": {\n      \"payment_type\": \"payment\",\n\
            \      \"payment_method\": {\n        \"payment_method_type\": \"credit-card\"\
            ,\n      \"card_type\": \"VISA\",\n      \"first_name\": \"Johnny\",\n\
            \      \"middle_name\": \"Be\",\n      \"last_name\": \"Goode\",\n   \
            \   \"suffix\": \"Jr.\",\n      \"identifier_number\": \"4111111111111111\"\
            ,\n      \"verification_number\": \"123\",\n      \"expiration_date\"\
            : \"12/2020\",\n      \"nickname\": \"Default\"\n      },\n      \"amount\"\
            : 60.00\n    }\n}\n"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 29
  /orders/{id}/custom-field-values:
    get:
      tags:
      - "Order"
      - "OrderCustomFieldValue"
      summary: "Query for custom field values"
      description: "Query for custom field values"
      operationId: "queryOrderCustomFieldValues"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "custom_field_value"
        in: "query"
        description: "A custom field value"
        required: false
        type: "string"
      - name: "custom_field_name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "custom_field_id"
        in: "query"
        description: "The id of a TRACT custom field"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/OrderCustomFieldValue"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Order"
      - "OrderCustomFieldValue"
      summary: "Create a custom field value"
      description: "Create a custom field value and add it to the order"
      operationId: "createOrderCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "order_custom_field_value"
        description: "The TRACT order custom field value in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateOrderCustomFieldValue"
        x-examples:
          default: "{\n  \"custom_field_value_type\":\"order\",\n  \"value\": \"value\
            \ 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\": \"\
            Test 3\",\n    \"custom_field_type\": \"order\"\n  }\n}\n"
      responses:
        201:
          description: "Creation of a billing account custom field value was successful"
          schema:
            $ref: "#/definitions/OrderCustomFieldValue"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 30
  /orders/{id}/custom-field-values/{custom_field_value_id}:
    get:
      tags:
      - "Order"
      - "OrderCustomFieldValue"
      summary: "Get an existing custom field value associated with this account"
      description: "Get an existing custom field value associated with this account"
      operationId: "getOrderCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/OrderCustomFieldValue"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "Order"
      - "OrderCustomFieldValue"
      summary: "Get an existing custom field value associated with this account"
      description: "Get an existing custom field value associated with this account"
      operationId: "updateOrderCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      - in: "body"
        name: "order_custom_field_value"
        description: "The TRACT order custom field value in JSON format"
        required: true
        schema:
          $ref: "#/definitions/UpdateOrderCustomFieldValue"
        x-examples:
          default: "{\n  \"custom_field_value_type\":\"order\",\n  \"value\": \"value\
            \ 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\": \"\
            Test 3\",\n    \"custom_field_type\": \"order\"\n  }\n}\n"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/OrderCustomFieldValue"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 1
    delete:
      tags:
      - "Order"
      - "OrderCustomFieldValue"
      summary: "Remove an existing custom field value associated with this account"
      description: "Remove an existing custom field value associated with this account"
      operationId: "removeOrderCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 2
    x-reprezen-normalization:
      position: 31
  /orders/{id}/payments:
    get:
      tags:
      - "Order"
      - "Payment"
      operationId: "queryPaymentsByOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "occurred_on"
        in: "query"
        description: "The date that the payment occurred"
        required: false
        type: "string"
        format: "date-time"
      - name: "reference"
        in: "query"
        description: "The payment reference"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The payment status"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "DRAFT"
        - "PROCESSING"
        - "COMPLETED"
        - "VOID"
        - "PROCESSING_ERROR"
        - "MERCHANT_VERIFICATION"
        - "MERCHANT_VERIFICATION_FAILED"
        - "CANCELED"
        - "ALLOCATION_ERROR"
      - name: "authorization"
        in: "query"
        description: "The payment authorization"
        required: false
        type: "string"
      - name: "unapplied_amount"
        in: "query"
        description: "The unapplied payment amount"
        required: false
        type: "number"
      - name: "token"
        in: "query"
        description: "The payment token"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Payment"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 32
  /orders/{id}/payments/{payment_id}:
    get:
      tags:
      - "Order"
      - "Payment"
      summary: "Get an existing payment associated with this order"
      description: "Get an existing payment associated with this order"
      operationId: "getPaymentByOrder"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "payment_id"
        in: "path"
        description: "The id of a TRACT payment"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Payment"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrdersController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 33
  /services:
    get:
      tags:
      - "Service"
      operationId: "queryServices"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The status of a TRACT service"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "DEACTIVATED"
        - "PENDING"
        - "CANCELED"
        - "TRANSFERRED"
        - "REPLACED"
        - "TRIAL"
        - "SCHEDULED"
      - name: "start_date"
        in: "query"
        description: "The start date of a TRACT service"
        required: false
        type: "string"
        format: "date-time"
      - name: "end_date"
        in: "query"
        description: "The end date of a TRACT service"
        required: false
        type: "string"
        format: "date-time"
      - name: "parent_id"
        in: "query"
        description: "The id of a TRACT parent service"
        required: false
        type: "string"
      - name: "previous_service_id"
        in: "query"
        description: "The id of the previous TRACT service"
        required: false
        type: "string"
      - name: "next_service_id"
        in: "query"
        description: "The id of  the next TRACT service"
        required: false
        type: "string"
      - name: "original_order_id"
        in: "query"
        description: "The id of a TRACT service relation"
        required: false
        type: "string"
      - name: "original_order_num"
        in: "query"
        description: "The order number of an order that created a TRACT service"
        required: false
        type: "string"
      - name: "original_order_item_sequence"
        in: "query"
        description: "The order item sequence number for an order item on a service"
        required: false
        type: "integer"
        format: "int32"
      - name: "renewal_count"
        in: "query"
        description: "The renewal count for a renewal service"
        required: false
        type: "integer"
        format: "int32"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "agreement_id"
        in: "query"
        description: "The id of a TRACT agreement"
        required: false
        type: "string"
      - name: "service_resource_identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
        maxLength: 255
      - name: "usage_pool_id"
        in: "query"
        description: "The id of a TRACT usage_pool"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Service"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 34
  /services/{id}:
    get:
      tags:
      - "Service"
      summary: "Get an existing service associated with this service"
      description: "Get an existing service associated with this service"
      operationId: "getService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Service"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 35
  /services/{id}/addresses:
    get:
      tags:
      - "Service"
      summary: "Get the addresses associated with an existing service associated"
      description: "Get the addresses associated with an existing service associated"
      operationId: "queryServiceAddresses"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/PostalAddress"
            maxItems: 50
          examples:
            application/json:
            - id: "1438752"
              address_type: "postal"
              purpose: "SERVICE"
              country: "USA"
              city: "Kalamazoo"
              region_or_state: "TN"
              attention: "Joe"
              postal_code: "55555"
              line1: "123 Avenue A"
              line2: "Suite 100"
              p_code: 0
              p_code_overridden: true
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Service"
      summary: "Add a service address to an existing service"
      description: "Add a service address to an existing service"
      operationId: "addServiceAddress"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "add_service_address"
        description: "A payload used to add a service address"
        required: true
        schema:
          $ref: "#/definitions/AddServiceAddress"
        x-examples:
          default: "{\n  \"address\": {\n        \"address_type\": \"postal\",\n \
            \       \"purpose\": \"SERVICE\",\n        \"country\": \"USA\",\n   \
            \     \"city\": \"Kalamazoo\",\n        \"region_or_state\": \"TN\",\n\
            \        \"attention\": \"Joe\",\n        \"postal_code\": \"55555\",\n\
            \        \"line1\": \"123 Avenue A\",\n        \"line2\": \"Suite 100\"\
            ,\n        \"p_code\": 0,\n        \"p_code_overridden\": true\n     \
            \ }\n }\n"
      responses:
        201:
          description: "Addition of a new service address was successful"
          schema:
            $ref: "#/definitions/PostalAddress"
          examples:
            id: "1438752"
            address_type: "postal"
            purpose: "SERVICE"
            country: "USA"
            city: "Kalamazoo"
            region_or_state: "TN"
            attention: "Joe"
            postal_code: "55555"
            line1: "123 Avenue A"
            line2: "Suite 100"
            p_code: 0
            p_code_overridden: true
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 36
  /services/{id}/deactivate:
    post:
      tags:
      - "Service"
      summary: "Deactivate a service"
      description: "Deactivate a service"
      operationId: "deactivateService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "deactivate_service"
        description: "The payload to deactivate a service"
        required: true
        schema:
          $ref: "#/definitions/DeactivateService"
        x-examples:
          default: "{\n    \"reason\": {\n        \"reason_type\" : \"service-deactivation\"\
            ,\n        \"id\" :  5432167\n    },\n   \"effective_date\": \"2017-02-14T18:20:10.382-06:00\"\
            \n}\n"
      responses:
        204:
          description: "Deactivation was successful"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 37
  /services/{id}/custom-field-values:
    get:
      tags:
      - "Service"
      - "ServiceCustomFieldValue"
      summary: "Query for custom field values"
      description: "Query for custom field values"
      operationId: "queryServiceCustomFieldValues"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "custom_field_value"
        in: "query"
        description: "A custom field value"
        required: false
        type: "string"
      - name: "custom_field_name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "custom_field_id"
        in: "query"
        description: "The id of a TRACT custom field"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ServiceCustomFieldValue"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Service"
      - "ServiceCustomFieldValue"
      summary: "Create a custom field value"
      description: "Create a custom field value and add it to the service"
      operationId: "createServiceCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "service_custom_field_value"
        description: "The TRACT service custom field value in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateServiceCustomFieldValue"
        x-examples:
          default: "{\n  \"custom_field_value_type\":\"service\",\n  \"value\": \"\
            value 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
            : \"Test 3\",\n    \"custom_field_type\": \"service\"\n  }\n}\n"
      responses:
        201:
          description: "Creation of a billing account custom field value was successful"
          schema:
            $ref: "#/definitions/ServiceCustomFieldValue"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 38
  /services/{id}/custom-field-values/{custom_field_value_id}:
    get:
      tags:
      - "Service"
      - "ServiceCustomFieldValue"
      summary: "Get an existing custom field value associated with this service"
      description: "Get an existing custom field value associated with this service"
      operationId: "getServiceCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceCustomFieldValue"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "Service"
      - "ServiceCustomFieldValue"
      summary: "Update an existing custom field value associated with this service"
      description: "Update an existing custom field value associated with this service"
      operationId: "updateServiceCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      - in: "body"
        name: "service_custom_field_value"
        description: "The TRACT service custom field value in JSON format"
        required: true
        schema:
          $ref: "#/definitions/UpdateServiceCustomFieldValue"
        x-examples:
          default: "{\n  \"custom_field_value_type\":\"service\",\n  \"value\": \"\
            value 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
            : \"Test 3\",\n    \"custom_field_type\": \"service\"\n  }\n}\n"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceCustomFieldValue"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 1
    delete:
      tags:
      - "Service"
      - "ServiceCustomFieldValue"
      summary: "Remove an existing custom field value associated with this account"
      description: "Remove an existing custom field value associated with this account"
      operationId: "removeServiceCustomFieldValue"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "custom_field_value_id"
        in: "path"
        description: "The id of a TRACT custom field value"
        required: true
        type: "string"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 2
    x-reprezen-normalization:
      position: 39
  /services/{id}/service-resources:
    get:
      tags:
      - "Service"
      - "ServiceResource"
      operationId: "queryServiceResourcesByService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
        maxLength: 255
      - name: "resource_category_id"
        in: "query"
        description: "The id of a TRACT service resource category"
        required: false
        type: "string"
      - name: "order_item_id"
        in: "query"
        description: "The order item id"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The status of a TRACT service resource category"
        required: false
        type: "string"
        enum:
        - "REQUESTED"
        - "AVAILABLE"
        - "ACTIVE"
        - "DEACTIVATED"
        - "QUARANTINED"
        - "USED"
        - "RESERVED"
      - name: "description"
        in: "query"
        description: "The description of a TRACT service resource category"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ServiceResource"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Service"
      - "ServiceResource"
      description: "Add service resource to specified service"
      operationId: "addServiceResource"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "add_service_resource"
        description: "The TRACT service resource"
        required: true
        schema:
          $ref: "#/definitions/AddServiceResource"
      responses:
        200:
          description: "Adding of a existiong service resource to specified service\
            \ was successful"
          schema:
            $ref: "#/definitions/ServiceResource"
          x-reprezen-normalization:
            position: 0
        201:
          description: "Creation of a new service resource was successful"
          schema:
            $ref: "#/definitions/ServiceResource"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 1
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 2
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 3
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 4
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 5
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 6
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 40
  /services/{id}/service-resources/{service_resource_id}:
    get:
      tags:
      - "Service"
      - "ServiceResource"
      description: "Get an existing service resource associated with this service"
      operationId: "getServiceResourceByService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "service_resource_id"
        in: "path"
        description: "The id of a TRACT service resource"
        required: true
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceResource"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 0
    delete:
      tags:
      - "Service"
      - "ServiceResource"
      description: "Remove an existing service resource associated with this service"
      operationId: "removeServiceResources"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "service_resource_id"
        in: "path"
        description: "The id of a TRACT service resource"
        required: true
        type: "string"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServicesController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 41
  /credit-adjustments:
    get:
      tags:
      - "Adjustment"
      operationId: "queryCreditAdjustments"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "status"
        in: "query"
        description: "The TRACT adjustment status"
        required: false
        type: "string"
        enum:
        - "PENDING"
        - "POSTED"
        - "REVERSED"
      - name: "invoice_id"
        in: "query"
        description: "The id of a TRACT invoice"
        required: false
        type: "string"
      - name: "invoice_num"
        in: "query"
        description: "The number of a TRACT invoice"
        required: false
        type: "string"
      - name: "occurred_on"
        in: "query"
        description: "The date that the adjustment occurred"
        required: false
        type: "string"
        format: "date-time"
      - name: "unapplied_amount"
        in: "query"
        description: "The unapplied adjustment amount"
        required: false
        type: "number"
      - name: "credit_number"
        in: "query"
        description: "The cdit number"
        required: false
        type: "number"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/CreditAccountAdjustment"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Adjustment"
      summary: "Create a credit adjustment"
      operationId: "createCreditAdjustment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "adjustment"
        description: "The TRACT adjustment in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateAccountAdjustment"
        x-examples:
          default: "{\n   \"amount\":3,\n   \"description\":\"Some description\",\n\
            \   \"reason\":{\n      \"id\":\"5\"\n   },\n   \"billing_account\":{\n\
            \      \"id\":\"15\"\n   }\n}"
      responses:
        201:
          description: "Creation of an adjustment was successful"
          schema:
            $ref: "#/definitions/CreditAccountAdjustment"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 42
  /credit-adjustments/{id}:
    get:
      tags:
      - "Adjustment"
      operationId: "getCreditAdjustment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/CreditAccountAdjustment"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 43
  /credit-adjustments/{id}/post:
    post:
      tags:
      - "Adjustment"
      operationId: "postCreditAdjustment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        204:
          description: "Success"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 44
  /debit-adjustments:
    get:
      tags:
      - "Adjustment"
      operationId: "queryDebitAdjustments"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "status"
        in: "query"
        description: "The TRACT adjustment status"
        required: false
        type: "string"
        enum:
        - "PENDING"
        - "POSTED"
        - "REVERSED"
      - name: "invoice_id"
        in: "query"
        description: "The id of a TRACT invoice"
        required: false
        type: "string"
      - name: "invoice_num"
        in: "query"
        description: "The number of a TRACT invoice"
        required: false
        type: "string"
      - name: "occurred_on"
        in: "query"
        description: "The date that the adjustment occurred"
        required: false
        type: "string"
        format: "date-time"
      - name: "unapplied_amount"
        in: "query"
        description: "The unapplied adjustment amount"
        required: false
        type: "number"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/DebitAccountAdjustment"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 0
    post:
      tags:
      - "Adjustment"
      summary: "Create a debit adjustment"
      operationId: "createDebitAdjustment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - in: "body"
        name: "adjustment"
        description: "The TRACT adjustment in JSON format"
        required: true
        schema:
          $ref: "#/definitions/CreateAccountAdjustment"
        x-examples:
          default: "{\n   \"amount\":3,\n   \"description\":\"Some description\",\n\
            \   \"reason\":{\n      \"id\":\"5\"\n   },\n   \"billing_account\":{\n\
            \      \"id\":\"15\"\n   }\n}"
      responses:
        201:
          description: "Creation of an adjustment was successful"
          schema:
            $ref: "#/definitions/DebitAccountAdjustment"
          headers:
            Location:
              type: "string"
              format: "url"
              description: "The HTTP Location header. Specifies the location of the\
                \ new resource"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 45
  /debit-adjustments/{id}:
    get:
      tags:
      - "Adjustment"
      operationId: "getDebitAdjustment"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/DebitAccountAdjustment"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 46
  /invoices:
    get:
      tags:
      - "Invoice"
      operationId: "queryInvoices"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "invoice_num"
        in: "query"
        description: "The number of a TRACT invoice"
        required: false
        type: "string"
      - name: "occurred_on"
        in: "query"
        description: "The TRACT  invoice occured on date"
        required: false
        type: "string"
        format: "date-time"
      - name: "due_date"
        in: "query"
        description: "The TRACT  invoice due date"
        required: false
        type: "string"
        format: "date"
      - name: "status"
        in: "query"
        description: "The TRACT status"
        required: false
        type: "string"
        default: "OPEN"
        enum:
        - "PROCESSING"
        - "OPEN"
        - "CLOSED"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "discount_code_service_id"
        in: "query"
        description: "The discount code service id limit"
        required: false
        type: "string"
      - name: "bill_cycle_run_id"
        in: "query"
        description: "The if of a TRACT bill cycle run"
        required: false
        type: "string"
      - name: "adjustment_id"
        in: "query"
        description: "The id of a TRACT adjustment"
        required: false
        type: "string"
      - name: "usage_event_id"
        in: "query"
        description: "The id of a TRACT usage_event"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            title: "invoices"
            items:
              $ref: "#/definitions/Invoice"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "InvoicesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 47
  /invoices/{id}:
    get:
      tags:
      - "Invoice"
      summary: "Get an existing bill cycle"
      description: "Get an existing bill cycle"
      operationId: "getInvoice"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Invoice"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "InvoicesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 48
  /invoices/{id}/downloads:
    get:
      tags:
      - "Invoice"
      summary: "Download an existing bill cycle in the specified format"
      description: "Download an existing bill cycle"
      operationId: "getRenderedInvoice"
      consumes:
      - "application/json"
      produces:
      - "application/pdf"
      - "text/csv"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "file"
            description: "Invoice formated as specified by the request media type"
            title: "Invoice"
          headers:
            Content-Length:
              type: "integer"
              format: "int64"
            Content-Type:
              type: "string"
              description: "Content-Type HTTP header"
            Content-Disposition:
              type: "string"
              description: "Content-Disposition HTTP header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        415:
          description: "Unsupported Media Type"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "InvoicesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 49
  /payment-applications:
    get:
      tags:
      - "PaymentApplication"
      operationId: "queryPaymentApplications"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "payment_id"
        in: "query"
        description: "The payment id"
        required: false
        type: "string"
      - name: "invoice_id"
        in: "query"
        description: "The id of a TRACT invoice"
        required: false
        type: "string"
      - name: "invoice_num"
        in: "query"
        description: "The number of a TRACT invoice"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "occurred_on"
        in: "query"
        description: "The date that the payment occurred"
        required: false
        type: "string"
        format: "date-time"
      - name: "updated_on"
        in: "query"
        description: "The date that the payment-application updated"
        required: false
        type: "string"
        format: "date-time"
      - name: "unapplied_amount"
        in: "query"
        description: "The unapplied payment amount"
        required: false
        type: "number"
      - name: "payment_application_type"
        in: "query"
        description: "The payment application type"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "standard-invoice"
        - "reversed-invoice"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/PaymentApplication"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentApplicationController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 50
  /payment-applications/{id}:
    get:
      tags:
      - "PaymentApplication"
      operationId: "getPaymentApplication"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/PaymentApplication"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentApplicationController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 51
  /actions:
    get:
      tags:
      - "Action"
      operationId: "queryActions"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "action_type"
        in: "query"
        required: false
        type: "string"
        enum:
        - "billing-account"
        - "product-sale"
        - "service"
        - "service-cfv"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Action"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ActionController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 52
  /actions/{id}:
    get:
      tags:
      - "Action"
      operationId: "getAction"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Action"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ActionController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 53
  /operations:
    get:
      tags:
      - "Operation"
      operationId: "queryOperations"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of action"
        required: false
        type: "string"
      - name: "action_id"
        in: "query"
        description: "The id of a TRACT action"
        required: false
        type: "string"
      - name: "operation_type"
        in: "query"
        required: false
        type: "string"
        enum:
        - "approval"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Operation"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OperationController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 54
  /operations/{id}:
    get:
      tags:
      - "Operation"
      operationId: "getOperation"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Operation"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OperationController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 55
  /payment-terms:
    get:
      tags:
      - "PaymentTerm"
      operationId: "queryPaymentTerms"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The payment term name"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "billing_account_category_id"
        in: "query"
        description: "The id of a TRACT billing account category"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/PaymentTerm"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentTermController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 56
  /payment-terms/{id}:
    get:
      tags:
      - "PaymentTerm"
      operationId: "getPaymentTerm"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/PaymentTerm"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentTermController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 57
  /billing-account-deactivation-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryBillingAccountDeactivationReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/BillingAccountDeactivationReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountDeactivationReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 58
  /billing-account-deactivation-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getBillingAccountDeactivationReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccountDeactivationReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountDeactivationReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 59
  /billing-account-suspension-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryBillingAccountSuspensionReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/BillingAccountSuspensionReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountSuspensionReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 60
  /billing-account-suspension-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getBillingAccountSuspensionReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccountSuspensionReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountSuspensionReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 61
  /service-deactivation-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryServiceDeactivationReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ServiceDeactivationReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceDeactivationReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 62
  /service-deactivation-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getServiceDeactivationReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceDeactivationReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceDeactivationReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 63
  /service-suspension-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryServiceSuspensionReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ServiceSuspensionReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceSuspensionReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 64
  /service-suspension-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getServiceSuspensionReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceSuspensionReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceSuspensionReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 65
  /payment-change-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryPaymentChangeReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/PaymentChangeReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentChangeReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 66
  /payment-change-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getPaymentChangeReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/PaymentChangeReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentChangeReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 67
  /credit-adjustment-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryCreditAdjustmentReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An reason status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "CANCELED"
      - name: "level"
        in: "query"
        description: "An adjustment reason level"
        required: false
        type: "string"
        enum:
        - "PRIMARY"
        - "SECONDARY"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/CreditAdjustmentReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "CreditAdjustmentReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 68
  /credit-adjustment-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getCreditAdjustmentReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/CreditAdjustmentReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "CreditAdjustmentReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 69
  /debit-adjustment-reasons:
    get:
      tags:
      - "Reason"
      operationId: "queryDebitAdjustmentReasons"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT reason"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An reason status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "CANCELED"
      - name: "level"
        in: "query"
        description: "An adjustment reason level"
        required: false
        type: "string"
        enum:
        - "PRIMARY"
        - "SECONDARY"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/DebitAdjustmentReason"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "DebitAdjustmentReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 70
  /debit-adjustment-reasons/{id}:
    get:
      tags:
      - "Reason"
      operationId: "getDebitAdjustmentReason"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/DebitAdjustmentReason"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "DebitAdjustmentReasonController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 71
  /billing-account-custom-fields:
    get:
      tags:
      - "BillingAccountCustomField"
      operationId: "queryBillingAccountCustomFields"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "enabled"
        in: "query"
        description: "The enabled property of a TRACT custom field"
        required: false
        type: "boolean"
      - name: "searchable"
        in: "query"
        description: "The searchable property of a TRACT custom field"
        required: false
        type: "boolean"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/BillingAccountCustomField"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 72
  /billing-account-custom-fields/{id}:
    get:
      tags:
      - "BillingAccountCustomField"
      summary: "Get an existing custom-field-value associated with this account"
      description: "Get an existing custom-field-value associated with this account"
      operationId: "getBillingAccountCustomField"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BillingAccountCustomField"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 73
  /billing-account-custom-fields/{id}/references:
    get:
      tags:
      - "BillingAccountCustomField"
      operationId: "queryBillingAccountCustomFieldValueReferences"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An custom field value reference status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/CustomFieldValueReference"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "BillingAccountCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 74
  /order-custom-fields:
    get:
      tags:
      - "OrderCustomField"
      operationId: "queryOrderCustomFields"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "enabled"
        in: "query"
        description: "The enabled property of a TRACT custom field"
        required: false
        type: "boolean"
      - name: "searchable"
        in: "query"
        description: "The searchable property of a TRACT custom field"
        required: false
        type: "boolean"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/OrderCustomField"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrderCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 75
  /order-custom-fields/{id}:
    get:
      tags:
      - "OrderCustomField"
      summary: "Get an existing custom-field-value associated with this account"
      description: "Get an existing custom-field-value associated with this account"
      operationId: "getOrderCustomField"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/OrderCustomField"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrderCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 76
  /order-custom-fields/{id}/references:
    get:
      tags:
      - "OrderCustomField"
      operationId: "queryOrderCustomFieldValueReferences"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An custom field value reference status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/CustomFieldValueReference"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrderCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 77
  /service-custom-fields:
    get:
      tags:
      - "ServiceCustomField"
      operationId: "queryServiceCustomFields"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "enabled"
        in: "query"
        description: "The enabled property of a TRACT custom field"
        required: false
        type: "boolean"
      - name: "searchable"
        in: "query"
        description: "The searchable property of a TRACT custom field"
        required: false
        type: "boolean"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ServiceCustomField"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 78
  /service-custom-fields/{id}:
    get:
      tags:
      - "ServiceCustomField"
      summary: "Get an existing custom-field-value associated with this account"
      description: "Get an existing custom-field-value associated with this account"
      operationId: "getServiceCustomField"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceCustomField"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 79
  /service-custom-fields/{id}/references:
    get:
      tags:
      - "ServiceCustomField"
      operationId: "queryServiceCustomFieldValueReferences"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An custom field value reference status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/CustomFieldValueReference"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 80
  /payment-method-custom-fields:
    get:
      tags:
      - "PaymentMethodCustomField"
      operationId: "queryPaymentMethodCustomFields"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of a TRACT custom field"
        required: false
        type: "string"
      - name: "enabled"
        in: "query"
        description: "The enabled property of a TRACT custom field"
        required: false
        type: "boolean"
      - name: "searchable"
        in: "query"
        description: "The searchable property of a TRACT custom field"
        required: false
        type: "boolean"
      - name: "payment_method_type"
        in: "query"
        description: "The payment method type"
        required: false
        type: "string"
        enum:
        - "bank"
        - "credit-card"
        - "cash"
        - "check"
        - "referenced-credit-card"
        - "paypal"
        - "pay-by-paypal"
        - "wire"
        - "mobile-carrier"
        - "custom"
        - "sepa-dd"
        - "sepa-dd-em"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/PaymentMethodCustomField"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentMethodCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 81
  /payment-method-custom-fields/{id}:
    get:
      tags:
      - "PaymentMethodCustomField"
      summary: "Get an existing custom-field-value associated with this account"
      description: "Get an existing custom-field-value associated with this account"
      operationId: "getPaymentMethodCustomField"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/PaymentMethodCustomField"
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentMethodCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 82
  /payment-method-custom-fields/{id}/references:
    get:
      tags:
      - "PaymentMethodCustomField"
      operationId: "queryPaymentMethodCustomFieldValueReferences"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An custom field value reference status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/CustomFieldValueReference"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PaymentMethodCustomFieldController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 83
  /order-items:
    get:
      tags:
      - "OrderItem"
      summary: "Query for order items with the specified query"
      description: "Query TRACT order items"
      operationId: "queryOrderItems"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "parent_order_item_id"
        in: "query"
        description: "The parent order item id"
        required: false
        type: "string"
      - name: "order_item_status"
        in: "query"
        description: "the order-item status"
        required: false
        type: "string"
        enum:
        - "TRIAL"
        - "FULFILLMENT"
        - "IN_PROGRESS"
        - "COMPLETED"
        - "CANCELED"
        - "DENIED"
        - "ERROR"
        - "DRAFT"
      - name: "order_id"
        in: "query"
        description: "The id of a TRACT order"
        required: false
        type: "string"
      - name: "order_num"
        in: "query"
        description: "(unique_key) An order number"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "service_id"
        in: "query"
        description: "The id of a TRACT service"
        required: false
        type: "string"
      - name: "service_resource_identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
        maxLength: 255
      - name: "discount_resource_identifier"
        in: "query"
        description: "The resource of a TRACT discount"
        required: false
        type: "string"
        maxLength: 255
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "product_type"
        in: "query"
        description: "The type of a TRACT product"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "tract-subscription"
        - "customer-subscription"
        - "general"
        - "addon"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/OrderItem"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrderItemsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 84
  /order-items/{id}:
    get:
      tags:
      - "OrderItem"
      summary: "Get the order item specified by the id"
      description: "Get an order-item"
      operationId: "getOrderItem"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/OrderItem"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrderItemsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 85
  /order-items/{id}/approve:
    post:
      tags:
      - "OrderItem"
      summary: "Approve an OrderItem"
      description: "Approve an OrderItem"
      operationId: "approveOrderItem"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "approve_order_item"
        description: "The payload to approve an order-item"
        required: true
        schema:
          $ref: "#/definitions/ApproveOrderItem"
        x-examples:
          default: "{\n   \"approval_date\":\"2017-02-14T18:20:10.382-06:00\"\n}\n"
      responses:
        204:
          description: "Successful request. No Content returned"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 3
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 4
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 5
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "OrderItemsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 86
  /price-lists:
    get:
      tags:
      - "PriceList"
      operationId: "queryPriceLists"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of a TRACT price list"
        required: false
        type: "string"
      - name: "description"
        in: "query"
        description: "The description of a TRACT price list"
        required: false
        type: "string"
      - name: "market_place_id"
        in: "query"
        description: "The market place  id of a TRACT price list"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/PriceList"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PriceListController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 87
  /price-lists/{id}:
    get:
      tags:
      - "PriceList"
      operationId: "getPriceList"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/PriceList"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "PriceListController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 88
  /agreements:
    get:
      tags:
      - "Agreement"
      operationId: "queryAgreements"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "valid_from"
        in: "query"
        description: "The valid from date"
        required: false
        type: "string"
        format: "date"
      - name: "valid_to"
        in: "query"
        description: "The valid to date"
        required: false
        type: "string"
        format: "date"
      - name: "name"
        in: "query"
        description: "The name of a TRACT agreement"
        required: false
        type: "string"
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The status of a TRACT agreement"
        required: false
        type: "string"
      - name: "termination_fee_currency_code"
        in: "query"
        description: "The currency code for agreement termination fee"
        required: false
        type: "string"
        enum:
        - "USD"
        - "GBP"
        - "EUR"
        - "SEK"
        - "NOK"
        - "DKK"
        - "CAD"
        - "AUD"
        - "ZAR"
        - "NZD"
        - "MXN"
        - "INR"
        - "JPY"
        - "SAR"
        - "QAR"
        - "EGP"
        - "AED"
        - "BHD"
        - "KWD"
        - "OMR"
        - "HKD"
        - "CHF"
        - "ILS"
        - "CNY"
        - "BRL"
        - "PLN"
        - "COP"
        - "PEN"
        - "RUB"
      - name: "max_termination_fee_currency_code"
        in: "query"
        description: "The currency code for max agreement termination fee"
        required: false
        type: "string"
        enum:
        - "USD"
        - "GBP"
        - "EUR"
        - "SEK"
        - "NOK"
        - "DKK"
        - "CAD"
        - "AUD"
        - "ZAR"
        - "NZD"
        - "MXN"
        - "INR"
        - "JPY"
        - "SAR"
        - "QAR"
        - "EGP"
        - "AED"
        - "BHD"
        - "KWD"
        - "OMR"
        - "HKD"
        - "CHF"
        - "ILS"
        - "CNY"
        - "BRL"
        - "PLN"
        - "COP"
        - "PEN"
        - "RUB"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Agreement"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AgreementController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 89
  /agreements/{id}:
    get:
      tags:
      - "Agreement"
      operationId: "getAgreement"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Agreement"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AgreementController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 90
  /agreement-services:
    get:
      tags:
      - "AgreementService"
      operationId: "queryAgreementServices"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "service_id"
        in: "query"
        description: "The id of a TRACT service"
        required: false
        type: "string"
      - name: "service_resource_identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
        maxLength: 255
      - name: "child_service_resource_identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "status"
        in: "query"
        description: "The status of a TRACT service"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "DEACTIVATED"
        - "PENDING"
        - "CANCELED"
        - "TRANSFERRED"
        - "REPLACED"
        - "TRIAL"
        - "SCHEDULED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/AgreementService"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AgreementServiceController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 91
  /agreement-services/{id}:
    get:
      tags:
      - "AgreementService"
      operationId: "getAgreementService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/AgreementService"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AgreementServiceController"
      x-reprezen-normalization:
        position: 0
    put:
      tags:
      - "AgreementService"
      operationId: "updateAgreementService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - in: "body"
        name: "agreement_service"
        description: "The payload to update an agreement service"
        required: true
        schema:
          $ref: "#/definitions/UpdateAgreementService"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/AgreementService"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AgreementServiceController"
      x-reprezen-normalization:
        position: 1
    x-reprezen-normalization:
      position: 92
  /products:
    get:
      tags:
      - "Product"
      operationId: "queryProducts"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of a TRACT product"
        required: false
        type: "string"
      - name: "internal_name"
        in: "query"
        description: "The internal name of a TRACT product"
        required: false
        type: "string"
      - name: "external_product_number"
        in: "query"
        description: "The external product number of a TRACT product"
        required: false
        type: "string"
      - name: "sku"
        in: "query"
        description: "The sku of a TRACT product"
        required: false
        type: "string"
      - name: "product_type"
        in: "query"
        description: "The type of a TRACT product"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "tract-subscription"
        - "customer-subscription"
        - "general"
        - "addon"
      - name: "product_state"
        in: "query"
        description: "The state  of a TRACT product"
        required: false
        type: "string"
        allowEmptyValue: true
        enum:
        - "DRAFT"
        - "AVAILABLE"
        - "NOT_AVAILABLE"
      - name: "product_category_id"
        in: "query"
        description: "The product category id of a TRACT product"
        required: false
        type: "string"
      - name: "product_category_name"
        in: "query"
        description: "The product category name of a TRACT product"
        required: false
        type: "string"
      - name: "currency_code"
        in: "query"
        description: "The currency_code for the amount."
        required: false
        type: "string"
        enum:
        - "USD"
        - "GBP"
        - "EUR"
        - "SEK"
        - "NOK"
        - "DKK"
        - "CAD"
        - "AUD"
        - "ZAR"
        - "NZD"
        - "MXN"
        - "INR"
        - "JPY"
        - "SAR"
        - "QAR"
        - "EGP"
        - "AED"
        - "BHD"
        - "KWD"
        - "OMR"
        - "HKD"
        - "CHF"
        - "ILS"
        - "CNY"
        - "BRL"
        - "PLN"
        - "COP"
        - "PEN"
        - "RUB"
      - name: "product_tag_id"
        in: "query"
        description: "The product tag id of a TRACT product"
        required: false
        type: "string"
      - name: "discount_code_id"
        in: "query"
        description: "The id of a TRACT discount code"
        required: false
        type: "string"
      - name: "discount_resource_identifier"
        in: "query"
        description: "The resource of a TRACT discount"
        required: false
        type: "string"
        maxLength: 255
      - name: "agreement_id"
        in: "query"
        description: "The id of a TRACT agreement"
        required: false
        type: "string"
      - name: "resource_category_id"
        in: "query"
        description: "The id of a TRACT service resource category"
        required: false
        type: "string"
      - name: "resource_category_name"
        in: "query"
        description: "The name of a TRACT service resource category"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/Product"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ProductsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 93
  /products/{id}:
    get:
      tags:
      - "Product"
      summary: "Get an existing product"
      description: "Get an existing product"
      operationId: "getProduct"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/Product"
          headers:
            PreferenceApplied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ProductsController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 94
  /recurring-product-prices:
    get:
      tags:
      - "RecurringProductPrice"
      operationId: "queryRecurringProductPrices"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "from_date"
        in: "query"
        description: "the from date"
        required: false
        type: "string"
        format: "date-time"
      - name: "thru_date"
        in: "query"
        description: "the thru date"
        required: false
        type: "string"
        format: "date-time"
      - name: "recurrence_period"
        in: "query"
        description: "The recurrence period"
        required: false
        type: "string"
        enum:
        - "BILL_CYCLE"
        - "DAY"
        - "FOUR_YEARS"
        - "FIVE_YEARS"
        - "MONTH"
        - "QUARTER"
        - "THREE_YEARS"
        - "TWICE_A_MONTH"
        - "TWICE_A_YEAR"
        - "TWO_WEEKS"
        - "TWO_YEARS"
        - "WEEK"
        - "YEAR"
        - "FOUR_MONTHS"
      - name: "recurrence_amount"
        in: "query"
        description: "use this charge to prorate order"
        required: false
        type: "number"
      - name: "recurring_payment_required"
        in: "query"
        description: "Is a recurring payment required?"
        required: false
        type: "boolean"
      - name: "bill_in_advance"
        in: "query"
        description: "bill an order in advance"
        required: false
        type: "boolean"
      - name: "prorated_on_cancel"
        in: "query"
        description: "PRorate on canel order"
        required: false
        type: "boolean"
      - name: "prorated_on_order"
        in: "query"
        description: "Prorate the order?"
        required: false
        type: "boolean"
      - name: "prorated_on_order_no_charge"
        in: "query"
        description: "use this charge to prorate order"
        required: false
        type: "boolean"
      - name: "currency_code"
        in: "query"
        description: "The currency_code for the amount."
        required: false
        type: "string"
        enum:
        - "USD"
        - "GBP"
        - "EUR"
        - "SEK"
        - "NOK"
        - "DKK"
        - "CAD"
        - "AUD"
        - "ZAR"
        - "NZD"
        - "MXN"
        - "INR"
        - "JPY"
        - "SAR"
        - "QAR"
        - "EGP"
        - "AED"
        - "BHD"
        - "KWD"
        - "OMR"
        - "HKD"
        - "CHF"
        - "ILS"
        - "CNY"
        - "BRL"
        - "PLN"
        - "COP"
        - "PEN"
        - "RUB"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/RecurringProductPrice"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "RecurringProductPricesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 95
  /recurring-product-prices/{id}:
    get:
      tags:
      - "RecurringProductPrice"
      summary: "Get an existing billing account category"
      description: "Get an existing billing account category"
      operationId: "getRecurringProductPrice"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/RecurringProductPrice"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "RecurringProductPricesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 96
  /usage-events:
    get:
      tags:
      - "UsageEvent"
      operationId: "queryUsageEvents"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "start_time"
        in: "query"
        description: "The start time of the usage event"
        required: false
        type: "string"
        format: "date-time"
      - name: "end_time"
        in: "query"
        description: "The end time for this event"
        required: false
        type: "string"
        format: "date-time"
      - name: "account_num"
        in: "query"
        description: "The account number which owns this usage event."
        required: false
        type: "string"
      - name: "service_period_id"
        in: "query"
        description: "The service period which owns this usage event."
        required: false
        type: "string"
      - name: "reference_id"
        in: "query"
        description: "The reference id associated with this usage event.  The combination\
          \ of the reference_id and sequence_id must be unique."
        required: false
        type: "string"
      - name: "sequence_id"
        in: "query"
        description: "The sequence id associated with this usage event.  The combination\
          \ of the reference_id and sequence_id must be unique."
        required: false
        type: "string"
      - name: "service_resource_identifier"
        in: "query"
        description: "The service resource identifier for this usage event."
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The billing account id which owns this usage event."
        required: false
        type: "string"
      - name: "closed"
        in: "query"
        description: "is the service period owning this event closed?"
        required: false
        type: "string"
      - name: "request_id"
        in: "query"
        description: "the request id uniquely identifies the batch that this usage\
          \ event belongs to.  There is a request_id gnerated for each API call."
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/RatedUsageEvent"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 97
  /usage-events/{id}:
    get:
      tags:
      - "UsageEvent"
      summary: "Get an existing usage event"
      description: "Get an existing usage event"
      operationId: "getUsageEvent"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      - name: "start_time"
        in: "query"
        description: "The start time of the usage event"
        required: false
        type: "string"
        format: "date-time"
      - name: "end_time"
        in: "query"
        description: "The end time for this event"
        required: false
        type: "string"
        format: "date-time"
      - name: "account_num"
        in: "query"
        description: "The account number which owns this usage event."
        required: false
        type: "string"
      - name: "service_period_id"
        in: "query"
        description: "The service period which owns this usage event."
        required: false
        type: "string"
      - name: "reference_id"
        in: "query"
        description: "The reference id associated with this usage event.  The combination\
          \ of the reference_id and sequence_id must be unique."
        required: false
        type: "string"
      - name: "sequence_id"
        in: "query"
        description: "The sequence id associated with this usage event.  The combination\
          \ of the reference_id and sequence_id must be unique."
        required: false
        type: "string"
      - name: "service_resource_identifier"
        in: "query"
        description: "The service resource identifier for this usage event."
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The billing account id which owns this usage event."
        required: false
        type: "string"
      - name: "closed"
        in: "query"
        description: "is the service period owning this event closed?"
        required: false
        type: "string"
      - name: "request_id"
        in: "query"
        description: "the request id uniquely identifies the batch that this usage\
          \ event belongs to.  There is a request_id gnerated for each API call."
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/RatedUsageEvent"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 98
  /usage-events/bulk:
    post:
      tags:
      - "UsageEvent"
      description: "Bulk create one or more usage events"
      operationId: "bulkUsageEventsRequest"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - in: "body"
        name: "bulk_usage_events_request"
        description: "The payload for bulk usage events"
        required: true
        schema:
          $ref: "#/definitions/BulkUsageEventsRequest"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/BulkUsageEventsResponse"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        202:
          description: "Accepted"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 1
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 2
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 3
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 4
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 5
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 6
      security:
      - api_key: []
      - bearer: []
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 99
  /discount-code-services:
    get:
      tags:
      - "DiscountCodeService"
      operationId: "queryDiscountCodeServices"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "service_id"
        in: "query"
        description: "The id of a TRACT service"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "external_account_num"
        in: "query"
        description: "The external account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "valid_from"
        in: "query"
        description: "The valid from date time"
        required: false
        type: "string"
        format: "date-time"
      - name: "valid_to"
        in: "query"
        description: "The valid to date time"
        required: false
        type: "string"
        format: "date-time"
      - name: "discount_resource_identifier"
        in: "query"
        description: "The resource of a TRACT discount"
        required: false
        type: "string"
        maxLength: 255
      - name: "discount_resource_id"
        in: "query"
        description: "The resource id of a TRACT discount"
        required: false
        type: "string"
        maxLength: 255
      - name: "discount_code_id"
        in: "query"
        description: "The id of a TRACT discount code"
        required: false
        type: "string"
      - name: "product_id"
        in: "query"
        description: "The id of a TRACT product"
        required: false
        type: "string"
      - name: "discount_type"
        in: "query"
        description: "The valid discount type"
        required: false
        type: "string"
        default: "FLAT"
        enum:
        - "PERCENTAGE"
        - "FLAT"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/DiscountCodeService"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "DiscountCodeServiceController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 100
  /discount-code-services/{id}:
    get:
      tags:
      - "DiscountCodeService"
      summary: "Get an existing discount code service"
      description: "Get an existing discount code service"
      operationId: "getDiscountCodeService"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/DiscountCodeService"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "DiscountCodeServiceController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 101
  /discount-resources:
    get:
      tags:
      - "DiscountResource"
      operationId: "queryDiscountResources"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
        maxLength: 255
      - name: "order_item_id"
        in: "query"
        description: "The order item id"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The valid discount resource status"
        required: false
        type: "string"
        default: "requested"
        enum:
        - "requested"
        - "available"
        - "active"
        - "deactivated"
        - "quarantined"
        - "used"
        - "expired"
        - "reserved"
      - name: "unlimited"
        in: "query"
        description: "Is discount resource status unlimited"
        required: false
        type: "boolean"
      - name: "limit"
        in: "query"
        description: "The discount resource status limit"
        required: false
        type: "integer"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/DiscountResource"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "the total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "DiscountResourceController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 102
  /discount-resources/{id}:
    get:
      tags:
      - "DiscountResource"
      operationId: "getDiscountResource"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/DiscountResource"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "DiscountResourceController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 103
  /resource-categories:
    get:
      tags:
      - "ResourceCategory"
      operationId: "queryResourceCategories"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "resource_category_name"
        in: "query"
        description: "The name of a TRACT service resource category"
        required: false
        type: "string"
      - name: "resource_type"
        in: "query"
        description: "The name of a TRACT service resource type"
        required: false
        type: "string"
        enum:
        - "service"
        - "discount"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ResourceCategory"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ResourceCategoriesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 104
  /resource-categories/{id}:
    get:
      tags:
      - "ResourceCategory"
      operationId: "getResourceCategory"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ResourceCategory"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ResourceCategoriesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 105
  /service-resources:
    get:
      tags:
      - "ServiceResource"
      operationId: "queryServiceResources"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "identifier"
        in: "query"
        description: "The identifier of a TRACT service resource"
        required: false
        type: "string"
        maxLength: 255
      - name: "resource_category_id"
        in: "query"
        description: "The id of a TRACT service resource category"
        required: false
        type: "string"
      - name: "order_item_id"
        in: "query"
        description: "The order item id"
        required: false
        type: "string"
      - name: "service_id"
        in: "query"
        description: "The id of a TRACT service"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "The status of a TRACT service resource category"
        required: false
        type: "string"
        enum:
        - "REQUESTED"
        - "AVAILABLE"
        - "ACTIVE"
        - "DEACTIVATED"
        - "QUARANTINED"
        - "USED"
        - "RESERVED"
      - name: "description"
        in: "query"
        description: "The description of a TRACT service resource category"
        required: false
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/ServiceResource"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceResourcesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 106
  /service-resources/{id}:
    get:
      tags:
      - "ServiceResource"
      operationId: "getServiceResource"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/ServiceResource"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "ServiceResourcesController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 107
  /adjustment-categories:
    get:
      tags:
      - "AdjustmentCategory"
      operationId: "queryAdjustmentCategories"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "name"
        in: "query"
        description: "The name of TRACT adjustment category"
        required: false
        type: "string"
      - name: "status"
        in: "query"
        description: "An adjustment price category status"
        required: false
        type: "string"
        enum:
        - "ACTIVE"
        - "SUSPENDED"
        - "CANCELED"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/AdjustmentCategory"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentCategoryController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 108
  /adjustment-categories/{id}:
    get:
      tags:
      - "AdjustmentCategory"
      operationId: "getAdjustmentCategory"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/AdjustmentCategory"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentCategoryController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 109
  /adjustment-applications:
    get:
      tags:
      - "AdjustmentApplication"
      operationId: "queryAdjustmentApplications"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "filter"
        in: "query"
        description: "API query language string"
        required: false
        type: "string"
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "page_number"
        in: "query"
        description: "The page number for multiple page queries"
        required: false
        type: "integer"
        default: 1
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "page_size"
        in: "query"
        description: "The page size for multiple page queries. Default maximum is\
          \ 50"
        required: false
        type: "integer"
        default: 50
        maximum: 5E+1
        exclusiveMaximum: false
        minimum: 0
        exclusiveMinimum: true
        allowEmptyValue: true
        format: "int32"
      - name: "id"
        in: "query"
        description: "The internal id of an object."
        required: false
        type: "string"
      - name: "adjustment_id"
        in: "query"
        description: "The id of a TRACT adjustment"
        required: false
        type: "string"
      - name: "billing_account_id"
        in: "query"
        description: "The id of a TRACT billing account"
        required: false
        type: "string"
      - name: "account_num"
        in: "query"
        description: "The billing account number"
        required: false
        type: "string"
        allowEmptyValue: true
      - name: "occurred_on"
        in: "query"
        description: "The date that the adjustment occurred"
        required: false
        type: "string"
        format: "date-time"
      - name: "unapplied_amount"
        in: "query"
        description: "The unapplied adjustment amount"
        required: false
        type: "number"
      - name: "adjustment_application_type"
        in: "query"
        description: "The type of a TRACT adjustment-application"
        required: false
        type: "string"
        enum:
        - "standard-invoice"
        - "negative-invoice"
        - "reversed-invoice"
        - "write-off"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              $ref: "#/definitions/AdjustmentApplication"
            maxItems: 50
          headers:
            ETags:
              type: "string"
              description: "The standard ETags HTTP header"
            X-total-count:
              type: "integer"
              format: "int64"
              description: "The total results for the particular query. Used to drive\
                \ paging requests."
            X-element-count:
              type: "integer"
              format: "int64"
              description: "The number of elements returned in the current request.\
                \ Used to drive paging requests."
            X-total-pages:
              type: "integer"
              format: "int64"
              description: "The total number of pages that can be requested. Used\
                \ to drive paging requests."
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 2
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentApplicationController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 110
  /adjustment-applications/{id}:
    get:
      tags:
      - "AdjustmentApplication"
      operationId: "getAdjustmentApplication"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "Prefer"
        in: "header"
        description: "return=[representation|minimal] The HTTP Prefer header. See\
          \ https://tools.ietf.org/html/rfc7240"
        required: false
        type: "string"
      - name: "return"
        in: "query"
        description: "Specifies the amount of detail to provide in a response."
        required: false
        type: "string"
        default: "FULL"
        allowEmptyValue: true
        enum:
        - "SIMPLE"
        - "FULL"
      - name: "id"
        in: "path"
        description: "The internal id of an object."
        required: true
        type: "string"
      responses:
        200:
          description: "Success"
          schema:
            $ref: "#/definitions/AdjustmentApplication"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        400:
          description: "Bad Request"
          schema:
            $ref: "#/definitions/BadRequestException"
          x-reprezen-normalization:
            position: 1
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Server Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-swagger-router-controller: "AdjustmentApplicationController"
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 111
  /ledgers/{id}/chart-of-accounts/validate:
    get:
      tags:
      - "Chart Of Accounts"
      description: "Validates a list of gl account numbers, returing an array of valid\
        \ numbers from the requested list."
      operationId: "validateChartOfAccounts"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The id for the ledger"
        required: true
        type: "string"
      - name: "account_numbers"
        in: "query"
        required: true
        type: "array"
        items:
          type: "string"
        collectionFormat: "csv"
      responses:
        200:
          description: "Success"
          schema:
            type: "array"
            items:
              type: "string"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 2
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 3
      security:
      - api_key: []
      - bearer: []
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 112
  /ledgers/{id}/transactions:
    post:
      tags:
      - "Journal Transactions"
      description: "Posts a journal transaction."
      operationId: "createTranactions"
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "id"
        in: "path"
        description: "The id for the ledger"
        required: true
        type: "string"
      - in: "body"
        name: "body"
        description: "The `manual entry` as JSON"
        required: true
        schema:
          $ref: "#/definitions/ManualJournalTransaction"
      responses:
        201:
          description: "Successfully posted journal transaction"
          schema:
            $ref: "#/definitions/ManualJournalTransaction"
          headers:
            Preference-Applied:
              type: "string"
              description: "Settings applied from the \"Prefer\" header"
          x-reprezen-normalization:
            position: 0
        401:
          description: "Unauthorized (This should be handled by the container)"
          schema:
            $ref: "#/definitions/UnauthorizedException"
          x-reprezen-normalization:
            position: 1
        403:
          description: "Forbidden"
          schema:
            $ref: "#/definitions/ForbiddenException"
          x-reprezen-normalization:
            position: 2
        404:
          description: "Not Found"
          schema:
            $ref: "#/definitions/NotFoundException"
          x-reprezen-normalization:
            position: 3
        default:
          description: "Unknown Error"
          schema:
            $ref: "#/definitions/GeneralException"
          x-reprezen-normalization:
            position: 4
      security:
      - api_key: []
      - bearer: []
      x-reprezen-normalization:
        position: 0
    x-reprezen-normalization:
      position: 113
securityDefinitions:
  api_key:
    type: "apiKey"
    name: "Authorization"
    in: "header"
  bearer:
    description: "A token that indicates a user has been previously authorized to\\\
      \ \\ perform an action in the system.  \\nPassed in the form of a JWT bearer\
      \ token\\ \\ without additional encoding, e.g. `Bearer abcd123456789efghiljklmnoqrstuvwkxz`\\\
      n'"
    type: "apiKey"
    name: "Authorization"
    in: "header"
definitions:
  BillingAccountRef:
    title: "BillingAccountRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        account_num:
          type: "string"
          example: "104-2345676"
          description: "(unique_key) The TRACT account number"
        external_account_num:
          type: "string"
          example: "ACME 543-0987"
          description: "(unique_key) An account number for this account tied to an\
            \ external system"
    description: "A representation of a TRACT minimal billing account"
    x-swagger-router-model: "BillingAccountDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountRef"
      position: 0
  CreateBillingAccount:
    type: "object"
    required:
    - "billing_account_category"
    - "responsible_party"
    properties:
      account_num:
        type: "string"
        example: "104-2345676"
        description: "(unique_key) The TRACT account number"
      external_account_num:
        type: "string"
        example: "ACME 543-0987"
        description: "(unique_key) An account number for this account tied to an external\
          \ system"
      bill_cycle:
        $ref: "#/definitions/BillCycleRef"
      responsible_party:
        $ref: "#/definitions/CreateParty"
      billing_account_category:
        $ref: "#/definitions/BillingAccountCategoryRef"
      bill_type:
        $ref: "#/definitions/BillType"
      auto_payment_authorized:
        type: "boolean"
        description: "Is the recurring payment used automatically"
        default: false
      currency_code:
        $ref: "#/definitions/CurrencyCode"
      recurring_payment:
        $ref: "#/definitions/CreateRecurringPayment"
      custom_field_values:
        type: "array"
        items:
          $ref: "#/definitions/CreateBillingAccountCustomFieldValue"
      contacts:
        type: "array"
        items:
          $ref: "#/definitions/Person"
      payment_term:
        $ref: "#/definitions/PaymentTermRef"
      start_date:
        type: "string"
        format: "date-time"
        example: "2015-04-01T12:13:26.000-05:00"
      end_date:
        type: "string"
        format: "date-time"
        example: "2015-04-12T08:21:45.000-05:00"
      tax_exempt:
        type: "boolean"
        description: "tax exempt"
      sales_order:
        $ref: "#/definitions/CreateSalesOrder"
    title: "CreateBillingAccount"
    description: "A representation of a TRACT billing account"
    x-swagger-router-model: "BillingAccountDTO"
    x-reprezen-normalization:
      typeName: "CreateBillingAccount"
      position: 1
  BillingAccount:
    title: "BillingAccount"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "bill_cycle"
      - "billing_account_category"
      - "responsible_party"
      properties:
        account_num:
          type: "string"
          example: "104-2345676"
          description: "(unique_key) The TRACT account number"
          readOnly: true
        external_account_num:
          type: "string"
          example: "ACME 543-0987"
          description: "(unique_key) (nullable) An account number for this account\
            \ tied to an external system"
        bill_cycle:
          $ref: "#/definitions/BillCycle"
        responsible_party:
          $ref: "#/definitions/Party"
        billing_account_category:
          $ref: "#/definitions/BillingAccountCategory"
        bill_type:
          $ref: "#/definitions/BillType"
        auto_payment_authorized:
          type: "boolean"
          description: "Is the recurring payment used automatically"
          default: false
        status:
          $ref: "#/definitions/BillingAccountStatus"
        pending_charges_total:
          type: "number"
          example: 200.0
          readOnly: true
        balance:
          type: "number"
          example: 100.0
          readOnly: true
        billing_account_segment:
          $ref: "#/definitions/BillingAccountSegment"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        recurring_payments:
          type: "array"
          items:
            $ref: "#/definitions/RecurringPayment"
        services:
          type: "array"
          items:
            $ref: "#/definitions/Service"
        pending_charges:
          type: "array"
          items:
            $ref: "#/definitions/OrderItemCharge"
        custom_field_values:
          type: "array"
          items:
            $ref: "#/definitions/BillingAccountCustomFieldValue"
        contacts:
          type: "array"
          items:
            $ref: "#/definitions/Person"
        payment_term:
          $ref: "#/definitions/PaymentTerm"
        start_date:
          type: "string"
          format: "date-time"
          example: "2015-04-01T12:13:26.000-05:00"
          readOnly: true
        end_date:
          type: "string"
          format: "date-time"
          example: "2015-04-12T08:21:45.000-05:00"
          readOnly: true
        tax_exempt:
          type: "boolean"
        next_invoice_date:
          type: "string"
          format: "date-time"
          example: "2015-04-12T00:00:00.000-05:00"
          readOnly: true
        parent_billing_account:
          $ref: "#/definitions/BillingAccountRef"
        responsible_account:
          $ref: "#/definitions/BillingAccountRef"
    description: "A representation of a TRACT billing account"
    x-swagger-router-model: "BillingAccountDTO"
    x-reprezen-normalization:
      typeName: "BillingAccount"
      position: 2
  BillingAccountCategory:
    title: "BillingAccountCategory"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          readOnly: true
        description:
          type: "string"
          readOnly: true
        status:
          $ref: "#/definitions/BillingAccountCategoryStatus"
    description: "The account category for this account. Account categories are used\
      \ for segmentation purposes and can be used to drive logic and behaviour throughout\
      \ TRACT"
    x-swagger-router-model: "BillingAccountCategoryDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountCategory"
      position: 3
  BillingAccountCategoryRef:
    title: "BillingAccountCategoryRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    description: "The account category for this account. Account categories are used\
      \ for segmentation purposes and can be used to drive logic and behaviour throughout\
      \ TRACT"
    x-swagger-router-model: "BillingAccountCategoryDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountCategoryRef"
      position: 4
  BillingAccountSegment:
    title: "BillingAccountSegment"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The category name"
        description:
          type: "string"
        status:
          $ref: "#/definitions/BillingAccountSegmentStatus"
        billing_account_segment_fields:
          type: "array"
          items:
            $ref: "#/definitions/BillingAccountSegmentField"
    description: "A Billing Account Segment entity"
    x-swagger-router-model: "BillingAccountSegmentDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountSegment"
      position: 5
  BillingAccountSegmentField:
    title: "BillingAccountSegmentField"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        field_type:
          $ref: "#/definitions/BillingAccountSegmentFieldType"
        name:
          type: "string"
          description: "(unique_key) The field name"
        required:
          type: "boolean"
    description: "A Billing Account Segment Field object."
    x-swagger-router-model: "BillingAccountSegmentFieldDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountSegmentField"
      position: 6
  SuspendBillingAccount:
    title: "SuspendBillingAccount"
    allOf:
    - $ref: "#/definitions/BillingAccountAction"
    - type: "object"
      properties:
        reason:
          $ref: "#/definitions/BillingAccountSuspensionReason"
    x-swagger-router-model: "SuspendBillingAccountDTO"
    x-reprezen-normalization:
      typeName: "SuspendBillingAccount"
      position: 7
  DeactivateBillingAccount:
    title: "DeactivateBillingAccount"
    allOf:
    - $ref: "#/definitions/BillingAccountAction"
    - type: "object"
      properties:
        reason:
          $ref: "#/definitions/BillingAccountDeactivationReason"
    x-swagger-router-model: "DeactivateBillingAccountDTO"
    x-reprezen-normalization:
      typeName: "DeactivateBillingAccount"
      position: 8
  ResumeBillingAccount:
    title: "ResumeBillingAccount"
    allOf:
    - $ref: "#/definitions/BillingAccountAction"
    - type: "object"
    x-swagger-router-model: "ResumeBillingAccountDTO"
    x-reprezen-normalization:
      typeName: "ResumeBillingAccount"
      position: 9
  ChangeResponsibleAccount:
    type: "object"
    properties:
      responsible_account:
        $ref: "#/definitions/BillingAccountRef"
    title: "ChangeResponsibleAccount"
    x-swagger-router-model: "ChangeResponsibleAccountDTO"
    x-reprezen-normalization:
      typeName: "ChangeResponsibleAccount"
      position: 10
  CreateParentAccountRelation:
    type: "object"
    required:
    - "parent_account"
    properties:
      parent_account:
        $ref: "#/definitions/BillingAccountRef"
      valid_from:
        type: "string"
        format: "date-time"
    title: "CreateParentAccountRelation"
    x-swagger-router-model: "CreateParentAccountRelationDto"
    x-reprezen-normalization:
      typeName: "CreateParentAccountRelation"
      position: 11
  ParentAccountRelation:
    title: "ParentAccountRelation"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        parent_account:
          $ref: "#/definitions/BillingAccountRef"
        child_account:
          $ref: "#/definitions/BillingAccountRef"
        valid_from:
          type: "string"
          format: "date-time"
          readOnly: true
        valid_to:
          type: "string"
          format: "date-time"
          readOnly: true
    x-swagger-router-model: "ParentAccountRelationDto"
    x-reprezen-normalization:
      typeName: "ParentAccountRelation"
      position: 12
  ParentAccountRelationRef:
    title: "ParentAccountRelationRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    x-swagger-router-model: "ParentAccountRelationRefDto"
    x-reprezen-normalization:
      typeName: "ParentAccountRelationRef"
      position: 13
  DeactivateParentAccountRelation:
    type: "object"
    properties:
      valid_to:
        type: "string"
        format: "date-time"
    title: "DeactivateParentAccountRelation"
    x-swagger-router-model: "DeactivateParentAccountRelationDto"
    x-reprezen-normalization:
      typeName: "DeactivateParentAccountRelation"
      position: 14
  BillingAccountStatus:
    type: "string"
    title: "BillingAccountStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "PENDING"
    - "COLLECTION"
    - "DEACTIVATED"
    - "FINAL_BILL"
    - "CLOSED"
    x-swagger-router-model: "BillingAccountStatusDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountStatus"
      position: 15
  BillingAccountCategoryStatus:
    type: "string"
    title: "BillingAccountCategoryStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-swagger-router-model: "BillingAccountCategoryStatusDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountCategoryStatus"
      position: 16
  BillingAccountSegmentStatus:
    type: "string"
    title: "BillingAccountSegmentStatus"
    enum:
    - "DRAFT"
    - "ACTIVE"
    - "SUSPENDED"
    x-swagger-router-model: "BillingAccountSegmentStatusDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountSegmentStatus"
      position: 17
  BillingAccountSegmentFieldType:
    type: "string"
    title: "BillingAccountSegmentFieldType"
    description: "A TRACT BillingAccount Segment Field Type"
    enum:
    - "ORDER"
    x-swagger-router-model: "BillingAccountSegmentFieldTypeDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountSegmentFieldType"
      position: 18
  BillType:
    type: "string"
    title: "BillType"
    enum:
    - "PAPER"
    - "EMAIL"
    - "PAPER_EMAIL"
    - "NONE"
    x-swagger-router-model: "BillTypeDTO"
    x-reprezen-normalization:
      typeName: "BillType"
      position: 19
  BillingAccountFieldsToNull:
    type: "string"
    title: "BillingAccountFieldsToNull"
    enum:
    - "external_account_num"
    x-reprezen-normalization:
      typeName: "BillingAccountFieldsToNull"
      position: 20
  OrderItemType:
    type: "string"
    title: "OrderItemType"
    enum:
    - "product"
    - "tenant-subscription"
    - "addon"
    - "tax"
    x-swagger-router-model: "OrderItemTypeDTO"
    x-reprezen-normalization:
      typeName: "OrderItemType"
      position: 21
  CreateOrderItemType:
    type: "string"
    title: "CreateOrderItemType"
    enum:
    - "product"
    - "tenant-subscription"
    - "addon"
    x-swagger-router-model: "OrderItemTypeDTO"
    x-reprezen-normalization:
      typeName: "CreateOrderItemType"
      position: 22
  OrderItemStatus:
    type: "string"
    title: "OrderItemStatus"
    enum:
    - "TRIAL"
    - "FULFILLMENT"
    - "IN_PROGRESS"
    - "COMPLETED"
    - "CANCELED"
    - "DENIED"
    - "ERROR"
    - "DRAFT"
    x-swagger-router-model: "OrderItemStatusDTO"
    x-reprezen-normalization:
      typeName: "OrderItemStatus"
      position: 23
  OrderItem:
    title: "OrderItem"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "order_item_type"
      discriminator: "order_item_type"
      properties:
        order_item_type:
          $ref: "#/definitions/OrderItemType"
        description:
          type: "string"
        quantity:
          type: "number"
        status:
          $ref: "#/definitions/OrderItemStatus"
        sequence:
          type: "integer"
          format: "int64"
        granted_value:
          type: "number"
          description: "val"
        auto_contribution_amount:
          type: "number"
          description: "amount"
        auto_contribution_threshold:
          type: "number"
          description: "threshhold"
        auto_contribution_granted_value:
          type: "number"
          description: "value"
        order_items:
          type: "array"
          items:
            $ref: "#/definitions/AddonServiceProductOrderItem"
        order_item_usage_rules:
          type: "array"
          items:
            $ref: "#/definitions/OrderItemUsageRule"
        order_item_prices:
          type: "array"
          items:
            $ref: "#/definitions/OrderItemPrice"
    x-swagger-router-model: "OrderItemDTO"
    x-reprezen-normalization:
      typeName: "OrderItem"
      position: 24
  ProductOrderItem:
    title: "ProductOrderItem"
    allOf:
    - $ref: "#/definitions/OrderItem"
    - type: "object"
      properties:
        awaiting_approval:
          type: "boolean"
          readOnly: true
        product:
          $ref: "#/definitions/ProductRef"
        price_list:
          $ref: "#/definitions/PriceListRef"
        order_item_agreement:
          $ref: "#/definitions/OrderItemAgreement"
        service_resources:
          type: "array"
          items:
            $ref: "#/definitions/ServiceResource"
        requested_effective_date:
          type: "string"
          format: "date-time"
          readOnly: true
        parent_service:
          $ref: "#/definitions/ServiceRef"
        override_trial_days:
          type: "integer"
          format: "int32"
          readOnly: true
        scheduled_charges:
          type: "array"
          items:
            $ref: "#/definitions/ServicePriceChargeRef"
        scheduled_one_time_price_charges:
          type: "array"
          items:
            $ref: "#/definitions/ServicePriceChargeRef"
        custom_field_values:
          type: "array"
          items:
            $ref: "#/definitions/ServiceCustomFieldValue"
        order_item_discounts:
          type: "array"
          items:
            $ref: "#/definitions/OrderItemDiscount"
        addresses:
          type: "array"
          items:
            $ref: "#/definitions/PostalAddress"
        operation_run_attributes:
          type: "array"
          items:
            $ref: "#/definitions/OperationRunAttribute"
    x-swagger-router-model: "ProductOrderItemDTO"
    x-discriminator-value: "product"
    x-reprezen-normalization:
      typeName: "ProductOrderItem"
      position: 25
  AddonServiceProductOrderItem:
    title: "AddonServiceProductOrderItem"
    allOf:
    - $ref: "#/definitions/ProductOrderItem"
    - type: "object"
    x-swagger-router-model: "AddonServiceProductOrderItemDTO"
    x-discriminator-value: "addon"
    x-reprezen-normalization:
      typeName: "AddonServiceProductOrderItem"
      position: 26
  TenantSubscriptionOrderItem:
    title: "TenantSubscriptionOrderItem"
    allOf:
    - $ref: "#/definitions/OrderItem"
    - type: "object"
      properties:
        user_name:
          type: "string"
          readOnly: true
        first_name:
          type: "string"
          readOnly: true
        last_name:
          type: "string"
          readOnly: true
        email:
          type: "string"
          format: "email"
          readOnly: true
        timezone:
          type: "string"
          readOnly: true
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        charge_file_type:
          $ref: "#/definitions/TenantChargeFileType"
        website:
          type: "string"
          readOnly: true
    x-swagger-router-model: "TenantSubscriptionOrderItemDTO"
    x-discriminator-value: "tenant-subscription"
    x-reprezen-normalization:
      typeName: "TenantSubscriptionOrderItem"
      position: 27
  TaxOrderItem:
    title: "TaxOrderItem"
    allOf:
    - $ref: "#/definitions/OrderItem"
    - type: "object"
      properties:
        total:
          type: "number"
          readOnly: true
    x-swagger-router-model: "TaxOrderItemDTO"
    x-discriminator-value: "tax"
    x-reprezen-normalization:
      typeName: "TaxOrderItem"
      position: 28
  CreateTenantOrderItem:
    title: "CreateTenantOrderItem"
    allOf:
    - $ref: "#/definitions/CreateProductOrderItem"
    - type: "object"
      properties:
        user_name:
          type: "string"
          description: "user name"
        first_name:
          type: "string"
          description: "first name"
        last_name:
          type: "string"
          description: "last name"
        email:
          type: "string"
          format: "email"
          description: "last name"
        timezone:
          type: "string"
          description: "timezone"
        website:
          type: "string"
          format: "url"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        charge_file_type:
          $ref: "#/definitions/TenantChargeFileType"
    x-swagger-router-model: "CreateTenantOrderItemDTO"
    x-discriminator-value: "tenant"
    x-reprezen-normalization:
      typeName: "CreateTenantOrderItem"
      position: 29
  CreateProductOrderItem:
    type: "object"
    required:
    - "create_product_order_item_type"
    discriminator: "create_product_order_item_type"
    properties:
      create_product_order_item_type:
        $ref: "#/definitions/CreateOrderItemType"
      quantity:
        type: "number"
        description: "quantity"
      description:
        type: "string"
      product:
        $ref: "#/definitions/ProductRef"
      price_list:
        $ref: "#/definitions/PriceListRef"
      sequence:
        type: "integer"
        format: "int64"
      requested_effective_date:
        type: "string"
        format: "date-time"
      override_trial_days:
        type: "integer"
        format: "int32"
      granted_value:
        type: "number"
        description: "val"
      auto_contribution_amount:
        type: "number"
        description: "amount"
      auto_contribution_threshold:
        type: "number"
        description: "threshhold"
      auto_contribution_granted_value:
        type: "number"
        description: "value"
      order_items:
        type: "array"
        items:
          $ref: "#/definitions/CreateAddOnProductOrderItem"
      scheduled_recurring_charges:
        type: "array"
        items:
          $ref: "#/definitions/ServicePriceCharge"
      scheduled_one_time_price_charges:
        type: "array"
        items:
          $ref: "#/definitions/OneTimePriceCharge"
      custom_field_values:
        type: "array"
        items:
          $ref: "#/definitions/CreateServiceCustomFieldValue"
      addresses:
        type: "array"
        items:
          $ref: "#/definitions/CreatePostalAddress"
      order_item_agreement:
        $ref: "#/definitions/OrderItemAgreement"
      service_resources:
        type: "array"
        items:
          $ref: "#/definitions/CreateServiceResource"
        maxItems: 50
      order_item_discount:
        $ref: "#/definitions/OrderItemDiscount"
      order_item_prices:
        type: "array"
        items:
          $ref: "#/definitions/CreateOrderItemPrice"
      operation_run_attributes:
        type: "array"
        items:
          $ref: "#/definitions/CreateOperationRunAttribute"
    title: "CreateProductOrderItem"
    x-swagger-router-model: "CreateProductOrderItemDTO"
    x-discriminator-value: "product"
    x-reprezen-normalization:
      typeName: "CreateProductOrderItem"
      position: 30
  CreateAddOnProductOrderItem:
    title: "CreateAddOnProductOrderItem"
    allOf:
    - $ref: "#/definitions/CreateProductOrderItem"
    - type: "object"
      properties:
        parent_service:
          $ref: "#/definitions/ServiceRef"
    x-swagger-router-model: "CreateAddOnProductOrderItemDTO"
    x-discriminator-value: "add-on"
    x-reprezen-normalization:
      typeName: "CreateAddOnProductOrderItem"
      position: 31
  BaseOrderItemCharge:
    title: "BaseOrderItemCharge"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "order_item_charge_type"
      discriminator: "order_item_charge_type"
      properties:
        product_name:
          type: "string"
        price_category:
          type: "string"
        order_date:
          type: "string"
          format: "date-time"
        amount:
          type: "number"
        order_item_charge_type:
          $ref: "#/definitions/OrderItemChargeType"
    x-swagger-router-model: "BaseOrderItemChargeDTO"
    x-reprezen-normalization:
      typeName: "BaseOrderItemCharge"
      position: 32
  OrderItemCharge:
    title: "OrderItemCharge"
    allOf:
    - $ref: "#/definitions/BaseOrderItemCharge"
    - type: "object"
    x-swagger-router-model: "OrderItemChargeDTO"
    x-discriminator-value: "order-item"
    x-reprezen-normalization:
      typeName: "OrderItemCharge"
      position: 33
  TaxOrderItemCharge:
    title: "TaxOrderItemCharge"
    allOf:
    - $ref: "#/definitions/OrderItemCharge"
    - type: "object"
      properties:
        category_id:
          type: "integer"
          format: "int32"
        description:
          type: "string"
        code:
          type: "string"
        level:
          type: "string"
        jurisdiction:
          type: "string"
        rate:
          type: "number"
    x-swagger-router-model: "TaxOrderItemChargeDTO"
    x-discriminator-value: "tax"
    x-reprezen-normalization:
      typeName: "TaxOrderItemCharge"
      position: 34
  TenantChargeFileType:
    type: "string"
    title: "TenantChargeFileType"
    enum:
    - "ACTIVE_ACCOUNTS"
    - "GROSS_BILLING"
    - "ORDER"
    x-swagger-router-model: "TenantChargeFileTypeDTO"
    x-reprezen-normalization:
      typeName: "TenantChargeFileType"
      position: 35
  OrderItemChargeType:
    type: "string"
    title: "OrderItemChargeType"
    enum:
    - "order-item"
    - "tax"
    x-reprezen-normalization:
      typeName: "OrderItemChargeType"
      position: 36
  ApproveOrderItem:
    type: "object"
    required:
    - "approval_date"
    properties:
      approval_date:
        type: "string"
        format: "date-time"
        description: "The date in which the order item will be approved"
        title: "The approval date"
    title: "ApproveOrderItem"
    x-reprezen-normalization:
      typeName: "ApproveOrderItem"
      position: 37
  OrderItemPrice:
    title: "OrderItemPrice"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "order_item_price_type"
      - "product_price"
      discriminator: "order_item_price_type"
      properties:
        order_item_price_type:
          $ref: "#/definitions/PriceType"
        price_override:
          type: "boolean"
          readOnly: true
        tapered:
          type: "boolean"
          readOnly: true
        amount:
          type: "number"
          readOnly: true
        taxable_amount:
          type: "number"
          readOnly: true
        product_price:
          $ref: "#/definitions/ProductPriceRef"
        order_item_price_ranges:
          type: "array"
          items:
            $ref: "#/definitions/OrderItemPriceRange"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        category:
          $ref: "#/definitions/PriceCategoryRef"
    x-swagger-router-model: "OrderItemPriceDTO"
    x-reprezen-normalization:
      typeName: "OrderItemPrice"
      position: 38
  OrderItemPriceRange:
    title: "OrderItemPriceRange"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        quantity_begin_range:
          type: "number"
          readOnly: true
        quantity_end_range:
          type: "number"
          readOnly: true
        price:
          type: "number"
          readOnly: true
        level:
          type: "integer"
          format: "int32"
          readOnly: true
        currency_code:
          $ref: "#/definitions/CurrencyCode"
    x-swagger-router-model: "OrderItemPriceRangeDTO"
    x-reprezen-normalization:
      typeName: "OrderItemPriceRange"
      position: 39
  OrderItemOneTimePrice:
    title: "OrderItemOneTimePrice"
    allOf:
    - $ref: "#/definitions/OrderItemPrice"
    - type: "object"
    x-swagger-router-model: "OrderItemOneTimePriceDTO"
    x-discriminator-value: "one-time"
    x-reprezen-normalization:
      typeName: "OrderItemOneTimePrice"
      position: 40
  OrderItemRecurringPrice:
    title: "OrderItemRecurringPrice"
    allOf:
    - $ref: "#/definitions/OrderItemPrice"
    - type: "object"
      properties:
        prorated_on_order:
          type: "boolean"
          readOnly: true
        prorated_on_cancel:
          type: "boolean"
          readOnly: true
        prorated_on_order_no_charge:
          type: "boolean"
          readOnly: true
    x-swagger-router-model: "OrderItemRecurringPriceDTO"
    x-discriminator-value: "recurring"
    x-reprezen-normalization:
      typeName: "OrderItemRecurringPrice"
      position: 41
  CreateOrderItemPrice:
    title: "CreateOrderItemPrice"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "order_item_price_type"
      - "product_price"
      discriminator: "order_item_price_type"
      properties:
        order_item_price_type:
          $ref: "#/definitions/PriceType"
        price_override:
          type: "boolean"
        tapered:
          type: "boolean"
        amount:
          type: "number"
        taxable_amount:
          type: "number"
        product_price:
          $ref: "#/definitions/ProductPriceRef"
        order_item_price_ranges:
          type: "array"
          items:
            $ref: "#/definitions/CreateOrderItemPriceRange"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        category:
          $ref: "#/definitions/PriceCategoryRef"
    x-swagger-router-model: "OrderItemPriceDTO"
    x-reprezen-normalization:
      typeName: "CreateOrderItemPrice"
      position: 42
  CreateOrderItemOneTimePrice:
    title: "CreateOrderItemOneTimePrice"
    allOf:
    - $ref: "#/definitions/CreateOrderItemPrice"
    - type: "object"
    x-swagger-router-model: "OrderItemOneTimePriceDTO"
    x-discriminator-value: "one-time"
    x-reprezen-normalization:
      typeName: "CreateOrderItemOneTimePrice"
      position: 43
  CreateOrderItemRecurringPrice:
    title: "CreateOrderItemRecurringPrice"
    allOf:
    - $ref: "#/definitions/CreateOrderItemPrice"
    - type: "object"
      properties:
        prorated_on_order:
          type: "boolean"
        prorated_on_cancel:
          type: "boolean"
        prorated_on_order_no_charge:
          type: "boolean"
    x-swagger-router-model: "OrderItemRecurringPriceDTO"
    x-discriminator-value: "recurring"
    x-reprezen-normalization:
      typeName: "CreateOrderItemRecurringPrice"
      position: 44
  CreateOrderItemPriceRange:
    title: "CreateOrderItemPriceRange"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        quantity_begin_range:
          type: "number"
        quantity_end_range:
          type: "number"
        price:
          type: "number"
        level:
          type: "integer"
          format: "int32"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
    x-swagger-router-model: "OrderItemPriceRangeDTO"
    x-reprezen-normalization:
      typeName: "CreateOrderItemPriceRange"
      position: 45
  BillCycleType:
    type: "string"
    title: "BillCycleType"
    enum:
    - "daily"
    - "monthly"
    - "quarterly"
    - "yearly"
    - "segmented-monthly"
    x-swagger-router-model: "BillCycleTypeDTO"
    x-reprezen-normalization:
      typeName: "BillCycleType"
      position: 46
  BillCycle:
    title: "BillCycle"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "bill_cycle_type"
      discriminator: "bill_cycle_type"
      properties:
        bill_cycle_type:
          $ref: "#/definitions/BillCycleType"
        name:
          type: "string"
          description: "(unique_key)"
          readOnly: true
        start_date:
          type: "string"
          format: "date-time"
          readOnly: true
        end_date:
          type: "string"
          format: "date-time"
          readOnly: true
        auto_bill:
          type: "boolean"
          readOnly: true
        use_payment_term:
          type: "boolean"
          readOnly: true
        status:
          $ref: "#/definitions/AccountingStatus"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
    description: "A representation of a TRACT bill cycle"
    x-swagger-router-model: "BillingCycleDTO"
    x-reprezen-normalization:
      typeName: "BillCycle"
      position: 47
  BillCycleRef:
    title: "BillCycleRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "bill_cycle_type"
      discriminator: "bill_cycle_type"
      properties:
        bill_cycle_type:
          $ref: "#/definitions/BillCycleType"
        name:
          type: "string"
          description: "(unique_key)"
          readOnly: true
    description: "A representation of a TRACT bill cycle"
    x-swagger-router-model: "BillingCycleDTO"
    x-reprezen-normalization:
      typeName: "BillCycleRef"
      position: 48
  DailyBillCycle:
    title: "DailyBillCycle"
    allOf:
    - $ref: "#/definitions/BillCycle"
    - type: "object"
    description: "A representation of a TRACT Daily Bill Cycle entity"
    x-swagger-router-model: "DailyBillCycleDTO"
    x-discriminator-value: "daily"
    x-reprezen-normalization:
      typeName: "DailyBillCycle"
      position: 49
  DailyBillCycleRef:
    title: "DailyBillCycleRef"
    allOf:
    - $ref: "#/definitions/BillCycleRef"
    - type: "object"
    description: "A representation of a TRACT Daily Bill Cycle entity"
    x-swagger-router-model: "DailyBillCycleDTO"
    x-discriminator-value: "daily"
    x-reprezen-normalization:
      typeName: "DailyBillCycleRef"
      position: 50
  MonthlyBillCycle:
    title: "MonthlyBillCycle"
    allOf:
    - $ref: "#/definitions/BillCycle"
    - type: "object"
      properties:
        day_of_month:
          type: "integer"
          format: "int32"
          readOnly: true
    description: "A representation of a TRACT Monthly Bill Cycle entity"
    x-discriminator-value: "monthly"
    x-swagger-router-model: "MonthlyBillCycleDTO"
    x-reprezen-normalization:
      typeName: "MonthlyBillCycle"
      position: 51
  MonthlyBillCycleRef:
    title: "MonthlyBillCycleRef"
    allOf:
    - $ref: "#/definitions/BillCycleRef"
    - type: "object"
    description: "A representation of a TRACT Monthly Bill Cycle entity"
    x-discriminator-value: "monthly"
    x-swagger-router-model: "MonthlyBillCycleDTO"
    x-reprezen-normalization:
      typeName: "MonthlyBillCycleRef"
      position: 52
  QuarterlyBillCycle:
    title: "QuarterlyBillCycle"
    allOf:
    - $ref: "#/definitions/BillCycle"
    - type: "object"
      properties:
        day_of_month:
          type: "integer"
          format: "int32"
          readOnly: true
        end_month:
          type: "integer"
          format: "int32"
          readOnly: true
    description: "A representation of a TRACT Quarterly Bill Cycle entity"
    x-discriminator-value: "quarterly"
    x-swagger-router-model: "QuarterlyBillCycleDTO"
    x-reprezen-normalization:
      typeName: "QuarterlyBillCycle"
      position: 53
  QuarterlyBillCycleRef:
    title: "QuarterlyBillCycleRef"
    allOf:
    - $ref: "#/definitions/BillCycleRef"
    - type: "object"
    description: "A representation of a TRACT Quarterly Bill Cycle entity"
    x-discriminator-value: "quarterly"
    x-swagger-router-model: "QuarterlyBillCycleDTO"
    x-reprezen-normalization:
      typeName: "QuarterlyBillCycleRef"
      position: 54
  YearlyBillCycle:
    title: "YearlyBillCycle"
    allOf:
    - $ref: "#/definitions/BillCycle"
    - type: "object"
      properties:
        day_of_year:
          type: "integer"
          format: "int32"
          readOnly: true
    description: "A representation of a TRACT Yearly Bill Cycle entity"
    x-discriminator-value: "yearly"
    x-swagger-router-model: "YearlyBillCycleDTO"
    x-reprezen-normalization:
      typeName: "YearlyBillCycle"
      position: 55
  YearlyBillCycleRef:
    title: "YearlyBillCycleRef"
    allOf:
    - $ref: "#/definitions/BillCycleRef"
    - type: "object"
    description: "A representation of a TRACT Yearly Bill Cycle entity"
    x-discriminator-value: "yearly"
    x-swagger-router-model: "YearlyBillCycleDTO"
    x-reprezen-normalization:
      typeName: "YearlyBillCycleRef"
      position: 56
  SegmentedMonthlyBillCycle:
    title: "SegmentedMonthlyBillCycle"
    allOf:
    - $ref: "#/definitions/BillCycle"
    - type: "object"
      properties:
        days_of_month:
          type: "string"
          readOnly: true
    description: "A representation of a TRACT SegmentedMonthly Bill Cycle entity"
    x-swagger-router-model: "SegmentedMonthlyBillCycleDTO"
    x-discriminator-value: "segmented-monthly"
    x-reprezen-normalization:
      typeName: "SegmentedMonthlyBillCycle"
      position: 57
  SegmentedMonthlyBillCycleRef:
    title: "SegmentedMonthlyBillCycleRef"
    allOf:
    - $ref: "#/definitions/BillCycleRef"
    - type: "object"
    description: "A representation of a TRACT SegmentedMonthly Bill Cycle entity"
    x-swagger-router-model: "SegmentedMonthlyBillCycleDTO"
    x-discriminator-value: "segmented-monthly"
    x-reprezen-normalization:
      typeName: "SegmentedMonthlyBillCycleRef"
      position: 58
  InvoiceItemCharge:
    title: "InvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "invoice_item_charge_type"
      discriminator: "invoice_item_charge_type"
      properties:
        invoice_item_charge_type:
          $ref: "#/definitions/InvoiceItemChargeType"
        un_prorated_amount:
          type: "number"
          description: "Un prorated amount"
        amount:
          type: "number"
          description: "desc"
        price_category:
          $ref: "#/definitions/ChargeCategory"
        balance:
          type: "number"
          description: "desc"
        paid:
          type: "boolean"
          description: "desc"
        recurring_charge:
          type: "boolean"
          description: "desc"
        bill_in_advance:
          type: "boolean"
          description: "desc"
        tax_description:
          type: "string"
          description: "desc"
        description:
          type: "string"
          description: "desc"
        quantity:
          type: "number"
          description: "desc"
        tax_identifier:
          type: "string"
          description: "desc"
          maxLength: 40
        tax_posted:
          type: "boolean"
          description: "desc"
    x-swagger-router-model: "InvoiceItemChargeDTO"
    x-reprezen-normalization:
      typeName: "InvoiceItemCharge"
      position: 59
  AdhocInvoiceItemCharge:
    title: "AdhocInvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/InvoiceItemCharge"
    - type: "object"
      properties:
        price_charge:
          $ref: "#/definitions/ServicePriceCharge"
    x-swagger-router-model: "AdhocInvoiceItemChargeDTO"
    x-discriminator-value: "adhoc"
    x-reprezen-normalization:
      typeName: "AdhocInvoiceItemCharge"
      position: 60
  OneTimePriceInvoiceItemCharge:
    title: "OneTimePriceInvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/InvoiceItemCharge"
    - type: "object"
      properties:
        price_charge:
          $ref: "#/definitions/OneTimePriceCharge"
    x-swagger-router-model: "OneTimePriceInvoiceItemChargeDTO"
    x-discriminator-value: "one-time-price"
    x-reprezen-normalization:
      typeName: "OneTimePriceInvoiceItemCharge"
      position: 61
  AdditionalFeeInvoiceItemCharge:
    title: "AdditionalFeeInvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/InvoiceItemCharge"
    - type: "object"
      properties:
        percentage_volume:
          type: "number"
          description: "desc"
        additional_fee:
          $ref: "#/definitions/AdditionalFee"
    x-swagger-router-model: "AdditionalFeeInvoiceItemChargeDTO"
    x-discriminator-value: "additional-fee"
    x-reprezen-normalization:
      typeName: "AdditionalFeeInvoiceItemCharge"
      position: 62
  DiscountInvoiceItemCharge:
    title: "DiscountInvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/InvoiceItemCharge"
    - type: "object"
      properties:
        discount_code:
          $ref: "#/definitions/DiscountCodeEntity"
    x-swagger-router-model: "DiscountInvoiceItemChargeDTO"
    x-discriminator-value: "discount"
    x-reprezen-normalization:
      typeName: "DiscountInvoiceItemCharge"
      position: 63
  TaxInvoiceItemCharge:
    title: "TaxInvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/InvoiceItemCharge"
    - type: "object"
      properties:
        tax_category_id:
          type: "integer"
          format: "int32"
          description: "desc"
        tax_description:
          type: "string"
          description: "desc"
        tax_code:
          type: "string"
          description: "desc"
        tax_level:
          type: "string"
          description: "desc"
        tax_rate:
          type: "number"
          description: "desc"
        jurisdiction_name:
          type: "string"
          description: "desc"
    x-swagger-router-model: "TaxInvoiceItemChargeDTO"
    x-discriminator-value: "tax"
    x-reprezen-normalization:
      typeName: "TaxInvoiceItemCharge"
      position: 64
  UsageInvoiceItemCharge:
    title: "UsageInvoiceItemCharge"
    allOf:
    - $ref: "#/definitions/InvoiceItemCharge"
    - type: "object"
      properties:
        usage_sums:
          type: "array"
          description: "desc"
          items:
            $ref: "#/definitions/UsageSum"
    x-swagger-router-model: "UsageInvoiceItemChargeDTO"
    x-discriminator-value: "usage"
    x-reprezen-normalization:
      typeName: "UsageInvoiceItemCharge"
      position: 65
  AdditionalFee:
    title: "AdditionalFee"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique-key) desc"
        description:
          type: "string"
          description: "desc"
        amount:
          type: "number"
          description: "desc"
        is_credit:
          type: "boolean"
          description: "desc"
        applicability_level:
          $ref: "#/definitions/ApplicabilityLevel"
        fee_type:
          $ref: "#/definitions/AdditionalFeeType"
        status:
          $ref: "#/definitions/AdditionalFeeStatus"
        price_category:
          $ref: "#/definitions/ChargeCategoryRef"
    x-swagger-router-model: "AdditionalFeeDTO"
    x-reprezen-normalization:
      typeName: "AdditionalFee"
      position: 66
  InvoiceItem:
    title: "InvoiceItem"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "invoice_item_type"
      discriminator: "invoice_item_type"
      properties:
        invoice_item_type:
          $ref: "#/definitions/InvoiceItemType"
        quantity:
          type: "number"
        unit_amount:
          type: "number"
        total_amount:
          type: "number"
        description:
          type: "string"
        taxable:
          type: "boolean"
        prorated_percentage:
          type: "number"
        start_date:
          type: "string"
          format: "date-time"
        end_date:
          type: "string"
          format: "date-time"
        line_item_type:
          type: "string"
        invoice_item_charges:
          type: "array"
          items:
            $ref: "#/definitions/InvoiceItemCharge"
    x-swagger-router-model: "InvoiceItemDTO"
    x-reprezen-normalization:
      typeName: "InvoiceItem"
      position: 67
  AdditionalFeeInvoiceItem:
    title: "AdditionalFeeInvoiceItem"
    allOf:
    - $ref: "#/definitions/InvoiceItem"
    - type: "object"
      properties:
        service:
          $ref: "#/definitions/ServiceRef"
        additional_fee:
          $ref: "#/definitions/AdditionalFee"
        line_item_type:
          type: "string"
    x-swagger-router-model: "AdditionalFeeInvoiceItemDTO"
    x-discriminator-value: "additional-fee"
    x-reprezen-normalization:
      typeName: "AdditionalFeeInvoiceItem"
      position: 68
  TaxInvoiceItem:
    title: "TaxInvoiceItem"
    allOf:
    - $ref: "#/definitions/InvoiceItem"
    - type: "object"
      properties:
        line_item_type:
          type: "string"
    x-swagger-router-model: "TaxInvoiceItemDTO"
    x-discriminator-value: "tax"
    x-reprezen-normalization:
      typeName: "TaxInvoiceItem"
      position: 69
  AdjustmentInvoiceItem:
    title: "AdjustmentInvoiceItem"
    allOf:
    - $ref: "#/definitions/InvoiceItem"
    - type: "object"
    x-swagger-router-model: "AdjustmentInvoiceItemDTO"
    x-discriminator-value: "adjustment"
    x-reprezen-normalization:
      typeName: "AdjustmentInvoiceItem"
      position: 70
  ProductInvoiceItem:
    title: "ProductInvoiceItem"
    allOf:
    - $ref: "#/definitions/InvoiceItem"
    - type: "object"
      properties:
        line_item_type:
          type: "string"
    x-swagger-router-model: "ProductInvoiceItemDTO"
    x-discriminator-value: "product"
    x-reprezen-normalization:
      typeName: "ProductInvoiceItem"
      position: 71
  ServiceInvoiceItem:
    title: "ServiceInvoiceItem"
    allOf:
    - $ref: "#/definitions/InvoiceItem"
    - type: "object"
      properties:
        line_item_type:
          type: "string"
    x-swagger-router-model: "ServiceInvoiceItemDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "ServiceInvoiceItem"
      position: 72
  UsageInvoiceItem:
    title: "UsageInvoiceItem"
    allOf:
    - $ref: "#/definitions/InvoiceItem"
    - type: "object"
      properties:
        service:
          $ref: "#/definitions/ServiceRef"
        line_item_type:
          type: "string"
    x-swagger-router-model: "UsageInvoiceItemDTO"
    x-discriminator-value: "usage"
    x-reprezen-normalization:
      typeName: "UsageInvoiceItem"
      position: 73
  UsageSum:
    title: "UsageSum"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        usage_amount:
          type: "number"
          description: "desc"
        usage_uom:
          $ref: "#/definitions/UsageDurationUom"
        usage_rule:
          $ref: "#/definitions/UsageRule"
    x-swagger-router-model: "UsageSumDTO"
    x-reprezen-normalization:
      typeName: "UsageSum"
      position: 74
  Invoice:
    title: "Invoice"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        invoice_num:
          type: "string"
          description: "(unique-key) description"
        amount:
          type: "number"
        description:
          type: "string"
        billing_account:
          $ref: "#/definitions/BillingAccountRef"
        occurred_on:
          type: "string"
          format: "date-time"
        amount_to_pay:
          type: "number"
        late_fee_charged:
          type: "boolean"
        bill_cycle:
          $ref: "#/definitions/BillCycle"
        invoice_items:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/InvoiceItem"
        status:
          $ref: "#/definitions/InvoiceStatus"
        billing_statement:
          $ref: "#/definitions/BillingStatement"
    x-swagger-router-model: "InvoiceDTO"
    x-reprezen-normalization:
      typeName: "Invoice"
      position: 75
  InvoiceRef:
    title: "InvoiceRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        invoice_num:
          type: "string"
          description: "(unique-key) description"
        billing_statement:
          $ref: "#/definitions/BillingStatement"
        bill_cycle:
          $ref: "#/definitions/BillCycleRef"
        invoice_items:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/InvoiceItem"
    x-swagger-router-model: "InvoiceDTO"
    x-reprezen-normalization:
      typeName: "InvoiceRef"
      position: 76
  BillingStatement:
    title: "BillingStatement"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "activity_charges"
      - "balance"
      - "credit_adjustments_posted_amount"
      - "credit_adjustments_write_off_amount"
      - "other_charges_and_credits"
      - "payments_canceled_amount"
      - "payments_received_amount"
      - "service_charges"
      - "taxes_and_fees"
      - "total_amount"
      - "total_current_charges"
      properties:
        total_amount:
          type: "number"
        balance:
          type: "number"
        service_charges:
          type: "number"
        activity_charges:
          type: "number"
        other_charges_and_credits:
          type: "number"
        taxes_and_fees:
          type: "number"
        total_current_charges:
          type: "number"
        payments_received_amount:
          type: "number"
        payments_canceled_amount:
          type: "number"
        credit_adjustments_posted_amount:
          type: "number"
        credit_adjustments_write_off_amount:
          type: "number"
    x-swagger-router-model: "StatementDTO"
    x-reprezen-normalization:
      typeName: "BillingStatement"
      position: 77
  InvoiceStatus:
    type: "string"
    title: "InvoiceStatus"
    enum:
    - "PROCESSING"
    - "OPEN"
    - "CLOSED"
    x-swagger-router-model: "InvoiceStatusDTO"
    x-reprezen-normalization:
      typeName: "InvoiceStatus"
      position: 78
  InvoiceItemType:
    type: "string"
    title: "InvoiceItemType"
    enum:
    - "addiitional-fee"
    - "adjustment"
    - "product"
    - "service"
    - "tax"
    - "usage"
    x-swagger-router-model: "InvoiceItemTypeDTO"
    x-reprezen-normalization:
      typeName: "InvoiceItemType"
      position: 79
  InvoiceItemChargeType:
    type: "string"
    title: "InvoiceItemChargeType"
    enum:
    - "adhoc"
    - "additional-fee"
    - "discount"
    - "one-time-price"
    - "tax"
    - "usage"
    x-swagger-router-model: "InvoiceItemChargeTypeDTO"
    x-reprezen-normalization:
      typeName: "InvoiceItemChargeType"
      position: 80
  ApplicabilityLevel:
    type: "string"
    title: "ApplicabilityLevel"
    enum:
    - "BILLING_ACCOUNT"
    - "PRODUCT"
    - "RESPONSIBLE_ACCOUNT"
    x-swagger-router-model: "ApplicabilityLevelDTO"
    x-reprezen-normalization:
      typeName: "ApplicabilityLevel"
      position: 81
  AdditionalFeeType:
    type: "string"
    title: "AdditionalFeeType"
    enum:
    - "CHARGE"
    - "PERCENTAGE"
    x-swagger-router-model: "AdditionalFeeTypeDTO"
    x-reprezen-normalization:
      typeName: "AdditionalFeeType"
      position: 82
  AdditionalFeeStatus:
    type: "string"
    title: "AdditionalFeeStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "DRAFT"
    x-swagger-router-model: "AdditionalFeeStatusDTO"
    x-reprezen-normalization:
      typeName: "AdditionalFeeStatus"
      position: 83
  Invoices:
    title: "Invoices"
    type: "array"
    description: "A list of invoices for apply payment payloads"
    items:
      $ref: "#/definitions/Invoice"
    x-reprezen-normalization:
      typeName: "Invoices"
      position: 84
  AdjustmentApplication:
    title: "AdjustmentApplication"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "adjustment_application_type"
      discriminator: "adjustment_application_type"
      properties:
        account_adjustment:
          $ref: "#/definitions/AccountAdjustment"
        applied_on:
          type: "string"
          format: "date-time"
        amount:
          type: "number"
        adjustment_application_type:
          $ref: "#/definitions/AdjustmentApplicationType"
    description: "Adjustment application"
    x-swagger-router-model: "AdjustmentApplicationDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentApplication"
      position: 85
  AdjustmentApplicationRef:
    title: "AdjustmentApplicationRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "adjustment_application_type"
      discriminator: "adjustment_application_type"
      properties:
        account_adjustment:
          $ref: "#/definitions/AccountAdjustmentRef"
        adjustment_application_type:
          $ref: "#/definitions/AdjustmentApplicationType"
    description: "Adjustment application"
    x-swagger-router-model: "AdjustmentApplicationDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentApplicationRef"
      position: 86
  InvoiceAdjustmentApplication:
    title: "InvoiceAdjustmentApplication"
    allOf:
    - $ref: "#/definitions/AdjustmentApplication"
    - type: "object"
      properties:
        invoice:
          $ref: "#/definitions/InvoiceRef"
    x-swagger-router-model: "InvoiceAdjustmentApplicationDTO"
    x-reprezen-normalization:
      typeName: "InvoiceAdjustmentApplication"
      position: 87
  InvoiceAdjustmentApplicationRef:
    title: "InvoiceAdjustmentApplicationRef"
    allOf:
    - $ref: "#/definitions/AdjustmentApplicationRef"
    - type: "object"
      properties:
        invoice:
          $ref: "#/definitions/InvoiceRef"
    x-swagger-router-model: "InvoiceAdjustmentApplicationDTO"
    x-reprezen-normalization:
      typeName: "InvoiceAdjustmentApplicationRef"
      position: 88
  NegativeInvoiceAdjustmentApplication:
    title: "NegativeInvoiceAdjustmentApplication"
    allOf:
    - $ref: "#/definitions/InvoiceAdjustmentApplication"
    - type: "object"
    x-swagger-router-model: "NegativeInvoiceAdjustmentApplicationDTO"
    x-discriminator-value: "negative-invoice"
    x-reprezen-normalization:
      typeName: "NegativeInvoiceAdjustmentApplication"
      position: 89
  ReversedInvoiceAdjustmentApplication:
    title: "ReversedInvoiceAdjustmentApplication"
    allOf:
    - $ref: "#/definitions/InvoiceAdjustmentApplication"
    - type: "object"
      properties:
        reversed_application:
          $ref: "#/definitions/StandardInvoiceAdjustmentApplicationRef"
    x-swagger-router-model: "ReversedInvoiceAdjustmentApplicationDTO"
    x-discriminator-value: "reversed-invoice"
    x-reprezen-normalization:
      typeName: "ReversedInvoiceAdjustmentApplication"
      position: 90
  StandardInvoiceAdjustmentApplication:
    title: "StandardInvoiceAdjustmentApplication"
    allOf:
    - $ref: "#/definitions/InvoiceAdjustmentApplication"
    - type: "object"
      properties:
        reversed:
          type: "boolean"
    x-swagger-router-model: "StandardInvoiceAdjustmentApplicationDTO"
    x-discriminator-value: "standard-invoice"
    x-reprezen-normalization:
      typeName: "StandardInvoiceAdjustmentApplication"
      position: 91
  StandardInvoiceAdjustmentApplicationRef:
    title: "StandardInvoiceAdjustmentApplicationRef"
    allOf:
    - $ref: "#/definitions/InvoiceAdjustmentApplicationRef"
    - type: "object"
    x-swagger-router-model: "StandardInvoiceAdjustmentApplicationDTO"
    x-discriminator-value: "standard-invoice"
    x-reprezen-normalization:
      typeName: "StandardInvoiceAdjustmentApplicationRef"
      position: 92
  WriteOffAdjustmentApplication:
    title: "WriteOffAdjustmentApplication"
    allOf:
    - $ref: "#/definitions/AdjustmentApplication"
    - type: "object"
    x-swagger-router-model: "WriteOffAdjustmentApplicationDTO"
    x-discriminator-value: "write-off"
    x-reprezen-normalization:
      typeName: "WriteOffAdjustmentApplication"
      position: 93
  AdjustmentApplicationType:
    type: "string"
    title: "AdjustmentApplicationType"
    enum:
    - "standard-invoice"
    - "negative-invoice"
    - "reversed-invoice"
    - "write-off"
    x-swagger-router-model: "AdjustmentApplicationTypeDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentApplicationType"
      position: 94
  PartyType:
    type: "string"
    title: "PartyType"
    enum:
    - "person"
    - "organization"
    x-swagger-router-model: "PartyTypeDTO"
    x-reprezen-normalization:
      typeName: "PartyType"
      position: 95
  PartyRef:
    title: "PartyRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "party_type"
      discriminator: "party_type"
      properties:
        party_type:
          $ref: "#/definitions/PartyType"
    description: "A representation of a minimal TRACT party - person or organization"
    x-swagger-router-model: "PartyDTO"
    x-reprezen-normalization:
      typeName: "PartyRef"
      position: 96
  Party:
    title: "Party"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "addresses"
      - "party_type"
      discriminator: "party_type"
      properties:
        party_type:
          $ref: "#/definitions/PartyType"
        tax_id_number:
          type: "string"
          readOnly: true
        addresses:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/Address"
    description: "A representation of a TRACT party - person or organization"
    x-swagger-router-model: "PartyDTO"
    x-reprezen-normalization:
      typeName: "Party"
      position: 97
  PersonRef:
    title: "PersonRef"
    allOf:
    - $ref: "#/definitions/PartyRef"
    - type: "object"
    description: "A representation of a TRACT Person entity"
    x-swagger-router-model: "PersonDTO"
    x-discriminator-value: "person"
    x-reprezen-normalization:
      typeName: "PersonRef"
      position: 98
  Person:
    title: "Person"
    allOf:
    - $ref: "#/definitions/Party"
    - type: "object"
      required:
      - "first_name"
      - "last_name"
      properties:
        first_name:
          type: "string"
        last_name:
          type: "string"
        middle_name:
          type: "string"
        suffix:
          type: "string"
        dob:
          type: "string"
          format: "date"
        company:
          type: "string"
        department:
          type: "string"
        title:
          type: "string"
        contact_category:
          $ref: "#/definitions/ContactCategoryRef"
    description: "A representation of a TRACT Person entity"
    x-swagger-router-model: "PersonDTO"
    x-discriminator-value: "person"
    x-reprezen-normalization:
      typeName: "Person"
      position: 99
  OrganizationRef:
    title: "OrganizationRef"
    allOf:
    - $ref: "#/definitions/PartyRef"
    - type: "object"
    description: "A representation of a TRACT Organization entity"
    x-swagger-router-model: "OrganizationDTO"
    x-discriminator-value: "organization"
    x-reprezen-normalization:
      typeName: "OrganizationRef"
      position: 100
  Organization:
    title: "Organization"
    allOf:
    - $ref: "#/definitions/Party"
    - type: "object"
      required:
      - "organization_name"
      properties:
        organization_name:
          type: "string"
          readOnly: true
        tax_id_validated:
          type: "boolean"
          description: "Specifies if the tax id number has been validated"
          readOnly: true
    description: "A representation of a TRACT Organization entity"
    x-swagger-router-model: "OrganizationDTO"
    x-discriminator-value: "organization"
    x-reprezen-normalization:
      typeName: "Organization"
      position: 101
  CreateParty:
    type: "object"
    required:
    - "addresses"
    - "party_type"
    discriminator: "party_type"
    properties:
      party_type:
        $ref: "#/definitions/PartyType"
      tax_id_number:
        type: "string"
      addresses:
        type: "array"
        uniqueItems: true
        items:
          $ref: "#/definitions/CreateAddress"
    title: "CreateParty"
    description: "A representation of a TRACT party - person or organization"
    x-swagger-router-model: "CreatePartyDTO"
    x-reprezen-normalization:
      typeName: "CreateParty"
      position: 102
  CreatePerson:
    title: "CreatePerson"
    allOf:
    - $ref: "#/definitions/CreateParty"
    - type: "object"
      required:
      - "first_name"
      - "last_name"
      properties:
        first_name:
          type: "string"
        last_name:
          type: "string"
        middle_name:
          type: "string"
        suffix:
          type: "string"
        dob:
          type: "string"
          format: "date"
        company:
          type: "string"
        department:
          type: "string"
        title:
          type: "string"
        contact_category:
          $ref: "#/definitions/ContactCategoryRef"
    description: "A representation of a TRACT Person entity"
    x-swagger-router-model: "CreatePersonDTO"
    x-discriminator-value: "person"
    x-reprezen-normalization:
      typeName: "CreatePerson"
      position: 103
  CreateOrganization:
    title: "CreateOrganization"
    allOf:
    - $ref: "#/definitions/CreateParty"
    - type: "object"
      required:
      - "organization_name"
      properties:
        organization_name:
          type: "string"
        tax_id_validated:
          type: "boolean"
          description: "Specifies if the tax id number has been validated"
    description: "A representation of a TRACT Organization entity"
    x-swagger-router-model: "CreateOrganizationDTO"
    x-discriminator-value: "organization"
    x-reprezen-normalization:
      typeName: "CreateOrganization"
      position: 104
  UpdateParty:
    type: "object"
    required:
    - "party_type"
    discriminator: "party_type"
    properties:
      party_type:
        $ref: "#/definitions/PartyType"
      tax_id_number:
        type: "string"
    title: "UpdateParty"
    description: "A representation of a TRACT party - person or organization"
    x-swagger-router-model: "UpdatePartyDTO"
    x-reprezen-normalization:
      typeName: "UpdateParty"
      position: 105
  UpdatePerson:
    title: "UpdatePerson"
    allOf:
    - $ref: "#/definitions/UpdateParty"
    - type: "object"
      properties:
        first_name:
          type: "string"
        last_name:
          type: "string"
        middle_name:
          type: "string"
        suffix:
          type: "string"
        dob:
          type: "string"
          format: "date"
        company:
          type: "string"
        department:
          type: "string"
        title:
          type: "string"
    description: "A representation of a TRACT Person entity"
    x-swagger-router-model: "UpdatePersonDTO"
    x-discriminator-value: "person"
    x-reprezen-normalization:
      typeName: "UpdatePerson"
      position: 106
  UpdateOrganization:
    title: "UpdateOrganization"
    allOf:
    - $ref: "#/definitions/UpdateParty"
    - type: "object"
      properties:
        organization_name:
          type: "string"
        tax_id_validated:
          type: "boolean"
          description: "Specifies if the tax id number has been validated"
    description: "A representation of a TRACT Organization entity"
    x-swagger-router-model: "UpdateOrganizationDTO"
    x-discriminator-value: "organization"
    x-reprezen-normalization:
      typeName: "UpdateOrganization"
      position: 107
  ContactCategory:
    title: "ContactCategory"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
        description:
          type: "string"
        status:
          $ref: "#/definitions/ContactCategoryStatus"
    x-swagger-router-model: "ContactCategoryDTO"
    x-reprezen-normalization:
      typeName: "ContactCategory"
      position: 108
  ContactCategoryRef:
    title: "ContactCategoryRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    x-swagger-router-model: "ContactCategoryDTO"
    x-reprezen-normalization:
      typeName: "ContactCategoryRef"
      position: 109
  ContactCategoryStatus:
    type: "string"
    title: "ContactCategoryStatus"
    enum:
    - "ACTIVE"
    - "CANCELED"
    - "SUSPENDED"
    x-swagger-router-model: "ContactCategoryStatusDTO"
    x-reprezen-normalization:
      typeName: "ContactCategoryStatus"
      position: 110
  Service:
    title: "Service"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        description:
          type: "string"
        amount:
          type: "number"
        start_date:
          type: "string"
          format: "date-time"
        end_date:
          type: "string"
          format: "date-time"
        status:
          $ref: "#/definitions/ServiceStatus"
        billing_account:
          $ref: "#/definitions/BillingAccountRef"
        status_date:
          type: "string"
          format: "date-time"
        custom_field_values:
          type: "array"
          items:
            $ref: "#/definitions/ServiceCustomFieldValue"
        old_level:
          type: "integer"
          format: "int32"
        current_level:
          type: "integer"
          format: "int32"
        quantity:
          type: "number"
        addresses:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/PostalAddress"
        service_resources:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/ServiceResource"
        product:
          $ref: "#/definitions/ProductRef"
        parent_service:
          $ref: "#/definitions/ServiceRef"
        service_periods:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/ServicePeriod"
        current_agreement_service:
          $ref: "#/definitions/AgreementService"
        service_prices:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/ServicePrice"
        renewal_count:
          type: "integer"
          format: "int32"
        commitment_end_date:
          type: "string"
          format: "date-time"
        next_service:
          $ref: "#/definitions/ServiceRef"
        service_usage_rules:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/ServiceUsageRule"
        counters:
          type: "array"
          uniqueItems: true
          items:
            $ref: "#/definitions/Counter"
    x-swagger-router-model: "ServiceDTO"
    x-reprezen-normalization:
      typeName: "Service"
      position: 111
  ServiceRef:
    title: "ServiceRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    x-swagger-router-model: "ServiceDTO"
    x-reprezen-normalization:
      typeName: "ServiceRef"
      position: 112
  ServicePeriod:
    title: "ServicePeriod"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        start:
          type: "string"
          format: "date-time"
        end:
          type: "string"
          format: "date-time"
        last_event_date:
          type: "string"
          format: "date-time"
        closed:
          type: "boolean"
        service:
          $ref: "#/definitions/Service"
        re_rate:
          type: "boolean"
        usage_rules:
          type: "array"
          items:
            $ref: "#/definitions/UsageRule"
    x-swagger-router-model: "ServicePeriodDTO"
    x-reprezen-normalization:
      typeName: "ServicePeriod"
      position: 113
  ServicePrice:
    title: "ServicePrice"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        amount:
          type: "number"
        start_date:
          type: "string"
          format: "date-time"
        end_date:
          type: "string"
          format: "date-time"
        bill_in_advance:
          type: "boolean"
        service_price_ranges:
          type: "array"
          items:
            $ref: "#/definitions/ServicePriceRange"
        scheduled_recurring_charges:
          type: "array"
          items:
            $ref: "#/definitions/ServicePriceCharge"
        recurrence_period:
          $ref: "#/definitions/RecurrencePeriod"
        product_price:
          $ref: "#/definitions/ProductPrice"
        estimated_invoice_amount:
          type: "number"
        invoice_quantity:
          type: "number"
    x-swagger-router-model: "ServicePriceDTO"
    x-reprezen-normalization:
      typeName: "ServicePrice"
      position: 114
  ServicePriceRange:
    title: "ServicePriceRange"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        quantity_begin_range:
          type: "number"
        quantity_end_range:
          type: "number"
        price:
          type: "number"
    x-swagger-router-model: "ServicePriceRangeDTO"
    x-reprezen-normalization:
      typeName: "ServicePriceRange"
      position: 115
  AddServiceAddress:
    type: "object"
    properties:
      address:
        $ref: "#/definitions/CreatePostalAddress"
    title: "AddServiceAddress"
    description: "The payload to add a service address"
    x-swagger-router-model: "AddServiceAddressDTO"
    x-reprezen-normalization:
      typeName: "AddServiceAddress"
      position: 116
  DeactivateService:
    type: "object"
    properties:
      effective_date:
        type: "string"
        format: "date-time"
        description: "The date on which to perform the deactivation"
        title: "The date on which to perform the deactivation"
      reason:
        $ref: "#/definitions/ServiceDeactivationReason"
    title: "DeactivateService"
    description: "The payload to deactivate a service"
    x-swagger-router-model: "DeactivateServiceDTO"
    x-reprezen-normalization:
      typeName: "DeactivateService"
      position: 117
  ServiceStatus:
    type: "string"
    title: "ServiceStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "DEACTIVATED"
    - "PENDING"
    - "CANCELED"
    - "TRANSFERRED"
    - "REPLACED"
    - "TRIAL"
    - "SCHEDULED"
    x-swagger-router-model: "ServiceStatusDTO"
    x-reprezen-normalization:
      typeName: "ServiceStatus"
      position: 118
  ReturnScope:
    type: "string"
    title: "ReturnScope"
    enum:
    - "SIMPLE"
    - "FULL"
    x-swagger-router-model: "ReturnScopeDTO"
    x-reprezen-normalization:
      typeName: "ReturnScope"
      position: 119
  Product:
    title: "Product"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        product_type:
          $ref: "#/definitions/ProductType"
        name:
          type: "string"
          description: "(unique_key) The product name"
        description:
          type: "string"
        short_description:
          type: "string"
        state:
          $ref: "#/definitions/ProductState"
        sku:
          type: "string"
          description: "(unique_key) The product SKU"
        requires_agreement:
          type: "boolean"
        serialized:
          type: "boolean"
        taxable:
          type: "boolean"
        trial:
          type: "boolean"
        trial_days:
          type: "integer"
          format: "int32"
        trial_override:
          type: "boolean"
        default_quantity:
          type: "number"
        product_level:
          type: "integer"
          format: "int32"
        prices:
          type: "array"
          items:
            $ref: "#/definitions/ProductPrice"
        product_category:
          $ref: "#/definitions/ProductCategory"
        internal_name:
          type: "string"
        external_product_number:
          type: "string"
          description: "(unique_key) External product number"
        min_service_resources:
          type: "integer"
          format: "int32"
        max_service_resources:
          type: "integer"
          format: "int32"
        service_resource_category:
          $ref: "#/definitions/ResourceCategory"
        actions:
          type: "array"
          items:
            $ref: "#/definitions/Action"
        product_usage_rules:
          type: "array"
          items:
            $ref: "#/definitions/ProductUsageRule"
        product_tags:
          type: "array"
          items:
            $ref: "#/definitions/ProductTag"
    x-swagger-router-model: "ProductDTO"
    x-reprezen-normalization:
      typeName: "Product"
      position: 120
  ProductRef:
    title: "ProductRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        product_type:
          $ref: "#/definitions/ProductType"
        name:
          type: "string"
        sku:
          type: "string"
    x-swagger-router-model: "ProductDTO"
    x-reprezen-normalization:
      typeName: "ProductRef"
      position: 121
  ProductCategory:
    title: "ProductCategory"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
        description:
          type: "string"
        status:
          $ref: "#/definitions/ProductCategoryStatus"
    x-swagger-router-model: "ProductCategoryDTO"
    x-reprezen-normalization:
      typeName: "ProductCategory"
      position: 122
  ProductTag:
    title: "ProductTag"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
        description:
          type: "string"
        priority:
          type: "integer"
          format: "int32"
    x-swagger-router-model: "ProductTagDTO"
    x-reprezen-normalization:
      typeName: "ProductTag"
      position: 123
  ProductPrice:
    title: "ProductPrice"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "price_type"
      discriminator: "price_type"
      properties:
        price_type:
          $ref: "#/definitions/PriceType"
        from_date:
          type: "string"
          format: "date-time"
        thru_date:
          type: "string"
          format: "date-time"
        price_override:
          type: "boolean"
        allow_scheduled_charges:
          type: "boolean"
        price_ranges:
          type: "array"
          items:
            $ref: "#/definitions/ProductPriceRange"
        payment_on_purchase_required:
          type: "boolean"
        product_usage_rules:
          type: "array"
          items:
            $ref: "#/definitions/ProductUsageRule"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        price_category:
          $ref: "#/definitions/PriceCategory"
    x-swagger-router-model: "ProductPriceDTO"
    x-reprezen-normalization:
      typeName: "ProductPrice"
      position: 124
  ProductPriceRef:
    title: "ProductPriceRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "price_type"
      discriminator: "price_type"
      properties:
        price_type:
          $ref: "#/definitions/PriceType"
    x-swagger-router-model: "ProductPriceDTO"
    x-reprezen-normalization:
      typeName: "ProductPriceRef"
      position: 125
  OneTimeProductPrice:
    title: "OneTimeProductPrice"
    allOf:
    - $ref: "#/definitions/ProductPrice"
    - type: "object"
      properties:
        charge_during_renewal:
          type: "boolean"
    x-swagger-router-model: "OneTimeProductPriceDTO"
    x-discriminator-value: "one-time"
    x-reprezen-normalization:
      typeName: "OneTimeProductPrice"
      position: 126
  RecurringProductPrice:
    title: "RecurringProductPrice"
    allOf:
    - $ref: "#/definitions/ProductPrice"
    - type: "object"
      properties:
        recurring_payment_required:
          type: "boolean"
        recurrence_period:
          $ref: "#/definitions/RecurrencePeriod"
        recurrence_amount:
          type: "number"
        prorated_on_order:
          type: "boolean"
        prorated_on_cancel:
          type: "boolean"
        prorated_on_order_no_charge:
          type: "boolean"
        bill_in_advance:
          type: "boolean"
    x-swagger-router-model: "RecurringProductPriceDTO"
    x-discriminator-value: "recurring"
    x-reprezen-normalization:
      typeName: "RecurringProductPrice"
      position: 127
  OneTimeProductPriceRef:
    title: "OneTimeProductPriceRef"
    allOf:
    - $ref: "#/definitions/ProductPriceRef"
    - type: "object"
    x-swagger-router-model: "OneTimeProductPriceDTO"
    x-discriminator-value: "one-time"
    x-reprezen-normalization:
      typeName: "OneTimeProductPriceRef"
      position: 128
  RecurringProductPriceRef:
    title: "RecurringProductPriceRef"
    allOf:
    - $ref: "#/definitions/ProductPriceRef"
    - type: "object"
    x-swagger-router-model: "RecurringProductPriceDTO"
    x-discriminator-value: "recurring"
    x-reprezen-normalization:
      typeName: "RecurringProductPriceRef"
      position: 129
  ProductPriceRange:
    title: "ProductPriceRange"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        quantity_begin_range:
          type: "number"
        quantity_end_range:
          type: "number"
        price:
          type: "number"
        level:
          type: "integer"
          format: "int32"
        currency_code:
          $ref: "#/definitions/CurrencyCode"
    x-swagger-router-model: "ProductPriceRangeDTO"
    x-reprezen-normalization:
      typeName: "ProductPriceRange"
      position: 130
  ProductType:
    type: "string"
    title: "ProductType"
    enum:
    - "tract-subscription"
    - "customer-subscription"
    - "general"
    - "addon"
    x-swagger-router-model: "ProductTypeDTO"
    x-reprezen-normalization:
      typeName: "ProductType"
      position: 131
  ProductState:
    type: "string"
    title: "ProductState"
    enum:
    - "DRAFT"
    - "AVAILABLE"
    - "NOT_AVAILABLE"
    x-swagger-router-model: "ProductStateDTO"
    x-reprezen-normalization:
      typeName: "ProductState"
      position: 132
  ProductCategoryStatus:
    type: "string"
    title: "ProductCategoryStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-swagger-router-model: "ProductCategoryStatusDTO"
    x-reprezen-normalization:
      typeName: "ProductCategoryStatus"
      position: 133
  TenantChargeFileType_1:
    type: "string"
    title: "TenantChargeFileType"
    enum:
    - "ACTIVE_ACCOUNTS"
    - "GROSS_BILLING"
    - "ORDER"
    x-swagger-router-model: "TenantChargeFileTypeDTO"
    x-reprezen-normalization:
      typeName: "TenantChargeFileType"
      position: 134
  RecurrencePeriod:
    type: "string"
    title: "RecurrencePeriod"
    enum:
    - "BILL_CYCLE"
    - "DAY"
    - "FOUR_YEARS"
    - "FIVE_YEARS"
    - "MONTH"
    - "QUARTER"
    - "THREE_YEARS"
    - "TWICE_A_MONTH"
    - "TWICE_A_YEAR"
    - "TWO_WEEKS"
    - "TWO_YEARS"
    - "WEEK"
    - "YEAR"
    - "FOUR_MONTHS"
    x-swagger-router-model: "RecurrencePeriodDTO"
    x-reprezen-normalization:
      typeName: "RecurrencePeriod"
      position: 135
  Address:
    title: "Address"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "address_type"
      discriminator: "address_type"
      properties:
        address_type:
          $ref: "#/definitions/AddressType"
    description: "A representation of a TRACT address"
    x-swagger-router-model: "AddressDTO"
    x-reprezen-normalization:
      typeName: "Address"
      position: 136
  CreateAddress:
    type: "object"
    required:
    - "address_type"
    discriminator: "address_type"
    properties:
      address_type:
        $ref: "#/definitions/AddressType"
    title: "CreateAddress"
    description: "A representation of a TRACT address"
    x-swagger-router-model: "CreateAddressDTO"
    x-reprezen-normalization:
      typeName: "CreateAddress"
      position: 137
  EmailAddress:
    title: "EmailAddress"
    allOf:
    - $ref: "#/definitions/Address"
    - type: "object"
      required:
      - "email"
      - "purpose"
      properties:
        purpose:
          $ref: "#/definitions/EmailAddressPurpose"
        email:
          type: "string"
          format: "email"
          pattern: "[a-zA-Z0-0]+@[a-zA-Z0-0.]+"
    x-swagger-router-model: "EmailAddressDTO"
    x-discriminator-value: "email"
    x-reprezen-normalization:
      typeName: "EmailAddress"
      position: 138
  CreateEmailAddress:
    title: "CreateEmailAddress"
    allOf:
    - $ref: "#/definitions/CreateAddress"
    - type: "object"
      required:
      - "email"
      - "purpose"
      properties:
        purpose:
          $ref: "#/definitions/EmailAddressPurpose"
        email:
          type: "string"
          format: "email"
          pattern: "[a-zA-Z0-0]+@[a-zA-Z0-0.]+"
    x-swagger-router-model: "CreateEmailAddressDTO"
    x-discriminator-value: "email"
    x-reprezen-normalization:
      typeName: "CreateEmailAddress"
      position: 139
  PostalAddress:
    title: "PostalAddress"
    allOf:
    - $ref: "#/definitions/Address"
    - type: "object"
      required:
      - "city"
      - "country"
      - "line1"
      - "postal_code"
      - "purpose"
      - "region_or_state"
      properties:
        purpose:
          $ref: "#/definitions/PostalAddressPurpose"
        country:
          type: "string"
        city:
          type: "string"
        region_or_state:
          type: "string"
        attention:
          type: "string"
        postal_code:
          type: "string"
        line1:
          type: "string"
        line2:
          type: "string"
        p_code:
          type: "integer"
          format: "int32"
        p_code_overridden:
          type: "boolean"
    x-swagger-router-model: "PostalAddressDTO"
    x-discriminator-value: "postal"
    x-reprezen-normalization:
      typeName: "PostalAddress"
      position: 140
  CreatePostalAddress:
    title: "CreatePostalAddress"
    allOf:
    - $ref: "#/definitions/CreateAddress"
    - type: "object"
      required:
      - "city"
      - "country"
      - "line1"
      - "postal_code"
      - "purpose"
      - "region_or_state"
      properties:
        purpose:
          $ref: "#/definitions/PostalAddressPurpose"
        country:
          type: "string"
        city:
          type: "string"
        region_or_state:
          type: "string"
        attention:
          type: "string"
        postal_code:
          type: "string"
        line1:
          type: "string"
        line2:
          type: "string"
        p_code:
          type: "integer"
          format: "int32"
        p_code_overridden:
          type: "boolean"
    x-swagger-router-model: "PostalAddressDTO"
    x-discriminator-value: "postal"
    x-reprezen-normalization:
      typeName: "CreatePostalAddress"
      position: 141
  TelecomAddress:
    title: "TelecomAddress"
    allOf:
    - $ref: "#/definitions/Address"
    - type: "object"
      required:
      - "area_code"
      - "number"
      - "purpose"
      properties:
        purpose:
          $ref: "#/definitions/TelecomAddressPurpose"
        dialing_prefix:
          type: "string"
        country_code:
          type: "string"
        area_code:
          type: "string"
        number:
          type: "string"
        extension:
          type: "string"
    x-swagger-router-model: "TelecomAddressDTO"
    x-discriminator-value: "telecom"
    x-reprezen-normalization:
      typeName: "TelecomAddress"
      position: 142
  CreateTelecomAddress:
    title: "CreateTelecomAddress"
    allOf:
    - $ref: "#/definitions/CreateAddress"
    - type: "object"
      required:
      - "area_code"
      - "number"
      - "purpose"
      properties:
        purpose:
          $ref: "#/definitions/TelecomAddressPurpose"
        dialing_prefix:
          type: "string"
        country_code:
          type: "string"
        area_code:
          type: "string"
        number:
          type: "string"
        extension:
          type: "string"
    x-swagger-router-model: "CreateTelecomAddressDTO"
    x-discriminator-value: "telecom"
    x-reprezen-normalization:
      typeName: "CreateTelecomAddress"
      position: 143
  AddressType:
    type: "string"
    title: "AddressType"
    enum:
    - "postal"
    - "email"
    - "telecom"
    x-reprezen-normalization:
      typeName: "AddressType"
      position: 144
  PostalAddressPurpose:
    type: "string"
    title: "PostalAddressPurpose"
    enum:
    - "BILLING"
    - "SHIPPING"
    - "SERVICE"
    - "PAYMENT"
    x-swagger-router-model: "PostalAddressPurposeDTO"
    x-reprezen-normalization:
      typeName: "PostalAddressPurpose"
      position: 145
  EmailAddressPurpose:
    type: "string"
    title: "EmailAddressPurpose"
    enum:
    - "PRIMARY"
    - "SECONDARY"
    - "PAYMENT"
    x-swagger-router-model: "EmailAddressPurposeDTO"
    x-reprezen-normalization:
      typeName: "EmailAddressPurpose"
      position: 146
  TelecomAddressPurpose:
    type: "string"
    title: "TelecomAddressPurpose"
    enum:
    - "OFFICE"
    - "HOME"
    - "FAX"
    - "MOBILE"
    - "PAYMENT"
    x-swagger-router-model: "TelecomAddressPurposeDTO"
    x-reprezen-normalization:
      typeName: "TelecomAddressPurpose"
      position: 147
  GenericResource:
    title: "GenericResource"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      discriminator: "resource_type"
      properties:
        resource_type:
          $ref: "#/definitions/ResourceType"
        identifier:
          type: "string"
          description: "(unique_key)"
        description:
          type: "string"
        category:
          $ref: "#/definitions/ResourceCategoryRef"
    x-swagger-router-model: "AbstractResourceDTO"
    x-reprezen-normalization:
      typeName: "GenericResource"
      position: 148
  GenericResourceRef:
    title: "GenericResourceRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        identifier:
          type: "string"
          description: "(unique_key)"
    x-swagger-router-model: "AbstractResourceDTO"
    x-reprezen-normalization:
      typeName: "GenericResourceRef"
      position: 149
  ServiceResource:
    title: "ServiceResource"
    allOf:
    - $ref: "#/definitions/GenericResource"
    - type: "object"
      properties:
        auto_select:
          type: "boolean"
        status:
          $ref: "#/definitions/ServiceResourceStatus"
    x-swagger-router-model: "GenericServiceResourceDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "ServiceResource"
      position: 150
  ResourceCategory:
    title: "ResourceCategory"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The name of a TRACT service resource category"
        resource_type:
          $ref: "#/definitions/ResourceType"
        status:
          $ref: "#/definitions/ResourceCategoryStatus"
        allow_multiple_services:
          type: "boolean"
          description: "Allows more than one service to use a service-resource"
    x-swagger-router-model: "ResourceCategoryDTO"
    x-reprezen-normalization:
      typeName: "ResourceCategory"
      position: 151
  ResourceCategoryRef:
    title: "ResourceCategoryRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The name of a TRACT service resource category"
    x-swagger-router-model: "ResourceCategoryDTO"
    x-reprezen-normalization:
      typeName: "ResourceCategoryRef"
      position: 152
  AddServiceResource:
    type: "object"
    required:
    - "service_resource"
    properties:
      service_resource:
        $ref: "#/definitions/ServiceResource"
      effective_date:
        type: "string"
        format: "date-time"
        example: "2015-04-01T12:13:26.000-05:00"
    title: "AddServiceResource"
    x-swagger-router-model: "AddServiceResourceDTO"
    x-reprezen-normalization:
      typeName: "AddServiceResource"
      position: 153
  CreateResource:
    type: "object"
    required:
    - "category"
    - "identifier"
    - "resource_type"
    discriminator: "resource_type"
    properties:
      resource_type:
        $ref: "#/definitions/ResourceType"
      identifier:
        type: "string"
        description: "(unique_key)"
      description:
        type: "string"
      category:
        $ref: "#/definitions/ResourceCategoryRef"
    title: "CreateResource"
    x-swagger-router-model: "CreateResourceDTO"
    x-reprezen-normalization:
      typeName: "CreateResource"
      position: 154
  CreateServiceResource:
    title: "CreateServiceResource"
    allOf:
    - $ref: "#/definitions/CreateResource"
    - type: "object"
      properties:
        auto_select:
          type: "boolean"
          description: "Select an existing service resource available for use"
        status:
          $ref: "#/definitions/ServiceResourceStatus"
    x-swagger-router-model: "CreateServiceResourceDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "CreateServiceResource"
      position: 155
  ServiceResourceStatus:
    type: "string"
    title: "ServiceResourceStatus"
    enum:
    - "REQUESTED"
    - "AVAILABLE"
    - "ACTIVE"
    - "DEACTIVATED"
    - "QUARANTINED"
    - "USED"
    - "RESERVED"
    x-swagger-router-model: "GenericServiceResourceStatusDTO"
    x-reprezen-normalization:
      typeName: "ServiceResourceStatus"
      position: 156
  ResourceCategoryStatus:
    type: "string"
    title: "ResourceCategoryStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-swagger-router-model: "ServiceResourceCategoryStatusDTO"
    x-reprezen-normalization:
      typeName: "ResourceCategoryStatus"
      position: 157
  ResourceType:
    type: "string"
    title: "ResourceType"
    enum:
    - "service"
    - "discount"
    x-swagger-router-model: "ServiceIdentifierTypeDTO"
    x-reprezen-normalization:
      typeName: "ResourceType"
      position: 158
  CustomFieldValue:
    title: "CustomFieldValue"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "custom_field_value_type"
      discriminator: "custom_field_value_type"
      properties:
        custom_field_value_type:
          $ref: "#/definitions/CustomFieldValueType"
        value:
          type: "string"
          description: "The custom field value."
        custom_field:
          $ref: "#/definitions/CustomFieldRef"
    x-swagger-router-model: "CustomFieldValueDTO"
    x-reprezen-normalization:
      typeName: "CustomFieldValue"
      position: 159
  OrderCustomFieldValue:
    title: "OrderCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CustomFieldValue"
    - type: "object"
    x-swagger-router-model: "OrderCustomFieldValueDTO"
    x-discriminator-value: "order"
    x-reprezen-normalization:
      typeName: "OrderCustomFieldValue"
      position: 160
  PaymentMethodCustomFieldValue:
    title: "PaymentMethodCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CustomFieldValue"
    - type: "object"
    x-swagger-router-model: "PaymentMethodCustomFieldValueDTO"
    x-discriminator-value: "payment-method"
    x-reprezen-normalization:
      typeName: "PaymentMethodCustomFieldValue"
      position: 161
  BillingAccountCustomFieldValue:
    title: "BillingAccountCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CustomFieldValue"
    - type: "object"
    x-swagger-router-model: "BillingAccountCustomFieldValueDTO"
    x-discriminator-value: "billing-account"
    x-reprezen-normalization:
      typeName: "BillingAccountCustomFieldValue"
      position: 162
  ServiceCustomFieldValue:
    title: "ServiceCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CustomFieldValue"
    - type: "object"
    x-swagger-router-model: "ServiceCustomFieldValueDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "ServiceCustomFieldValue"
      position: 163
  CreateCustomFieldValue:
    type: "object"
    required:
    - "custom_field"
    - "custom_field_value_type"
    discriminator: "custom_field_value_type"
    properties:
      custom_field_value_type:
        $ref: "#/definitions/CustomFieldValueType"
      value:
        type: "string"
        description: "The custom field value."
      custom_field:
        $ref: "#/definitions/CustomFieldRef"
    title: "CreateCustomFieldValue"
    x-swagger-router-model: "CustomFieldValueDTO"
    x-reprezen-normalization:
      typeName: "CreateCustomFieldValue"
      position: 164
  CreateOrderCustomFieldValue:
    title: "CreateOrderCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CreateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "OrderCustomFieldValueDTO"
    x-discriminator-value: "order"
    x-reprezen-normalization:
      typeName: "CreateOrderCustomFieldValue"
      position: 165
  CreatePaymentMethodCustomFieldValue:
    title: "CreatePaymentMethodCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CreateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "PaymentMethodCustomFieldValueDTO"
    x-discriminator-value: "payment-method"
    x-reprezen-normalization:
      typeName: "CreatePaymentMethodCustomFieldValue"
      position: 166
  CreateBillingAccountCustomFieldValue:
    title: "CreateBillingAccountCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CreateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "BillingAccountCustomFieldValueDTO"
    x-discriminator-value: "billing-account"
    x-reprezen-normalization:
      typeName: "CreateBillingAccountCustomFieldValue"
      position: 167
  CreateServiceCustomFieldValue:
    title: "CreateServiceCustomFieldValue"
    allOf:
    - $ref: "#/definitions/CreateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "ServiceCustomFieldValueDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "CreateServiceCustomFieldValue"
      position: 168
  UpdateCustomFieldValue:
    type: "object"
    required:
    - "custom_field_value_type"
    discriminator: "custom_field_value_type"
    properties:
      custom_field_value_type:
        $ref: "#/definitions/CustomFieldValueType"
      value:
        type: "string"
        description: "The custom field value."
    title: "UpdateCustomFieldValue"
    x-swagger-router-model: "CustomFieldValueDTO"
    x-reprezen-normalization:
      typeName: "UpdateCustomFieldValue"
      position: 169
  UpdateOrderCustomFieldValue:
    title: "UpdateOrderCustomFieldValue"
    allOf:
    - $ref: "#/definitions/UpdateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "OrderCustomFieldValueDTO"
    x-discriminator-value: "order"
    x-reprezen-normalization:
      typeName: "UpdateOrderCustomFieldValue"
      position: 170
  UpdatePaymentMethodCustomFieldValue:
    title: "UpdatePaymentMethodCustomFieldValue"
    allOf:
    - $ref: "#/definitions/UpdateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "PaymentMethodCustomFieldValueDTO"
    x-discriminator-value: "payment-method"
    x-reprezen-normalization:
      typeName: "UpdatePaymentMethodCustomFieldValue"
      position: 171
  UpdateBillingAccountCustomFieldValue:
    title: "UpdateBillingAccountCustomFieldValue"
    allOf:
    - $ref: "#/definitions/UpdateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "BillingAccountCustomFieldValueDTO"
    x-discriminator-value: "billing-account"
    x-reprezen-normalization:
      typeName: "UpdateBillingAccountCustomFieldValue"
      position: 172
  UpdateServiceCustomFieldValue:
    title: "UpdateServiceCustomFieldValue"
    allOf:
    - $ref: "#/definitions/UpdateCustomFieldValue"
    - type: "object"
    x-swagger-router-model: "ServiceCustomFieldValueDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "UpdateServiceCustomFieldValue"
      position: 173
  CustomField:
    title: "CustomField"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "custom_field_type"
      discriminator: "custom_field_type"
      properties:
        name:
          type: "string"
          description: "(unique_key)"
          readOnly: true
        custom_field_type:
          $ref: "#/definitions/CustomFieldType"
        description:
          type: "string"
          readOnly: true
        enabled:
          type: "boolean"
          readOnly: true
        searchable:
          type: "boolean"
          readOnly: true
        reg_ex:
          type: "string"
          readOnly: true
        field_type:
          $ref: "#/definitions/FieldType"
        field_validation_type:
          $ref: "#/definitions/FieldValidationType"
        references:
          type: "array"
          items:
            $ref: "#/definitions/CustomFieldValueReference"
    x-swagger-router-model: "CustomFieldDTO"
    x-reprezen-normalization:
      typeName: "CustomField"
      position: 174
  CustomFieldRef:
    title: "CustomFieldRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "custom_field_type"
      discriminator: "custom_field_type"
      properties:
        name:
          type: "string"
          description: "(unique_key)"
        custom_field_type:
          $ref: "#/definitions/CustomFieldType"
    x-swagger-router-model: "CustomFieldDTO"
    x-discriminator-value: "custom-field"
    x-reprezen-normalization:
      typeName: "CustomFieldRef"
      position: 175
  CustomFieldValueReference:
    title: "CustomFieldValueReference"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        value:
          type: "string"
          description: "The value for this reference"
        status:
          $ref: "#/definitions/CustomFieldValueReferenceStatus"
    x-swagger-router-model: "CustomFieldValueReferenceDTO"
    x-reprezen-normalization:
      typeName: "CustomFieldValueReference"
      position: 176
  CustomFieldValueReferenceStatus:
    type: "string"
    title: "CustomFieldValueReferenceStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    x-swagger-router-model: "CustomFieldValueReferenceStatusDTO"
    x-reprezen-normalization:
      typeName: "CustomFieldValueReferenceStatus"
      position: 177
  FieldType:
    type: "string"
    title: "FieldType"
    enum:
    - "TEXT_FIELD"
    - "LIST"
    x-swagger-router-model: "FieldTypeDTO"
    x-reprezen-normalization:
      typeName: "FieldType"
      position: 178
  FieldValidationType:
    type: "string"
    title: "FieldValidationType"
    enum:
    - "TEXT"
    - "BOOLEAN"
    - "DECIMAL"
    - "DATE"
    - "INTEGER"
    - "CUSTOM"
    x-swagger-router-model: "FieldValidationTypeDTO"
    x-reprezen-normalization:
      typeName: "FieldValidationType"
      position: 179
  CustomFieldType:
    type: "string"
    title: "CustomFieldType"
    enum:
    - "billing-account"
    - "order"
    - "service"
    - "payment-method"
    x-swagger-router-model: "CustomFieldTypeDTO"
    x-reprezen-normalization:
      typeName: "CustomFieldType"
      position: 180
  CustomFieldValueType:
    type: "string"
    title: "CustomFieldValueType"
    enum:
    - "billing-account"
    - "order"
    - "service"
    - "payment-method"
    - "order-item"
    x-reprezen-normalization:
      typeName: "CustomFieldValueType"
      position: 181
  ServiceCustomField:
    title: "ServiceCustomField"
    allOf:
    - $ref: "#/definitions/CustomField"
    - type: "object"
      properties:
        actions:
          type: "array"
          items:
            $ref: "#/definitions/ServiceCFVAction"
    x-swagger-router-model: "ServiceCustomFieldDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "ServiceCustomField"
      position: 182
  ServiceCustomFieldRef:
    title: "ServiceCustomFieldRef"
    allOf:
    - $ref: "#/definitions/CustomFieldRef"
    - type: "object"
    x-swagger-router-model: "ServiceCustomFieldDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "ServiceCustomFieldRef"
      position: 183
  OrderCustomField:
    title: "OrderCustomField"
    allOf:
    - $ref: "#/definitions/CustomField"
    - type: "object"
    x-swagger-router-model: "OrderCustomFieldDTO"
    x-discriminator-value: "order"
    x-reprezen-normalization:
      typeName: "OrderCustomField"
      position: 184
  PaymentMethodCustomField:
    title: "PaymentMethodCustomField"
    allOf:
    - $ref: "#/definitions/CustomField"
    - type: "object"
      properties:
        payment_method_type:
          $ref: "#/definitions/PaymentMethodType"
    x-swagger-router-model: "PaymentMethodCustomFieldDTO"
    x-discriminator-value: "payment-method"
    x-reprezen-normalization:
      typeName: "PaymentMethodCustomField"
      position: 185
  BillingAccountCustomField:
    title: "BillingAccountCustomField"
    allOf:
    - $ref: "#/definitions/CustomField"
    - type: "object"
    x-swagger-router-model: "BillingAccountCustomFieldDTO"
    x-discriminator-value: "billing-account"
    x-reprezen-normalization:
      typeName: "BillingAccountCustomField"
      position: 186
  PaymentType:
    type: "string"
    title: "PaymentType"
    enum:
    - "payment"
    - "refund"
    x-swagger-router-model: "PaymentTypeDTO"
    x-reprezen-normalization:
      typeName: "PaymentType"
      position: 187
  CreatePaymentMethodType:
    type: "string"
    title: "CreatePaymentMethodType"
    enum:
    - "bank"
    - "credit-card"
    - "cash"
    - "check"
    - "referenced-credit-card"
    - "paypal"
    - "pay-by-paypal"
    - "wire"
    - "mobile-carrier"
    - "custom"
    - "sepa-dd"
    - "sepa-dd-em"
    x-swagger-router-model: "PaymentMethodTypeDTO"
    x-reprezen-normalization:
      typeName: "CreatePaymentMethodType"
      position: 188
  PaymentMethodType:
    type: "string"
    title: "PaymentMethodType"
    enum:
    - "bank"
    - "credit-card"
    - "cash"
    - "check"
    - "referenced-credit-card"
    - "paypal"
    - "pay-by-paypal"
    - "wire"
    - "mobile-carrier"
    - "custom"
    - "sepa-dd"
    - "sepa-dd-em - direct-debit"
    x-swagger-router-model: "PaymentMethodTypeDTO"
    x-reprezen-normalization:
      typeName: "PaymentMethodType"
      position: 189
  BankPaymentMethodType:
    type: "string"
    title: "BankPaymentMethodType"
    enum:
    - "SAVINGS"
    - "CHECKING"
    x-swagger-router-model: "BankPaymentMethodTypeDTO"
    x-reprezen-normalization:
      typeName: "BankPaymentMethodType"
      position: 190
  CardType:
    type: "string"
    title: "CardType"
    description: "The credit card types supported"
    enum:
    - "AMEX"
    - "DINERSCLUB"
    - "DISCOVER"
    - "MASTERCARD"
    - "VISA"
    x-swagger-router-model: "CardTypeDTO"
    x-reprezen-normalization:
      typeName: "CardType"
      position: 191
  PaymentStatus:
    type: "string"
    title: "PaymentStatus"
    enum:
    - "DRAFT"
    - "PROCESSING"
    - "COMPLETED"
    - "VOID"
    - "PROCESSING_ERROR"
    - "MERCHANT_VERIFICATION"
    - "MERCHANT_VERIFICATION_FAILED"
    - "CANCELED"
    - "ALLOCATION_ERROR"
    x-swagger-router-model: "PaymentStatusDTO"
    x-reprezen-normalization:
      typeName: "PaymentStatus"
      position: 192
  PaymentTerm:
    title: "PaymentTerm"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The TRACT payment-term name"
        term_days:
          type: "integer"
          format: "int32"
        grace_days:
          type: "integer"
          format: "int32"
    description: "A representation of a TRACT SegmentedMonthly Bill Cycle entity"
    x-swagger-router-model: "PaymentTermDTO"
    x-reprezen-normalization:
      typeName: "PaymentTerm"
      position: 193
  PaymentTermRef:
    title: "PaymentTermRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The TRACT payment-term name"
    description: "A representation of a TRACT SegmentedMonthly Bill Cycle entity"
    x-swagger-router-model: "PaymentTermDTO"
    x-reprezen-normalization:
      typeName: "PaymentTermRef"
      position: 194
  RecurringPaymentRef:
    title: "RecurringPaymentRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    description: "A Billing Account Recurring Payment object."
    x-swagger-router-model: "BillingAccountRecurringPaymentDTO"
    x-reprezen-normalization:
      typeName: "RecurringPaymentRef"
      position: 195
  CreateRecurringPayment:
    type: "object"
    required:
    - "payment_method"
    properties:
      payment_method:
        $ref: "#/definitions/CreatePaymentMethod"
      auto_payment:
        type: "boolean"
    title: "CreateRecurringPayment"
    description: "A Billing Account Recurring Payment object."
    x-swagger-router-model: "BillingAccountRecurringPaymentDTO"
    x-reprezen-normalization:
      typeName: "CreateRecurringPayment"
      position: 196
  RecurringPayment:
    title: "RecurringPayment"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "billing_account"
      - "payment_method"
      properties:
        payment_method:
          $ref: "#/definitions/PaymentMethod"
        billing_account:
          $ref: "#/definitions/BillingAccountRef"
        valid_from:
          type: "string"
          format: "date-time"
          readOnly: true
        valid_to:
          type: "string"
          format: "date-time"
          readOnly: true
        auto_payment:
          type: "boolean"
          readOnly: true
    description: "A Billing Account Recurring Payment object."
    x-swagger-router-model: "BillingAccountRecurringPaymentDTO"
    x-reprezen-normalization:
      typeName: "RecurringPayment"
      position: 197
  BasePayment:
    title: "BasePayment"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "payment_type"
      discriminator: "payment_type"
      properties:
        payment_type:
          $ref: "#/definitions/PaymentMethodType"
        amount:
          type: "number"
          readOnly: true
        description:
          type: "string"
          readOnly: true
        payment_method:
          $ref: "#/definitions/PaymentMethod"
        billing_account:
          $ref: "#/definitions/BillingAccountRef"
        occurred_on:
          type: "string"
          format: "date-time"
          readOnly: true
        authorization:
          type: "string"
          readOnly: true
        reference:
          type: "string"
          readOnly: true
        use_recurring_payment:
          type: "boolean"
          readOnly: true
        unapplied_amount:
          type: "number"
        status:
          $ref: "#/definitions/PaymentStatus"
        ip_address:
          type: "string"
          description: "The IP address"
    description: "The parent for a Payment object."
    x-swagger-router-model: "AbstractPaymentDTO"
    x-reprezen-normalization:
      typeName: "BasePayment"
      position: 198
  BasePaymentRef:
    title: "BasePaymentRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    description: "The parent for a Payment object."
    x-swagger-router-model: "AbstractPaymentDTO"
    x-discriminator-value: "base-payment"
    x-reprezen-normalization:
      typeName: "BasePaymentRef"
      position: 199
  Payment:
    title: "Payment"
    allOf:
    - $ref: "#/definitions/BasePayment"
    - type: "object"
      properties:
        received_amount:
          type: "number"
          readOnly: true
        refunded_amount:
          type: "number"
          readOnly: true
        canceled_amount:
          type: "number"
          readOnly: true
        received_currency_code:
          $ref: "#/definitions/CurrencyCode"
        conversion_rate:
          type: "number"
          readOnly: true
        effective_conversion_rate:
          type: "number"
          readOnly: true
        apply_automatically:
          type: "boolean"
          readOnly: true
        refunds:
          type: "array"
          items:
            $ref: "#/definitions/Refund"
    description: "The Payment object."
    x-swagger-router-model: "PaymentDTO"
    x-discriminator-value: "payment"
    x-reprezen-normalization:
      typeName: "Payment"
      position: 200
  PaymentRef:
    title: "PaymentRef"
    allOf:
    - $ref: "#/definitions/BasePaymentRef"
    - type: "object"
    description: "The Payment object."
    x-swagger-router-model: "PaymentDTO"
    x-discriminator-value: "payment"
    x-reprezen-normalization:
      typeName: "PaymentRef"
      position: 201
  Refund:
    title: "Refund"
    allOf:
    - $ref: "#/definitions/BasePayment"
    - type: "object"
      properties:
        payment_change_reason:
          $ref: "#/definitions/PaymentChangeReason"
        original_payment:
          $ref: "#/definitions/Payment"
    description: "The Payment object."
    x-swagger-router-model: "PaymentDTO"
    x-discriminator-value: "refund"
    x-reprezen-normalization:
      typeName: "Refund"
      position: 202
  PaymentMethod:
    title: "PaymentMethod"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "payment_method_type"
      discriminator: "payment_method_type"
      properties:
        payment_method_type:
          $ref: "#/definitions/PaymentMethodType"
        custom_field_values:
          type: "array"
          items:
            $ref: "#/definitions/PaymentMethodCustomFieldValue"
    description: "A representation of the TRACT PaymentMethodDTO"
    x-swagger-router-model: "PaymentMethodDTO"
    x-reprezen-normalization:
      typeName: "PaymentMethod"
      position: 203
  PaymentMethodRef:
    title: "PaymentMethodRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    description: "A representation of the TRACT PaymentMethodDTO"
    x-swagger-router-model: "PaymentMethodDTO"
    x-discriminator-value: "payment-method"
    x-reprezen-normalization:
      typeName: "PaymentMethodRef"
      position: 204
  BankPaymentMethod:
    title: "BankPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        bank_name:
          type: "string"
          readOnly: true
        routing_number:
          type: "string"
          readOnly: true
        account_type:
          $ref: "#/definitions/BankPaymentMethodType"
        account_number:
          type: "string"
          readOnly: true
        check_number:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT BankPaymentMethodDTO"
    x-swagger-router-model: "BankPaymentMethodDTO"
    x-discriminator-value: "bank"
    x-reprezen-normalization:
      typeName: "BankPaymentMethod"
      position: 205
  BankPaymentMethodRef:
    title: "BankPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT BankPaymentMethodDTO"
    x-swagger-router-model: "BankPaymentMethodDTO"
    x-discriminator-value: "bank"
    x-reprezen-normalization:
      typeName: "BankPaymentMethodRef"
      position: 206
  CreditCardPaymentMethod:
    title: "CreditCardPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        card_type:
          $ref: "#/definitions/CardType"
        first_name:
          type: "string"
          readOnly: true
        middle_name:
          type: "string"
          readOnly: true
        last_name:
          type: "string"
          readOnly: true
        suffix:
          type: "string"
          readOnly: true
        identifier_number:
          type: "string"
          readOnly: true
        verification_number:
          type: "string"
          readOnly: true
        expiration_date:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CreditCardPaymentMethodDTO"
    x-swagger-router-model: "CreditCardPaymentMethodDTO"
    x-discriminator-value: "credit-card"
    x-reprezen-normalization:
      typeName: "CreditCardPaymentMethod"
      position: 207
  CreditCardPaymentMethodRef:
    title: "CreditCardPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT CreditCardPaymentMethodDTO"
    x-swagger-router-model: "CreditCardPaymentMethodDTO"
    x-discriminator-value: "credit-card"
    x-reprezen-normalization:
      typeName: "CreditCardPaymentMethodRef"
      position: 208
  CashPaymentMethod:
    title: "CashPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
    description: "A representation of the TRACT CashPaymentMethodDTO"
    x-swagger-router-model: "CashPaymentMethodDTO"
    x-discriminator-value: "cash"
    x-reprezen-normalization:
      typeName: "CashPaymentMethod"
      position: 209
  CashPaymentMethodRef:
    title: "CashPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT CashPaymentMethodDTO"
    x-swagger-router-model: "CashPaymentMethodDTO"
    x-discriminator-value: "cash"
    x-reprezen-normalization:
      typeName: "CashPaymentMethodRef"
      position: 210
  CheckPaymentMethod:
    title: "CheckPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        check_number:
          type: "string"
          readOnly: true
        routing_number:
          type: "string"
          readOnly: true
        account_number:
          type: "string"
          readOnly: true
        customer_name:
          type: "string"
          readOnly: true
        description:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CheckPaymentMethodDTO"
    x-swagger-router-model: "CheckPaymentMethodDTO"
    x-discriminator-value: "check"
    x-reprezen-normalization:
      typeName: "CheckPaymentMethod"
      position: 211
  CheckPaymentMethodRef:
    title: "CheckPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT CheckPaymentMethodDTO"
    x-swagger-router-model: "CheckPaymentMethodDTO"
    x-discriminator-value: "check"
    x-reprezen-normalization:
      typeName: "CheckPaymentMethodRef"
      position: 212
  ReferencedCreditCardPaymentMethod:
    title: "ReferencedCreditCardPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        reference_key:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT ReferencedCreditCardPaymentMethodDTO"
    x-swagger-router-model: "ReferencedCreditCardPaymentMethodDTO"
    x-discriminator-value: "referenced-credit-card"
    x-reprezen-normalization:
      typeName: "ReferencedCreditCardPaymentMethod"
      position: 213
  ReferencedCreditCardPaymentMethodRef:
    title: "ReferencedCreditCardPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT ReferencedCreditCardPaymentMethodDTO"
    x-swagger-router-model: "ReferencedCreditCardPaymentMethodDTO"
    x-discriminator-value: "referenced-credit-card"
    x-reprezen-normalization:
      typeName: "ReferencedCreditCardPaymentMethodRef"
      position: 214
  PayPalPaymentMethod:
    title: "PayPalPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        pre_approval_key:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT PayPalPaymentMethodDTO"
    x-swagger-router-model: "PayPalPaymentMethodDTO"
    x-discriminator-value: "paypal"
    x-reprezen-normalization:
      typeName: "PayPalPaymentMethod"
      position: 215
  PayPalPaymentMethodRef:
    title: "PayPalPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT PayPalPaymentMethodDTO"
    x-swagger-router-model: "PayPalPaymentMethodDTO"
    x-discriminator-value: "paypal"
    x-reprezen-normalization:
      typeName: "PayPalPaymentMethodRef"
      position: 216
  WireTransferPaymentMethod:
    title: "WireTransferPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        reference:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT WireTransferPaymentMethodDTO"
    x-swagger-router-model: "WireTransferPaymentMethodDTO"
    x-discriminator-value: "wire"
    x-reprezen-normalization:
      typeName: "WireTransferPaymentMethod"
      position: 217
  WireTransferPaymentMethodRef:
    title: "WireTransferPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
      properties:
        reference:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT WireTransferPaymentMethodDTO"
    x-swagger-router-model: "WireTransferPaymentMethodDTO"
    x-discriminator-value: "wire"
    x-reprezen-normalization:
      typeName: "WireTransferPaymentMethodRef"
      position: 218
  PayByPayPalPaymentMethod:
    title: "PayByPayPalPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        reference:
          type: "string"
    description: "A representation of the TRACT PayByPayPalPaymentMethodDTO"
    x-swagger-router-model: "PayByPayPalPaymentMethodDTO"
    x-discriminator-value: "pay-by-paypal"
    x-reprezen-normalization:
      typeName: "PayByPayPalPaymentMethod"
      position: 219
  PayByPayPalPaymentMethodRef:
    title: "PayByPayPalPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
      properties:
        reference:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT PayByPayPalPaymentMethodDTO"
    x-swagger-router-model: "PayByPayPalPaymentMethodDTO"
    x-discriminator-value: "pay-by-paypal"
    x-reprezen-normalization:
      typeName: "PayByPayPalPaymentMethodRef"
      position: 220
  MobileCarrierPaymentMethod:
    title: "MobileCarrierPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        msisdn:
          type: "string"
          readOnly: true
        carrier_name:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT MobileCarrierPaymentMethodDTO"
    x-swagger-router-model: "MobileCarrierPaymentMethodDTO"
    x-discriminator-value: "mobile-carrier"
    x-reprezen-normalization:
      typeName: "MobileCarrierPaymentMethod"
      position: 221
  MobileCarrierPaymentMethodRef:
    title: "MobileCarrierPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT MobileCarrierPaymentMethodDTO"
    x-swagger-router-model: "MobileCarrierPaymentMethodDTO"
    x-discriminator-value: "mobile-carrier"
    x-reprezen-normalization:
      typeName: "MobileCarrierPaymentMethodRef"
      position: 222
  CustomPaymentMethod:
    title: "CustomPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        reference:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CustomPaymentMethodDTO"
    x-swagger-router-model: "CustomPaymentMethodDTO"
    x-discriminator-value: "custom"
    x-reprezen-normalization:
      typeName: "CustomPaymentMethod"
      position: 223
  CustomPaymentMethodRef:
    title: "CustomPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
      properties:
        reference:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CustomPaymentMethodDTO"
    x-swagger-router-model: "CustomPaymentMethodDTO"
    x-discriminator-value: "custom"
    x-reprezen-normalization:
      typeName: "CustomPaymentMethodRef"
      position: 224
  NamedAddressPaymentMethod:
    title: "NamedAddressPaymentMethod"
    allOf:
    - $ref: "#/definitions/PaymentMethod"
    - type: "object"
      properties:
        email_address:
          $ref: "#/definitions/EmailAddress"
        postal_address:
          $ref: "#/definitions/PostalAddress"
        telecom_address:
          $ref: "#/definitions/TelecomAddress"
        nickname:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT NameAddressPaymentMethodDto"
    x-swagger-router-model: "NameAddressPaymentMethodDto"
    x-reprezen-normalization:
      typeName: "NamedAddressPaymentMethod"
      position: 225
  SepaDirectDebitPaymentMethod:
    title: "SepaDirectDebitPaymentMethod"
    allOf:
    - $ref: "#/definitions/NamedAddressPaymentMethod"
    - type: "object"
      properties:
        iban:
          type: "string"
          readOnly: true
        owner_name:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT SEPAPaymentMethodDto"
    x-swagger-router-model: "SEPAPaymentMethodDto"
    x-discriminator-value: "sepa-dd"
    x-reprezen-normalization:
      typeName: "SepaDirectDebitPaymentMethod"
      position: 226
  SepaDirectDebitPaymentMethodRef:
    title: "SepaDirectDebitPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT SEPAPaymentMethodDto"
    x-swagger-router-model: "SEPAPaymentMethodDto"
    x-discriminator-value: "sepa-dd"
    x-reprezen-normalization:
      typeName: "SepaDirectDebitPaymentMethodRef"
      position: 227
  SepaDirectDebitExternalManagementPaymentMethod:
    title: "SepaDirectDebitExternalManagementPaymentMethod"
    allOf:
    - $ref: "#/definitions/SepaDirectDebitPaymentMethod"
    - type: "object"
      properties:
        mandateId:
          type: "string"
          readOnly: true
        mandate_signature_date:
          type: "string"
          format: "date-time"
          readOnly: true
        bic:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT SEPAExternalManagementPaymentMethodDTO"
    x-swagger-router-model: "SEPAExternalManagementPaymentMethodDTO"
    x-discriminator-value: "sepa-dd-em"
    x-reprezen-normalization:
      typeName: "SepaDirectDebitExternalManagementPaymentMethod"
      position: 228
  SepaDirectDebitExternalManagementPaymentMethodRef:
    title: "SepaDirectDebitExternalManagementPaymentMethodRef"
    allOf:
    - $ref: "#/definitions/PaymentMethodRef"
    - type: "object"
    description: "A representation of the TRACT SEPAExternalManagementPaymentMethodDTO"
    x-swagger-router-model: "SEPAExternalManagementPaymentMethodDTO"
    x-discriminator-value: "sepa-dd-em"
    x-reprezen-normalization:
      typeName: "SepaDirectDebitExternalManagementPaymentMethodRef"
      position: 229
  CreatePaymentOrRefund:
    type: "object"
    required:
    - "amount"
    - "payment_type"
    discriminator: "payment_type"
    properties:
      payment_type:
        $ref: "#/definitions/PaymentType"
      amount:
        type: "number"
        description: "The payment or refund amount"
      description:
        type: "string"
        description: "Description of payment or refund"
      ip_address:
        type: "string"
        description: "blah"
      authorization:
        type: "string"
        description: "blah"
    title: "CreatePaymentOrRefund"
    description: "Base class for all create payment or  refund"
    x-swagger-router-model: "CreatePaymentOrRefundDTO"
    x-reprezen-normalization:
      typeName: "CreatePaymentOrRefund"
      position: 230
  CreatePayment:
    title: "CreatePayment"
    allOf:
    - $ref: "#/definitions/CreatePaymentOrRefund"
    - type: "object"
      required:
      - "payment_method"
      properties:
        payment_method:
          $ref: "#/definitions/CreatePaymentMethod"
        occurs_on:
          type: "string"
          format: "date-time"
          description: "Date the payment occurs on"
        received_amount:
          type: "number"
          description: "Date the payment occurs on"
        received_currency_code:
          $ref: "#/definitions/CurrencyCode"
        apply_automatically:
          type: "boolean"
          description: "Date the payment occurs on"
        use_recurring_payment:
          type: "boolean"
          description: "Date the payment occurs on"
    description: "A payment object to create"
    x-swagger-router-model: "CreatePaymentDTO"
    x-discriminator-value: "payment"
    x-reprezen-normalization:
      typeName: "CreatePayment"
      position: 231
  CreateRefund:
    title: "CreateRefund"
    allOf:
    - $ref: "#/definitions/CreatePaymentOrRefund"
    - type: "object"
      required:
      - "payment_change_reason"
      properties:
        payment_change_reason:
          $ref: "#/definitions/PaymentChangeReason"
        original_payment:
          $ref: "#/definitions/PaymentRef"
    description: "A refund object to create"
    x-swagger-router-model: "CreateRefundDTO"
    x-discriminator-value: "payment"
    x-reprezen-normalization:
      typeName: "CreateRefund"
      position: 232
  CreatePaymentMethod:
    type: "object"
    required:
    - "payment_method_type"
    discriminator: "payment_method_type"
    properties:
      payment_method_type:
        $ref: "#/definitions/CreatePaymentMethodType"
      custom_field_values:
        type: "array"
        items:
          $ref: "#/definitions/CreatePaymentMethodCustomFieldValue"
    title: "CreatePaymentMethod"
    description: "A payment method"
    x-swagger-router-model: "CreatePaymentMethodDTO"
    x-reprezen-normalization:
      typeName: "CreatePaymentMethod"
      position: 233
  CreateBankPaymentMethod:
    title: "CreateBankPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      properties:
        bank_name:
          type: "string"
          description: "The bank name"
        routing_number:
          type: "string"
        account_type:
          $ref: "#/definitions/BankPaymentMethodType"
        account_number:
          type: "string"
        check_number:
          type: "string"
    description: "A payload for creating a bank payment method"
    x-swagger-router-model: "CreateBankPaymentMethodDTO"
    x-discriminator-value: "bank"
    x-reprezen-normalization:
      typeName: "CreateBankPaymentMethod"
      position: 234
  CreateCashPaymentMethod:
    title: "CreateCashPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
    description: "A  payload for creating a cash payment method"
    x-swagger-router-model: "CashPaymentMethodDTO"
    x-discriminator-value: "cash"
    x-reprezen-normalization:
      typeName: "CreateCashPaymentMethod"
      position: 235
  CreateCheckPaymentMethod:
    title: "CreateCheckPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      required:
      - "account_number"
      - "check_number"
      - "routing_number"
      properties:
        check_number:
          type: "string"
        routing_number:
          type: "string"
        account_number:
          type: "string"
        customer_name:
          type: "string"
        description:
          type: "string"
    description: "A  payload for creating a check payment method"
    x-swagger-router-model: "CheckPaymentMethodDTO"
    x-discriminator-value: "check"
    x-reprezen-normalization:
      typeName: "CreateCheckPaymentMethod"
      position: 236
  CreateCreditCardPaymentMethod:
    title: "CreateCreditCardPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      required:
      - "card_type"
      - "expiration_date"
      - "first_name"
      - "identifier_number"
      - "last_name"
      properties:
        card_type:
          $ref: "#/definitions/CardType"
        first_name:
          type: "string"
        middle_name:
          type: "string"
        last_name:
          type: "string"
        suffix:
          type: "string"
        identifier_number:
          type: "string"
        verification_number:
          type: "string"
        expiration_date:
          type: "string"
    description: "A  payload for creating a credit card payment method"
    x-swagger-router-model: "CreateCreditCardPaymentMethodDTO"
    x-discriminator-value: "credit-card"
    x-reprezen-normalization:
      typeName: "CreateCreditCardPaymentMethod"
      position: 237
  CreateCustomPaymentMethod:
    title: "CreateCustomPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      required:
      - "reference"
      properties:
        reference:
          type: "string"
    description: "A  payload for creating a custom payment method"
    x-swagger-router-model: "CustomPaymentMethodDTO"
    x-discriminator-value: "custom"
    x-reprezen-normalization:
      typeName: "CreateCustomPaymentMethod"
      position: 238
  CreateMobileCarrierPaymentMethod:
    title: "CreateMobileCarrierPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      required:
      - "carrier_name"
      - "msisdn"
      properties:
        msisdn:
          type: "string"
          description: "MS ISDN identifier"
        carrier_name:
          type: "string"
          description: "Mobile Carrier Name"
    description: "A  payload for creating a mobile carrier payment method"
    x-swagger-router-model: "MobileCarrierPaymentMethodDTO"
    x-discriminator-value: "mobile-carrier"
    x-reprezen-normalization:
      typeName: "CreateMobileCarrierPaymentMethod"
      position: 239
  CreatePayByPayPalPaymentMethod:
    title: "CreatePayByPayPalPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      properties:
        reference:
          type: "string"
          description: "Reference number"
    description: "A  payload for creating a pay by PayPal payment method"
    x-swagger-router-model: "PayByPayPalPaymentMethodDTO"
    x-discriminator-value: "pay-by-paypal"
    x-reprezen-normalization:
      typeName: "CreatePayByPayPalPaymentMethod"
      position: 240
  CreatePayPalPaymentMethod:
    title: "CreatePayPalPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      required:
      - "pre_approval_key"
      properties:
        pre_approval_key:
          type: "string"
          description: "pre approval key"
    description: "A payload for creating a PayPal payment method"
    x-swagger-router-model: "PayPalPaymentMethodDTO"
    x-discriminator-value: "paypal"
    x-reprezen-normalization:
      typeName: "CreatePayPalPaymentMethod"
      position: 241
  CreateReferencedCreditCardPaymentMethod:
    title: "CreateReferencedCreditCardPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      required:
      - "reference_key"
      properties:
        reference_key:
          type: "string"
    description: "A  payload for creating a referenced credit card payment method"
    x-swagger-router-model: "CreateReferencedCreditCardPaymentMethodDTO"
    x-discriminator-value: "referenced-credit-card"
    x-reprezen-normalization:
      typeName: "CreateReferencedCreditCardPaymentMethod"
      position: 242
  CreateWireTransferPaymentMethod:
    title: "CreateWireTransferPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      properties:
        reference:
          type: "string"
    description: "A payload for creating a wire transfer payment method"
    x-swagger-router-model: "WireTransferPaymentMethodDTO"
    x-discriminator-value: "wire"
    x-reprezen-normalization:
      typeName: "CreateWireTransferPaymentMethod"
      position: 243
  CreateNamedAddressPaymentMethod:
    title: "CreateNamedAddressPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreatePaymentMethod"
    - type: "object"
      properties:
        email_address:
          $ref: "#/definitions/CreateEmailAddress"
        postal_address:
          $ref: "#/definitions/CreatePostalAddress"
        telecom_address:
          $ref: "#/definitions/CreateTelecomAddress"
        nickname:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CreateNameAddressPaymentMethodDto"
    x-swagger-router-model: "CreateNameAddressPaymentMethodDto"
    x-reprezen-normalization:
      typeName: "CreateNamedAddressPaymentMethod"
      position: 244
  CreateSepaDirectDebitPaymentMethod:
    title: "CreateSepaDirectDebitPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreateNamedAddressPaymentMethod"
    - type: "object"
      properties:
        iban:
          type: "string"
          readOnly: true
        owner_name:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CreateSEPAPaymentMethodDto"
    x-swagger-router-model: "CreateSEPAPaymentMethodDto"
    x-discriminator-value: "sepa-dd"
    x-reprezen-normalization:
      typeName: "CreateSepaDirectDebitPaymentMethod"
      position: 245
  CreateSepaDirectDebitExternalManagementPaymentMethod:
    title: "CreateSepaDirectDebitExternalManagementPaymentMethod"
    allOf:
    - $ref: "#/definitions/CreateSepaDirectDebitPaymentMethod"
    - type: "object"
      properties:
        mandateId:
          type: "string"
          readOnly: true
        mandate_signature_date:
          type: "string"
          format: "date-time"
          readOnly: true
        bic:
          type: "string"
          readOnly: true
    description: "A representation of the TRACT CreateSEPAExternalManagementPaymentMethodDTO"
    x-swagger-router-model: "CreateSEPAExternalManagementPaymentMethodDTO"
    x-discriminator-value: "sepa-dd-em"
    x-reprezen-normalization:
      typeName: "CreateSepaDirectDebitExternalManagementPaymentMethod"
      position: 246
  CreateApplyPayment:
    type: "object"
    properties:
      payment:
        $ref: "#/definitions/Payment"
      invoices:
        type: "array"
        uniqueItems: true
        items:
          $ref: "#/definitions/Invoice"
    title: "CreateApplyPayment"
    description: "The object for creating a new payment and appling it to the specified\
      \ invoices"
    x-swagger-router-model: "CreateApplyPaymentDTO"
    x-reprezen-normalization:
      typeName: "CreateApplyPayment"
      position: 247
  ChargeCategory:
    title: "ChargeCategory"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "charge_category_type"
      discriminator: "charge_category_type"
      properties:
        charge_category_type:
          $ref: "#/definitions/ChargeCategoryType"
        name:
          type: "string"
          description: "(unique_key) The name of TRACT category"
        description:
          type: "string"
        priority:
          type: "integer"
          format: "int64"
        status:
          $ref: "#/definitions/PriceCategoryStatus"
    x-swagger-router-model: "ChargeCategoryDTO"
    x-reprezen-normalization:
      typeName: "ChargeCategory"
      position: 248
  UsageChargeCategory:
    title: "UsageChargeCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "UsageChargeCategoryDTO"
    x-discriminator-value: "usage-price"
    x-reprezen-normalization:
      typeName: "UsageChargeCategory"
      position: 249
  PaymentCategory:
    title: "PaymentCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "PaymentCategoryDTO"
    x-discriminator-value: "payment"
    x-reprezen-normalization:
      typeName: "PaymentCategory"
      position: 250
  TaxPriceCategory:
    title: "TaxPriceCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "TaxPriceCategoryDTO"
    x-discriminator-value: "tax"
    x-reprezen-normalization:
      typeName: "TaxPriceCategory"
      position: 251
  AdditionalFeeCategory:
    title: "AdditionalFeeCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "AdditionalFeeCategoryDTO"
    x-discriminator-value: "additional-fee"
    x-reprezen-normalization:
      typeName: "AdditionalFeeCategory"
      position: 252
  PaymentCategoryRef:
    title: "PaymentCategoryRef"
    allOf:
    - $ref: "#/definitions/ChargeCategoryRef"
    - type: "object"
    x-swagger-router-model: "PaymentCategoryDTO"
    x-discriminator-value: "payment"
    x-reprezen-normalization:
      typeName: "PaymentCategoryRef"
      position: 253
  TaxPriceCategoryRef:
    title: "TaxPriceCategoryRef"
    allOf:
    - $ref: "#/definitions/ChargeCategoryRef"
    - type: "object"
    x-swagger-router-model: "TaxPriceCategoryDTO"
    x-discriminator-value: "tax"
    x-reprezen-normalization:
      typeName: "TaxPriceCategoryRef"
      position: 254
  AdditionalFeeCategoryRef:
    title: "AdditionalFeeCategoryRef"
    allOf:
    - $ref: "#/definitions/ChargeCategoryRef"
    - type: "object"
    x-swagger-router-model: "AdditionalFeeCategoryDTO"
    x-discriminator-value: "additional-fee"
    x-reprezen-normalization:
      typeName: "AdditionalFeeCategoryRef"
      position: 255
  PriceCategory:
    title: "PriceCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "PriceCategoryDTO"
    x-discriminator-value: "price"
    x-reprezen-normalization:
      typeName: "PriceCategory"
      position: 256
  ChargeCategoryRef:
    title: "ChargeCategoryRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "charge_category_type"
      discriminator: "charge_category_type"
      properties:
        charge_category_type:
          $ref: "#/definitions/ChargeCategoryType"
        name:
          type: "string"
          description: "(unique_key)"
    x-swagger-router-model: "ChargeCategoryDTO"
    x-reprezen-normalization:
      typeName: "ChargeCategoryRef"
      position: 257
  UsageChargeCategoryRef:
    title: "UsageChargeCategoryRef"
    allOf:
    - $ref: "#/definitions/ChargeCategoryRef"
    - type: "object"
    x-swagger-router-model: "UsageChargeCategoryDTO"
    x-discriminator-value: "usage-price"
    x-reprezen-normalization:
      typeName: "UsageChargeCategoryRef"
      position: 258
  PriceCategoryRef:
    title: "PriceCategoryRef"
    allOf:
    - $ref: "#/definitions/ChargeCategoryRef"
    - type: "object"
    x-swagger-router-model: "PriceCategoryDTO"
    x-discriminator-value: "price"
    x-reprezen-normalization:
      typeName: "PriceCategoryRef"
      position: 259
  ScheduledPriceCharge:
    title: "ScheduledPriceCharge"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "scheduled_price_charge_type"
      discriminator: "scheduled_price_charge_type"
      properties:
        scheduled_price_charge_type:
          $ref: "#/definitions/PriceChargeType"
        description:
          type: "string"
        amount:
          type: "number"
        invoiced:
          type: "boolean"
        charge_date:
          type: "string"
          format: "date-time"
        status:
          $ref: "#/definitions/PriceChargeStatus"
    x-swagger-router-model: "AbstractPriceChargeDTO"
    x-reprezen-normalization:
      typeName: "ScheduledPriceCharge"
      position: 260
  ServicePriceCharge:
    title: "ServicePriceCharge"
    allOf:
    - $ref: "#/definitions/ScheduledPriceCharge"
    - type: "object"
    x-swagger-router-model: "ServicePriceChargeDTO"
    x-discriminator-value: "scheduled-recurring"
    x-reprezen-normalization:
      typeName: "ServicePriceCharge"
      position: 261
  OneTimePriceCharge:
    title: "OneTimePriceCharge"
    allOf:
    - $ref: "#/definitions/ScheduledPriceCharge"
    - type: "object"
    x-swagger-router-model: "OneTimePriceChargeDTO"
    x-discriminator-value: "scheduled-one-time"
    x-reprezen-normalization:
      typeName: "OneTimePriceCharge"
      position: 262
  ScheduledPriceChargeRef:
    title: "ScheduledPriceChargeRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "scheduled_price_charge_type"
      discriminator: "scheduled_price_charge_type"
      properties:
        scheduled_price_charge_type:
          $ref: "#/definitions/PriceChargeType"
    x-swagger-router-model: "AbstractPriceChargeDTO"
    x-reprezen-normalization:
      typeName: "ScheduledPriceChargeRef"
      position: 263
  ServicePriceChargeRef:
    title: "ServicePriceChargeRef"
    allOf:
    - $ref: "#/definitions/ScheduledPriceChargeRef"
    - type: "object"
    x-swagger-router-model: "ServicePriceChargeDTO"
    x-discriminator-value: "scheduled-recurring"
    x-reprezen-normalization:
      typeName: "ServicePriceChargeRef"
      position: 264
  OneTimePriceChargeRef:
    title: "OneTimePriceChargeRef"
    allOf:
    - $ref: "#/definitions/ScheduledPriceChargeRef"
    - type: "object"
    x-swagger-router-model: "OneTimePriceChargeDTO"
    x-discriminator-value: "scheduled-one-time"
    x-reprezen-normalization:
      typeName: "OneTimePriceChargeRef"
      position: 265
  PriceChargeStatus:
    type: "string"
    title: "PriceChargeStatus"
    enum:
    - "ACTIVE"
    - "CANCELED"
    x-swagger-router-model: "PriceChargeStatusDTO"
    x-reprezen-normalization:
      typeName: "PriceChargeStatus"
      position: 266
  PriceCategoryStatus:
    type: "string"
    title: "PriceCategoryStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-swagger-router-model: "PriceCategoryStatusDTO"
    x-reprezen-normalization:
      typeName: "PriceCategoryStatus"
      position: 267
  PriceType:
    type: "string"
    title: "PriceType"
    enum:
    - "one-time"
    - "recurring"
    x-swagger-router-model: "PriceTypeDTO"
    x-reprezen-normalization:
      typeName: "PriceType"
      position: 268
  ChargeCategoryType:
    type: "string"
    title: "ChargeCategoryType"
    enum:
    - "adjustment"
    - "discount"
    - "price"
    - "usage-price"
    - "additional-fee"
    - "payment"
    - "tax"
    x-reprezen-normalization:
      typeName: "ChargeCategoryType"
      position: 269
  PriceChargeType:
    type: "string"
    title: "PriceChargeType"
    enum:
    - "scheduled-one-time"
    - "scheduled-recurring"
    x-reprezen-normalization:
      typeName: "PriceChargeType"
      position: 270
  PaymentApplication:
    title: "PaymentApplication"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "payment_application_type"
      discriminator: "payment_application_type"
      properties:
        payment:
          $ref: "#/definitions/Payment"
        updated_on:
          type: "string"
          format: "date-time"
        amount:
          type: "number"
        invoice:
          $ref: "#/definitions/InvoiceRef"
        payment_application_type:
          $ref: "#/definitions/PaymentApplicationType"
    x-swagger-router-model: "PaymentApplicationDTO"
    x-reprezen-normalization:
      typeName: "PaymentApplication"
      position: 271
  PaymentApplicationRef:
    title: "PaymentApplicationRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "payment_application_type"
      discriminator: "payment_application_type"
      properties:
        payment:
          $ref: "#/definitions/PaymentRef"
        invoice:
          $ref: "#/definitions/InvoiceRef"
        payment_application_type:
          $ref: "#/definitions/PaymentApplicationType"
    x-swagger-router-model: "PaymentApplicationDTO"
    x-reprezen-normalization:
      typeName: "PaymentApplicationRef"
      position: 272
  StandardInvoicePaymentApplication:
    title: "StandardInvoicePaymentApplication"
    allOf:
    - $ref: "#/definitions/PaymentApplication"
    - type: "object"
      properties:
        reversed_application:
          $ref: "#/definitions/ReversedInvoicePaymentApplicationRef"
    x-swagger-router-model: "StandardInvoicePaymentApplicationDTO"
    x-discriminator-value: "standard-invoice"
    x-reprezen-normalization:
      typeName: "StandardInvoicePaymentApplication"
      position: 273
  StandardInvoicePaymentApplicationRef:
    title: "StandardInvoicePaymentApplicationRef"
    allOf:
    - $ref: "#/definitions/PaymentApplicationRef"
    - type: "object"
    x-swagger-router-model: "StandardInvoicePaymentApplicationDTO"
    x-discriminator-value: "standard-invoice"
    x-reprezen-normalization:
      typeName: "StandardInvoicePaymentApplicationRef"
      position: 274
  ReversedInvoicePaymentApplication:
    title: "ReversedInvoicePaymentApplication"
    allOf:
    - $ref: "#/definitions/PaymentApplication"
    - type: "object"
      properties:
        reversed_application:
          $ref: "#/definitions/StandardInvoicePaymentApplicationRef"
    x-swagger-router-model: "ReversedInvoicePaymentApplicationDTO"
    x-discriminator-value: "reversed-invoice"
    x-reprezen-normalization:
      typeName: "ReversedInvoicePaymentApplication"
      position: 275
  ReversedInvoicePaymentApplicationRef:
    title: "ReversedInvoicePaymentApplicationRef"
    allOf:
    - $ref: "#/definitions/PaymentApplicationRef"
    - type: "object"
    x-swagger-router-model: "ReversedInvoicePaymentApplicationDTO"
    x-discriminator-value: "reversed-invoice"
    x-reprezen-normalization:
      typeName: "ReversedInvoicePaymentApplicationRef"
      position: 276
  PaymentApplicationType:
    type: "string"
    title: "PaymentApplicationType"
    enum:
    - "standard-invoice"
    - "reversed-invoice"
    x-swagger-router-model: "PaymentApplicationTypeDTO"
    x-reprezen-normalization:
      typeName: "PaymentApplicationType"
      position: 277
  Order:
    title: "Order"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "order_type"
      discriminator: "order_type"
      properties:
        order_type:
          $ref: "#/definitions/OrderType"
        order_num:
          type: "string"
        order_items:
          type: "array"
          items:
            $ref: "#/definitions/OrderItem"
        billing_account:
          $ref: "#/definitions/BillingAccount"
        payments:
          type: "array"
          items:
            $ref: "#/definitions/Payment"
        note:
          type: "string"
        purchase_order_number:
          type: "string"
        emai_receipt:
          type: "boolean"
        referral:
          type: "string"
        order_date:
          type: "string"
          format: "date-time"
        total_amount:
          type: "number"
        custom_field_values:
          type: "array"
          items:
            $ref: "#/definitions/OrderCustomFieldValue"
        status:
          $ref: "#/definitions/OrderStatus"
        sub_total:
          type: "number"
        tax_total:
          type: "number"
        due_now_total:
          type: "number"
        due_now_tax_total:
          type: "number"
    x-swagger-router-model: "OrderDTO"
    x-reprezen-normalization:
      typeName: "Order"
      position: 278
  CreateSalesOrder:
    type: "object"
    required:
    - "order_items"
    properties:
      order_num:
        type: "string"
      order_items:
        type: "array"
        items:
          $ref: "#/definitions/CreateProductOrderItem"
      payment:
        $ref: "#/definitions/CreatePayment"
      note:
        type: "string"
      purchase_order_number:
        type: "string"
      emai_receipt:
        type: "boolean"
      referral:
        type: "string"
      order_date:
        type: "string"
        format: "date-time"
      custom_field_values:
        type: "array"
        items:
          $ref: "#/definitions/CreateOrderCustomFieldValue"
      initial_status:
        $ref: "#/definitions/CreateSalesOrderStatus"
    title: "CreateSalesOrder"
    description: "Represents a TRACT SalesOrder"
    x-swagger-router-model: "SalesOrderDTO"
    x-discriminator-value: "sales"
    x-reprezen-normalization:
      typeName: "CreateSalesOrder"
      position: 279
  ConfirmDraftOrder:
    type: "object"
    properties:
      payment:
        $ref: "#/definitions/CreatePayment"
    title: "ConfirmDraftOrder"
    description: "Payload for confirming a DRAFT order"
    x-swagger-router-model: "ConfirmDraftOrderDTO"
    x-reprezen-normalization:
      typeName: "ConfirmDraftOrder"
      position: 280
  UpdateSalesOrder:
    title: "UpdateSalesOrder"
    allOf:
    - $ref: "#/definitions/Order"
    - type: "object"
      required:
      - "order_type"
      discriminator: "order_type"
      properties:
        order_type:
          $ref: "#/definitions/OrderType"
        order_num:
          type: "string"
        note:
          type: "string"
        purchase_order_number:
          type: "string"
        emai_receipt:
          type: "boolean"
        referral:
          type: "string"
        order_date:
          type: "string"
          format: "date-time"
    description: "Represents a TRACT SalesOrder"
    x-swagger-router-model: "SalesOrderDTO"
    x-discriminator-value: "sales"
    x-reprezen-normalization:
      typeName: "UpdateSalesOrder"
      position: 281
  SalesOrder:
    title: "SalesOrder"
    allOf:
    - $ref: "#/definitions/Order"
    - type: "object"
    description: "Represents a TRACT SalesOrder"
    x-swagger-router-model: "SalesOrderDTO"
    x-discriminator-value: "sales"
    x-reprezen-normalization:
      typeName: "SalesOrder"
      position: 282
  ChangeOrder:
    title: "ChangeOrder"
    allOf:
    - $ref: "#/definitions/Order"
    - type: "object"
    description: "Represents a TRACT ChangeOrder"
    x-swagger-router-model: "ChangeOrderDTO"
    x-discriminator-value: "change"
    x-reprezen-normalization:
      typeName: "ChangeOrder"
      position: 283
  RenewalOrder:
    title: "RenewalOrder"
    allOf:
    - $ref: "#/definitions/Order"
    - type: "object"
      properties:
        renewal_date:
          type: "string"
          format: "date-time"
    description: "Represents a TRACT RenewalOrder"
    x-swagger-router-model: "RenewalOrderDTO"
    x-discriminator-value: "renewal"
    x-reprezen-normalization:
      typeName: "RenewalOrder"
      position: 284
  OrderStatus:
    type: "string"
    title: "OrderStatus"
    enum:
    - "APPROVED"
    - "COMPLETED"
    - "DRAFT"
    - "CANCELED"
    - "ERROR"
    - "IN_PROGRESS"
    x-swagger-router-model: "OrderStatusDTO"
    x-reprezen-normalization:
      typeName: "OrderStatus"
      position: 285
  CreateSalesOrderStatus:
    type: "string"
    title: "CreateSalesOrderStatus"
    enum:
    - "DRAFT"
    - "CONFIRMED"
    x-swagger-router-model: "OrderStatusDTO"
    x-reprezen-normalization:
      typeName: "CreateSalesOrderStatus"
      position: 286
  OrderType:
    type: "string"
    title: "OrderType"
    enum:
    - "sales"
    - "renewal"
    - "change"
    x-reprezen-normalization:
      typeName: "OrderType"
      position: 287
  EntityRef:
    type: "object"
    properties:
      id:
        type: "string"
        example: "1438752"
        description: "(unique_key) The internal entity id for this entity representation"
    title: "EntityRef"
    description: "A representation of a TRACT entity object that only contains a minimal\
      \ set of attributes; typically ones that are used for query"
    x-swagger-router-model: "DTOObject"
    x-reprezen-normalization:
      typeName: "EntityRef"
      position: 288
  CurrencyCode:
    type: "string"
    title: "CurrencyCode"
    description: "Supported Currencies"
    enum:
    - "USD"
    - "GBP"
    - "EUR"
    - "SEK"
    - "NOK"
    - "DKK"
    - "CAD"
    - "AUD"
    - "ZAR"
    - "NZD"
    - "MXN"
    - "INR"
    - "JPY"
    - "SAR"
    - "QAR"
    - "EGP"
    - "AED"
    - "BHD"
    - "KWD"
    - "OMR"
    - "HKD"
    - "CHF"
    - "ILS"
    - "CNY"
    - "BRL"
    - "PLN"
    - "COP"
    - "PEN"
    - "RUB"
    x-swagger-router-model: "CurrencyTypeDTO"
    x-reprezen-normalization:
      typeName: "CurrencyCode"
      position: 289
  Entity:
    type: "object"
    properties:
      id:
        type: "string"
        example: "1438752"
        description: "(unique_key)  The internal entity id for this entity representation"
        readOnly: true
    title: "Entity"
    description: "A representation of a TRACT entity object"
    x-swagger-router-model: "DTOObject"
    x-reprezen-normalization:
      typeName: "Entity"
      position: 290
  BillingAccountAction:
    title: "BillingAccountAction"
    allOf:
    - $ref: "#/definitions/Action"
    - type: "object"
      properties:
        status:
          type: "string"
          enum:
          - "SUSPEND"
          - "DEACTIVATE"
          - "RESUME"
        start_date:
          type: "string"
          format: "date-time"
          example: "2015-04-12T00:00:00.000-05:00"
          description: "The start date"
        notes:
          type: "string"
    description: "A base representation of a TRACT billing account"
    x-swagger-router-model: "BillingAccountActionDTO"
    x-discriminator-value: "billing-account"
    x-reprezen-normalization:
      typeName: "BillingAccountAction"
      position: 291
  BillingAccountSuspensionReason:
    title: "BillingAccountSuspensionReason"
    allOf:
    - $ref: "#/definitions/Reason"
    - type: "object"
    x-swagger-router-model: "BillingAccountSuspensionReasonDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountSuspensionReason"
      position: 292
  BillingAccountDeactivationReason:
    title: "BillingAccountDeactivationReason"
    allOf:
    - $ref: "#/definitions/Reason"
    - type: "object"
    x-swagger-router-model: "BillingAccountDeactivationReasonDTO"
    x-reprezen-normalization:
      typeName: "BillingAccountDeactivationReason"
      position: 293
  OrderItemUsageRule:
    title: "OrderItemUsageRule"
    allOf:
    - $ref: "#/definitions/UsageRuleTemplate"
    - type: "object"
      required:
      - "order_item_usage_rule_type"
      discriminator: "order_item_usage_rule_type"
      properties:
        order_item_usage_rule_type:
          type: "string"
        order_item:
          $ref: "#/definitions/ProductOrderItem"
        status:
          $ref: "#/definitions/OrderItemUsageRuleStatus"
    x-swagger-router-model: "OrderItemUsageRuleDTO"
    x-reprezen-normalization:
      typeName: "OrderItemUsageRule"
      position: 294
  PriceListRef:
    title: "PriceListRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        name:
          type: "string"
    x-swagger-router-model: "PriceListDTO"
    x-reprezen-normalization:
      typeName: "PriceListRef"
      position: 295
  OrderItemAgreement:
    type: "object"
    properties:
      agreement:
        $ref: "#/definitions/AgreementRef"
      end_date:
        type: "string"
        format: "date-time"
      end_action:
        $ref: "#/definitions/AgreementEndActionType"
      next_agreement:
        $ref: "#/definitions/AgreementRef"
      next_end_action:
        $ref: "#/definitions/AgreementNextEndActionType"
      next_service_product:
        $ref: "#/definitions/ProductRef"
      next_service_product_price:
        $ref: "#/definitions/RecurringProductPriceRef"
      preserve_service_price:
        type: "boolean"
      next_preserve_service_price:
        type: "boolean"
      agreement_period:
        type: "integer"
        format: "int32"
      minimum_amount:
        type: "number"
      minimum_amount_currency_code:
        $ref: "#/definitions/CurrencyCode"
      omit_minimum_amount:
        type: "boolean"
    title: "OrderItemAgreement"
    description: "models the OrderItemAgeeement object in TRACT"
    x-swagger-router-model: "OrderItemAgreementDTO"
    x-reprezen-normalization:
      typeName: "OrderItemAgreement"
      position: 296
  OrderItemDiscount:
    type: "object"
    properties:
      discount_resource:
        $ref: "#/definitions/DiscountResourceRef"
      override_amount:
        type: "number"
      override_percentage:
        type: "number"
      override_duration:
        type: "integer"
        format: "int32"
    title: "OrderItemDiscount"
    x-swagger-router-model: "OrderItemDiscountDTO"
    x-reprezen-normalization:
      typeName: "OrderItemDiscount"
      position: 297
  OperationRunAttribute:
    title: "OperationRunAttribute"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "operation_run_attribute_type"
      properties:
        operation_run_attribute_type:
          $ref: "#/definitions/OperationRunAttributeType"
        email_address:
          type: "string"
          format: "email"
        operation:
          $ref: "#/definitions/OperationRef"
    x-swagger-router-model: "OperationRunAttributeDTO"
    x-reprezen-normalization:
      typeName: "OperationRunAttribute"
      position: 298
  CreateOperationRunAttribute:
    type: "object"
    required:
    - "operation_run_attribute_type"
    properties:
      operation_run_attribute_type:
        $ref: "#/definitions/OperationRunAttributeType"
      email_address:
        type: "string"
        format: "email"
      operation:
        $ref: "#/definitions/OperationRef"
    title: "CreateOperationRunAttribute"
    x-swagger-router-model: "CreateOperationRunAttributeDTO"
    x-reprezen-normalization:
      typeName: "CreateOperationRunAttribute"
      position: 299
  AccountingStatus:
    type: "string"
    title: "AccountingStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-swagger-router-model: "AccountingStatusDTO"
    x-reprezen-normalization:
      typeName: "AccountingStatus"
      position: 300
  UnauthorizedException:
    title: "UnauthorizedException"
    allOf:
    - $ref: "#/definitions/ApiError"
    - type: "object"
    description: "The error returned for an HTTP status code 401"
    example:
      code: "401"
      message: "Authorization header not found."
    x-reprezen-normalization:
      typeName: "UnauthorizedException"
      position: 301
  GeneralException:
    title: "GeneralException"
    allOf:
    - $ref: "#/definitions/ApiError"
    - type: "object"
    description: "The error returned for an HTTP status code 500 - Internal Server\
      \ Error"
    example:
      code: "500"
      message: "There was an error on the server."
    x-swagger-router-model: "RuntimeException"
    x-reprezen-normalization:
      typeName: "GeneralException"
      position: 302
  BadRequestException:
    title: "BadRequestException"
    allOf:
    - $ref: "#/definitions/ApiError"
    - type: "object"
    description: "The error returned for an HTTP status code 400"
    example:
      code: "400"
      message: "Wrong query parameters or payload validation."
    x-swagger-router-model:
    - "ApiGeneralException"
    - "ApiQueryException"
    - "ApiStateException"
    - "ApiValidationException"
    x-reprezen-normalization:
      typeName: "BadRequestException"
      position: 303
  ForbiddenException:
    title: "ForbiddenException"
    allOf:
    - $ref: "#/definitions/ApiError"
    - type: "object"
    description: "The error returned for an HTTP status code 403"
    example:
      code: "403"
      message: "Duplication occurred."
    x-swagger-router-model: "ApiDuplicationException"
    x-reprezen-normalization:
      typeName: "ForbiddenException"
      position: 304
  NotFoundException:
    title: "NotFoundException"
    allOf:
    - $ref: "#/definitions/ApiError"
    - type: "object"
    description: "The error returned for an HTTP status code 404"
    example:
      code: "404"
      message: "Entity not found."
    x-swagger-router-model: "ApiNotFoundException"
    x-reprezen-normalization:
      typeName: "NotFoundException"
      position: 305
  CreditAccountAdjustment:
    title: "CreditAccountAdjustment"
    allOf:
    - $ref: "#/definitions/AccountAdjustment"
    - type: "object"
      properties:
        credit_number:
          type: "string"
    description: "A representation of a TRACT adjustment"
    x-swagger-router-model: "AccountAdjustmentDTO"
    x-reprezen-normalization:
      typeName: "CreditAccountAdjustment"
      position: 306
  CreateAccountAdjustment:
    type: "object"
    properties:
      amount:
        type: "number"
      description:
        type: "string"
      adjustment_type:
        $ref: "#/definitions/AdjustmentType"
      billing_account:
        $ref: "#/definitions/BillingAccountRef"
      reason:
        $ref: "#/definitions/AdjustmentReasonRef"
      secondary_reason:
        $ref: "#/definitions/AdjustmentReasonRef"
      manual_invoice_application:
        type: "boolean"
    title: "CreateAccountAdjustment"
    x-swagger-router-model: "AccountAdjustmentDTO"
    x-reprezen-normalization:
      typeName: "CreateAccountAdjustment"
      position: 307
  DebitAccountAdjustment:
    title: "DebitAccountAdjustment"
    allOf:
    - $ref: "#/definitions/AccountAdjustment"
    - type: "object"
      properties:
        billed_invoice:
          $ref: "#/definitions/InvoiceRef"
    description: "A representation of a TRACT adjustment"
    x-swagger-router-model: "AccountAdjustmentDTO"
    x-reprezen-normalization:
      typeName: "DebitAccountAdjustment"
      position: 308
  Action:
    title: "Action"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "action_type"
      discriminator: "action_type"
      properties:
        name:
          type: "string"
        enabled:
          type: "boolean"
        friendly_name:
          type: "string"
        supports_approval:
          type: "boolean"
        action_type:
          $ref: "#/definitions/ActionType"
        operations:
          type: "array"
          description: "The list of operations"
          items:
            $ref: "#/definitions/Operation"
    x-swagger-router-model: "ActionDTO"
    x-reprezen-normalization:
      typeName: "Action"
      position: 309
  Operation:
    title: "Operation"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "operation_type"
      discriminator: "operation_type"
      properties:
        operation_type:
          $ref: "#/definitions/OperationType"
        name:
          type: "string"
          description: "Name of the operation"
        enabled:
          type: "boolean"
    x-swagger-router-model: "OperationDto"
    x-reprezen-normalization:
      typeName: "Operation"
      position: 310
  ServiceDeactivationReason:
    title: "ServiceDeactivationReason"
    allOf:
    - $ref: "#/definitions/Reason"
    - type: "object"
    x-swagger-router-model: "ServiceDeactivationReasonDTO"
    x-reprezen-normalization:
      typeName: "ServiceDeactivationReason"
      position: 311
  ServiceSuspensionReason:
    title: "ServiceSuspensionReason"
    allOf:
    - $ref: "#/definitions/Reason"
    - type: "object"
    x-swagger-router-model: "ServiceSuspensionReasonDTO"
    x-reprezen-normalization:
      typeName: "ServiceSuspensionReason"
      position: 312
  PaymentChangeReason:
    title: "PaymentChangeReason"
    allOf:
    - $ref: "#/definitions/Reason"
    - type: "object"
    x-swagger-router-model: "PaymentChangeReasonDTO"
    x-reprezen-normalization:
      typeName: "PaymentChangeReason"
      position: 313
  CreditAdjustmentReason:
    title: "CreditAdjustmentReason"
    allOf:
    - $ref: "#/definitions/AdjustmentReason"
    - type: "object"
    x-swagger-router-model: "AdjustmentReasonDTO"
    x-reprezen-normalization:
      typeName: "CreditAdjustmentReason"
      position: 314
  DebitAdjustmentReason:
    title: "DebitAdjustmentReason"
    allOf:
    - $ref: "#/definitions/AdjustmentReason"
    - type: "object"
    x-swagger-router-model: "AdjustmentReasonDTO"
    x-reprezen-normalization:
      typeName: "DebitAdjustmentReason"
      position: 315
  PriceList:
    title: "PriceList"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
        description:
          type: "string"
        products:
          type: "array"
          items:
            $ref: "#/definitions/Product"
    x-swagger-router-model: "PriceListDTO"
    x-reprezen-normalization:
      typeName: "PriceList"
      position: 316
  Agreement:
    title: "Agreement"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          format: "int32"
          readOnly: true
        agreement_period:
          type: "integer"
          format: "int32"
          readOnly: true
        status:
          $ref: "#/definitions/AgreementStatus"
        termination_flat_charge:
          type: "number"
          readOnly: true
        termination_percentage_charge:
          type: "number"
          readOnly: true
        max_termination_charge:
          type: "number"
          readOnly: true
        prorate_on_cancel:
          type: "boolean"
          readOnly: true
        adjustment_category:
          $ref: "#/definitions/AdjustmentCategoryRef"
        end_action:
          $ref: "#/definitions/AgreementEndActionType"
        termination_fee_currency_code:
          $ref: "#/definitions/CurrencyCode"
        max_termination_fee_currency_code:
          $ref: "#/definitions/CurrencyCode"
        valid_from:
          type: "string"
          format: "date"
          readOnly: true
        valid_to:
          type: "string"
          format: "date"
          readOnly: true
        next_agreement:
          $ref: "#/definitions/AgreementRef"
        agreement_period_type:
          $ref: "#/definitions/AgreementPeriodType"
        minimum_amount:
          type: "number"
          readOnly: true
        minimum_amount_currency_type:
          $ref: "#/definitions/CurrencyCode"
        true_up_adjustment_reason:
          $ref: "#/definitions/AdjustmentReasonRef"
        true_up_charge_types:
          type: "array"
          items:
            $ref: "#/definitions/TrueUpChargeType"
        preserve_service_price:
          type: "boolean"
          readOnly: true
    description: "models the Agreement object in TRACT"
    x-swagger-router-model: "AgreementDTO"
    x-reprezen-normalization:
      typeName: "Agreement"
      position: 317
  AgreementService:
    title: "AgreementService"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        agreement:
          $ref: "#/definitions/AgreementRef"
        minimum_amount:
          type: "number"
        minimum_amount_currency_code:
          $ref: "#/definitions/CurrencyCode"
        start_date:
          type: "string"
          format: "date-time"
        end_date:
          type: "string"
          format: "date-time"
        end_action:
          $ref: "#/definitions/AgreementEndActionType"
        next_agreement:
          $ref: "#/definitions/AgreementRef"
        next_end_action:
          $ref: "#/definitions/AgreementEndActionType"
        next_service_product:
          $ref: "#/definitions/ProductRef"
        next_service_pay_on_purchase:
          type: "boolean"
        renewed:
          type: "boolean"
          readOnly: true
        next_service_product_price:
          $ref: "#/definitions/RecurringProductPriceRef"
        preserve_service_price:
          type: "boolean"
        next_preserve_service_price:
          type: "boolean"
        omit_minimum_amount:
          type: "boolean"
        accumulated_charges_amount:
          type: "number"
    description: "models the AgreementService object in TRACT"
    x-swagger-router-model: "AgreementServiceDTO"
    x-reprezen-normalization:
      typeName: "AgreementService"
      position: 318
  UpdateAgreementService:
    type: "object"
    properties:
      agreement:
        $ref: "#/definitions/AgreementRef"
      minimum_amount:
        type: "number"
      end_date:
        type: "string"
        format: "date-time"
      end_action:
        $ref: "#/definitions/AgreementEndActionType"
      next_agreement:
        $ref: "#/definitions/AgreementRef"
      next_end_action:
        $ref: "#/definitions/AgreementEndActionType"
      next_service_product:
        $ref: "#/definitions/ProductRef"
      next_service_pay_on_purchase:
        type: "boolean"
      next_service_product_price:
        $ref: "#/definitions/RecurringProductPriceRef"
      preserve_service_price:
        type: "boolean"
      next_preserve_service_price:
        type: "boolean"
        description: "Only set on agreement-service when end_action is CHANGE_SERVICE\
          \ or CHANGE_AGREEMENT  or when agreement-service's end_action is CHANGE_AGREEMENT"
      omit_minimum_amount:
        type: "boolean"
    title: "UpdateAgreementService"
    description: "models the AgreementService object in TRACT"
    x-swagger-router-model: "UpdateAgreementServiceDTO"
    x-reprezen-normalization:
      typeName: "UpdateAgreementService"
      position: 319
  RatedUsageEvent:
    title: "RatedUsageEvent"
    allOf:
    - $ref: "#/definitions/UsageEvent"
    - type: "object"
      properties:
        total_charge:
          type: "number"
          readOnly: true
        request_id:
          type: "string"
          readOnly: true
        service_period:
          $ref: "#/definitions/ServicePeriodRef"
        event_charges:
          type: "array"
          items:
            $ref: "#/definitions/EventCharge"
    x-reprezen-normalization:
      typeName: "RatedUsageEvent"
      position: 320
  BulkUsageEventsRequest:
    type: "object"
    required:
    - "mode"
    - "usage_events"
    properties:
      mode:
        $ref: "#/definitions/UsageMode"
      usage_events:
        type: "array"
        items:
          $ref: "#/definitions/UsageEvent"
    title: "BulkUsageEventsRequest"
    x-reprezen-normalization:
      typeName: "BulkUsageEventsRequest"
      position: 321
  BulkUsageEventsResponse:
    type: "object"
    properties:
      rated_events:
        type: "array"
        items:
          $ref: "#/definitions/RatedUsageEvent"
      erred_events:
        type: "array"
        items:
          $ref: "#/definitions/ErredUsageEvent"
    title: "BulkUsageEventsResponse"
    x-reprezen-normalization:
      typeName: "BulkUsageEventsResponse"
      position: 322
  DiscountCodeService:
    title: "DiscountCodeService"
    allOf:
    - $ref: "#/definitions/DiscountCodeEntity"
    - type: "object"
      properties:
        service:
          $ref: "#/definitions/Service"
    x-swagger-router-model: "DiscountCodeServiceDTO"
    x-discriminator-value: "service"
    x-reprezen-normalization:
      typeName: "DiscountCodeService"
      position: 323
  DiscountResource:
    title: "DiscountResource"
    allOf:
    - $ref: "#/definitions/GenericResource"
    - type: "object"
      properties:
        status:
          $ref: "#/definitions/DiscountResourceStatus"
        unlimited:
          type: "boolean"
        limit:
          type: "integer"
          format: "int32"
        uses:
          type: "integer"
          format: "int32"
    x-swagger-router-model: "DiscountResourceDTO"
    x-discriminator-value: "discount"
    x-reprezen-normalization:
      typeName: "DiscountResource"
      position: 324
  AdjustmentCategory:
    title: "AdjustmentCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "AdjustmentCategoryDTO"
    x-discriminator-value: "adjustment"
    x-reprezen-normalization:
      typeName: "AdjustmentCategory"
      position: 325
  ManualJournalTransaction:
    title: "ManualJournalTransaction"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        billing_account_number:
          type: "string"
          description: "The billing account number to post to."
        created_date:
          type: "string"
          format: "date-time"
          description: "The date and time this records was created.  Auto generated\
            \ by backend."
        created_by:
          type: "string"
          description: "The user creating this transaction."
        currency_code:
          $ref: "#/definitions/CurrencyCode"
        converted_currency_code:
          $ref: "#/definitions/CurrencyCode"
        conversion_rate:
          type: "number"
        transaction_date:
          type: "string"
          format: "date-time"
        description:
          type: "string"
          description: "The description for this journal transaction."
        gl_accounting_period_id:
          type: "string"
        entries:
          type: "array"
          items:
            $ref: "#/definitions/JournalEntry"
    x-swagger-router-model: "ManualAccountingTransactionDTO"
    x-reprezen-normalization:
      typeName: "ManualJournalTransaction"
      position: 326
  DiscountCodeEntity:
    title: "DiscountCodeEntity"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "discount_code_type"
      discriminator: "discount_code_type"
      properties:
        discount_code_type:
          $ref: "#/definitions/DiscountCodeType"
        discount_code:
          $ref: "#/definitions/DiscountCode"
        discount_resource:
          $ref: "#/definitions/DiscountResourceRef"
        valid_from:
          type: "string"
          format: "date-time"
        valid_to:
          type: "string"
          format: "date-time"
        duration:
          type: "integer"
          format: "int32"
        amount:
          type: "number"
        percentage:
          type: "number"
    x-swagger-router-model: "DiscountCodeEntityDTO"
    x-reprezen-normalization:
      typeName: "DiscountCodeEntity"
      position: 327
  UsageDurationUom:
    type: "string"
    title: "UsageDurationUom"
    enum:
    - "MILLISECOND"
    - "SECOND"
    - "MINUTE"
    - "HOUR"
    - "DAY"
    - "WEEK"
    - "EVENT"
    - "BYTE"
    - "KILOBYTE"
    - "MEGABYTE"
    - "GIGABYTE"
    - "TERABYTE"
    - "COUNT"
    - "BITS_PER_SECOND"
    - "KILOBITS_PER_SECOND"
    - "MEGABITS_PER_SECOND"
    - "GIGABITS_PER_SECOND"
    - "CURRENCY"
    - "WATT"
    - "KILOWATT"
    - "MEGAWATT"
    - "GIGAWATT"
    - "WATTS_PER_HOUR"
    - "KILOWATTS_PER_HOUR"
    - "MEGAWATTS_PER_HOUR"
    - "GIGAWATTS_PER_HOUR"
    x-swagger-router-model: "UsageDurationUomDTO"
    x-reprezen-normalization:
      typeName: "UsageDurationUom"
      position: 328
  UsageRule:
    title: "UsageRule"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        limit:
          type: "number"
        remaining:
          type: "number"
        used:
          type: "number"
        rollover:
          type: "number"
        current_allowance:
          type: "number"
        service_name:
          type: "string"
        name:
          type: "string"
        service_period:
          $ref: "#/definitions/ServicePeriod"
    x-swagger-router-model: "UsageRuleDTO"
    x-reprezen-normalization:
      typeName: "UsageRule"
      position: 329
  AccountAdjustment:
    title: "AccountAdjustment"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        occurred_on:
          type: "string"
          format: "date-time"
        amount:
          type: "number"
        description:
          type: "string"
        invoiced:
          type: "boolean"
        credit:
          type: "boolean"
        status:
          $ref: "#/definitions/AdjustmentStatus"
        adjustment_type:
          $ref: "#/definitions/AdjustmentType"
        billing_account:
          $ref: "#/definitions/BillingAccountRef"
        reason:
          $ref: "#/definitions/AdjustmentReason"
        secondary_reason:
          $ref: "#/definitions/AdjustmentReason"
        posted_on:
          type: "string"
          format: "date-time"
        posted_by:
          type: "string"
        manual_invoice_application:
          type: "boolean"
        adjustment_applications:
          type: "array"
          items:
            $ref: "#/definitions/AdjustmentApplicationRef"
        unapplied_amount:
          type: "number"
    description: "A representation of a TRACT adjustment"
    x-swagger-router-model: "AccountAdjustmentDTO"
    x-reprezen-normalization:
      typeName: "AccountAdjustment"
      position: 330
  AccountAdjustmentRef:
    title: "AccountAdjustmentRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        reason:
          $ref: "#/definitions/AdjustmentReasonRef"
        secondary_reason:
          $ref: "#/definitions/AdjustmentReasonRef"
    description: "A representation of a TRACT adjustment"
    x-swagger-router-model: "AccountAdjustmentDTO"
    x-reprezen-normalization:
      typeName: "AccountAdjustmentRef"
      position: 331
  ServiceUsageRule:
    title: "ServiceUsageRule"
    allOf:
    - $ref: "#/definitions/UsageRuleTemplate"
    - type: "object"
      required:
      - "service_usage_rule_type"
      discriminator: "service_usage_rule_type"
      properties:
        service_usage_rule_type:
          type: "string"
        order_item_usage_rule:
          $ref: "#/definitions/OrderItemUsageRule"
        status:
          $ref: "#/definitions/ServiceUsageRuleStatus"
    x-swagger-router-model: "ServiceUsageRuleDTO"
    x-reprezen-normalization:
      typeName: "ServiceUsageRule"
      position: 332
  Counter:
    title: "Counter"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "counter_type"
      discriminator: "counter_type"
      properties:
        counter_type:
          $ref: "#/definitions/CounterType"
        name:
          type: "string"
        description:
          type: "string"
        from_date:
          type: "string"
          format: "date-time"
        thru_date:
          type: "string"
          format: "date-time"
        status:
          $ref: "#/definitions/CounterStatus"
        entity_relation_type:
          $ref: "#/definitions/CounterEntityRelationType"
    x-swagger-router-model: "CounterDTO"
    x-reprezen-normalization:
      typeName: "Counter"
      position: 333
  ProductUsageRule:
    title: "ProductUsageRule"
    allOf:
    - $ref: "#/definitions/UsageRuleTemplate"
    - type: "object"
      properties:
        status:
          $ref: "#/definitions/ServiceUsageRuleStatus"
    x-swagger-router-model: "ProductUsageRuleDTO"
    x-reprezen-normalization:
      typeName: "ProductUsageRule"
      position: 334
  ServiceCFVAction:
    title: "ServiceCFVAction"
    allOf:
    - $ref: "#/definitions/Action"
    - type: "object"
      properties:
        service_custom_field:
          $ref: "#/definitions/ServiceCustomFieldRef"
    x-discriminator-value: "service-cfv"
    x-reprezen-normalization:
      typeName: "ServiceCFVAction"
      position: 335
  Reason:
    title: "Reason"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
        description:
          type: "string"
        status:
          type: "string"
    description: "A representation of a TRACT reason"
    x-swagger-router-model: "ReasonDTO"
    x-reprezen-normalization:
      typeName: "Reason"
      position: 336
  UsageRuleTemplate:
    title: "UsageRuleTemplate"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        limit:
          type: "number"
        usage_uom:
          $ref: "#/definitions/UsageDurationUom"
        name:
          type: "string"
        order:
          type: "integer"
          format: "int32"
        prorate_on_order:
          type: "boolean"
        prorate_on_cancel:
          type: "boolean"
        rollover_type:
          $ref: "#/definitions/RollOverType"
        allowance_type:
          $ref: "#/definitions/AllowanceType"
        valid_from:
          type: "string"
          format: "date-time"
        valid_to:
          type: "string"
          format: "date-time"
        rule_type:
          $ref: "#/definitions/RuleType"
        charge_category:
          $ref: "#/definitions/UsageChargeCategory"
        usage_rate:
          $ref: "#/definitions/UsageRate"
    x-swagger-router-model: "UsageRuleTemplateDTO"
    x-reprezen-normalization:
      typeName: "UsageRuleTemplate"
      position: 337
  OrderItemUsageRuleStatus:
    type: "string"
    title: "OrderItemUsageRuleStatus"
    enum:
    - "ACTIVE"
    - "DRAFT"
    x-swagger-router-model: "OrderItemUsageRuleStatusDTO"
    x-reprezen-normalization:
      typeName: "OrderItemUsageRuleStatus"
      position: 338
  AgreementRef:
    title: "AgreementRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        name:
          type: "string"
    description: "models the Agreement object in TRACT"
    x-swagger-router-model: "AgreementDTO"
    x-reprezen-normalization:
      typeName: "AgreementRef"
      position: 339
  AgreementEndActionType:
    type: "string"
    title: "AgreementEndActionType"
    enum:
    - "RENEW_AGREEMENT"
    - "SERVICE_ONLY"
    - "DEACTIVATE_SERVICE"
    - "CHANGE_AGREEMENT"
    - "CHANGE_SERVICE"
    - "CPQ_MANAGED"
    x-swagger-router-model: "AgreementEndActionTypeDTO"
    x-reprezen-normalization:
      typeName: "AgreementEndActionType"
      position: 340
  AgreementNextEndActionType:
    type: "string"
    title: "AgreementNextEndActionType"
    enum:
    - "RENEW_AGREEMENT"
    - "SERVICE_ONLY"
    - "DEACTIVATE_SERVICE"
    - "CPQ_MANAGED"
    x-swagger-router-model: "AgreementEndActionTypeDTO"
    x-reprezen-normalization:
      typeName: "AgreementNextEndActionType"
      position: 341
  DiscountResourceRef:
    title: "DiscountResourceRef"
    allOf:
    - $ref: "#/definitions/GenericResourceRef"
    - type: "object"
    x-swagger-router-model: "DiscountIdentifierDTO"
    x-discriminator-value: "discount-resource"
    x-reprezen-normalization:
      typeName: "DiscountResourceRef"
      position: 342
  OperationRunAttributeType:
    type: "string"
    title: "OperationRunAttributeType"
    enum:
    - "product-sale"
    x-reprezen-normalization:
      typeName: "OperationRunAttributeType"
      position: 343
  OperationRef:
    title: "OperationRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      required:
      - "operation_type"
      discriminator: "operation_type"
      properties:
        operation_type:
          $ref: "#/definitions/OperationType"
    x-swagger-router-model: "OperationRefDto"
    x-reprezen-normalization:
      typeName: "OperationRef"
      position: 344
  ApiError:
    type: "object"
    required:
    - "code"
    - "message"
    properties:
      code:
        type: "string"
        description: "The error code. Usually it is the HTTP error code"
        readOnly: true
      message:
        type: "string"
        description: "The description"
        readOnly: true
    title: "ApiError"
    description: "The base error object"
    x-swagger-router-model: "ApiGeneralException"
    x-reprezen-normalization:
      typeName: "ApiError"
      position: 345
  AdjustmentType:
    type: "string"
    title: "AdjustmentType"
    enum:
    - "MANUAL"
    - "LATE_FEE"
    - "TERMINATION_CHARGE"
    - "INVOICE_ADJUSTMENT"
    x-swagger-router-model: "AdjustmentTypeDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentType"
      position: 346
  AdjustmentReasonRef:
    title: "AdjustmentReasonRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The name of TRACT adjustment reason"
    x-swagger-router-model: "AdjustmentReasonDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentReasonRef"
      position: 347
  ActionType:
    type: "string"
    title: "ActionType"
    enum:
    - "billing-account"
    - "product-sale"
    - "service"
    - "service-cfv"
    x-swagger-router-model: "ActionTypeDTO"
    x-reprezen-normalization:
      typeName: "ActionType"
      position: 348
  OperationType:
    type: "string"
    title: "OperationType"
    enum:
    - "approval"
    x-swagger-router-model: "OperationTypeDto"
    x-reprezen-normalization:
      typeName: "OperationType"
      position: 349
  AdjustmentReason:
    title: "AdjustmentReason"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key) The name of TRACT adjustment reason"
        description:
          type: "string"
          description: "An adjustment reason description"
        status:
          $ref: "#/definitions/AdjustmentReasonStatus"
        level:
          $ref: "#/definitions/AdjustmentReasonLevel"
    x-swagger-router-model: "AdjustmentReasonDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentReason"
      position: 350
  AgreementStatus:
    type: "string"
    title: "AgreementStatus"
    enum:
    - "DRAFT"
    - "ACTIVE"
    - "SUSPENDED"
    x-swagger-router-model: "AgreementStatusDTO"
    x-reprezen-normalization:
      typeName: "AgreementStatus"
      position: 351
  AdjustmentCategoryRef:
    title: "AdjustmentCategoryRef"
    allOf:
    - $ref: "#/definitions/ChargeCategoryRef"
    - type: "object"
    x-swagger-router-model: "AdjustmentCategoryDTO"
    x-discriminator-value: "adjustment"
    x-reprezen-normalization:
      typeName: "AdjustmentCategoryRef"
      position: 352
  AgreementPeriodType:
    type: "string"
    title: "AgreementPeriodType"
    enum:
    - "MONTH"
    - "DAY"
    x-swagger-router-model: "AgreementPeriodTypeDTO"
    x-reprezen-normalization:
      typeName: "AgreementPeriodType"
      position: 353
  TrueUpChargeType:
    type: "string"
    title: "TrueUpChargeType"
    enum:
    - "DISCOUNT"
    - "ONETIME"
    - "RECURRING"
    - "USAGE"
    x-swagger-router-model: "TrueUpChargeTypeDTO"
    x-reprezen-normalization:
      typeName: "TrueUpChargeType"
      position: 354
  UsageEvent:
    title: "UsageEvent"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
    x-swagger-router-model: "UsageEventDTO"
    x-reprezen-normalization:
      typeName: "UsageEvent"
      position: 355
  ServicePeriodRef:
    title: "ServicePeriodRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
    x-swagger-router-model: "ServicePeriodDTO"
    x-reprezen-normalization:
      typeName: "ServicePeriodRef"
      position: 356
  EventCharge:
    title: "EventCharge"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "charge"
      - "rate"
      - "usage_amount"
      - "usage_rule"
      - "usage_uom"
      properties:
        usage_uom:
          $ref: "#/definitions/UsageDurationUom"
        usage_amount:
          type: "number"
        usage_rule:
          $ref: "#/definitions/UsageRuleRef"
        rate:
          type: "number"
        charge:
          type: "number"
        charge_category:
          $ref: "#/definitions/UsageChargeCategoryRef"
    x-swagger-router-model: "EventChargeDTO"
    x-reprezen-normalization:
      typeName: "EventCharge"
      position: 357
  UsageMode:
    type: "string"
    title: "UsageMode"
    enum:
    - "FAIL_ON_EXISTING"
    - "OVERWRITE_ON_EXISTING"
    x-reprezen-normalization:
      typeName: "UsageMode"
      position: 358
  ErredUsageEvent:
    type: "object"
    required:
    - "code"
    - "message"
    properties:
      request_id:
        type: "string"
        description: "the unique request id generated by TRACT"
      message:
        type: "string"
        description: "a message indicating information about the error."
      code:
        type: "string"
        description: "a status code indicating the type of error."
    title: "ErredUsageEvent"
    x-reprezen-normalization:
      typeName: "ErredUsageEvent"
      position: 359
  DiscountResourceStatus:
    type: "string"
    title: "DiscountResourceStatus"
    enum:
    - "requested"
    - "available"
    - "active"
    - "deactivated"
    - "quarantined"
    - "used"
    - "expired"
    - "reserved"
    x-swagger-router-model: "DiscountResourceStatusDTO"
    x-reprezen-normalization:
      typeName: "DiscountResourceStatus"
      position: 360
  JournalEntry:
    title: "JournalEntry"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        gl_account_number:
          type: "string"
          description: "The GL account number for the entry."
        debit_amount:
          type: "number"
        credit_amount:
          type: "number"
        converted_debit_amount:
          type: "number"
        converted_credit_amount:
          type: "number"
        service_id:
          type: "string"
        product_id:
          type: "string"
        invoice_number:
          type: "string"
        order_id:
          type: "string"
        payment_id:
          type: "string"
        billing_account_id:
          type: "string"
    x-swagger-router-model: "AccountingEntryDTO"
    x-reprezen-normalization:
      typeName: "JournalEntry"
      position: 361
  DiscountCodeType:
    type: "string"
    title: "DiscountCodeType"
    enum:
    - "service"
    x-reprezen-normalization:
      typeName: "DiscountCodeType"
      position: 362
  DiscountCode:
    title: "DiscountCode"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
        status:
          $ref: "#/definitions/DiscountCodeStatus"
        description:
          type: "string"
        valid_from:
          type: "string"
          format: "date-time"
        valid_to:
          type: "string"
          format: "date-time"
        discount_charge_category:
          $ref: "#/definitions/DiscountChargeCategory"
        discount:
          $ref: "#/definitions/DiscountRef"
        limit:
          type: "integer"
          format: "int32"
        uses:
          type: "integer"
          format: "int32"
        unlimited:
          type: "boolean"
    x-swagger-router-model: "DiscountCodeDTO"
    x-reprezen-normalization:
      typeName: "DiscountCode"
      position: 363
  AdjustmentStatus:
    type: "string"
    title: "AdjustmentStatus"
    enum:
    - "PENDING"
    - "POSTED"
    - "REVERSED"
    x-swagger-router-model: "AdjustmentStatusDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentStatus"
      position: 364
  ServiceUsageRuleStatus:
    type: "string"
    title: "ServiceUsageRuleStatus"
    enum:
    - "ACTIVE"
    - "DEACTIVATED"
    - "DRAFT"
    x-swagger-router-model: "ServiceUsageRuleStatusDTO"
    x-reprezen-normalization:
      typeName: "ServiceUsageRuleStatus"
      position: 365
  CounterType:
    type: "string"
    title: "CounterType"
    enum:
    - "USAGE_EVENT"
    - "USAGE_RULE"
    - "USAGE_CHARGE"
    x-swagger-router-model: "CounterTypeDTO"
    x-reprezen-normalization:
      typeName: "CounterType"
      position: 366
  CounterStatus:
    type: "string"
    title: "CounterStatus"
    enum:
    - "DRAFT"
    - "ACTIVE"
    - "SUSPENDED"
    x-swagger-router-model: "CounterStatusDTO"
    x-reprezen-normalization:
      typeName: "CounterStatus"
      position: 367
  CounterEntityRelationType:
    type: "string"
    title: "CounterEntityRelationType"
    enum:
    - "SERVICE"
    x-swagger-router-model: "CounterEntityRelationTypeDTO"
    x-reprezen-normalization:
      typeName: "CounterEntityRelationType"
      position: 368
  RollOverType:
    type: "string"
    title: "RollOverType"
    enum:
    - "NONE"
    - "UNCAPPED"
    x-swagger-router-model: "RollOverTypeDTO"
    x-reprezen-normalization:
      typeName: "RollOverType"
      position: 369
  AllowanceType:
    type: "string"
    title: "AllowanceType"
    enum:
    - "UNLIMITED"
    - "RECURRING"
    - "ONE_TIME"
    x-swagger-router-model: "AllowanceTypeDTO"
    x-reprezen-normalization:
      typeName: "AllowanceType"
      position: 370
  RuleType:
    type: "string"
    title: "RuleType"
    enum:
    - "TAPERED"
    - "TIERED"
    x-swagger-router-model: "RuleTypeDTO"
    x-reprezen-normalization:
      typeName: "RuleType"
      position: 371
  UsageRate:
    title: "UsageRate"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      required:
      - "usage_rate_type"
      discriminator: "usage_rate_type"
      properties:
        usage_rate_type:
          type: "string"
        uom:
          $ref: "#/definitions/UsageDurationUom"
        valid_from:
          type: "string"
          format: "date-time"
        valid_to:
          type: "string"
          format: "date-time"
    x-swagger-router-model: "UsageRateDTO"
    x-reprezen-normalization:
      typeName: "UsageRate"
      position: 372
  AdjustmentReasonStatus:
    type: "string"
    title: "AdjustmentReasonStatus"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-swagger-router-model: "AdjustmentReasonStatusDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentReasonStatus"
      position: 373
  AdjustmentReasonLevel:
    type: "string"
    title: "AdjustmentReasonLevel"
    enum:
    - "PRIMARY"
    - "SECONDARY"
    x-swagger-router-model: "AdjustmentReasonLevelDTO"
    x-reprezen-normalization:
      typeName: "AdjustmentReasonLevel"
      position: 374
  UsageRuleRef:
    title: "UsageRuleRef"
    allOf:
    - $ref: "#/definitions/EntityRef"
    - type: "object"
      properties:
        name:
          type: "string"
    x-swagger-router-model: "UsageRuleDTO"
    x-reprezen-normalization:
      typeName: "UsageRuleRef"
      position: 375
  DiscountCodeStatus:
    type: "string"
    title: "DiscountCodeStatus"
    enum:
    - "DRAFT"
    - "ACTIVE"
    - "SUSPENDED"
    x-swagger-router-model: "DiscountCodeStatusDTO"
    x-reprezen-normalization:
      typeName: "DiscountCodeStatus"
      position: 376
  DiscountChargeCategory:
    title: "DiscountChargeCategory"
    allOf:
    - $ref: "#/definitions/ChargeCategory"
    - type: "object"
    x-swagger-router-model: "DiscountChargeCategoryDTO"
    x-discriminator-value: "discount"
    x-reprezen-normalization:
      typeName: "DiscountChargeCategory"
      position: 377
  DiscountRef:
    title: "DiscountRef"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        discount_category:
          $ref: "#/definitions/DiscountCategoryRef"
    x-swagger-router-model: "DiscountDTO"
    x-discriminator-value: "discount"
    x-reprezen-normalization:
      typeName: "DiscountRef"
      position: 378
  DiscountCategoryRef:
    title: "DiscountCategoryRef"
    allOf:
    - $ref: "#/definitions/Entity"
    - type: "object"
      properties:
        name:
          type: "string"
          description: "(unique_key)"
    x-swagger-router-model: "DiscountCategoryDTO"
    x-reprezen-normalization:
      typeName: "DiscountCategoryRef"
      position: 379
parameters:
  q_billing_account_id:
    name: "billing_account_id"
    in: "query"
    description: "The id of a TRACT billing account"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 0
  q_billing_account_status:
    name: "status"
    in: "query"
    description: "The billing account status"
    required: false
    type: "string"
    allowEmptyValue: true
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "PENDING"
    - "COLLECTION"
    - "DEACTIVATED"
    - "FINAL_BILL"
    - "CLOSED"
    x-reprezen-normalization:
      position: 1
  q_billing_account_category_status:
    name: "status"
    in: "query"
    description: "Billing Account Category Status"
    required: false
    type: "string"
    default: "ACTIVE"
    allowEmptyValue: true
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-reprezen-normalization:
      position: 2
  q_billing_account_segment_status:
    name: "status"
    in: "query"
    description: "Billing Account Segment Status"
    required: false
    type: "string"
    default: "ACTIVE"
    allowEmptyValue: true
    enum:
    - "DRAFT"
    - "ACTIVE"
    - "SUSPENDED"
    x-reprezen-normalization:
      position: 3
  q_bill_type:
    name: "bill_type"
    in: "query"
    description: "the bill type"
    required: false
    type: "string"
    enum:
    - "PAPER"
    - "EMAIL"
    - "PAPER_EMAIL"
    - "NONE"
    x-reprezen-normalization:
      position: 4
  q_billing_account_num:
    name: "account_num"
    in: "query"
    description: "The billing account number"
    required: false
    type: "string"
    allowEmptyValue: true
    x-reprezen-normalization:
      position: 5
  q_external_billing_account_num:
    name: "external_account_num"
    in: "query"
    description: "The external account number"
    required: false
    type: "string"
    allowEmptyValue: true
    x-reprezen-normalization:
      position: 6
  q_billing_account_category_id:
    name: "billing_account_category_id"
    in: "query"
    description: "The id of a TRACT billing account category"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 7
  q_billing_account_segment_id:
    name: "billing_account_segment_id"
    in: "query"
    description: "The id of a TRACT billing account segment"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 8
  q_parent_billing_account_id:
    name: "parent_id"
    in: "query"
    description: "The id of a TRACT parent billing account segment"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 9
  q_billing_account_custom_field_id:
    name: "billing_account_custom_field_id"
    in: "query"
    description: "The id of a TRACT custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 10
  q_billing_account_custom_field_value_id:
    name: "billing_account_custom_field_value_id"
    in: "query"
    description: "The id of a TRACT custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 11
  q_billing_account_custom_field_value:
    name: "billing_account_custom_field_value"
    in: "query"
    description: "An account custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 12
  q_billing_account_category_name:
    name: "category_name"
    in: "query"
    description: "Billing Account Category Name"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 13
  q_billing_account_fields_to_null:
    name: "fields_to_null"
    in: "query"
    description: "List of fields that will be set to null value."
    required: false
    type: "array"
    items:
      type: "string"
      enum:
      - "external_account_num"
    collectionFormat: "multi"
    x-reprezen-normalization:
      position: 14
  q_billing_account_category_desc:
    name: "category_description"
    in: "query"
    description: "Billing Account Category Description"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 15
  billing_account_id:
    name: "billing_account_id"
    in: "path"
    description: "The internal id of a billing account."
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 16
  billing_account_custom_field_id:
    name: "account_custom_field_id"
    in: "path"
    description: "The id of a TRACT account custom field"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 17
  billing_account_child_relation_id:
    name: "child_relation_id"
    in: "path"
    description: "The id of a TRACT billing account child relation"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 18
  parent_account_relation_id:
    name: "parent_account_relation_id"
    in: "path"
    description: "The id of a TRACT parent billing account relation"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 19
  b_create_billing_account:
    in: "body"
    name: "billing_account"
    description: "The TRACT billing account in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateBillingAccount"
    x-examples:
      default: "{\n    \"auto_payment_authorized\": false,\n    \"bill_cycle\": {\n\
        \        \"bill_cycle_type\": \"daily\",\n        \"id\": 6\n    }, \n   \
        \ \"bill_type\": \"NONE\", \n    \"billing_account_category\": {\n       \
        \ \"id\": 4\n    }, \n    \"responsible_party\": {\n      \"party_type\":\
        \ \"person\",\n        \"addresses\": [\n            {\n                \"\
        purpose\": \"BILLING\", \n                \"city\": \"Austin\", \n       \
        \         \"line1\": \"620 Congress Ave.\",\n                \"line2\": \"\
        Suite 100\", \n                \"postal_code\": \"78701\", \n            \
        \    \"region_or_state\": \"TX\",\n                \"address_type\": \"postal\"\
        \n            }\n        ], \n        \"first_name\": \"Johnny\", \n     \
        \   \"last_name\": \"Goode\", \n        \"middle_name\": \"Be\"\n    },\n\
        \    \"order\": {\n        \"note\": \"Order Note\",\n        \"email_receipt\"\
        : true,\n        \"purchase_order_number\": \"PO Number 1234\",\n        \"\
        referral\": \"Johnny Cash\",\n        \"order_items\": [\n          {\n  \
        \              \"order_item_type\": \"product\",\n                \"product\"\
        : {\n                    \"default_quantity\": 1.0,\n                    \"\
        id\": \"15\",\n                    \"product_type\": \"customer-subscription\"\
        \n                },\n                \"quantity\": 1,\n                \"\
        order_items\": [\n                  {\n                    \"order_item_type\"\
        : \"addon\",\n                    \"quantity\": 1,\n                    \"\
        product\": {\n                        \"default_quantity\": 1.0,\n       \
        \                 \"id\": \"14\",\n                        \"product_type\"\
        : \"customer-subscription\"\n                    },\n                    \"\
        service_resources\": [\n                      {\n                        \"\
        resource_type\": \"service\",\n                        \"identifier\": \"\
        API-NG-008\",\n                        \"category\": {\n                 \
        \         \"id\": 6\n                        }\n                      }\n\
        \                    ]\n                  }\n              ]\n           \
        \   }\n          ]\n    }\n}\n"
    x-reprezen-normalization:
      position: 20
  b_update_billing_account:
    in: "body"
    name: "billing_account"
    description: "The TRACT billing account in JSON format"
    required: true
    schema:
      $ref: "#/definitions/BillingAccount"
    x-examples:
      default: "{\n    \"auto_payment_authorized\": false,\n    \"external_account_num\"\
        : \"098763554\",\n    \"tax_exempt\": true,\n    \"billing_account_category\"\
        : {\"id\": 123},\n    \"bill_type\": \"EMAIL\",\n    \"payment_term\": {\"\
        id\": 12}\n}\n"
    x-reprezen-normalization:
      position: 21
  b_suspend_billing_account:
    in: "body"
    name: "suspend_billing_account"
    description: "The reason to suspending a TRACT entity"
    required: true
    schema:
      $ref: "#/definitions/SuspendBillingAccount"
    x-reprezen-normalization:
      position: 22
  b_deactivate_billing_account:
    in: "body"
    name: "deactivate_billing_account"
    description: "The reason to deactivating a TRACT entity"
    required: true
    schema:
      $ref: "#/definitions/DeactivateBillingAccount"
    x-reprezen-normalization:
      position: 23
  b_resume_billing_account:
    in: "body"
    name: "resume_billing_account"
    description: "The payload for resuming a biling account"
    required: true
    schema:
      $ref: "#/definitions/ResumeBillingAccount"
    x-reprezen-normalization:
      position: 24
  b_change_responsible_account:
    in: "body"
    name: "change_responsible_account"
    description: "The payload for changing a responsible account"
    required: true
    schema:
      $ref: "#/definitions/ChangeResponsibleAccount"
    x-reprezen-normalization:
      position: 25
  b_create_parent_account_relation:
    in: "body"
    name: "create_parent_account_relation"
    description: "The payload for adding a parent billing account relation"
    required: true
    schema:
      $ref: "#/definitions/CreateParentAccountRelation"
    x-examples:
      default: "{\n   \"parent_account\": {\n      \"id\": \"18\"\n   }\n}\n"
    x-reprezen-normalization:
      position: 26
  b_deactivate_parent_account_relation:
    in: "body"
    name: "deactivate_parent_account_relation"
    description: "The payload for deactivation of a parent billing account relation"
    required: false
    schema:
      $ref: "#/definitions/DeactivateParentAccountRelation"
    x-examples:
      default: "{}\n"
    x-reprezen-normalization:
      position: 27
  q_order_item_id:
    name: "order_item_id"
    in: "query"
    description: "The order item id"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 28
  q_parent_order_item_id:
    name: "parent_order_item_id"
    in: "query"
    description: "The parent order item id"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 29
  q_order_item_status:
    name: "order_item_status"
    in: "query"
    description: "the order-item status"
    required: false
    type: "string"
    enum:
    - "TRIAL"
    - "FULFILLMENT"
    - "IN_PROGRESS"
    - "COMPLETED"
    - "CANCELED"
    - "DENIED"
    - "ERROR"
    - "DRAFT"
    x-reprezen-normalization:
      position: 30
  b_approve_order_item:
    in: "body"
    name: "approve_order_item"
    description: "The payload to approve an order-item"
    required: true
    schema:
      $ref: "#/definitions/ApproveOrderItem"
    x-examples:
      default: "{\n   \"approval_date\":\"2017-02-14T18:20:10.382-06:00\"\n}\n"
    x-reprezen-normalization:
      position: 31
  q_bill_cycle_type:
    name: "bill_cycle_type"
    in: "query"
    description: "bill cycle type"
    required: false
    type: "string"
    default: "monthly"
    enum:
    - "daily"
    - "monthly"
    - "quarterly"
    - "yearly"
    - "segmented-monthly"
    x-reprezen-normalization:
      position: 32
  q_bill_cycle_id:
    name: "bill_cycle_id"
    in: "query"
    description: "The id of a TRACT bill cycle"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 33
  q_bill_cycle_name:
    name: "name"
    in: "query"
    description: "The name of a TRACT bill cycle"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 34
  q_bill_cycle_run_id:
    name: "bill_cycle_run_id"
    in: "query"
    description: "The if of a TRACT bill cycle run"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 35
  bill_cycle_id:
    name: "bill_cycle_id"
    in: "path"
    description: "The id of a TRACT bill cycle"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 36
  b_bill_cycle:
    in: "body"
    name: "bill_cycle"
    description: "The payload for move billing account"
    required: true
    schema:
      $ref: "#/definitions/BillCycle"
    x-reprezen-normalization:
      position: 37
  q_invoice_id:
    name: "invoice_id"
    in: "query"
    description: "The id of a TRACT invoice"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 38
  q_invoice_num:
    name: "invoice_num"
    in: "query"
    description: "The number of a TRACT invoice"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 39
  q_occurred_on:
    name: "occurred_on"
    in: "query"
    description: "The TRACT  invoice occured on date"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 40
  q_due_date:
    name: "due_date"
    in: "query"
    description: "The TRACT  invoice due date"
    required: false
    type: "string"
    format: "date"
    x-reprezen-normalization:
      position: 41
  q_invoice_status:
    name: "status"
    in: "query"
    description: "The TRACT status"
    required: false
    type: "string"
    default: "OPEN"
    enum:
    - "PROCESSING"
    - "OPEN"
    - "CLOSED"
    x-reprezen-normalization:
      position: 42
  invoice_id:
    name: "invoice_id"
    in: "path"
    description: "The id of a TRACT invoice"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 43
  f_invoice_pdf:
    name: "invoice_pdf_file"
    in: "formData"
    required: false
    type: "file"
    x-reprezen-normalization:
      position: 44
  f_invoice_csv:
    name: "invoice_csv_file"
    in: "formData"
    required: false
    type: "file"
    x-reprezen-normalization:
      position: 45
  f_invoice_json:
    name: "invoice_json_file"
    in: "formData"
    required: false
    type: "file"
    x-reprezen-normalization:
      position: 46
  q_occurred_on_1:
    name: "occurred_on"
    in: "query"
    description: "The date that the adjustment occurred"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 47
  q_unapplied_amount:
    name: "unapplied_amount"
    in: "query"
    description: "The unapplied adjustment amount"
    required: false
    type: "number"
    x-reprezen-normalization:
      position: 48
  q_adjustment_application_type:
    name: "adjustment_application_type"
    in: "query"
    description: "The type of a TRACT adjustment-application"
    required: false
    type: "string"
    enum:
    - "standard-invoice"
    - "negative-invoice"
    - "reversed-invoice"
    - "write-off"
    x-reprezen-normalization:
      position: 49
  q_party_id:
    name: "party_id"
    in: "query"
    description: "The id of a TRACT party"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 50
  q_person_id:
    name: "person_id"
    in: "query"
    description: "The id of a TRACT person"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 51
  q_first_name:
    name: "first_name"
    in: "query"
    description: "The first name of a TRACT person"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 52
  q_last_name:
    name: "last_name"
    in: "query"
    description: "The last name of a TRACT person"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 53
  q_organization_id:
    name: "organization_id"
    in: "query"
    description: "The id of a TRACT organization"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 54
  q_organization_name:
    name: "organization_name"
    in: "query"
    description: "The name of a TRACT organization"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 55
  party_id:
    name: "party_id"
    in: "path"
    description: "The id of a TRACT party"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 56
  person_id:
    name: "person_id"
    in: "path"
    description: "The id of a TRACT person"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 57
  organization_id:
    name: "organization_id"
    in: "path"
    description: "The id of a TRACT organization"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 58
  b_create_person:
    in: "body"
    name: "person"
    description: "The TRACT person in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreatePerson"
    x-reprezen-normalization:
      position: 59
  b_create_organization:
    in: "body"
    name: "organization"
    description: "The TRACT organization in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateOrganization"
    x-reprezen-normalization:
      position: 60
  b_update_person:
    in: "body"
    name: "person"
    description: "The TRACT person in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdatePerson"
    x-reprezen-normalization:
      position: 61
  b_update_organization:
    in: "body"
    name: "organization"
    description: "The TRACT organization in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdateOrganization"
    x-reprezen-normalization:
      position: 62
  q_service_id:
    name: "service_id"
    in: "query"
    description: "The id of a TRACT service"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 63
  q_parent_service_id:
    name: "parent_id"
    in: "query"
    description: "The id of a TRACT parent service"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 64
  q_prev_service_id:
    name: "previous_service_id"
    in: "query"
    description: "The id of the previous TRACT service"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 65
  q_next_service_id:
    name: "next_service_id"
    in: "query"
    description: "The id of  the next TRACT service"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 66
  q_original_order_id:
    name: "original_order_id"
    in: "query"
    description: "The id of a TRACT service relation"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 67
  q_original_order_num:
    name: "original_order_num"
    in: "query"
    description: "The order number of an order that created a TRACT service"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 68
  q_original_order_item_sequence:
    name: "original_order_item_sequence"
    in: "query"
    description: "The order item sequence number for an order item on a service"
    required: false
    type: "integer"
    format: "int32"
    x-reprezen-normalization:
      position: 69
  q_service_relation_id:
    name: "service_relation_id"
    in: "query"
    description: "The id of a TRACT service relation"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 70
  q_service_custom_field_id:
    name: "custom_field_id"
    in: "query"
    description: "The id of a TRACT service custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 71
  q_service_custom_field_value_id:
    name: "custom_field_value_id"
    in: "query"
    description: "The id of a TRACT service custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 72
  q_service_custom_field_value:
    name: "custom_field_value"
    in: "query"
    description: "A service custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 73
  q_service_renewal_count:
    name: "renewal_count"
    in: "query"
    description: "The renewal count for a renewal service"
    required: false
    type: "integer"
    format: "int32"
    x-reprezen-normalization:
      position: 74
  q_service_start_date:
    name: "start_date"
    in: "query"
    description: "The start date of a TRACT service"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 75
  q_service_end_date:
    name: "end_date"
    in: "query"
    description: "The end date of a TRACT service"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 76
  q_service_status:
    name: "status"
    in: "query"
    description: "The status of a TRACT service"
    required: false
    type: "string"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "DEACTIVATED"
    - "PENDING"
    - "CANCELED"
    - "TRANSFERRED"
    - "REPLACED"
    - "TRIAL"
    - "SCHEDULED"
    x-reprezen-normalization:
      position: 77
  service_id:
    name: "service_id"
    in: "path"
    description: "The id of a TRACT service"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 78
  service_relation_id:
    name: "service_relation_id"
    in: "path"
    description: "The id of a TRACT service relation"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 79
  b_service:
    in: "body"
    name: "service"
    description: "The TRACT service in JSON format"
    required: true
    schema:
      $ref: "#/definitions/Service"
    x-reprezen-normalization:
      position: 80
  b_service_address:
    in: "body"
    name: "add_service_address"
    description: "A payload used to add a service address"
    required: true
    schema:
      $ref: "#/definitions/AddServiceAddress"
    x-examples:
      default: "{\n  \"address\": {\n        \"address_type\": \"postal\",\n     \
        \   \"purpose\": \"SERVICE\",\n        \"country\": \"USA\",\n        \"city\"\
        : \"Kalamazoo\",\n        \"region_or_state\": \"TN\",\n        \"attention\"\
        : \"Joe\",\n        \"postal_code\": \"55555\",\n        \"line1\": \"123\
        \ Avenue A\",\n        \"line2\": \"Suite 100\",\n        \"p_code\": 0,\n\
        \        \"p_code_overridden\": true\n      }\n }\n"
    x-reprezen-normalization:
      position: 81
  b_deactivate_service:
    in: "body"
    name: "deactivate_service"
    description: "The payload to deactivate a service"
    required: true
    schema:
      $ref: "#/definitions/DeactivateService"
    x-examples:
      default: "{\n    \"reason\": {\n        \"reason_type\" : \"service-deactivation\"\
        ,\n        \"id\" :  5432167\n    },\n   \"effective_date\": \"2017-02-14T18:20:10.382-06:00\"\
        \n}\n"
    x-reprezen-normalization:
      position: 82
  h_tenant_id:
    name: "tenant_id"
    in: "header"
    description: "The id for the tenant being accessed."
    required: true
    type: "integer"
    format: "int64"
    x-reprezen-normalization:
      position: 83
  h_prefer:
    name: "Prefer"
    in: "header"
    description: "return=[representation|minimal] The HTTP Prefer header. See https://tools.ietf.org/html/rfc7240"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 84
  q_expand:
    name: "expand"
    in: "query"
    description: "Provides the capabilty for the desired output fields to be specified"
    required: false
    type: "array"
    items:
      type: "string"
    collectionFormat: "multi"
    maxLength: 255
    uniqueItems: true
    x-reprezen-normalization:
      position: 85
  q_return_scope:
    name: "return"
    in: "query"
    description: "Specifies the amount of detail to provide in a response."
    required: false
    type: "string"
    default: "FULL"
    allowEmptyValue: true
    enum:
    - "SIMPLE"
    - "FULL"
    x-reprezen-normalization:
      position: 86
  q_filter:
    name: "filter"
    in: "query"
    description: "API query language string"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 87
  q_sort:
    name: "sort"
    in: "query"
    description: "Provides cabability to specify sort parameters - \"+ for ascending,\
      \ \"-\" for descending . example - \"+id|-name\""
    required: false
    type: "array"
    items:
      type: "string"
      pattern: "[-+](.*)"
    collectionFormat: "pipes"
    minItems: 1
    uniqueItems: true
    x-reprezen-normalization:
      position: 88
  q_valid_from_date_time:
    name: "valid_from"
    in: "query"
    description: "The valid from date time"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 89
  q_valid_to_date_time:
    name: "valid_to"
    in: "query"
    description: "The valid to date time"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 90
  q_valid_from_date:
    name: "valid_from"
    in: "query"
    description: "The valid from date"
    required: false
    type: "string"
    format: "date"
    x-reprezen-normalization:
      position: 91
  q_valid_to_date:
    name: "valid_to"
    in: "query"
    description: "The valid to date"
    required: false
    type: "string"
    format: "date"
    x-reprezen-normalization:
      position: 92
  q_product_id:
    name: "product_id"
    in: "query"
    description: "The id of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 93
  q_product_name:
    name: "name"
    in: "query"
    description: "The name of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 94
  q_product_internal_name:
    name: "internal_name"
    in: "query"
    description: "The internal name of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 95
  q_external_product_number:
    name: "external_product_number"
    in: "query"
    description: "The external product number of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 96
  q_product_sku:
    name: "sku"
    in: "query"
    description: "The sku of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 97
  q_product_type:
    name: "product_type"
    in: "query"
    description: "The type of a TRACT product"
    required: false
    type: "string"
    allowEmptyValue: true
    enum:
    - "tract-subscription"
    - "customer-subscription"
    - "general"
    - "addon"
    x-reprezen-normalization:
      position: 98
  q_product_state:
    name: "product_state"
    in: "query"
    description: "The state  of a TRACT product"
    required: false
    type: "string"
    allowEmptyValue: true
    enum:
    - "DRAFT"
    - "AVAILABLE"
    - "NOT_AVAILABLE"
    x-reprezen-normalization:
      position: 99
  q_product_category_id:
    name: "product_category_id"
    in: "query"
    description: "The product category id of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 100
  q_product_category_name:
    name: "product_category_name"
    in: "query"
    description: "The product category name of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 101
  q_product_tag_id:
    name: "product_tag_id"
    in: "query"
    description: "The product tag id of a TRACT product"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 102
  q_recurring_product_price_from_date:
    name: "from_date"
    in: "query"
    description: "the from date"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 103
  q_recurring_product_price_thru_date:
    name: "thru_date"
    in: "query"
    description: "the thru date"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 104
  q_recurring_product_price_recurrence_period:
    name: "recurrence_period"
    in: "query"
    description: "The recurrence period"
    required: false
    type: "string"
    enum:
    - "BILL_CYCLE"
    - "DAY"
    - "FOUR_YEARS"
    - "FIVE_YEARS"
    - "MONTH"
    - "QUARTER"
    - "THREE_YEARS"
    - "TWICE_A_MONTH"
    - "TWICE_A_YEAR"
    - "TWO_WEEKS"
    - "TWO_YEARS"
    - "WEEK"
    - "YEAR"
    - "FOUR_MONTHS"
    x-reprezen-normalization:
      position: 105
  q_recurring_product_price_recurrence_amount:
    name: "recurrence_amount"
    in: "query"
    description: "use this charge to prorate order"
    required: false
    type: "number"
    x-reprezen-normalization:
      position: 106
  q_recurring_product_price_payment_required:
    name: "recurring_payment_required"
    in: "query"
    description: "Is a recurring payment required?"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 107
  q_recurring_product_price_bill_in_advance:
    name: "bill_in_advance"
    in: "query"
    description: "bill an order in advance"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 108
  q_recurring_product_price_prorated_on_cancel:
    name: "prorated_on_cancel"
    in: "query"
    description: "PRorate on canel order"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 109
  q_recurring_product_price_prorated_on_order:
    name: "prorated_on_order"
    in: "query"
    description: "Prorate the order?"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 110
  q_recurring_product_price_prorated_on_order_no_charge:
    name: "prorated_on_order_no_charge"
    in: "query"
    description: "use this charge to prorate order"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 111
  q_address_id:
    name: "address_id"
    in: "query"
    description: "The id of a TRACT address"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 112
  q_email_address:
    name: "email_address"
    in: "query"
    description: "An email address"
    required: false
    type: "string"
    format: "email"
    x-reprezen-normalization:
      position: 113
  q_address_type:
    name: "address_type"
    in: "query"
    description: "The system wide address types"
    required: false
    type: "string"
    enum:
    - "postal"
    - "email"
    - "telecom"
    x-reprezen-normalization:
      position: 114
  address_id:
    name: "address_id"
    in: "path"
    description: "The id of a TRACT address"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 115
  b_address:
    in: "body"
    name: "add_address"
    description: "A payload used to add an address"
    required: false
    schema:
      $ref: "#/definitions/CreateAddress"
    x-examples:
      default: "{\n   \"id\": \"1438752\",\n   \"address_type\": \"postal\",\n   \"\
        purpose\": \"BILLING\",\n   \"country\": \"USA\",\n   \"city\": \"Kalamazoo\"\
        ,\n   \"region_or_state\": \"TN\",\n   \"attention\": \"Joe\",\n   \"postal_code\"\
        : \"55555\",\n   \"line1\": \"123 Avenue A\",\n   \"line2\": \"Suite 100\"\
        ,\n   \"p_code\": 0,\n   \"p_code_overridden\": true\n }"
    x-reprezen-normalization:
      position: 116
  q_service_resource_id:
    name: "service_resource_id"
    in: "query"
    description: "The id of a TRACT service resource"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 117
  q_service_resource_identifier:
    name: "service_resource_identifier"
    in: "query"
    description: "The identifier of a TRACT service resource"
    required: false
    type: "string"
    maxLength: 255
    x-reprezen-normalization:
      position: 118
  q_child_service_resource_identifier:
    name: "child_service_resource_identifier"
    in: "query"
    description: "The identifier of a TRACT service resource"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 119
  q_generic_resource_identifier:
    name: "identifier"
    in: "query"
    description: "The identifier of a TRACT service resource"
    required: false
    type: "string"
    maxLength: 255
    x-reprezen-normalization:
      position: 120
  q_resource_category_id:
    name: "resource_category_id"
    in: "query"
    description: "The id of a TRACT service resource category"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 121
  q_resource_category_name:
    name: "resource_category_name"
    in: "query"
    description: "The name of a TRACT service resource category"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 122
  q_service_resource_status:
    name: "status"
    in: "query"
    description: "The status of a TRACT service resource category"
    required: false
    type: "string"
    enum:
    - "REQUESTED"
    - "AVAILABLE"
    - "ACTIVE"
    - "DEACTIVATED"
    - "QUARANTINED"
    - "USED"
    - "RESERVED"
    x-reprezen-normalization:
      position: 123
  q_service_resource_desc:
    name: "description"
    in: "query"
    description: "The description of a TRACT service resource category"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 124
  q_resource_type:
    name: "resource_type"
    in: "query"
    description: "The name of a TRACT service resource type"
    required: false
    type: "string"
    enum:
    - "service"
    - "discount"
    x-reprezen-normalization:
      position: 125
  service_resource_id:
    name: "service_resource_id"
    in: "path"
    description: "The id of a TRACT service resource"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 126
  b_add_service_resource:
    in: "body"
    name: "add_service_resource"
    description: "The TRACT service resource"
    required: true
    schema:
      $ref: "#/definitions/AddServiceResource"
    x-reprezen-normalization:
      position: 127
  q_custom_field_value_id:
    name: "custom_field_value_id"
    in: "query"
    description: "The id of a TRACT custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 128
  q_custom_field_id:
    name: "custom_field_id"
    in: "query"
    description: "The id of a TRACT custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 129
  q_name:
    name: "name"
    in: "query"
    description: "The name of a TRACT custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 130
  q_custom_field_name:
    name: "custom_field_name"
    in: "query"
    description: "The name of a TRACT custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 131
  q_custom_field_enabled:
    name: "custom_field_enabled"
    in: "query"
    description: "The enabled property of a TRACT custom field"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 132
  q_enabled:
    name: "enabled"
    in: "query"
    description: "The enabled property of a TRACT custom field"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 133
  q_custom_field_searchable:
    name: "custom_field_searchable"
    in: "query"
    description: "The searchable property of a TRACT custom field"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 134
  q_searchable:
    name: "searchable"
    in: "query"
    description: "The searchable property of a TRACT custom field"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 135
  q_custom_field_type:
    name: "custom_field_type"
    in: "query"
    description: "A custom field type"
    required: false
    type: "string"
    enum:
    - "billing-account"
    - "order"
    - "service"
    - "payment-method"
    x-reprezen-normalization:
      position: 136
  q_custom_field_value:
    name: "custom_field_value"
    in: "query"
    description: "A custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 137
  q_custom_field_value_reference_status:
    name: "status"
    in: "query"
    description: "An custom field value reference status"
    required: false
    type: "string"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    x-reprezen-normalization:
      position: 138
  q_billing_account_custom_field_id_1:
    name: "billing_account_custom_field_id"
    in: "query"
    description: "The id of a TRACT billing account custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 139
  q_billing_account_custom_field_value_1:
    name: "billing_account_custom_field_value"
    in: "query"
    description: "A billing account custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 140
  q_billing_account_custom_field_name:
    name: "billing_account_custom_field_name"
    in: "query"
    description: "A billing account custom field name"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 141
  q_service_custom_field_id_1:
    name: "service_custom_field_id"
    in: "query"
    description: "The id of a TRACT service custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 142
  q_service_custom_field_value_id_1:
    name: "service_custom_field_value_id"
    in: "query"
    description: "The id of a TRACT service custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 143
  q_service_custom_field_value_1:
    name: "service_custom_field_value"
    in: "query"
    description: "An service custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 144
  q_service_custom_field_name:
    name: "service_custom_field_name"
    in: "query"
    description: "A service custom field name"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 145
  q_order_custom_field_id:
    name: "order_custom_field_id"
    in: "query"
    description: "The id of a TRACT order custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 146
  q_order_custom_field_value_id:
    name: "order_custom_field_value_id"
    in: "query"
    description: "The id of a TRACT order custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 147
  q_order_custom_field_name:
    name: "order_custom_field_name"
    in: "query"
    description: "The name of a TRACT order custom field"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 148
  q_order_custom_field_value:
    name: "order_custom_field_value"
    in: "query"
    description: "An order custom field value"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 149
  custom_field_id:
    name: "custom_field_id"
    in: "path"
    description: "The id of a TRACT custom field"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 150
  custom_field_value_id:
    name: "custom_field_value_id"
    in: "path"
    description: "The id of a TRACT custom field value"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 151
  b_create_order_custom_field_value:
    in: "body"
    name: "order_custom_field_value"
    description: "The TRACT order custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateOrderCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"order\",\n  \"value\": \"value\
        \ 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\": \"Test\
        \ 3\",\n    \"custom_field_type\": \"order\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 152
  b_update_order_custom_field_value:
    in: "body"
    name: "order_custom_field_value"
    description: "The TRACT order custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdateOrderCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"order\",\n  \"value\": \"value\
        \ 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\": \"Test\
        \ 3\",\n    \"custom_field_type\": \"order\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 153
  b_create_billing_account_custom_field_value:
    in: "body"
    name: "billing_account_custom_field_value"
    description: "The TRACT billing account custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateBillingAccountCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"billing-account\",\n  \"value\"\
        : \"value 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
        : \"Test 3\",\n    \"custom_field_type\": \"billing-account\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 154
  b_update_billing_account_custom_field_value:
    in: "body"
    name: "billing_account_custom_field_value"
    description: "The TRACT billing account custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdateBillingAccountCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"billing-account\",\n  \"value\"\
        : \"value 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
        : \"Test 3\",\n    \"custom_field_type\": \"billing-account\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 155
  b_create_service_custom_field_value:
    in: "body"
    name: "service_custom_field_value"
    description: "The TRACT service custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateServiceCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"service\",\n  \"value\": \"value\
        \ 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\": \"Test\
        \ 3\",\n    \"custom_field_type\": \"service\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 156
  b_update_service_custom_field_value:
    in: "body"
    name: "service_custom_field_value"
    description: "The TRACT service custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdateServiceCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"service\",\n  \"value\": \"value\
        \ 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\": \"Test\
        \ 3\",\n    \"custom_field_type\": \"service\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 157
  b_create_payment_method_custom_field_value:
    in: "body"
    name: "payment_method_custom_field_value"
    description: "The TRACT payment method custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreatePaymentMethodCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"payment-method\",\n  \"value\"\
        : \"value 1\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
        : \"Test 3\",\n    \"custom_field_type\": \"payment-method\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 158
  b_update_payment_method_custom_field_value:
    in: "body"
    name: "payment_method_custom_field_value"
    description: "The TRACT payment method custom field value in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdatePaymentMethodCustomFieldValue"
    x-examples:
      default: "{\n  \"custom_field_value_type\":\"payment-method\",\n  \"value\"\
        : \"value 2\",\n  \"custom_field\": {\n    \"id\": \"1088\",\n    \"name\"\
        : \"Test 3\",\n    \"custom_field_type\": \"payment-method\"\n  }\n}\n"
    x-reprezen-normalization:
      position: 159
  b_custom_field:
    in: "body"
    name: "custom_field"
    description: "The TRACT custom field in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CustomField"
    x-reprezen-normalization:
      position: 160
  q_payment_id:
    name: "payment_id"
    in: "query"
    description: "The payment id"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 161
  q_payment_occurred_on:
    name: "occurred_on"
    in: "query"
    description: "The date that the payment occurred"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 162
  q_payment_reference:
    name: "reference"
    in: "query"
    description: "The payment reference"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 163
  q_payment_status:
    name: "status"
    in: "query"
    description: "The payment status"
    required: false
    type: "string"
    allowEmptyValue: true
    enum:
    - "DRAFT"
    - "PROCESSING"
    - "COMPLETED"
    - "VOID"
    - "PROCESSING_ERROR"
    - "MERCHANT_VERIFICATION"
    - "MERCHANT_VERIFICATION_FAILED"
    - "CANCELED"
    - "ALLOCATION_ERROR"
    x-reprezen-normalization:
      position: 164
  q_payment_authorization:
    name: "authorization"
    in: "query"
    description: "The payment authorization"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 165
  q_payment_unapplied_amount:
    name: "unapplied_amount"
    in: "query"
    description: "The unapplied payment amount"
    required: false
    type: "number"
    x-reprezen-normalization:
      position: 166
  q_payment_token:
    name: "token"
    in: "query"
    description: "The payment token"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 167
  q_auto_payment:
    name: "auto_payment"
    in: "query"
    description: "Is the payment an auto payment?"
    required: false
    type: "boolean"
    x-reprezen-normalization:
      position: 168
  q_payment_method_id:
    name: "payment_method_id"
    in: "query"
    description: "The payment method id"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 169
  q_payment_method_type:
    name: "payment_method_type"
    in: "query"
    description: "The payment method type"
    required: false
    type: "string"
    enum:
    - "bank"
    - "credit-card"
    - "cash"
    - "check"
    - "referenced-credit-card"
    - "paypal"
    - "pay-by-paypal"
    - "wire"
    - "mobile-carrier"
    - "custom"
    - "sepa-dd"
    - "sepa-dd-em"
    x-reprezen-normalization:
      position: 170
  q_payment_term_name:
    name: "name"
    in: "query"
    description: "The payment term name"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 171
  payment_id:
    name: "payment_id"
    in: "path"
    description: "The id of a TRACT payment"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 172
  recurring_payment_id:
    name: "recurring_payment_id"
    in: "path"
    description: "The id of a TRACT recurring payment"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 173
  b_payment:
    in: "body"
    name: "payment"
    description: "The TRACT payment in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreatePayment"
    x-reprezen-normalization:
      position: 174
  b_recurring_payment:
    in: "body"
    name: "recurring_payment"
    description: "The TRACT recurring payment in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateRecurringPayment"
    x-examples:
      default: "{\n    \"payment_method\": {\n        \"card_type\": \"VISA\", \n\
        \        \"custom_field_values\": [], \n        \"expiration_date\": \"12/2020\"\
        , \n        \"first_name\": \"Recurring\", \n        \"identifier_number\"\
        : \"4111111111111111\", \n        \"last_name\": \"Payment\", \n        \"\
        payment_method_type\": \"credit-card\", \n        \"verification_number\"\
        : \"123\"\n    }\n}\n"
    x-reprezen-normalization:
      position: 175
  b_create_apply_payment:
    in: "body"
    name: "create_apply_payment"
    description: "The payload for a PATCH of payment objects"
    required: true
    schema:
      $ref: "#/definitions/CreateApplyPayment"
    x-reprezen-normalization:
      position: 176
  q_adjustment_category_name:
    name: "name"
    in: "query"
    description: "The name of TRACT adjustment category"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 177
  q_adjustment_category_status:
    name: "status"
    in: "query"
    description: "An adjustment price category status"
    required: false
    type: "string"
    enum:
    - "ACTIVE"
    - "SUSPENDED"
    - "CANCELED"
    x-reprezen-normalization:
      position: 178
  q_updated_on:
    name: "updated_on"
    in: "query"
    description: "The date that the payment-application updated"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 179
  q_payment_application_type:
    name: "payment_application_type"
    in: "query"
    description: "The payment application type"
    required: false
    type: "string"
    allowEmptyValue: true
    enum:
    - "standard-invoice"
    - "reversed-invoice"
    x-reprezen-normalization:
      position: 180
  q_order_id:
    name: "order_id"
    in: "query"
    description: "The id of a TRACT order"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 181
  q_po_num:
    name: "purchase_order_number"
    in: "query"
    description: "An purchase order number"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 182
  q_order_num:
    name: "order_num"
    in: "query"
    description: "(unique_key) An order number"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 183
  q_order_date:
    name: "order_date"
    in: "query"
    description: "The date that the order takes place"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 184
  q_order_status:
    name: "status"
    in: "query"
    description: "The order status"
    required: false
    type: "string"
    enum:
    - "APPROVED"
    - "COMPLETED"
    - "DRAFT"
    - "CANCELED"
    - "ERROR"
    - "IN_PROGRESS"
    x-reprezen-normalization:
      position: 185
  q_order_referral:
    name: "referral"
    in: "query"
    description: "the order referral"
    required: false
    type: "string"
    x-reprezen-normalization:
      position: 186
  q_order_renewal_date:
    name: "renewal_date"
    in: "query"
    description: "The reneal date for a renewal order"
    required: false
    type: "string"
    format: "date-time"
    x-reprezen-normalization:
      position: 187
  q_order_type:
    name: "order_type"
    in: "query"
    description: "The order type"
    required: false
    type: "string"
    enum:
    - "sales"
    - "renewal"
    - "change"
    x-reprezen-normalization:
      position: 188
  order_id:
    name: "order_id"
    in: "path"
    description: "The id of a TRACT order"
    required: true
    type: "string"
    x-reprezen-normalization:
      position: 189
  b_create_order:
    in: "body"
    name: "order"
    description: "The TRACT order in JSON format"
    required: true
    schema:
      $ref: "#/definitions/CreateSalesOrder"
    x-examples:
      default: "{\n    \"billing_account\": {\n        \"id\": 123456\n    },\n  \
        \  \"order_items\": [\n        {\n            \"order_item_type\": \"product\"\
        , \n            \"product\": {\n                \"default_quantity\": 1.0,\
        \ \n                \"id\": \"15\", \n                \"product_type\": \"\
        customer-subscription\"\n            }, \n            \"quantity\": 1\n  \
        \      }\n    ], \n    \"order_type\": \"sales\"\n}\n"
    x-reprezen-normalization:
      position: 190
  b_update_order:
    in: "body"
    name: "order"
    description: "The TRACT order in JSON format"
    required: true
    schema:
      $ref: "#/definitions/UpdateSalesOrder"
    x-reprezen-normalization:
      position: 191
  b_confirm_order:
    in: "body"
    name: "order"
    description: "Payload used for confirming a DRAFT order"
    required: true
    schema:
      $ref: "#/definitions/ConfirmDraftOrder"
    x-examples:
      default: "{\n    \"payment\": {\n      \"payment_type\": \"payment\",\n    \
        \  \"payment_method\": {\n        \"payment_method_type\": \"credit-card\"\
        ,\n      \"card_type\": \"VISA\",\n      \"first_name\": \"Johnny\",\n   \
        \   \"middle_name\": \"Be\",\n      \"last_name\": \"Goode\",\n      \"suffix\"\
        : \"Jr.\",\n      \"identifier_number\": \"4111111111111111\",\n      \"verification_number\"\
        : \"123\",\n      \"expiration_date\": \"12/2020\",\n      \"nickname\": \"\
        Default\"\n      },\n      \"amount\": 60.00\n    }\n}\n"
    x-reprezen-normalization:
      position: 192
externalDocs:
  description: "Documentation describing how to use this API\n"
  url: "http://documentation.gotransverse.com/api"