openapi: 3.0.3
info:
  title: 'Laravel API Documentation'
  description: ''
  version: 1.0.0
servers:
  -
    url: 'https://apiv3.mango.cloud'
tags:
  -
    name: 'Accounting Groups'
    description: ''
  -
    name: 'Agreement Types'
    description: ''
  -
    name: Agreements
    description: ''
  -
    name: Authentication
    description: ''
  -
    name: 'Billing Plans'
    description: ''
  -
    name: 'Customer Contacts'
    description: ''
  -
    name: 'Customer Groups'
    description: ''
  -
    name: 'Customer Param Definitions'
    description: ''
  -
    name: 'Customer Service Discounts'
    description: ''
  -
    name: 'Customer Service Event Types'
    description: ''
  -
    name: 'Customer Service History'
    description: ''
  -
    name: 'Customer Services'
    description: ''
  -
    name: 'Customer Units'
    description: ''
  -
    name: Customers
    description: ''
  -
    name: 'Device Interfaces'
    description: ''
  -
    name: 'Device Param Definitions'
    description: ''
  -
    name: 'Device Service History'
    description: ''
  -
    name: Devices
    description: ''
  -
    name: 'Discount Definitions'
    description: ''
  -
    name: Esbe
    description: ''
  -
    name: 'Internal Tax Documents'
    description: ''
  -
    name: Invoices
    description: ''
  -
    name: Locations
    description: ''
  -
    name: 'Operator Roles'
    description: ''
  -
    name: Operators
    description: ''
  -
    name: 'Payment Accounts'
    description: ''
  -
    name: Payments
    description: ''
  -
    name: 'Process Jobs'
    description: ''
  -
    name: Processes
    description: ''
  -
    name: Reminders
    description: ''
  -
    name: 'Right Definitions'
    description: ''
  -
    name: SIPO
    description: ''
  -
    name: 'Service Definitions'
    description: ''
  -
    name: 'Service Groups'
    description: ''
  -
    name: 'Service Periods'
    description: ''
  -
    name: 'Service States'
    description: ''
  -
    name: 'Text Templates'
    description: ''
  -
    name: 'Time Tracking'
    description: ''
  -
    name: 'Token Management'
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.'
security:
  -
    default: []
paths:
  /api/v3/accounting-groups:
    get:
      summary: 'List Accounting Groups'
      operationId: listAccountingGroups
      description: "  Returns a paginated list of accounting groups.\n  By default only active groups are returned; use `active=false` for inactive.\n  Each group includes its account-number mappings (one per accounting type)."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page.'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated accounting group IDs.'
          example: '1,5,8'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated accounting group IDs.'
            example: '1,5,8'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '27,28'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '27,28'
        -
          in: query
          name: active
          description: 'Filter by active status. When omitted, only active groups are returned (default). Set to false for inactive only.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Filter by active status. When omitted, only active groups are returned (default). Set to false for inactive only.'
            example: true
        -
          in: query
          name: search
          description: 'Search in accounting group name (partial match).'
          example: Internet
          required: false
          schema:
            type: string
            description: 'Search in accounting group name (partial match).'
            example: Internet
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 2214
                      AG_NAME: 'aut adipisci'
                      AG_NOTE: 'Qui commodi incidunt iure odit.'
                      AG_VAS: 0
                      AG_CT: 35
                      AG_CREATED: null
                      AG_L_ID_CREATED: null
                      AG_CHANGED: null
                      AG_L_ID_CHANGED: null
                      AG_ACTIVE: 1
                      AG_ID_CT: null
                      account_mappings:
                        -
                          AGN_ID: 37161
                          AGN_AG_ID: 2214
                          AGN_TYPE: LIABILITIES_OTHERS
                          AGN_ACCOUNT: '326'
                          AGN_ACCOUNT_V: null
                          AGN_TITLE: ''
                          AGN_CREATED: null
                          AGN_L_ID_CREATED: null
                          AGN_CHANGED: null
                          AGN_L_ID_CHANGED: null
                    -
                      ID: 2215
                      AG_NAME: 'ipsum nostrum'
                      AG_NOTE: null
                      AG_VAS: 0
                      AG_CT: 7
                      AG_CREATED: null
                      AG_L_ID_CREATED: null
                      AG_CHANGED: null
                      AG_L_ID_CHANGED: null
                      AG_ACTIVE: 1
                      AG_ID_CT: null
                      account_mappings:
                        -
                          AGN_ID: 37162
                          AGN_AG_ID: 2215
                          AGN_TYPE: OTHER
                          AGN_ACCOUNT: '525'
                          AGN_ACCOUNT_V: null
                          AGN_TITLE: ''
                          AGN_CREATED: null
                          AGN_L_ID_CREATED: null
                          AGN_CHANGED: null
                          AGN_L_ID_CHANGED: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 2214
                        AG_NAME: 'aut adipisci'
                        AG_NOTE: 'Qui commodi incidunt iure odit.'
                        AG_VAS: 0
                        AG_CT: 35
                        AG_CREATED: null
                        AG_L_ID_CREATED: null
                        AG_CHANGED: null
                        AG_L_ID_CHANGED: null
                        AG_ACTIVE: 1
                        AG_ID_CT: null
                        account_mappings:
                          -
                            AGN_ID: 37161
                            AGN_AG_ID: 2214
                            AGN_TYPE: LIABILITIES_OTHERS
                            AGN_ACCOUNT: '326'
                            AGN_ACCOUNT_V: null
                            AGN_TITLE: ''
                            AGN_CREATED: null
                            AGN_L_ID_CREATED: null
                            AGN_CHANGED: null
                            AGN_L_ID_CHANGED: null
                      -
                        ID: 2215
                        AG_NAME: 'ipsum nostrum'
                        AG_NOTE: null
                        AG_VAS: 0
                        AG_CT: 7
                        AG_CREATED: null
                        AG_L_ID_CREATED: null
                        AG_CHANGED: null
                        AG_L_ID_CHANGED: null
                        AG_ACTIVE: 1
                        AG_ID_CT: null
                        account_mappings:
                          -
                            AGN_ID: 37162
                            AGN_AG_ID: 2215
                            AGN_TYPE: OTHER
                            AGN_ACCOUNT: '525'
                            AGN_ACCOUNT_V: null
                            AGN_TITLE: ''
                            AGN_CREATED: null
                            AGN_L_ID_CREATED: null
                            AGN_CHANGED: null
                            AGN_L_ID_CHANGED: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 2214
                          description: 'Unique accounting group identifier (primary key, zerofill int(4)).'
                        AG_NAME:
                          type: string
                          example: 'aut adipisci'
                          description: 'Accounting group name (max 40 chars).'
                        AG_NOTE:
                          type: string
                          example: 'Qui commodi incidunt iure odit.'
                          description: 'Optional description / note.'
                          nullable: true
                        AG_VAS:
                          type: integer
                          example: 0
                          description: 'VAS (value-added / resale services) flag. 1 = external resale services, 0 = standard.'
                        AG_CT:
                          type: integer
                          example: 35
                          description: 'Location (installation / CT) ID. 0 = global (visible to all locations).'
                        AG_CREATED:
                          type: string
                          example: null
                          description: 'Creation timestamp (datetime).'
                          nullable: true
                        AG_L_ID_CREATED:
                          type: string
                          example: null
                          description: 'Operator (login) ID who created this record.'
                          nullable: true
                        AG_CHANGED:
                          type: string
                          example: null
                          description: 'Last modification timestamp (datetime).'
                          nullable: true
                        AG_L_ID_CHANGED:
                          type: string
                          example: null
                          description: 'Operator (login) ID who last modified this record.'
                          nullable: true
                        AG_ACTIVE:
                          type: integer
                          example: 1
                          description: 'Active status. 1 = active, 0 = inactive (soft-deleted or deactivated).'
                        AG_ID_CT:
                          type: string
                          example: null
                          description: 'Reference to CT record (currently unused).'
                          nullable: true
                        account_mappings:
                          type: array
                          example:
                            -
                              AGN_ID: 37161
                              AGN_AG_ID: 2214
                              AGN_TYPE: LIABILITIES_OTHERS
                              AGN_ACCOUNT: '326'
                              AGN_ACCOUNT_V: null
                              AGN_TITLE: ''
                              AGN_CREATED: null
                              AGN_L_ID_CREATED: null
                              AGN_CHANGED: null
                              AGN_L_ID_CHANGED: null
                          description: 'Account-number mappings — one entry per accounting type (SERVICE, REVENUES, DPH, ADVANCE, etc.).'
                          items:
                            type: object
                            properties:
                              AGN_ID:
                                type: integer
                                example: 37161
                              AGN_AG_ID:
                                type: integer
                                example: 2214
                              AGN_TYPE:
                                type: string
                                example: LIABILITIES_OTHERS
                              AGN_ACCOUNT:
                                type: string
                                example: '326'
                              AGN_ACCOUNT_V:
                                type: string
                                example: null
                                nullable: true
                              AGN_TITLE:
                                type: string
                                example: ''
                              AGN_CREATED:
                                type: string
                                example: null
                                nullable: true
                              AGN_L_ID_CREATED:
                                type: string
                                example: null
                                nullable: true
                              AGN_CHANGED:
                                type: string
                                example: null
                                nullable: true
                              AGN_L_ID_CHANGED:
                                type: string
                                example: null
                                nullable: true
                    required:
                      - ID
                      - AG_NAME
                      - AG_NOTE
                      - AG_VAS
                      - AG_CT
                      - AG_CREATED
                      - AG_L_ID_CREATED
                      - AG_CHANGED
                      - AG_L_ID_CHANGED
                      - AG_ACTIVE
                      - AG_ID_CT
                      - account_mappings
      tags:
        - 'Accounting Groups'
  '/api/v3/accounting-groups/{id}':
    get:
      summary: 'Get Accounting Group'
      operationId: getAccountingGroup
      description: '  Returns a single accounting group by ID, including its account-number mappings.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 2216
                    AG_NAME: 'aut adipisci'
                    AG_NOTE: 'Qui commodi incidunt iure odit.'
                    AG_VAS: 0
                    AG_CT: 35
                    AG_CREATED: null
                    AG_L_ID_CREATED: null
                    AG_CHANGED: null
                    AG_L_ID_CHANGED: null
                    AG_ACTIVE: 1
                    AG_ID_CT: null
                    account_mappings:
                      -
                        AGN_ID: 37163
                        AGN_AG_ID: 2216
                        AGN_TYPE: LIABILITIES_OTHERS
                        AGN_ACCOUNT: '326'
                        AGN_ACCOUNT_V: null
                        AGN_TITLE: ''
                        AGN_CREATED: null
                        AGN_L_ID_CREATED: null
                        AGN_CHANGED: null
                        AGN_L_ID_CHANGED: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 2216
                        description: 'Unique accounting group identifier (primary key, zerofill int(4)).'
                      AG_NAME:
                        type: string
                        example: 'aut adipisci'
                        description: 'Accounting group name (max 40 chars).'
                      AG_NOTE:
                        type: string
                        example: 'Qui commodi incidunt iure odit.'
                        description: 'Optional description / note.'
                        nullable: true
                      AG_VAS:
                        type: integer
                        example: 0
                        description: 'VAS (value-added / resale services) flag. 1 = external resale services, 0 = standard.'
                      AG_CT:
                        type: integer
                        example: 35
                        description: 'Location (installation / CT) ID. 0 = global (visible to all locations).'
                      AG_CREATED:
                        type: string
                        example: null
                        description: 'Creation timestamp (datetime).'
                        nullable: true
                      AG_L_ID_CREATED:
                        type: string
                        example: null
                        description: 'Operator (login) ID who created this record.'
                        nullable: true
                      AG_CHANGED:
                        type: string
                        example: null
                        description: 'Last modification timestamp (datetime).'
                        nullable: true
                      AG_L_ID_CHANGED:
                        type: string
                        example: null
                        description: 'Operator (login) ID who last modified this record.'
                        nullable: true
                      AG_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Active status. 1 = active, 0 = inactive (soft-deleted or deactivated).'
                      AG_ID_CT:
                        type: string
                        example: null
                        description: 'Reference to CT record (currently unused).'
                        nullable: true
                      account_mappings:
                        type: array
                        example:
                          -
                            AGN_ID: 37163
                            AGN_AG_ID: 2216
                            AGN_TYPE: LIABILITIES_OTHERS
                            AGN_ACCOUNT: '326'
                            AGN_ACCOUNT_V: null
                            AGN_TITLE: ''
                            AGN_CREATED: null
                            AGN_L_ID_CREATED: null
                            AGN_CHANGED: null
                            AGN_L_ID_CHANGED: null
                        description: 'Account-number mappings — one entry per accounting type (SERVICE, REVENUES, DPH, ADVANCE, etc.).'
                        items:
                          type: object
                          properties:
                            AGN_ID:
                              type: integer
                              example: 37163
                            AGN_AG_ID:
                              type: integer
                              example: 2216
                            AGN_TYPE:
                              type: string
                              example: LIABILITIES_OTHERS
                            AGN_ACCOUNT:
                              type: string
                              example: '326'
                            AGN_ACCOUNT_V:
                              type: string
                              example: null
                              nullable: true
                            AGN_TITLE:
                              type: string
                              example: ''
                            AGN_CREATED:
                              type: string
                              example: null
                              nullable: true
                            AGN_L_ID_CREATED:
                              type: string
                              example: null
                              nullable: true
                            AGN_CHANGED:
                              type: string
                              example: null
                              nullable: true
                            AGN_L_ID_CHANGED:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - AG_NAME
                      - AG_NOTE
                      - AG_VAS
                      - AG_CT
                      - AG_CREATED
                      - AG_L_ID_CREATED
                      - AG_CHANGED
                      - AG_L_ID_CHANGED
                      - AG_ACTIVE
                      - AG_ID_CT
                      - account_mappings
      tags:
        - 'Accounting Groups'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the accounting group.'
        example: 0
        required: true
        schema:
          type: integer
  /api/v3/agreement-types:
    get:
      summary: 'List Agreement Types'
      operationId: listAgreementTypes
      description: "Returns a paginated list of agreement type definitions.\nIncludes global types (AT_CT = NULL) available to all locations."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of agreement types to return per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of agreement types to return per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated agreement type IDs.'
          example: '50,51'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated agreement type IDs.'
            example: '50,51'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      AT_ID: 455
                      AT_CP: null
                      AT_CT: 239
                      AT_TYPE: aut_2839
                      AT_NUMBERING: auto
                      AT_NUMBER_FORMAT: '{A_NUMBER}'
                      AT_TEMPLATE: quidem
                      AT_NOTE: 'Qui commodi incidunt iure odit.'
                      AT_FLAGS: ''
                      AT_PRINT: ALL
                      AT_VALID_FROM: null
                      AT_VALID_TO: null
                      AT_CONFIRM: null
                      AT_REMIND_DAYS: null
                      AT_BLOCK_DAYS: null
                    -
                      AT_ID: 456
                      AT_CP: null
                      AT_CT: 137
                      AT_TYPE: et_1839
                      AT_NUMBERING: auto
                      AT_NUMBER_FORMAT: '{A_NUMBER}'
                      AT_TEMPLATE: modi
                      AT_NOTE: 'Nostrum omnis autem et consequatur aut.'
                      AT_FLAGS: ''
                      AT_PRINT: ALL
                      AT_VALID_FROM: null
                      AT_VALID_TO: null
                      AT_CONFIRM: null
                      AT_REMIND_DAYS: null
                      AT_BLOCK_DAYS: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        AT_ID: 455
                        AT_CP: null
                        AT_CT: 239
                        AT_TYPE: aut_2839
                        AT_NUMBERING: auto
                        AT_NUMBER_FORMAT: '{A_NUMBER}'
                        AT_TEMPLATE: quidem
                        AT_NOTE: 'Qui commodi incidunt iure odit.'
                        AT_FLAGS: ''
                        AT_PRINT: ALL
                        AT_VALID_FROM: null
                        AT_VALID_TO: null
                        AT_CONFIRM: null
                        AT_REMIND_DAYS: null
                        AT_BLOCK_DAYS: null
                      -
                        AT_ID: 456
                        AT_CP: null
                        AT_CT: 137
                        AT_TYPE: et_1839
                        AT_NUMBERING: auto
                        AT_NUMBER_FORMAT: '{A_NUMBER}'
                        AT_TEMPLATE: modi
                        AT_NOTE: 'Nostrum omnis autem et consequatur aut.'
                        AT_FLAGS: ''
                        AT_PRINT: ALL
                        AT_VALID_FROM: null
                        AT_VALID_TO: null
                        AT_CONFIRM: null
                        AT_REMIND_DAYS: null
                        AT_BLOCK_DAYS: null
                    items:
                      type: object
                      properties:
                        AT_ID:
                          type: integer
                          example: 455
                          description: 'Unique agreement type ID (primary key).'
                        AT_CP:
                          type: string
                          example: null
                          description: 'Company/partner ID (cibs_partners).'
                          nullable: true
                        AT_CT:
                          type: integer
                          example: 239
                          description: 'Location (installation) ID. NULL = global type available to all locations.'
                          nullable: true
                        AT_TYPE:
                          type: string
                          example: aut_2839
                          description: 'Agreement type name / identifier.'
                        AT_NUMBERING:
                          type: string
                          example: auto
                          description: 'Agreement number generation strategy.'
                          enum:
                            - auto
                            - auto.type
                            - auto.user
                            - auto.type=user
                            - none
                        AT_NUMBER_FORMAT:
                          type: string
                          example: '{A_NUMBER}'
                          description: 'Format template for agreement numbers (e.g. {A_NUMBER}).'
                          nullable: true
                        AT_TEMPLATE:
                          type: string
                          example: quidem
                          description: 'Document template name used for PDF generation.'
                        AT_NOTE:
                          type: string
                          example: 'Qui commodi incidunt iure odit.'
                          description: 'Description / note for this agreement type.'
                        AT_FLAGS:
                          type: string
                          example: ''
                          description: 'Comma-separated behavior flags.'
                          enum:
                            - AUTO_ON_ACTIVATE
                            - USER_DISTINCT
                            - SERVICE_DISTINCT
                            - AUTO_ON_CONNECT
                            - AUTO_ON_CONNECT_SET
                        AT_PRINT:
                          type: string
                          example: ALL
                          description: 'Print mode for document expedition.'
                          enum:
                            - SCAN
                            - ALL
                        AT_VALID_FROM:
                          type: string
                          example: null
                          description: 'Date from which this agreement type is available (YYYY-MM-DD).'
                          nullable: true
                        AT_VALID_TO:
                          type: string
                          example: null
                          description: 'Date until which this agreement type is available (YYYY-MM-DD).'
                          nullable: true
                        AT_CONFIRM:
                          type: string
                          example: null
                          description: 'Whether agreements of this type require customer confirmation. 1 = yes.'
                          nullable: true
                        AT_REMIND_DAYS:
                          type: string
                          example: null
                          description: 'Days after conclusion to send a confirmation reminder.'
                          nullable: true
                        AT_BLOCK_DAYS:
                          type: string
                          example: null
                          description: 'Days after conclusion to block services if not confirmed.'
                          nullable: true
                    required:
                      - AT_ID
                      - AT_CP
                      - AT_CT
                      - AT_TYPE
                      - AT_NUMBERING
                      - AT_NUMBER_FORMAT
                      - AT_TEMPLATE
                      - AT_NOTE
                      - AT_FLAGS
                      - AT_PRINT
                      - AT_VALID_FROM
                      - AT_VALID_TO
                      - AT_CONFIRM
                      - AT_REMIND_DAYS
                      - AT_BLOCK_DAYS
      tags:
        - 'Agreement Types'
  /api/v3/agreements:
    get:
      summary: 'List Agreements'
      operationId: listAgreements
      description: "Returns a paginated list of agreements.\nBy default, only valid agreements (A_VALID = 1) are returned.\nUse `valid=0` to see only invalid, or `valid=all` to see both."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of agreements to return per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of agreements to return per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated agreement IDs.'
          example: '41,42,45'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated agreement IDs.'
            example: '41,42,45'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by comma-separated customer (user) IDs.'
          example: '30367,28934'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated customer (user) IDs.'
            example: '30367,28934'
        -
          in: query
          name: type
          description: 'Filter by comma-separated agreement type IDs.'
          example: '50,51'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated agreement type IDs.'
            example: '50,51'
        -
          in: query
          name: valid
          description: 'Filter by validity. true = valid only (default), false = invalid only, all = both.'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by validity. true = valid only (default), false = invalid only, all = both.'
            example: 'true'
        -
          in: query
          name: customer_service
          description: 'Filter agreements linked to a specific customer service (services_active) ID.'
          example: 266773
          required: false
          schema:
            type: integer
            description: 'Filter agreements linked to a specific customer service (services_active) ID.'
            example: 266773
        -
          in: query
          name: date_from
          description: 'Filter agreements with conclusion date on or after this date (YYYY-MM-DD).'
          example: '2020-01-01'
          required: false
          schema:
            type: string
            description: 'Filter agreements with conclusion date on or after this date (YYYY-MM-DD).'
            example: '2020-01-01'
        -
          in: query
          name: date_to
          description: 'Filter agreements with conclusion date on or before this date (YYYY-MM-DD).'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter agreements with conclusion date on or before this date (YYYY-MM-DD).'
            example: '2024-12-31'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      A_ID: 349467
                      A_AT_ID: 452
                      A_USER_ID: 346556
                      A_CT: 14
                      A_NUMBER: '857680'
                      A_NOTE: 'Quidem nostrum qui commodi incidunt iure odit.'
                      A_CONCLUSION_DATE: '1977-08-15'
                      A_CREATED: '2026-03-08 18:21:08'
                      A_L_ID: 2019
                      A_ML_ID: null
                      A_NUM: null
                      A_VALID: 1
                      A_INVALID_NOTE: null
                      A_CONFIRMED: null
                      A_CONFIRM_L_ID: null
                      A_REMINDER_DATE: null
                      A_REMEMBER_L_ID: null
                      A_BLOCK_DATE: null
                      A_BLOCKED_L_ID: null
                      A_UNBLOCK_DATE: null
                      A_UNBLOCKED_L_ID: null
                      customer_service_links:
                        -
                          AS_ID: 578232
                          AS_A_ID: 349467
                          AS_SA_ID: 2388437
                      type:
                        AT_ID: 452
                        AT_CP: null
                        AT_CT: 63
                        AT_TYPE: modi_967
                        AT_NUMBERING: auto
                        AT_NUMBER_FORMAT: '{A_NUMBER}'
                        AT_TEMPLATE: nostrum
                        AT_NOTE: 'Autem et consequatur aut dolores enim non facere tempora.'
                        AT_FLAGS: ''
                        AT_PRINT: ALL
                        AT_VALID_FROM: null
                        AT_VALID_TO: null
                        AT_CONFIRM: null
                        AT_REMIND_DAYS: null
                        AT_BLOCK_DAYS: null
                    -
                      A_ID: 349468
                      A_AT_ID: 453
                      A_USER_ID: 473088
                      A_CT: 52
                      A_NUMBER: '187043'
                      A_NOTE: 'Laboriosam praesentium quis adipisci molestias fugit deleniti distinctio.'
                      A_CONCLUSION_DATE: '2013-02-14'
                      A_CREATED: '2026-03-16 21:09:05'
                      A_L_ID: 1019
                      A_ML_ID: null
                      A_NUM: null
                      A_VALID: 1
                      A_INVALID_NOTE: null
                      A_CONFIRMED: null
                      A_CONFIRM_L_ID: null
                      A_REMINDER_DATE: null
                      A_REMEMBER_L_ID: null
                      A_BLOCK_DATE: null
                      A_BLOCKED_L_ID: null
                      A_UNBLOCK_DATE: null
                      A_UNBLOCKED_L_ID: null
                      customer_service_links:
                        -
                          AS_ID: 578233
                          AS_A_ID: 349468
                          AS_SA_ID: 3304408
                      type:
                        AT_ID: 453
                        AT_CP: null
                        AT_CT: 43
                        AT_TYPE: id_4781
                        AT_NUMBERING: auto
                        AT_NUMBER_FORMAT: '{A_NUMBER}'
                        AT_TEMPLATE: libero
                        AT_NOTE: 'Veniam corporis dolorem mollitia.'
                        AT_FLAGS: ''
                        AT_PRINT: ALL
                        AT_VALID_FROM: null
                        AT_VALID_TO: null
                        AT_CONFIRM: null
                        AT_REMIND_DAYS: null
                        AT_BLOCK_DAYS: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        A_ID: 349467
                        A_AT_ID: 452
                        A_USER_ID: 346556
                        A_CT: 14
                        A_NUMBER: '857680'
                        A_NOTE: 'Quidem nostrum qui commodi incidunt iure odit.'
                        A_CONCLUSION_DATE: '1977-08-15'
                        A_CREATED: '2026-03-08 18:21:08'
                        A_L_ID: 2019
                        A_ML_ID: null
                        A_NUM: null
                        A_VALID: 1
                        A_INVALID_NOTE: null
                        A_CONFIRMED: null
                        A_CONFIRM_L_ID: null
                        A_REMINDER_DATE: null
                        A_REMEMBER_L_ID: null
                        A_BLOCK_DATE: null
                        A_BLOCKED_L_ID: null
                        A_UNBLOCK_DATE: null
                        A_UNBLOCKED_L_ID: null
                        customer_service_links:
                          -
                            AS_ID: 578232
                            AS_A_ID: 349467
                            AS_SA_ID: 2388437
                        type:
                          AT_ID: 452
                          AT_CP: null
                          AT_CT: 63
                          AT_TYPE: modi_967
                          AT_NUMBERING: auto
                          AT_NUMBER_FORMAT: '{A_NUMBER}'
                          AT_TEMPLATE: nostrum
                          AT_NOTE: 'Autem et consequatur aut dolores enim non facere tempora.'
                          AT_FLAGS: ''
                          AT_PRINT: ALL
                          AT_VALID_FROM: null
                          AT_VALID_TO: null
                          AT_CONFIRM: null
                          AT_REMIND_DAYS: null
                          AT_BLOCK_DAYS: null
                      -
                        A_ID: 349468
                        A_AT_ID: 453
                        A_USER_ID: 473088
                        A_CT: 52
                        A_NUMBER: '187043'
                        A_NOTE: 'Laboriosam praesentium quis adipisci molestias fugit deleniti distinctio.'
                        A_CONCLUSION_DATE: '2013-02-14'
                        A_CREATED: '2026-03-16 21:09:05'
                        A_L_ID: 1019
                        A_ML_ID: null
                        A_NUM: null
                        A_VALID: 1
                        A_INVALID_NOTE: null
                        A_CONFIRMED: null
                        A_CONFIRM_L_ID: null
                        A_REMINDER_DATE: null
                        A_REMEMBER_L_ID: null
                        A_BLOCK_DATE: null
                        A_BLOCKED_L_ID: null
                        A_UNBLOCK_DATE: null
                        A_UNBLOCKED_L_ID: null
                        customer_service_links:
                          -
                            AS_ID: 578233
                            AS_A_ID: 349468
                            AS_SA_ID: 3304408
                        type:
                          AT_ID: 453
                          AT_CP: null
                          AT_CT: 43
                          AT_TYPE: id_4781
                          AT_NUMBERING: auto
                          AT_NUMBER_FORMAT: '{A_NUMBER}'
                          AT_TEMPLATE: libero
                          AT_NOTE: 'Veniam corporis dolorem mollitia.'
                          AT_FLAGS: ''
                          AT_PRINT: ALL
                          AT_VALID_FROM: null
                          AT_VALID_TO: null
                          AT_CONFIRM: null
                          AT_REMIND_DAYS: null
                          AT_BLOCK_DAYS: null
                    items:
                      type: object
                      properties:
                        A_ID:
                          type: integer
                          example: 349467
                          description: 'Unique agreement identifier (primary key).'
                        A_AT_ID:
                          type: integer
                          example: 452
                          description: 'Agreement type ID. See GET /v3/agreement-types.'
                        A_USER_ID:
                          type: integer
                          example: 346556
                          description: 'Customer (user) ID. See GET /v3/customers.'
                        A_CT:
                          type: integer
                          example: 14
                          description: 'Location (installation) ID — multi-tenant discriminator.'
                        A_NUMBER:
                          type: string
                          example: '857680'
                          description: 'Agreement number (may be auto-generated based on agreement type numbering rules).'
                        A_NOTE:
                          type: string
                          example: 'Quidem nostrum qui commodi incidunt iure odit.'
                          description: 'Agreement note / description.'
                        A_CONCLUSION_DATE:
                          type: string
                          example: '1977-08-15'
                          description: 'Date the agreement was concluded (YYYY-MM-DD).'
                        A_CREATED:
                          type: string
                          example: '2026-03-08 18:21:08'
                          description: 'Datetime when the agreement was created (YYYY-MM-DD HH:MM:SS).'
                        A_L_ID:
                          type: integer
                          example: 2019
                          description: 'Operator login ID who created the agreement.'
                        A_ML_ID:
                          type: string
                          example: null
                          description: 'Related process (maintenance_list) ID, if the agreement was created from a process.'
                          nullable: true
                        A_NUM:
                          type: string
                          example: null
                          description: 'Internal numbering counter (used by auto-numbering).'
                          nullable: true
                        A_VALID:
                          type: integer
                          example: 1
                          description: 'Validity flag. 1 = valid, 0 = invalidated.'
                        A_INVALID_NOTE:
                          type: string
                          example: null
                          description: 'Reason for invalidation (set when A_VALID = 0).'
                          nullable: true
                        A_CONFIRMED:
                          type: string
                          example: null
                          description: 'Datetime when the agreement was confirmed by the customer.'
                          nullable: true
                        A_CONFIRM_L_ID:
                          type: string
                          example: null
                          description: 'Operator login ID who recorded the confirmation.'
                          nullable: true
                        A_REMINDER_DATE:
                          type: string
                          example: null
                          description: 'Datetime when a confirmation reminder was sent.'
                          nullable: true
                        A_REMEMBER_L_ID:
                          type: string
                          example: null
                          description: 'Operator login ID who triggered the reminder (or system if automatic).'
                          nullable: true
                        A_BLOCK_DATE:
                          type: string
                          example: null
                          description: 'Datetime when services were blocked due to missing confirmation.'
                          nullable: true
                        A_BLOCKED_L_ID:
                          type: string
                          example: null
                          description: 'Operator login ID who triggered the blocking (or system if automatic).'
                          nullable: true
                        A_UNBLOCK_DATE:
                          type: string
                          example: null
                          description: 'Datetime when services were unblocked after confirmation.'
                          nullable: true
                        A_UNBLOCKED_L_ID:
                          type: string
                          example: null
                          description: 'Operator login ID who triggered the unblocking.'
                          nullable: true
                        customer_service_links:
                          type: array
                          example:
                            -
                              AS_ID: 578232
                              AS_A_ID: 349467
                              AS_SA_ID: 2388437
                          description: 'Customer services covered by this agreement (junction records).'
                          items:
                            type: object
                            properties:
                              AS_ID:
                                type: integer
                                example: 578232
                              AS_A_ID:
                                type: integer
                                example: 349467
                              AS_SA_ID:
                                type: integer
                                example: 2388437
                        type:
                          type: object
                          properties:
                            AT_ID:
                              type: integer
                              example: 452
                              description: 'Unique agreement type ID.'
                            AT_CP:
                              type: string
                              example: null
                              nullable: true
                            AT_CT:
                              type: integer
                              example: 63
                            AT_TYPE:
                              type: string
                              example: modi_967
                              description: 'Agreement type name / identifier.'
                            AT_NUMBERING:
                              type: string
                              example: auto
                            AT_NUMBER_FORMAT:
                              type: string
                              example: '{A_NUMBER}'
                            AT_TEMPLATE:
                              type: string
                              example: nostrum
                              description: 'Document template name used for PDF generation.'
                            AT_NOTE:
                              type: string
                              example: 'Autem et consequatur aut dolores enim non facere tempora.'
                            AT_FLAGS:
                              type: string
                              example: ''
                            AT_PRINT:
                              type: string
                              example: ALL
                            AT_VALID_FROM:
                              type: string
                              example: null
                              nullable: true
                            AT_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            AT_CONFIRM:
                              type: string
                              example: null
                              nullable: true
                            AT_REMIND_DAYS:
                              type: string
                              example: null
                              nullable: true
                            AT_BLOCK_DAYS:
                              type: string
                              example: null
                              nullable: true
                          required:
                            - AT_ID
                            - AT_TYPE
                            - AT_TEMPLATE
                          description: 'Agreement type definition.'
                          nullable: true
                    required:
                      - A_ID
                      - A_AT_ID
                      - A_USER_ID
                      - A_CT
                      - A_NUMBER
                      - A_NOTE
                      - A_CONCLUSION_DATE
                      - A_CREATED
                      - A_L_ID
                      - A_ML_ID
                      - A_NUM
                      - A_VALID
                      - A_INVALID_NOTE
                      - A_CONFIRMED
                      - A_CONFIRM_L_ID
                      - A_REMINDER_DATE
                      - A_REMEMBER_L_ID
                      - A_BLOCK_DATE
                      - A_BLOCKED_L_ID
                      - A_UNBLOCK_DATE
                      - A_UNBLOCKED_L_ID
                      - customer_service_links
                      - type
      tags:
        - Agreements
  '/api/v3/agreements/{id}':
    get:
      summary: 'Get Agreement'
      operationId: getAgreement
      description: 'Returns a single agreement by ID, including its customer service links and type.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    A_ID: 349469
                    A_AT_ID: 454
                    A_USER_ID: 343329
                    A_CT: 59
                    A_NUMBER: '333724'
                    A_NOTE: 'Nostrum qui commodi incidunt iure.'
                    A_CONCLUSION_DATE: '1990-01-29'
                    A_CREATED: '2026-02-18 14:50:09'
                    A_L_ID: 2546
                    A_ML_ID: null
                    A_NUM: null
                    A_VALID: 1
                    A_INVALID_NOTE: null
                    A_CONFIRMED: null
                    A_CONFIRM_L_ID: null
                    A_REMINDER_DATE: null
                    A_REMEMBER_L_ID: null
                    A_BLOCK_DATE: null
                    A_BLOCKED_L_ID: null
                    A_UNBLOCK_DATE: null
                    A_UNBLOCKED_L_ID: null
                    customer_service_links:
                      -
                        AS_ID: 578234
                        AS_A_ID: 349469
                        AS_SA_ID: 1635533
                    type:
                      AT_ID: 454
                      AT_CP: null
                      AT_CT: 70
                      AT_TYPE: et_1769
                      AT_NUMBERING: auto
                      AT_NUMBER_FORMAT: '{A_NUMBER}'
                      AT_TEMPLATE: ipsum
                      AT_NOTE: 'Omnis autem et consequatur.'
                      AT_FLAGS: ''
                      AT_PRINT: ALL
                      AT_VALID_FROM: null
                      AT_VALID_TO: null
                      AT_CONFIRM: null
                      AT_REMIND_DAYS: null
                      AT_BLOCK_DAYS: null
                properties:
                  data:
                    type: object
                    properties:
                      A_ID:
                        type: integer
                        example: 349469
                        description: 'Unique agreement identifier (primary key).'
                      A_AT_ID:
                        type: integer
                        example: 454
                        description: 'Agreement type ID. See GET /v3/agreement-types.'
                      A_USER_ID:
                        type: integer
                        example: 343329
                        description: 'Customer (user) ID. See GET /v3/customers.'
                      A_CT:
                        type: integer
                        example: 59
                        description: 'Location (installation) ID — multi-tenant discriminator.'
                      A_NUMBER:
                        type: string
                        example: '333724'
                        description: 'Agreement number (may be auto-generated based on agreement type numbering rules).'
                      A_NOTE:
                        type: string
                        example: 'Nostrum qui commodi incidunt iure.'
                        description: 'Agreement note / description.'
                      A_CONCLUSION_DATE:
                        type: string
                        example: '1990-01-29'
                        description: 'Date the agreement was concluded (YYYY-MM-DD).'
                      A_CREATED:
                        type: string
                        example: '2026-02-18 14:50:09'
                        description: 'Datetime when the agreement was created (YYYY-MM-DD HH:MM:SS).'
                      A_L_ID:
                        type: integer
                        example: 2546
                        description: 'Operator login ID who created the agreement.'
                      A_ML_ID:
                        type: string
                        example: null
                        description: 'Related process (maintenance_list) ID, if the agreement was created from a process.'
                        nullable: true
                      A_NUM:
                        type: string
                        example: null
                        description: 'Internal numbering counter (used by auto-numbering).'
                        nullable: true
                      A_VALID:
                        type: integer
                        example: 1
                        description: 'Validity flag. 1 = valid, 0 = invalidated.'
                      A_INVALID_NOTE:
                        type: string
                        example: null
                        description: 'Reason for invalidation (set when A_VALID = 0).'
                        nullable: true
                      A_CONFIRMED:
                        type: string
                        example: null
                        description: 'Datetime when the agreement was confirmed by the customer.'
                        nullable: true
                      A_CONFIRM_L_ID:
                        type: string
                        example: null
                        description: 'Operator login ID who recorded the confirmation.'
                        nullable: true
                      A_REMINDER_DATE:
                        type: string
                        example: null
                        description: 'Datetime when a confirmation reminder was sent.'
                        nullable: true
                      A_REMEMBER_L_ID:
                        type: string
                        example: null
                        description: 'Operator login ID who triggered the reminder (or system if automatic).'
                        nullable: true
                      A_BLOCK_DATE:
                        type: string
                        example: null
                        description: 'Datetime when services were blocked due to missing confirmation.'
                        nullable: true
                      A_BLOCKED_L_ID:
                        type: string
                        example: null
                        description: 'Operator login ID who triggered the blocking (or system if automatic).'
                        nullable: true
                      A_UNBLOCK_DATE:
                        type: string
                        example: null
                        description: 'Datetime when services were unblocked after confirmation.'
                        nullable: true
                      A_UNBLOCKED_L_ID:
                        type: string
                        example: null
                        description: 'Operator login ID who triggered the unblocking.'
                        nullable: true
                      customer_service_links:
                        type: array
                        example:
                          -
                            AS_ID: 578234
                            AS_A_ID: 349469
                            AS_SA_ID: 1635533
                        description: 'Customer services covered by this agreement (junction records).'
                        items:
                          type: object
                          properties:
                            AS_ID:
                              type: integer
                              example: 578234
                            AS_A_ID:
                              type: integer
                              example: 349469
                            AS_SA_ID:
                              type: integer
                              example: 1635533
                      type:
                        type: object
                        properties:
                          AT_ID:
                            type: integer
                            example: 454
                            description: 'Unique agreement type ID.'
                          AT_CP:
                            type: string
                            example: null
                            nullable: true
                          AT_CT:
                            type: integer
                            example: 70
                          AT_TYPE:
                            type: string
                            example: et_1769
                            description: 'Agreement type name / identifier.'
                          AT_NUMBERING:
                            type: string
                            example: auto
                          AT_NUMBER_FORMAT:
                            type: string
                            example: '{A_NUMBER}'
                          AT_TEMPLATE:
                            type: string
                            example: ipsum
                            description: 'Document template name used for PDF generation.'
                          AT_NOTE:
                            type: string
                            example: 'Omnis autem et consequatur.'
                          AT_FLAGS:
                            type: string
                            example: ''
                          AT_PRINT:
                            type: string
                            example: ALL
                          AT_VALID_FROM:
                            type: string
                            example: null
                            nullable: true
                          AT_VALID_TO:
                            type: string
                            example: null
                            nullable: true
                          AT_CONFIRM:
                            type: string
                            example: null
                            nullable: true
                          AT_REMIND_DAYS:
                            type: string
                            example: null
                            nullable: true
                          AT_BLOCK_DAYS:
                            type: string
                            example: null
                            nullable: true
                        required:
                          - AT_ID
                          - AT_TYPE
                          - AT_TEMPLATE
                        description: 'Agreement type definition.'
                        nullable: true
                    required:
                      - A_ID
                      - A_AT_ID
                      - A_USER_ID
                      - A_CT
                      - A_NUMBER
                      - A_NOTE
                      - A_CONCLUSION_DATE
                      - A_CREATED
                      - A_L_ID
                      - A_ML_ID
                      - A_NUM
                      - A_VALID
                      - A_INVALID_NOTE
                      - A_CONFIRMED
                      - A_CONFIRM_L_ID
                      - A_REMINDER_DATE
                      - A_REMEMBER_L_ID
                      - A_BLOCK_DATE
                      - A_BLOCKED_L_ID
                      - A_UNBLOCK_DATE
                      - A_UNBLOCKED_L_ID
                      - customer_service_links
                      - type
      tags:
        - Agreements
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the agreement.'
        example: 41
        required: true
        schema:
          type: integer
  '/api/v3/agreements/{agreement}/download':
    get:
      summary: 'Download Agreement PDF'
      operationId: downloadAgreementPDF
      description: 'Downloads the agreement document as a PDF file.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Agreements
    parameters:
      -
        in: path
        name: agreement
        description: 'The agreement.'
        example: 41
        required: true
        schema:
          type: integer
  /api/v3/login:
    post:
      summary: 'User Login'
      operationId: userLogin
      description: "   Authenticates a user with login credentials and returns a bearer token.\n   The token should be included in the Authorization header for subsequent API requests."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: 'Successful authentication'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 5534
                    LOGIN: idickens
                    IS_SUPER_ADMIN: true
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 5534
                      LOGIN:
                        type: string
                        example: idickens
                      IS_SUPER_ADMIN:
                        type: boolean
                        example: true
      tags:
        - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                login:
                  type: 'The login name'
                  description: string
                  example: architecto
                password:
                  type: 'The password'
                  description: string
                  example: '|]|{+-'
              required:
                - login
                - password
      security: []
  /api/v3/sso/login:
    get:
      summary: 'SSO Login'
      operationId: sSOLogin
      description: "   Authenticates a user from Mango session passed in MANGO_SESSION header.\n   On success issues Sanctum token cookie and redirects to configured frontend URL."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: ''
                properties:
                  message:
                    type: string
                    example: ''
      tags:
        - Authentication
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                mango_session:
                  type: 'The Mango session'
                  description: string
                  example: architecto
                return_url:
                  type: 'The return URL'
                  description: url
                  example: 'http://www.bailey.biz/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html'
              required:
                - mango_session
      security: []
  /api/v3/logout:
    post:
      summary: 'User Logout'
      operationId: userLogout
      description: '   Logs out the current user and clears the authentication cookie.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses: {  }
      tags:
        - Authentication
  /api/v3/me:
    get:
      summary: 'Current User'
      operationId: currentUser
      description: '   Returns the currently authenticated user.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: 'Current authenticated user'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 5535
                    LOGIN: dare.emelie
                    IS_SUPER_ADMIN: true
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 5535
                      LOGIN:
                        type: string
                        example: dare.emelie
                      IS_SUPER_ADMIN:
                        type: boolean
                        example: true
      tags:
        - Authentication
  /api/v3/billing-plans:
    get:
      summary: 'List Billing Plans'
      operationId: listBillingPlans
      description: "Returns a paginated list of billing plans (billing and payment configuration templates).\nBy default, disabled plans are excluded. Use `disabled=all` to include them.\nCT scoping returns global plans (BP_CT IS NULL) plus plans specific to the user's locations."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated billing plan IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated billing plan IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated CT (installation) IDs. Returns global (BP_CT IS NULL) plans plus plans matching the specified CTs.'
          example: '5,27'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated CT (installation) IDs. Returns global (BP_CT IS NULL) plans plus plans matching the specified CTs.'
            example: '5,27'
        -
          in: query
          name: disabled
          description: 'Filter by disabled status. Default (omitted): exclude disabled plans. Pass "true" for disabled only, "all" to include both.'
          example: all
          required: false
          schema:
            type: string
            description: 'Filter by disabled status. Default (omitted): exclude disabled plans. Pass "true" for disabled only, "all" to include both.'
            example: all
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      BP_ID: 1073
                      BP_NAME: 'autem et consequatur'
                      BP_EU_NAME: null
                      BP_NOTE: null
                      BP_SC_ID: null
                      BP_CT: null
                      BP_CP_ID: null
                      BP_DISABLED: 0
                      BP_PAID: NONE
                      BP_PAID_SN_ID: null
                      BP_PAID_TIME: NONE
                      BP_PAID_LEGEND: null
                      BP_BLOCK: NONE
                      BP_DEFAULT: 1
                      BP_TAXDOC_ROUNDING: DEFAULT
                      BP_SEPARATE: 0
                      BP_VAR_PRICE_ACCORD: null
                      BP_VAR_PRICE_SEPARATE: 0
                      BP_TAX_DAY: 0
                      BP_TAX_DATE_SHIFT: 0
                      BP_TAXDOC_DELIVERY_TYPE: NONE
                      BP_COLLECTION_TYPE: NONE
                      BP_COLLECTION_DATE: null
                      BP_COLLECTION_DAY: null
                      BP_COLLECTION_DEBTS: NONE
                      BP_COLLECTION_DEBTS_AGE: 0
                      BP_APPLICATION_TYPE: NONE
                      BP_APPLICATION_DELIVERY_TYPE: null
                      BP_APPLICATION_DAY: null
                      BP_PROFORMA_TYPE: NONE
                      BP_PROFORMA_DELIVERY_TYPE: null
                      BP_PROFORMA_DATE: null
                      BP_PROFORMA_DAY: null
                      BP_ADVANCE: 0
                      BP_ADVANCE_DELIVERY_TYPE: NONE
                      BP_CREDIT_NOTE_TYPE: NONE
                      BP_CREDIT_NOTE_DELIVERY_TYPE: null
                      BP_CREDIT_NOTE_DAY: null
                      BP_PAYMENT_TYPE: ACCOUNT
                      BP_PA_ID: null
                      BP_PA_AUTO: null
                      BP_MATURITY_TYPE: ACTUAL
                      BP_MATURITY_DAY: 0
                      BP_RETURN_TYPE: NONE
                      BP_RETURN_PA_ID: null
                      BP_VAR_TAX_DAY: 0
                      BP_VAR_TAX_DATE_SHIFT: 0
                      BP_VAR_TAXDOC_DELIVERY_TYPE: NONE
                      BP_VAR_COLLECTION_TYPE: NONE
                      BP_VAR_COLLECTION_DATE: null
                      BP_VAR_COLLECTION_DAY: null
                      BP_VAR_COLLECTION_DEBTS: NONE
                      BP_VAR_COLLECTION_DEBTS_AGE: 0
                      BP_VAR_APPLICATION_TYPE: NONE
                      BP_VAR_APPLICATION_DELIVERY_TYPE: NONE
                      BP_VAR_APPLICATION_DAY: null
                      BP_VAR_PROFORMA_TYPE: NONE
                      BP_VAR_PROFORMA_DELIVERY_TYPE: null
                      BP_VAR_PROFORMA_DATE: null
                      BP_VAR_PROFORMA_DAY: null
                      BP_VAR_PAYMENT_TYPE: ACCOUNT
                      BP_VAR_PA_ID: null
                      BP_VAR_MATURITY_TYPE: ACTUAL
                      BP_VAR_MATURITY_DAY: 0
                      BP_VAR_RETURN_TYPE: NONE
                      BP_VAR_RETURN_PA_ID: null
                      BP_VARIABILITY: ''
                      BP_AGR_NAME: null
                    -
                      BP_ID: 1074
                      BP_NAME: 'enim non facere'
                      BP_EU_NAME: 'Voluptatem laboriosam praesentium.'
                      BP_NOTE: null
                      BP_SC_ID: null
                      BP_CT: null
                      BP_CP_ID: null
                      BP_DISABLED: 0
                      BP_PAID: POSTPAID
                      BP_PAID_SN_ID: null
                      BP_PAID_TIME: NONE
                      BP_PAID_LEGEND: null
                      BP_BLOCK: NONE
                      BP_DEFAULT: 1
                      BP_TAXDOC_ROUNDING: DEFAULT
                      BP_SEPARATE: 0
                      BP_VAR_PRICE_ACCORD: null
                      BP_VAR_PRICE_SEPARATE: 0
                      BP_TAX_DAY: 0
                      BP_TAX_DATE_SHIFT: 0
                      BP_TAXDOC_DELIVERY_TYPE: NONE
                      BP_COLLECTION_TYPE: NONE
                      BP_COLLECTION_DATE: null
                      BP_COLLECTION_DAY: null
                      BP_COLLECTION_DEBTS: NONE
                      BP_COLLECTION_DEBTS_AGE: 0
                      BP_APPLICATION_TYPE: NONE
                      BP_APPLICATION_DELIVERY_TYPE: null
                      BP_APPLICATION_DAY: null
                      BP_PROFORMA_TYPE: NONE
                      BP_PROFORMA_DELIVERY_TYPE: null
                      BP_PROFORMA_DATE: null
                      BP_PROFORMA_DAY: null
                      BP_ADVANCE: 0
                      BP_ADVANCE_DELIVERY_TYPE: NONE
                      BP_CREDIT_NOTE_TYPE: NONE
                      BP_CREDIT_NOTE_DELIVERY_TYPE: null
                      BP_CREDIT_NOTE_DAY: null
                      BP_PAYMENT_TYPE: ACCOUNT
                      BP_PA_ID: null
                      BP_PA_AUTO: null
                      BP_MATURITY_TYPE: ACTUAL
                      BP_MATURITY_DAY: 0
                      BP_RETURN_TYPE: NONE
                      BP_RETURN_PA_ID: null
                      BP_VAR_TAX_DAY: 0
                      BP_VAR_TAX_DATE_SHIFT: 0
                      BP_VAR_TAXDOC_DELIVERY_TYPE: NONE
                      BP_VAR_COLLECTION_TYPE: NONE
                      BP_VAR_COLLECTION_DATE: null
                      BP_VAR_COLLECTION_DAY: null
                      BP_VAR_COLLECTION_DEBTS: NONE
                      BP_VAR_COLLECTION_DEBTS_AGE: 0
                      BP_VAR_APPLICATION_TYPE: NONE
                      BP_VAR_APPLICATION_DELIVERY_TYPE: NONE
                      BP_VAR_APPLICATION_DAY: null
                      BP_VAR_PROFORMA_TYPE: NONE
                      BP_VAR_PROFORMA_DELIVERY_TYPE: null
                      BP_VAR_PROFORMA_DATE: null
                      BP_VAR_PROFORMA_DAY: null
                      BP_VAR_PAYMENT_TYPE: ACCOUNT
                      BP_VAR_PA_ID: null
                      BP_VAR_MATURITY_TYPE: ACTUAL
                      BP_VAR_MATURITY_DAY: 0
                      BP_VAR_RETURN_TYPE: NONE
                      BP_VAR_RETURN_PA_ID: null
                      BP_VARIABILITY: ''
                      BP_AGR_NAME: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        BP_ID: 1073
                        BP_NAME: 'autem et consequatur'
                        BP_EU_NAME: null
                        BP_NOTE: null
                        BP_SC_ID: null
                        BP_CT: null
                        BP_CP_ID: null
                        BP_DISABLED: 0
                        BP_PAID: NONE
                        BP_PAID_SN_ID: null
                        BP_PAID_TIME: NONE
                        BP_PAID_LEGEND: null
                        BP_BLOCK: NONE
                        BP_DEFAULT: 1
                        BP_TAXDOC_ROUNDING: DEFAULT
                        BP_SEPARATE: 0
                        BP_VAR_PRICE_ACCORD: null
                        BP_VAR_PRICE_SEPARATE: 0
                        BP_TAX_DAY: 0
                        BP_TAX_DATE_SHIFT: 0
                        BP_TAXDOC_DELIVERY_TYPE: NONE
                        BP_COLLECTION_TYPE: NONE
                        BP_COLLECTION_DATE: null
                        BP_COLLECTION_DAY: null
                        BP_COLLECTION_DEBTS: NONE
                        BP_COLLECTION_DEBTS_AGE: 0
                        BP_APPLICATION_TYPE: NONE
                        BP_APPLICATION_DELIVERY_TYPE: null
                        BP_APPLICATION_DAY: null
                        BP_PROFORMA_TYPE: NONE
                        BP_PROFORMA_DELIVERY_TYPE: null
                        BP_PROFORMA_DATE: null
                        BP_PROFORMA_DAY: null
                        BP_ADVANCE: 0
                        BP_ADVANCE_DELIVERY_TYPE: NONE
                        BP_CREDIT_NOTE_TYPE: NONE
                        BP_CREDIT_NOTE_DELIVERY_TYPE: null
                        BP_CREDIT_NOTE_DAY: null
                        BP_PAYMENT_TYPE: ACCOUNT
                        BP_PA_ID: null
                        BP_PA_AUTO: null
                        BP_MATURITY_TYPE: ACTUAL
                        BP_MATURITY_DAY: 0
                        BP_RETURN_TYPE: NONE
                        BP_RETURN_PA_ID: null
                        BP_VAR_TAX_DAY: 0
                        BP_VAR_TAX_DATE_SHIFT: 0
                        BP_VAR_TAXDOC_DELIVERY_TYPE: NONE
                        BP_VAR_COLLECTION_TYPE: NONE
                        BP_VAR_COLLECTION_DATE: null
                        BP_VAR_COLLECTION_DAY: null
                        BP_VAR_COLLECTION_DEBTS: NONE
                        BP_VAR_COLLECTION_DEBTS_AGE: 0
                        BP_VAR_APPLICATION_TYPE: NONE
                        BP_VAR_APPLICATION_DELIVERY_TYPE: NONE
                        BP_VAR_APPLICATION_DAY: null
                        BP_VAR_PROFORMA_TYPE: NONE
                        BP_VAR_PROFORMA_DELIVERY_TYPE: null
                        BP_VAR_PROFORMA_DATE: null
                        BP_VAR_PROFORMA_DAY: null
                        BP_VAR_PAYMENT_TYPE: ACCOUNT
                        BP_VAR_PA_ID: null
                        BP_VAR_MATURITY_TYPE: ACTUAL
                        BP_VAR_MATURITY_DAY: 0
                        BP_VAR_RETURN_TYPE: NONE
                        BP_VAR_RETURN_PA_ID: null
                        BP_VARIABILITY: ''
                        BP_AGR_NAME: null
                      -
                        BP_ID: 1074
                        BP_NAME: 'enim non facere'
                        BP_EU_NAME: 'Voluptatem laboriosam praesentium.'
                        BP_NOTE: null
                        BP_SC_ID: null
                        BP_CT: null
                        BP_CP_ID: null
                        BP_DISABLED: 0
                        BP_PAID: POSTPAID
                        BP_PAID_SN_ID: null
                        BP_PAID_TIME: NONE
                        BP_PAID_LEGEND: null
                        BP_BLOCK: NONE
                        BP_DEFAULT: 1
                        BP_TAXDOC_ROUNDING: DEFAULT
                        BP_SEPARATE: 0
                        BP_VAR_PRICE_ACCORD: null
                        BP_VAR_PRICE_SEPARATE: 0
                        BP_TAX_DAY: 0
                        BP_TAX_DATE_SHIFT: 0
                        BP_TAXDOC_DELIVERY_TYPE: NONE
                        BP_COLLECTION_TYPE: NONE
                        BP_COLLECTION_DATE: null
                        BP_COLLECTION_DAY: null
                        BP_COLLECTION_DEBTS: NONE
                        BP_COLLECTION_DEBTS_AGE: 0
                        BP_APPLICATION_TYPE: NONE
                        BP_APPLICATION_DELIVERY_TYPE: null
                        BP_APPLICATION_DAY: null
                        BP_PROFORMA_TYPE: NONE
                        BP_PROFORMA_DELIVERY_TYPE: null
                        BP_PROFORMA_DATE: null
                        BP_PROFORMA_DAY: null
                        BP_ADVANCE: 0
                        BP_ADVANCE_DELIVERY_TYPE: NONE
                        BP_CREDIT_NOTE_TYPE: NONE
                        BP_CREDIT_NOTE_DELIVERY_TYPE: null
                        BP_CREDIT_NOTE_DAY: null
                        BP_PAYMENT_TYPE: ACCOUNT
                        BP_PA_ID: null
                        BP_PA_AUTO: null
                        BP_MATURITY_TYPE: ACTUAL
                        BP_MATURITY_DAY: 0
                        BP_RETURN_TYPE: NONE
                        BP_RETURN_PA_ID: null
                        BP_VAR_TAX_DAY: 0
                        BP_VAR_TAX_DATE_SHIFT: 0
                        BP_VAR_TAXDOC_DELIVERY_TYPE: NONE
                        BP_VAR_COLLECTION_TYPE: NONE
                        BP_VAR_COLLECTION_DATE: null
                        BP_VAR_COLLECTION_DAY: null
                        BP_VAR_COLLECTION_DEBTS: NONE
                        BP_VAR_COLLECTION_DEBTS_AGE: 0
                        BP_VAR_APPLICATION_TYPE: NONE
                        BP_VAR_APPLICATION_DELIVERY_TYPE: NONE
                        BP_VAR_APPLICATION_DAY: null
                        BP_VAR_PROFORMA_TYPE: NONE
                        BP_VAR_PROFORMA_DELIVERY_TYPE: null
                        BP_VAR_PROFORMA_DATE: null
                        BP_VAR_PROFORMA_DAY: null
                        BP_VAR_PAYMENT_TYPE: ACCOUNT
                        BP_VAR_PA_ID: null
                        BP_VAR_MATURITY_TYPE: ACTUAL
                        BP_VAR_MATURITY_DAY: 0
                        BP_VAR_RETURN_TYPE: NONE
                        BP_VAR_RETURN_PA_ID: null
                        BP_VARIABILITY: ''
                        BP_AGR_NAME: null
                    items:
                      type: object
                      properties:
                        BP_ID:
                          type: integer
                          example: 1073
                          description: 'Billing plan ID.'
                        BP_NAME:
                          type: string
                          example: 'autem et consequatur'
                          description: 'Internal name of the billing plan.'
                        BP_EU_NAME:
                          type: string
                          example: null
                          description: 'End-user (customer-facing) name.'
                          nullable: true
                        BP_NOTE:
                          type: string
                          example: null
                          description: 'Internal notes or description.'
                          nullable: true
                        BP_SC_ID:
                          type: string
                          example: null
                          description: 'Service class ID.'
                          nullable: true
                        BP_CT:
                          type: string
                          example: null
                          description: 'Location (CT) ID. NULL means this is a global plan available to all locations.'
                          nullable: true
                        BP_CP_ID:
                          type: string
                          example: null
                          description: 'CIBS partner ID.'
                          nullable: true
                        BP_DISABLED:
                          type: integer
                          example: 0
                          description: 'Whether the plan is disabled. 0 = active, 1 = disabled.'
                        BP_PAID:
                          type: string
                          example: NONE
                          description: 'Payment mode.'
                          nullable: true
                          enum:
                            - NONE
                            - PREPAID
                            - ONTIMEPAID
                            - POSTPAID
                            - ACTUALPAID
                            - BOX
                        BP_PAID_SN_ID:
                          type: string
                          example: null
                          description: 'Service definition ID for payment service.'
                          nullable: true
                        BP_PAID_TIME:
                          type: string
                          example: NONE
                          description: 'Payment time mode.'
                          enum:
                            - WAITING
                            - NONE
                        BP_PAID_LEGEND:
                          type: string
                          example: null
                          description: 'Payment legend text.'
                          nullable: true
                        BP_BLOCK:
                          type: string
                          example: NONE
                          description: 'Blocking mode for non-payment.'
                          nullable: true
                          enum:
                            - NONE
                            - MATURITY
                            - EXPIRATION_SHIFT
                        BP_DEFAULT:
                          type: integer
                          example: 1
                          description: 'Default priority ranking (higher = more preferred).'
                        BP_TAXDOC_ROUNDING:
                          type: string
                          example: DEFAULT
                          description: 'Tax document rounding mode.'
                          enum:
                            - DEFAULT
                            - NOTROUNDED
                        BP_SEPARATE:
                          type: integer
                          example: 0
                          description: 'Whether to generate separate tax documents. 0 = no, 1 = yes.'
                        BP_VAR_PRICE_ACCORD:
                          type: string
                          example: null
                          description: 'Variable pricing accord flag.'
                          nullable: true
                        BP_VAR_PRICE_SEPARATE:
                          type: integer
                          example: 0
                          description: 'Separate variable pricing flag.'
                        BP_TAX_DAY:
                          type: integer
                          example: 0
                          description: 'Tax document day of month.'
                        BP_TAX_DATE_SHIFT:
                          type: integer
                          example: 0
                          description: 'Tax date shift in days.'
                        BP_TAXDOC_DELIVERY_TYPE:
                          type: string
                          example: NONE
                          description: 'Tax document delivery method.'
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_COLLECTION_TYPE:
                          type: string
                          example: NONE
                          description: 'Collection type.'
                          enum:
                            - NONE
                            - SIPO
                            - FETCH
                        BP_COLLECTION_DATE:
                          type: string
                          example: null
                          description: 'Collection date reference.'
                          nullable: true
                          enum:
                            - PREV
                            - ACTUAL
                            - NEXT
                            - 2NEXT
                            - TAXDOC
                        BP_COLLECTION_DAY:
                          type: string
                          example: null
                          description: 'Collection day of month.'
                          nullable: true
                        BP_COLLECTION_DEBTS:
                          type: string
                          example: NONE
                          description: 'Whether to collect debts.'
                          enum:
                            - NONE
                            - ALL
                        BP_COLLECTION_DEBTS_AGE:
                          type: integer
                          example: 0
                          description: 'Minimum debt age in days for collection.'
                        BP_APPLICATION_TYPE:
                          type: string
                          example: NONE
                          description: 'Application (invoice) type.'
                          enum:
                            - NONE
                            - INVOICE
                        BP_APPLICATION_DELIVERY_TYPE:
                          type: string
                          example: null
                          description: 'Application delivery method.'
                          nullable: true
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_APPLICATION_DAY:
                          type: string
                          example: null
                          description: 'Application day.'
                          nullable: true
                        BP_PROFORMA_TYPE:
                          type: string
                          example: NONE
                          description: 'Proforma invoice type.'
                          nullable: true
                          enum:
                            - NONE
                            - PROFORMA
                        BP_PROFORMA_DELIVERY_TYPE:
                          type: string
                          example: null
                          description: 'Proforma delivery method.'
                          nullable: true
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_PROFORMA_DATE:
                          type: string
                          example: null
                          description: 'Proforma date reference.'
                          nullable: true
                          enum:
                            - PREV
                            - ACTUAL
                            - NEXT
                            - TAXDOC
                            - MATURITY
                            - USER
                        BP_PROFORMA_DAY:
                          type: string
                          example: null
                          description: 'Proforma day.'
                          nullable: true
                        BP_ADVANCE:
                          type: integer
                          example: 0
                          description: 'Advance payment amount.'
                        BP_ADVANCE_DELIVERY_TYPE:
                          type: string
                          example: NONE
                          description: 'Advance delivery method.'
                          nullable: true
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_CREDIT_NOTE_TYPE:
                          type: string
                          example: NONE
                          description: 'Credit note type.'
                          enum:
                            - NONE
                            - CREDIT_NOTE
                        BP_CREDIT_NOTE_DELIVERY_TYPE:
                          type: string
                          example: null
                          description: 'Credit note delivery method.'
                          nullable: true
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_CREDIT_NOTE_DAY:
                          type: string
                          example: null
                          description: 'Credit note day.'
                          nullable: true
                        BP_PAYMENT_TYPE:
                          type: string
                          example: ACCOUNT
                          description: 'Payment type.'
                          enum:
                            - CASH
                            - ACCOUNT
                        BP_PA_ID:
                          type: string
                          example: null
                          description: 'Payment account ID.'
                          nullable: true
                        BP_PA_AUTO:
                          type: string
                          example: null
                          description: 'Automatic payment account assignment.'
                          nullable: true
                        BP_MATURITY_TYPE:
                          type: string
                          example: ACTUAL
                          description: 'Maturity date reference.'
                          enum:
                            - PREV
                            - ACTUAL
                            - NEXT
                            - TAXDOC
                            - INVOICE
                            - PREVFIX
                        BP_MATURITY_DAY:
                          type: integer
                          example: 0
                          description: 'Maturity day.'
                        BP_RETURN_TYPE:
                          type: string
                          example: NONE
                          description: 'Return payment type.'
                          enum:
                            - NONE
                            - SIPO
                            - ORDER
                        BP_RETURN_PA_ID:
                          type: string
                          example: null
                          description: 'Return payment account ID.'
                          nullable: true
                        BP_VAR_TAX_DAY:
                          type: integer
                          example: 0
                          description: 'Variable section tax day.'
                        BP_VAR_TAX_DATE_SHIFT:
                          type: integer
                          example: 0
                          description: 'Variable section tax date shift.'
                        BP_VAR_TAXDOC_DELIVERY_TYPE:
                          type: string
                          example: NONE
                          description: 'Variable section tax document delivery.'
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_VAR_COLLECTION_TYPE:
                          type: string
                          example: NONE
                          description: 'Variable section collection type.'
                          enum:
                            - NONE
                            - SIPO
                            - FETCH
                        BP_VAR_COLLECTION_DATE:
                          type: string
                          example: null
                          description: 'Variable section collection date reference.'
                          nullable: true
                          enum:
                            - PREV
                            - ACTUAL
                            - NEXT
                            - 2NEXT
                            - TAXDOC
                        BP_VAR_COLLECTION_DAY:
                          type: string
                          example: null
                          description: 'Variable section collection day.'
                          nullable: true
                        BP_VAR_COLLECTION_DEBTS:
                          type: string
                          example: NONE
                          description: 'Variable section debt collection.'
                          enum:
                            - NONE
                            - ALL
                        BP_VAR_COLLECTION_DEBTS_AGE:
                          type: integer
                          example: 0
                          description: 'Variable section minimum debt age.'
                        BP_VAR_APPLICATION_TYPE:
                          type: string
                          example: NONE
                          description: 'Variable section application type.'
                          enum:
                            - NONE
                            - INVOICE
                        BP_VAR_APPLICATION_DELIVERY_TYPE:
                          type: string
                          example: NONE
                          description: 'Variable section application delivery.'
                          nullable: true
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_VAR_APPLICATION_DAY:
                          type: string
                          example: null
                          description: 'Variable section application day.'
                          nullable: true
                        BP_VAR_PROFORMA_TYPE:
                          type: string
                          example: NONE
                          description: 'Variable section proforma type.'
                          nullable: true
                          enum:
                            - NONE
                            - PROFORMA
                        BP_VAR_PROFORMA_DELIVERY_TYPE:
                          type: string
                          example: null
                          description: 'Variable section proforma delivery.'
                          nullable: true
                          enum:
                            - NONE
                            - EMAIL
                            - MAIL
                            - SMS
                        BP_VAR_PROFORMA_DATE:
                          type: string
                          example: null
                          description: 'Variable section proforma date reference.'
                          nullable: true
                          enum:
                            - PREV
                            - ACTUAL
                            - NEXT
                            - TAXDOC
                            - MATURITY
                            - USER
                        BP_VAR_PROFORMA_DAY:
                          type: string
                          example: null
                          description: 'Variable section proforma day.'
                          nullable: true
                        BP_VAR_PAYMENT_TYPE:
                          type: string
                          example: ACCOUNT
                          description: 'Variable section payment type.'
                          enum:
                            - CASH
                            - ACCOUNT
                        BP_VAR_PA_ID:
                          type: string
                          example: null
                          description: 'Variable section payment account ID.'
                          nullable: true
                        BP_VAR_MATURITY_TYPE:
                          type: string
                          example: ACTUAL
                          description: 'Variable section maturity reference.'
                          enum:
                            - PREV
                            - ACTUAL
                            - NEXT
                            - TAXDOC
                            - INVOICE
                            - PREVFIX
                        BP_VAR_MATURITY_DAY:
                          type: integer
                          example: 0
                          description: 'Variable section maturity day.'
                        BP_VAR_RETURN_TYPE:
                          type: string
                          example: NONE
                          description: 'Variable section return type.'
                          enum:
                            - NONE
                            - SIPO
                            - ORDER
                        BP_VAR_RETURN_PA_ID:
                          type: string
                          example: null
                          description: 'Variable section return payment account ID.'
                          nullable: true
                        BP_VARIABILITY:
                          type: string
                          example: ''
                          description: 'SET field indicating which sections can vary per service. Possible values: tax_date, maturity_date, rounding, separate.'
                        BP_AGR_NAME:
                          type: string
                          example: null
                          description: 'Agreement name template.'
                          nullable: true
                    required:
                      - BP_ID
                      - BP_NAME
                      - BP_EU_NAME
                      - BP_NOTE
                      - BP_SC_ID
                      - BP_CT
                      - BP_CP_ID
                      - BP_DISABLED
                      - BP_PAID
                      - BP_PAID_SN_ID
                      - BP_PAID_TIME
                      - BP_PAID_LEGEND
                      - BP_BLOCK
                      - BP_DEFAULT
                      - BP_TAXDOC_ROUNDING
                      - BP_SEPARATE
                      - BP_VAR_PRICE_ACCORD
                      - BP_VAR_PRICE_SEPARATE
                      - BP_TAX_DAY
                      - BP_TAX_DATE_SHIFT
                      - BP_TAXDOC_DELIVERY_TYPE
                      - BP_COLLECTION_TYPE
                      - BP_COLLECTION_DATE
                      - BP_COLLECTION_DAY
                      - BP_COLLECTION_DEBTS
                      - BP_COLLECTION_DEBTS_AGE
                      - BP_APPLICATION_TYPE
                      - BP_APPLICATION_DELIVERY_TYPE
                      - BP_APPLICATION_DAY
                      - BP_PROFORMA_TYPE
                      - BP_PROFORMA_DELIVERY_TYPE
                      - BP_PROFORMA_DATE
                      - BP_PROFORMA_DAY
                      - BP_ADVANCE
                      - BP_ADVANCE_DELIVERY_TYPE
                      - BP_CREDIT_NOTE_TYPE
                      - BP_CREDIT_NOTE_DELIVERY_TYPE
                      - BP_CREDIT_NOTE_DAY
                      - BP_PAYMENT_TYPE
                      - BP_PA_ID
                      - BP_PA_AUTO
                      - BP_MATURITY_TYPE
                      - BP_MATURITY_DAY
                      - BP_RETURN_TYPE
                      - BP_RETURN_PA_ID
                      - BP_VAR_TAX_DAY
                      - BP_VAR_TAX_DATE_SHIFT
                      - BP_VAR_TAXDOC_DELIVERY_TYPE
                      - BP_VAR_COLLECTION_TYPE
                      - BP_VAR_COLLECTION_DATE
                      - BP_VAR_COLLECTION_DAY
                      - BP_VAR_COLLECTION_DEBTS
                      - BP_VAR_COLLECTION_DEBTS_AGE
                      - BP_VAR_APPLICATION_TYPE
                      - BP_VAR_APPLICATION_DELIVERY_TYPE
                      - BP_VAR_APPLICATION_DAY
                      - BP_VAR_PROFORMA_TYPE
                      - BP_VAR_PROFORMA_DELIVERY_TYPE
                      - BP_VAR_PROFORMA_DATE
                      - BP_VAR_PROFORMA_DAY
                      - BP_VAR_PAYMENT_TYPE
                      - BP_VAR_PA_ID
                      - BP_VAR_MATURITY_TYPE
                      - BP_VAR_MATURITY_DAY
                      - BP_VAR_RETURN_TYPE
                      - BP_VAR_RETURN_PA_ID
                      - BP_VARIABILITY
                      - BP_AGR_NAME
      tags:
        - 'Billing Plans'
  /api/v3/customer-contacts:
    get:
      summary: 'List Customer Contacts'
      operationId: listCustomerContacts
      description: "Retrieve a paginated list of customer contacts (contact persons).\nContacts are scoped by CT through the parent customer."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of contacts to return per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of contacts to return per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated contact IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated contact IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer ID (UC_USER_ID)'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer ID (UC_USER_ID)'
            example: 100
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      UC_ID: 20903
                      UC_USER_ID: 681
                      UC_P_ID: null
                      UC_LOGIN: null
                      UC_LAST_NAME: Price
                      UC_FIRST_NAME: Amber
                      UC_EMAIL: emelie.baumbach@example.net
                      UC_PHONE: 420760725744
                      UC_PHONE2: null
                      UC_GSM: 420659135052
                      UC_FAX: null
                      UC_FINANCE: 0
                      UC_TECHNIC: 0
                      UC_LEADER: 0
                      UC_MANAGEMENT: 0
                      UC_MARKETING: 0
                      UC_SHOP: 0
                      UC_POSITION: null
                    -
                      UC_ID: 20904
                      UC_USER_ID: 59
                      UC_P_ID: null
                      UC_LOGIN: schultz.audrey
                      UC_LAST_NAME: Koch
                      UC_FIRST_NAME: Christian
                      UC_EMAIL: sleffler@example.org
                      UC_PHONE: 420784087043
                      UC_PHONE2: null
                      UC_GSM: null
                      UC_FAX: null
                      UC_FINANCE: 0
                      UC_TECHNIC: 0
                      UC_LEADER: 0
                      UC_MANAGEMENT: 0
                      UC_MARKETING: 0
                      UC_SHOP: 0
                      UC_POSITION: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        UC_ID: 20903
                        UC_USER_ID: 681
                        UC_P_ID: null
                        UC_LOGIN: null
                        UC_LAST_NAME: Price
                        UC_FIRST_NAME: Amber
                        UC_EMAIL: emelie.baumbach@example.net
                        UC_PHONE: 420760725744
                        UC_PHONE2: null
                        UC_GSM: 420659135052
                        UC_FAX: null
                        UC_FINANCE: 0
                        UC_TECHNIC: 0
                        UC_LEADER: 0
                        UC_MANAGEMENT: 0
                        UC_MARKETING: 0
                        UC_SHOP: 0
                        UC_POSITION: null
                      -
                        UC_ID: 20904
                        UC_USER_ID: 59
                        UC_P_ID: null
                        UC_LOGIN: schultz.audrey
                        UC_LAST_NAME: Koch
                        UC_FIRST_NAME: Christian
                        UC_EMAIL: sleffler@example.org
                        UC_PHONE: 420784087043
                        UC_PHONE2: null
                        UC_GSM: null
                        UC_FAX: null
                        UC_FINANCE: 0
                        UC_TECHNIC: 0
                        UC_LEADER: 0
                        UC_MANAGEMENT: 0
                        UC_MARKETING: 0
                        UC_SHOP: 0
                        UC_POSITION: null
                    items:
                      type: object
                      properties:
                        UC_ID:
                          type: integer
                          example: 20903
                          description: 'Unique contact record ID (primary key).'
                        UC_USER_ID:
                          type: integer
                          example: 681
                          description: 'Customer ID this contact belongs to. See GET /v3/customers/{id}.'
                        UC_P_ID:
                          type: string
                          example: null
                          description: 'Premise ID (point of presence) associated with this contact.'
                          nullable: true
                        UC_LOGIN:
                          type: string
                          example: null
                          description: 'Login name for the customer portal (SelfCare).'
                          nullable: true
                        UC_LAST_NAME:
                          type: string
                          example: Price
                          description: "Contact person's last name (surname)."
                        UC_FIRST_NAME:
                          type: string
                          example: Amber
                          description: "Contact person's first name."
                          nullable: true
                        UC_EMAIL:
                          type: string
                          example: emelie.baumbach@example.net
                          description: 'Email address.'
                          nullable: true
                        UC_PHONE:
                          type: integer
                          example: 420760725744
                          description: 'Primary phone number.'
                          nullable: true
                        UC_PHONE2:
                          type: string
                          example: null
                          description: 'Additional phone number.'
                          nullable: true
                        UC_GSM:
                          type: integer
                          example: 420659135052
                          description: 'Mobile phone number.'
                          nullable: true
                        UC_FAX:
                          type: string
                          example: null
                          description: 'Fax number.'
                          nullable: true
                        UC_FINANCE:
                          type: integer
                          example: 0
                          description: 'Finance contact flag. 1 = contact for finance/billing matters.'
                          nullable: true
                        UC_TECHNIC:
                          type: integer
                          example: 0
                          description: 'Technical contact flag. 1 = contact for technical matters.'
                          nullable: true
                        UC_LEADER:
                          type: integer
                          example: 0
                          description: 'Statutory representative flag. 1 = contact is a company representative (jednatel).'
                          nullable: true
                        UC_MANAGEMENT:
                          type: integer
                          example: 0
                          description: 'Management contact flag. 1 = contact is in management.'
                          nullable: true
                        UC_MARKETING:
                          type: integer
                          example: 0
                          description: 'Marketing contact flag. 1 = contact for marketing matters.'
                          nullable: true
                        UC_SHOP:
                          type: integer
                          example: 0
                          description: 'Sales/shop contact flag. 1 = contact for sales and orders.'
                          nullable: true
                        UC_POSITION:
                          type: string
                          example: null
                          description: 'Position code from the code list (installation-specific values, e.g. "DIR" = director, "UCT" = accountant, "SEC" = secretary).'
                          nullable: true
                    required:
                      - UC_ID
                      - UC_USER_ID
                      - UC_P_ID
                      - UC_LOGIN
                      - UC_LAST_NAME
                      - UC_FIRST_NAME
                      - UC_EMAIL
                      - UC_PHONE
                      - UC_PHONE2
                      - UC_GSM
                      - UC_FAX
                      - UC_FINANCE
                      - UC_TECHNIC
                      - UC_LEADER
                      - UC_MANAGEMENT
                      - UC_MARKETING
                      - UC_SHOP
                      - UC_POSITION
      tags:
        - 'Customer Contacts'
  '/api/v3/customer-contacts/{id}':
    get:
      summary: 'Get Customer Contact'
      operationId: getCustomerContact
      description: 'Retrieve a specific customer contact by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    UC_ID: 20905
                    UC_USER_ID: 681
                    UC_P_ID: null
                    UC_LOGIN: null
                    UC_LAST_NAME: Price
                    UC_FIRST_NAME: Amber
                    UC_EMAIL: emelie.baumbach@example.net
                    UC_PHONE: 420760725744
                    UC_PHONE2: null
                    UC_GSM: 420659135052
                    UC_FAX: null
                    UC_FINANCE: 0
                    UC_TECHNIC: 0
                    UC_LEADER: 0
                    UC_MANAGEMENT: 0
                    UC_MARKETING: 0
                    UC_SHOP: 0
                    UC_POSITION: null
                properties:
                  data:
                    type: object
                    properties:
                      UC_ID:
                        type: integer
                        example: 20905
                        description: 'Unique contact record ID (primary key).'
                      UC_USER_ID:
                        type: integer
                        example: 681
                        description: 'Customer ID this contact belongs to. See GET /v3/customers/{id}.'
                      UC_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (point of presence) associated with this contact.'
                        nullable: true
                      UC_LOGIN:
                        type: string
                        example: null
                        description: 'Login name for the customer portal (SelfCare).'
                        nullable: true
                      UC_LAST_NAME:
                        type: string
                        example: Price
                        description: "Contact person's last name (surname)."
                      UC_FIRST_NAME:
                        type: string
                        example: Amber
                        description: "Contact person's first name."
                        nullable: true
                      UC_EMAIL:
                        type: string
                        example: emelie.baumbach@example.net
                        description: 'Email address.'
                        nullable: true
                      UC_PHONE:
                        type: integer
                        example: 420760725744
                        description: 'Primary phone number.'
                        nullable: true
                      UC_PHONE2:
                        type: string
                        example: null
                        description: 'Additional phone number.'
                        nullable: true
                      UC_GSM:
                        type: integer
                        example: 420659135052
                        description: 'Mobile phone number.'
                        nullable: true
                      UC_FAX:
                        type: string
                        example: null
                        description: 'Fax number.'
                        nullable: true
                      UC_FINANCE:
                        type: integer
                        example: 0
                        description: 'Finance contact flag. 1 = contact for finance/billing matters.'
                        nullable: true
                      UC_TECHNIC:
                        type: integer
                        example: 0
                        description: 'Technical contact flag. 1 = contact for technical matters.'
                        nullable: true
                      UC_LEADER:
                        type: integer
                        example: 0
                        description: 'Statutory representative flag. 1 = contact is a company representative (jednatel).'
                        nullable: true
                      UC_MANAGEMENT:
                        type: integer
                        example: 0
                        description: 'Management contact flag. 1 = contact is in management.'
                        nullable: true
                      UC_MARKETING:
                        type: integer
                        example: 0
                        description: 'Marketing contact flag. 1 = contact for marketing matters.'
                        nullable: true
                      UC_SHOP:
                        type: integer
                        example: 0
                        description: 'Sales/shop contact flag. 1 = contact for sales and orders.'
                        nullable: true
                      UC_POSITION:
                        type: string
                        example: null
                        description: 'Position code from the code list (installation-specific values, e.g. "DIR" = director, "UCT" = accountant, "SEC" = secretary).'
                        nullable: true
                    required:
                      - UC_ID
                      - UC_USER_ID
                      - UC_P_ID
                      - UC_LOGIN
                      - UC_LAST_NAME
                      - UC_FIRST_NAME
                      - UC_EMAIL
                      - UC_PHONE
                      - UC_PHONE2
                      - UC_GSM
                      - UC_FAX
                      - UC_FINANCE
                      - UC_TECHNIC
                      - UC_LEADER
                      - UC_MANAGEMENT
                      - UC_MARKETING
                      - UC_SHOP
                      - UC_POSITION
      tags:
        - 'Customer Contacts'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer contact.'
        example: 21
        required: true
        schema:
          type: integer
  /api/v3/customer-groups:
    get:
      summary: 'List Customer Groups'
      operationId: listCustomerGroups
      description: "Retrieve a paginated list of customer groups.\nBy default, only active groups (G_ACTIVE=1) are returned.\nPass `active=all` to include inactive groups."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of groups to return per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of groups to return per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: active
          description: "Filter by active status. 'true' = active only (default), 'false' = inactive only, 'all' = both."
          example: 'true'
          required: false
          schema:
            type: string
            description: "Filter by active status. 'true' = active only (default), 'false' = inactive only, 'all' = both."
            example: 'true'
        -
          in: query
          name: type
          description: 'Filter by group type.'
          example: OTHER
          required: false
          schema:
            type: string
            description: 'Filter by group type.'
            example: OTHER
        -
          in: query
          name: search
          description: 'Search by group name (partial match).'
          example: VIP
          required: false
          schema:
            type: string
            description: 'Search by group name (partial match).'
            example: VIP
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 2657
                      G_TARGET: user
                      GROUP_NAME: 'adipisci quidem nostrum'
                      NOTE: null
                      G_NOTE_BS: null
                      CT: 6
                      G_TYPE: SELFCARE
                      G_UDF_COLOR: null
                      G_VIRTUAL: 0
                      G_USER_DETAIL: 0
                      G_WIZARD: 0
                      G_ACTIVE: 1
                      G_SELFCARE: 0
                      G_DETAIL: null
                    -
                      ID: 2658
                      G_TARGET: user
                      GROUP_NAME: 'odit et et'
                      NOTE: 'Nostrum omnis autem et consequatur aut.'
                      G_NOTE_BS: null
                      CT: 7
                      G_TYPE: SELFCARE
                      G_UDF_COLOR: null
                      G_VIRTUAL: 0
                      G_USER_DETAIL: 0
                      G_WIZARD: 0
                      G_ACTIVE: 1
                      G_SELFCARE: 0
                      G_DETAIL: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 2657
                        G_TARGET: user
                        GROUP_NAME: 'adipisci quidem nostrum'
                        NOTE: null
                        G_NOTE_BS: null
                        CT: 6
                        G_TYPE: SELFCARE
                        G_UDF_COLOR: null
                        G_VIRTUAL: 0
                        G_USER_DETAIL: 0
                        G_WIZARD: 0
                        G_ACTIVE: 1
                        G_SELFCARE: 0
                        G_DETAIL: null
                      -
                        ID: 2658
                        G_TARGET: user
                        GROUP_NAME: 'odit et et'
                        NOTE: 'Nostrum omnis autem et consequatur aut.'
                        G_NOTE_BS: null
                        CT: 7
                        G_TYPE: SELFCARE
                        G_UDF_COLOR: null
                        G_VIRTUAL: 0
                        G_USER_DETAIL: 0
                        G_WIZARD: 0
                        G_ACTIVE: 1
                        G_SELFCARE: 0
                        G_DETAIL: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 2657
                          description: 'Unique customer group identifier (primary key).'
                        G_TARGET:
                          type: string
                          example: user
                          description: 'Target entity type for the group. Possible values: "user" (customer group), "premise" (premise group).'
                          enum:
                            - user
                            - premise
                        GROUP_NAME:
                          type: string
                          example: 'adipisci quidem nostrum'
                          description: 'Name of the customer group.'
                        NOTE:
                          type: string
                          example: null
                          description: 'Group note / description.'
                          nullable: true
                        G_NOTE_BS:
                          type: string
                          example: null
                          description: 'Extended group note (rich text / business note).'
                          nullable: true
                        CT:
                          type: integer
                          example: 6
                          description: 'Company/tenant identifier — multi-tenant discriminator.'
                        G_TYPE:
                          type: string
                          example: SELFCARE
                          description: 'Group type. Possible values: "OTHER" (general purpose), "ACCESS" (operator access control), "SELFCARE" (product availability in selfcare), "SC_TYPE" (selfcare access type), "SELFCARE_MTT" (process display in selfcare).'
                          enum:
                            - OTHER
                            - ACCESS
                            - SELFCARE
                            - SC_TYPE
                            - SELFCARE_MTT
                        G_UDF_COLOR:
                          type: string
                          example: null
                          description: 'User-defined color for the group (stored as an integer color value).'
                          nullable: true
                        G_VIRTUAL:
                          type: integer
                          example: 0
                          description: 'Virtual group flag. 1 = virtual (membership is computed from rules, users cannot be directly assigned). 0 = regular group.'
                        G_USER_DETAIL:
                          type: integer
                          example: 0
                          description: 'Flag indicating the group is displayed in the customer detail view. 1 = shown.'
                        G_WIZARD:
                          type: integer
                          example: 0
                          description: 'Flag indicating the group is available in the new customer wizard. 1 = shown.'
                        G_ACTIVE:
                          type: integer
                          example: 1
                          description: 'Active flag. 1 = active, 0 = inactive. Inactive groups are hidden by default.'
                        G_SELFCARE:
                          type: integer
                          example: 0
                          description: 'Selfcare visibility flag.'
                          nullable: true
                        G_DETAIL:
                          type: string
                          example: null
                          description: 'Reference ID to additional group information in related tables.'
                          nullable: true
                    required:
                      - ID
                      - G_TARGET
                      - GROUP_NAME
                      - NOTE
                      - G_NOTE_BS
                      - CT
                      - G_TYPE
                      - G_UDF_COLOR
                      - G_VIRTUAL
                      - G_USER_DETAIL
                      - G_WIZARD
                      - G_ACTIVE
                      - G_SELFCARE
                      - G_DETAIL
      tags:
        - 'Customer Groups'
  '/api/v3/customer-groups/{id}':
    get:
      summary: 'Get Customer Group'
      operationId: getCustomerGroup
      description: 'Retrieve a specific customer group by ID, including its user group memberships.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 2659
                    G_TARGET: user
                    GROUP_NAME: 'adipisci quidem nostrum'
                    NOTE: null
                    G_NOTE_BS: null
                    CT: 6
                    G_TYPE: SELFCARE
                    G_UDF_COLOR: null
                    G_VIRTUAL: 0
                    G_USER_DETAIL: 0
                    G_WIZARD: 0
                    G_ACTIVE: 1
                    G_SELFCARE: 0
                    G_DETAIL: null
                    members:
                      -
                        ID: 1367460
                        GROUP_ID: 2659
                        USER_ID: 1038
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 2659
                        description: 'Unique customer group identifier (primary key).'
                      G_TARGET:
                        type: string
                        example: user
                        description: 'Target entity type for the group. Possible values: "user" (customer group), "premise" (premise group).'
                        enum:
                          - user
                          - premise
                      GROUP_NAME:
                        type: string
                        example: 'adipisci quidem nostrum'
                        description: 'Name of the customer group.'
                      NOTE:
                        type: string
                        example: null
                        description: 'Group note / description.'
                        nullable: true
                      G_NOTE_BS:
                        type: string
                        example: null
                        description: 'Extended group note (rich text / business note).'
                        nullable: true
                      CT:
                        type: integer
                        example: 6
                        description: 'Company/tenant identifier — multi-tenant discriminator.'
                      G_TYPE:
                        type: string
                        example: SELFCARE
                        description: 'Group type. Possible values: "OTHER" (general purpose), "ACCESS" (operator access control), "SELFCARE" (product availability in selfcare), "SC_TYPE" (selfcare access type), "SELFCARE_MTT" (process display in selfcare).'
                        enum:
                          - OTHER
                          - ACCESS
                          - SELFCARE
                          - SC_TYPE
                          - SELFCARE_MTT
                      G_UDF_COLOR:
                        type: string
                        example: null
                        description: 'User-defined color for the group (stored as an integer color value).'
                        nullable: true
                      G_VIRTUAL:
                        type: integer
                        example: 0
                        description: 'Virtual group flag. 1 = virtual (membership is computed from rules, users cannot be directly assigned). 0 = regular group.'
                      G_USER_DETAIL:
                        type: integer
                        example: 0
                        description: 'Flag indicating the group is displayed in the customer detail view. 1 = shown.'
                      G_WIZARD:
                        type: integer
                        example: 0
                        description: 'Flag indicating the group is available in the new customer wizard. 1 = shown.'
                      G_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Active flag. 1 = active, 0 = inactive. Inactive groups are hidden by default.'
                      G_SELFCARE:
                        type: integer
                        example: 0
                        description: 'Selfcare visibility flag.'
                        nullable: true
                      G_DETAIL:
                        type: string
                        example: null
                        description: 'Reference ID to additional group information in related tables.'
                        nullable: true
                      members:
                        type: array
                        example:
                          -
                            ID: 1367460
                            GROUP_ID: 2659
                            USER_ID: 1038
                        description: 'Group membership records — each entry links a customer to this group. Only included in the show (detail) endpoint.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 1367460
                            GROUP_ID:
                              type: integer
                              example: 2659
                            USER_ID:
                              type: integer
                              example: 1038
                    required:
                      - ID
                      - G_TARGET
                      - GROUP_NAME
                      - NOTE
                      - G_NOTE_BS
                      - CT
                      - G_TYPE
                      - G_UDF_COLOR
                      - G_VIRTUAL
                      - G_USER_DETAIL
                      - G_WIZARD
                      - G_ACTIVE
                      - G_SELFCARE
                      - G_DETAIL
                      - members
      tags:
        - 'Customer Groups'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer group.'
        example: 141
        required: true
        schema:
          type: integer
  /api/v3/customer-param-definitions:
    get:
      summary: 'List Customer Param Definitions'
      operationId: listCustomerParamDefinitions
      description: "Retrieve a paginated list of customer parameter definitions.\nBy default, only enabled definitions (UPD_DISABLED=0) are returned.\nPass `disabled=all` to include disabled definitions.\nGlobal definitions (UPD_CT IS NULL) are always included alongside\nlocation-specific ones."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of definitions to return per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of definitions to return per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated definition IDs'
          example: '101,133,135'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated definition IDs'
            example: '101,133,135'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Returns global definitions (UPD_CT IS NULL) plus definitions for the specified CTs. Overrides X-CT header default.'
          example: '31,101'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Returns global definitions (UPD_CT IS NULL) plus definitions for the specified CTs. Overrides X-CT header default.'
            example: '31,101'
        -
          in: query
          name: disabled
          description: "Filter by disabled status. Default (omitted): only enabled (UPD_DISABLED=0). 'true' = disabled only, 'all' = both enabled and disabled."
          example: all
          required: false
          schema:
            type: string
            description: "Filter by disabled status. Default (omitted): only enabled (UPD_DISABLED=0). 'true' = disabled only, 'all' = both enabled and disabled."
            example: all
        -
          in: query
          name: target
          description: 'Filter by target entity type.'
          example: user
          required: false
          schema:
            type: string
            description: 'Filter by target entity type.'
            example: user
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      UPD_ID: 1032
                      UPD_CT: 181
                      UPD_TARGET: user
                      UPD_NAME: QUI
                      UPD_DISPLAY: 'commodi incidunt'
                      UPD_DEFAULT_VALUE: ''
                      UPD_TYPE: BOOL
                      UPD_INDEXED: 0
                      UPD_DOMAIN: null
                      UPD_NOTNULL: 0
                      UPD_TIME_RESOLUTION: 0
                      UPD_DISABLED: 0
                      UPD_PUBLIC: 0
                      UPD_L_ID: 12
                      UPD_CREATED: '2026-02-18 15:02:14'
                      UPD_DOC_VARNAME: ''
                      UPD_SHOW: 1
                      UPD_PAY_SHOW: 0
                      UPD_PROVISIONING: 0
                      UPD_SYSTEM: 'N'
                      UPD_SC_VISIBLE: null
                      UPD_SC_EDITABLE: null
                    -
                      UPD_ID: 1033
                      UPD_CT: 45
                      UPD_TARGET: premise
                      UPD_NAME: IPSUM
                      UPD_DISPLAY: 'nostrum omnis'
                      UPD_DEFAULT_VALUE: ''
                      UPD_TYPE: BOOL
                      UPD_INDEXED: 0
                      UPD_DOMAIN: null
                      UPD_NOTNULL: 0
                      UPD_TIME_RESOLUTION: 0
                      UPD_DISABLED: 0
                      UPD_PUBLIC: 0
                      UPD_L_ID: 776
                      UPD_CREATED: '2026-04-16 17:17:19'
                      UPD_DOC_VARNAME: ''
                      UPD_SHOW: 1
                      UPD_PAY_SHOW: 0
                      UPD_PROVISIONING: 0
                      UPD_SYSTEM: 'N'
                      UPD_SC_VISIBLE: null
                      UPD_SC_EDITABLE: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        UPD_ID: 1032
                        UPD_CT: 181
                        UPD_TARGET: user
                        UPD_NAME: QUI
                        UPD_DISPLAY: 'commodi incidunt'
                        UPD_DEFAULT_VALUE: ''
                        UPD_TYPE: BOOL
                        UPD_INDEXED: 0
                        UPD_DOMAIN: null
                        UPD_NOTNULL: 0
                        UPD_TIME_RESOLUTION: 0
                        UPD_DISABLED: 0
                        UPD_PUBLIC: 0
                        UPD_L_ID: 12
                        UPD_CREATED: '2026-02-18 15:02:14'
                        UPD_DOC_VARNAME: ''
                        UPD_SHOW: 1
                        UPD_PAY_SHOW: 0
                        UPD_PROVISIONING: 0
                        UPD_SYSTEM: 'N'
                        UPD_SC_VISIBLE: null
                        UPD_SC_EDITABLE: null
                      -
                        UPD_ID: 1033
                        UPD_CT: 45
                        UPD_TARGET: premise
                        UPD_NAME: IPSUM
                        UPD_DISPLAY: 'nostrum omnis'
                        UPD_DEFAULT_VALUE: ''
                        UPD_TYPE: BOOL
                        UPD_INDEXED: 0
                        UPD_DOMAIN: null
                        UPD_NOTNULL: 0
                        UPD_TIME_RESOLUTION: 0
                        UPD_DISABLED: 0
                        UPD_PUBLIC: 0
                        UPD_L_ID: 776
                        UPD_CREATED: '2026-04-16 17:17:19'
                        UPD_DOC_VARNAME: ''
                        UPD_SHOW: 1
                        UPD_PAY_SHOW: 0
                        UPD_PROVISIONING: 0
                        UPD_SYSTEM: 'N'
                        UPD_SC_VISIBLE: null
                        UPD_SC_EDITABLE: null
                    items:
                      type: object
                      properties:
                        UPD_ID:
                          type: integer
                          example: 1032
                          description: 'Unique parameter definition ID (primary key).'
                        UPD_CT:
                          type: integer
                          example: 181
                          description: 'Location (installation) ID this definition belongs to. NULL = global definition available to all locations.'
                          nullable: true
                        UPD_TARGET:
                          type: string
                          example: user
                          description: "Target entity type: 'user' = customer parameter, 'premise' = premise parameter."
                          enum:
                            - user
                            - premise
                        UPD_NAME:
                          type: string
                          example: QUI
                          description: 'Parameter name (unique within a CT or globally). Max 50 characters.'
                        UPD_DISPLAY:
                          type: string
                          example: 'commodi incidunt'
                          description: 'Display label shown in the UI.'
                          nullable: true
                        UPD_DEFAULT_VALUE:
                          type: string
                          example: ''
                          description: 'Default value for new parameter instances.'
                        UPD_TYPE:
                          type: string
                          example: BOOL
                          description: 'Data type of the parameter value.'
                          enum:
                            - STRING
                            - NUM
                            - FLOAT
                            - PRICE
                            - BOOL
                            - DATE
                            - FILE
                            - PREMISEIDBOX
                            - PREMISEIDMEGA
                            - SELECT
                        UPD_INDEXED:
                          type: integer
                          example: 0
                          description: 'Whether the parameter values are indexed for search.'
                        UPD_DOMAIN:
                          type: string
                          example: null
                          description: 'Value constraints / domain (e.g. allowed values for SELECT type). JSON or delimited format.'
                          nullable: true
                        UPD_NOTNULL:
                          type: integer
                          example: 0
                          description: 'Whether this parameter is required (1 = mandatory, 0 = optional).'
                        UPD_TIME_RESOLUTION:
                          type: integer
                          example: 0
                          description: 'Whether temporal (valid_from/valid_to) resolution is enabled for this parameter.'
                        UPD_DISABLED:
                          type: integer
                          example: 0
                          description: 'Whether the definition is disabled (1 = disabled, 0 = active). Disabled definitions are excluded from listings by default.'
                        UPD_PUBLIC:
                          type: integer
                          example: 0
                          description: 'Whether the parameter is publicly visible.'
                        UPD_L_ID:
                          type: integer
                          example: 12
                          description: 'ID of the login session that created this definition.'
                        UPD_CREATED:
                          type: string
                          example: '2026-02-18 15:02:14'
                          description: 'Timestamp when this definition was created. Format: YYYY-MM-DD HH:MM:SS.'
                        UPD_DOC_VARNAME:
                          type: string
                          example: ''
                          description: 'Variable name used in document templates for this parameter.'
                        UPD_SHOW:
                          type: integer
                          example: 1
                          description: 'Whether to display the parameter on customer detail views.'
                        UPD_PAY_SHOW:
                          type: integer
                          example: 0
                          description: 'Whether to display the parameter in payment/billing context.'
                        UPD_PROVISIONING:
                          type: integer
                          example: 0
                          description: 'Whether this parameter is provisioned to external systems (e.g. Portax).'
                        UPD_SYSTEM:
                          type: string
                          example: 'N'
                          description: "System classification: 'N' = normal (user-defined), 'S' = system (managed by Mango), 'I' = internal (hidden from UI)."
                          enum:
                            - 'N'
                            - S
                            - I
                        UPD_SC_VISIBLE:
                          type: string
                          example: null
                          description: 'Whether the parameter is visible in the customer self-care portal.'
                          nullable: true
                        UPD_SC_EDITABLE:
                          type: string
                          example: null
                          description: 'Whether the parameter is editable by the customer in the self-care portal.'
                          nullable: true
                    required:
                      - UPD_ID
                      - UPD_CT
                      - UPD_TARGET
                      - UPD_NAME
                      - UPD_DISPLAY
                      - UPD_DEFAULT_VALUE
                      - UPD_TYPE
                      - UPD_INDEXED
                      - UPD_DOMAIN
                      - UPD_NOTNULL
                      - UPD_TIME_RESOLUTION
                      - UPD_DISABLED
                      - UPD_PUBLIC
                      - UPD_L_ID
                      - UPD_CREATED
                      - UPD_DOC_VARNAME
                      - UPD_SHOW
                      - UPD_PAY_SHOW
                      - UPD_PROVISIONING
                      - UPD_SYSTEM
                      - UPD_SC_VISIBLE
                      - UPD_SC_EDITABLE
      tags:
        - 'Customer Param Definitions'
  /api/v3/customer-service-discounts:
    get:
      summary: 'List Customer Service Discounts'
      operationId: listCustomerServiceDiscounts
      description: "Returns a paginated list of discounts applied to customer services.\nFilterable by customer, service, discount definition, status, and more.\nCT scoping is indirect — resolved via the customer's location."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page.'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated customer service discount IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated customer service discount IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Resolves indirectly via customer.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Resolves indirectly via customer.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID.'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID.'
            example: 100
        -
          in: query
          name: customer_service
          description: 'Filter by customer service (services_active) ID.'
          example: 500
          required: false
          schema:
            type: integer
            description: 'Filter by customer service (services_active) ID.'
            example: 500
        -
          in: query
          name: discount_definition
          description: 'Filter by discount definition (campaign) ID.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Filter by discount definition (campaign) ID.'
            example: 10
        -
          in: query
          name: status
          description: 'Filter by status. Comma-separated for multiple values.'
          example: 'ACTIVE,WAITING'
          required: false
          schema:
            type: string
            description: 'Filter by status. Comma-separated for multiple values.'
            example: 'ACTIVE,WAITING'
        -
          in: query
          name: active
          description: 'Shorthand: when true, returns only ACTIVE discounts. Ignored when `status` is provided.'
          example: true
          required: false
          schema:
            type: boolean
            description: 'Shorthand: when true, returns only ACTIVE discounts. Ignored when `status` is provided.'
            example: true
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      SAD_ID: 309747
                      SAD_U_ID: 5898
                      SAD_SA_ID: 3460
                      SAD_SD_ID: 50
                      SAD_DEP_SA_IDS: null
                      SAD_TYPE: percentage
                      SAD_VALUE: '60.3120'
                      SAD_START: '2017-04-10'
                      SAD_STOP: null
                      SAD_CREATED: '2026-01-31 23:59:26'
                      SAD_CREATOR_L_ID: 3899
                      SAD_STATUS: FINISHED
                      SAD_POINTS: null
                      SAD_SD_START_RECREATE: null
                      SAD_SADG_ID: null
                      SAD_END_NOTIFIED: null
                      SAD_STOP_FLOATING: null
                    -
                      SAD_ID: 309748
                      SAD_U_ID: 5398
                      SAD_SA_ID: 5931
                      SAD_SD_ID: 50
                      SAD_DEP_SA_IDS: null
                      SAD_TYPE: points
                      SAD_VALUE: '40.7577'
                      SAD_START: null
                      SAD_STOP: null
                      SAD_CREATED: '2026-04-08 15:43:10'
                      SAD_CREATOR_L_ID: 7286
                      SAD_STATUS: WAITING
                      SAD_POINTS: null
                      SAD_SD_START_RECREATE: null
                      SAD_SADG_ID: null
                      SAD_END_NOTIFIED: null
                      SAD_STOP_FLOATING: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        SAD_ID: 309747
                        SAD_U_ID: 5898
                        SAD_SA_ID: 3460
                        SAD_SD_ID: 50
                        SAD_DEP_SA_IDS: null
                        SAD_TYPE: percentage
                        SAD_VALUE: '60.3120'
                        SAD_START: '2017-04-10'
                        SAD_STOP: null
                        SAD_CREATED: '2026-01-31 23:59:26'
                        SAD_CREATOR_L_ID: 3899
                        SAD_STATUS: FINISHED
                        SAD_POINTS: null
                        SAD_SD_START_RECREATE: null
                        SAD_SADG_ID: null
                        SAD_END_NOTIFIED: null
                        SAD_STOP_FLOATING: null
                      -
                        SAD_ID: 309748
                        SAD_U_ID: 5398
                        SAD_SA_ID: 5931
                        SAD_SD_ID: 50
                        SAD_DEP_SA_IDS: null
                        SAD_TYPE: points
                        SAD_VALUE: '40.7577'
                        SAD_START: null
                        SAD_STOP: null
                        SAD_CREATED: '2026-04-08 15:43:10'
                        SAD_CREATOR_L_ID: 7286
                        SAD_STATUS: WAITING
                        SAD_POINTS: null
                        SAD_SD_START_RECREATE: null
                        SAD_SADG_ID: null
                        SAD_END_NOTIFIED: null
                        SAD_STOP_FLOATING: null
                    items:
                      type: object
                      properties:
                        SAD_ID:
                          type: integer
                          example: 309747
                          description: 'Active discount ID (primary key).'
                        SAD_U_ID:
                          type: integer
                          example: 5898
                          description: 'Customer ID. The customer who owns the discounted service. See GET /v3/customers/{id}.'
                        SAD_SA_ID:
                          type: integer
                          example: 3460
                          description: 'Active service ID. The service this discount is applied to. See GET /v3/customer-services/{id}.'
                        SAD_SD_ID:
                          type: integer
                          example: 50
                          description: 'Discount definition ID. The discount campaign template this instance is based on. See GET /v3/discount-definitions/{id}.'
                        SAD_DEP_SA_IDS:
                          type: string
                          example: null
                          description: 'Comma-separated list of dependent active service IDs. Links the discount to specific dependent services.'
                          nullable: true
                        SAD_TYPE:
                          type: string
                          example: percentage
                          description: 'Discount type. Determines how SAD_VALUE is interpreted.'
                          enum:
                            - percentage
                            - definite
                            - credit
                            - points
                        SAD_VALUE:
                          type: string
                          example: '60.3120'
                          description: 'Discount value. Interpretation depends on SAD_TYPE: percentage = % off, definite = fixed currency amount, credit = credit amount, points = point value.'
                        SAD_START:
                          type: string
                          example: '2017-04-10'
                          description: 'Discount validity start date (YYYY-MM-DD). If null, defaults to the service billing start (ACCOUNT_FROM).'
                          nullable: true
                        SAD_STOP:
                          type: string
                          example: null
                          description: 'Discount validity end date (YYYY-MM-DD). If null, the discount runs until the service billing end.'
                          nullable: true
                        SAD_CREATED:
                          type: string
                          example: '2026-01-31 23:59:26'
                          description: 'Timestamp when this discount was created (YYYY-MM-DD HH:MM:SS).'
                        SAD_CREATOR_L_ID:
                          type: integer
                          example: 3899
                          description: 'Creator operator (login) ID. The admin/operator who created this discount.'
                        SAD_STATUS:
                          type: string
                          example: FINISHED
                          description: 'Current status of the discount.'
                          enum:
                            - ACTIVE
                            - WAITING
                            - FINISHED
                        SAD_POINTS:
                          type: string
                          example: null
                          description: 'Loyalty/bonus points associated with this discount.'
                          nullable: true
                        SAD_SD_START_RECREATE:
                          type: string
                          example: null
                          description: 'Flag indicating whether the discount should be recreated on group discount start. 1 = recreate on start.'
                          nullable: true
                        SAD_SADG_ID:
                          type: string
                          example: null
                          description: 'Discount group ID. Groups related discounts together.'
                          nullable: true
                        SAD_END_NOTIFIED:
                          type: string
                          example: null
                          description: 'Timestamp when the discount end notification was sent (YYYY-MM-DD HH:MM:SS).'
                          nullable: true
                        SAD_STOP_FLOATING:
                          type: string
                          example: null
                          description: 'Floating (relative) end date for the discount (YYYY-MM-DD). Used when the discount duration is relative rather than fixed.'
                          nullable: true
                    required:
                      - SAD_ID
                      - SAD_U_ID
                      - SAD_SA_ID
                      - SAD_SD_ID
                      - SAD_DEP_SA_IDS
                      - SAD_TYPE
                      - SAD_VALUE
                      - SAD_START
                      - SAD_STOP
                      - SAD_CREATED
                      - SAD_CREATOR_L_ID
                      - SAD_STATUS
                      - SAD_POINTS
                      - SAD_SD_START_RECREATE
                      - SAD_SADG_ID
                      - SAD_END_NOTIFIED
                      - SAD_STOP_FLOATING
      tags:
        - 'Customer Service Discounts'
  '/api/v3/customer-service-discounts/{id}':
    get:
      summary: 'Get Customer Service Discount'
      operationId: getCustomerServiceDiscount
      description: 'Returns a single customer service discount by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    SAD_ID: 309749
                    SAD_U_ID: 2878
                    SAD_SA_ID: 2839
                    SAD_SD_ID: 50
                    SAD_DEP_SA_IDS: null
                    SAD_TYPE: definite
                    SAD_VALUE: '66.2031'
                    SAD_START: null
                    SAD_STOP: null
                    SAD_CREATED: '2026-03-22 08:46:47'
                    SAD_CREATOR_L_ID: 3940
                    SAD_STATUS: ACTIVE
                    SAD_POINTS: null
                    SAD_SD_START_RECREATE: null
                    SAD_SADG_ID: null
                    SAD_END_NOTIFIED: null
                    SAD_STOP_FLOATING: null
                properties:
                  data:
                    type: object
                    properties:
                      SAD_ID:
                        type: integer
                        example: 309749
                        description: 'Active discount ID (primary key).'
                      SAD_U_ID:
                        type: integer
                        example: 2878
                        description: 'Customer ID. The customer who owns the discounted service. See GET /v3/customers/{id}.'
                      SAD_SA_ID:
                        type: integer
                        example: 2839
                        description: 'Active service ID. The service this discount is applied to. See GET /v3/customer-services/{id}.'
                      SAD_SD_ID:
                        type: integer
                        example: 50
                        description: 'Discount definition ID. The discount campaign template this instance is based on. See GET /v3/discount-definitions/{id}.'
                      SAD_DEP_SA_IDS:
                        type: string
                        example: null
                        description: 'Comma-separated list of dependent active service IDs. Links the discount to specific dependent services.'
                        nullable: true
                      SAD_TYPE:
                        type: string
                        example: definite
                        description: 'Discount type. Determines how SAD_VALUE is interpreted.'
                        enum:
                          - percentage
                          - definite
                          - credit
                          - points
                      SAD_VALUE:
                        type: string
                        example: '66.2031'
                        description: 'Discount value. Interpretation depends on SAD_TYPE: percentage = % off, definite = fixed currency amount, credit = credit amount, points = point value.'
                      SAD_START:
                        type: string
                        example: null
                        description: 'Discount validity start date (YYYY-MM-DD). If null, defaults to the service billing start (ACCOUNT_FROM).'
                        nullable: true
                      SAD_STOP:
                        type: string
                        example: null
                        description: 'Discount validity end date (YYYY-MM-DD). If null, the discount runs until the service billing end.'
                        nullable: true
                      SAD_CREATED:
                        type: string
                        example: '2026-03-22 08:46:47'
                        description: 'Timestamp when this discount was created (YYYY-MM-DD HH:MM:SS).'
                      SAD_CREATOR_L_ID:
                        type: integer
                        example: 3940
                        description: 'Creator operator (login) ID. The admin/operator who created this discount.'
                      SAD_STATUS:
                        type: string
                        example: ACTIVE
                        description: 'Current status of the discount.'
                        enum:
                          - ACTIVE
                          - WAITING
                          - FINISHED
                      SAD_POINTS:
                        type: string
                        example: null
                        description: 'Loyalty/bonus points associated with this discount.'
                        nullable: true
                      SAD_SD_START_RECREATE:
                        type: string
                        example: null
                        description: 'Flag indicating whether the discount should be recreated on group discount start. 1 = recreate on start.'
                        nullable: true
                      SAD_SADG_ID:
                        type: string
                        example: null
                        description: 'Discount group ID. Groups related discounts together.'
                        nullable: true
                      SAD_END_NOTIFIED:
                        type: string
                        example: null
                        description: 'Timestamp when the discount end notification was sent (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      SAD_STOP_FLOATING:
                        type: string
                        example: null
                        description: 'Floating (relative) end date for the discount (YYYY-MM-DD). Used when the discount duration is relative rather than fixed.'
                        nullable: true
                    required:
                      - SAD_ID
                      - SAD_U_ID
                      - SAD_SA_ID
                      - SAD_SD_ID
                      - SAD_DEP_SA_IDS
                      - SAD_TYPE
                      - SAD_VALUE
                      - SAD_START
                      - SAD_STOP
                      - SAD_CREATED
                      - SAD_CREATOR_L_ID
                      - SAD_STATUS
                      - SAD_POINTS
                      - SAD_SD_START_RECREATE
                      - SAD_SADG_ID
                      - SAD_END_NOTIFIED
                      - SAD_STOP_FLOATING
      tags:
        - 'Customer Service Discounts'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer service discount.'
        example: 474
        required: true
        schema:
          type: integer
  /api/v3/customer-service-event-types:
    get:
      summary: 'List Service Event Types'
      operationId: listServiceEventTypes
      description: "Retrieve a paginated list of service event types.\nThis is a global codelist — no CT scoping is applied."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of results per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 60
                      NAME: 'Dobití kreditu na ústředně Phonet'
                      SET_PRICE_AFFECT: 0
                      SET_ATTACHMENT: 0
                      SET_MT_NAME: null
                      SET_CAN_DELETE: 0
                      SET_CAN_EDIT: 0
                      SET_EU_SHOW: 1
                      SET_PDC_ERASE: 1
                    -
                      ID: 19
                      NAME: 'Plán přenést zařízení'
                      SET_PRICE_AFFECT: 0
                      SET_ATTACHMENT: 0
                      SET_MT_NAME: null
                      SET_CAN_DELETE: 0
                      SET_CAN_EDIT: 0
                      SET_EU_SHOW: 0
                      SET_PDC_ERASE: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 60
                        NAME: 'Dobití kreditu na ústředně Phonet'
                        SET_PRICE_AFFECT: 0
                        SET_ATTACHMENT: 0
                        SET_MT_NAME: null
                        SET_CAN_DELETE: 0
                        SET_CAN_EDIT: 0
                        SET_EU_SHOW: 1
                        SET_PDC_ERASE: 1
                      -
                        ID: 19
                        NAME: 'Plán přenést zařízení'
                        SET_PRICE_AFFECT: 0
                        SET_ATTACHMENT: 0
                        SET_MT_NAME: null
                        SET_CAN_DELETE: 0
                        SET_CAN_EDIT: 0
                        SET_EU_SHOW: 0
                        SET_PDC_ERASE: 0
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 60
                          description: 'Unique event type identifier.'
                        NAME:
                          type: string
                          example: 'Dobití kreditu na ústředně Phonet'
                          description: 'Event type name (e.g. "Aktivace služby", "Změna ceny").'
                          nullable: true
                        SET_PRICE_AFFECT:
                          type: integer
                          example: 0
                          description: 'Whether this event type affects pricing.'
                          nullable: true
                        SET_ATTACHMENT:
                          type: integer
                          example: 0
                          description: 'Whether this event type supports file attachments.'
                        SET_MT_NAME:
                          type: string
                          example: null
                          description: 'Associated maintenance task type name.'
                          nullable: true
                        SET_CAN_DELETE:
                          type: integer
                          example: 0
                          description: 'Whether events of this type can be deleted (0=no, 1=yes, 2=conditional).'
                          nullable: true
                        SET_CAN_EDIT:
                          type: integer
                          example: 0
                          description: 'Whether events of this type can be edited.'
                        SET_EU_SHOW:
                          type: integer
                          example: 1
                          description: 'Whether this event type is visible in the end-user (selfcare) portal.'
                        SET_PDC_ERASE:
                          type: integer
                          example: 1
                          description: 'Whether events of this type are erased during personal data cleanup.'
                    required:
                      - ID
                      - NAME
                      - SET_PRICE_AFFECT
                      - SET_ATTACHMENT
                      - SET_MT_NAME
                      - SET_CAN_DELETE
                      - SET_CAN_EDIT
                      - SET_EU_SHOW
                      - SET_PDC_ERASE
      tags:
        - 'Customer Service Event Types'
  /api/v3/customer-service-history:
    get:
      summary: 'List Service History'
      operationId: listServiceHistory
      description: "Retrieve a paginated list of service history events.\nAt least one identifying filter (customer, service_id, customer_service, or event_type) is required."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of results per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated service history IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated service history IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer ID (USER_ID)'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer ID (USER_ID)'
            example: 100
        -
          in: query
          name: service_id
          description: 'Filter by service definition ID (SERVICE_ID)'
          example: 50
          required: false
          schema:
            type: integer
            description: 'Filter by service definition ID (SERVICE_ID)'
            example: 50
        -
          in: query
          name: customer_service
          description: 'Filter by active service instance ID (USER_SERVICE_ID)'
          example: 200
          required: false
          schema:
            type: integer
            description: 'Filter by active service instance ID (USER_SERVICE_ID)'
            example: 200
        -
          in: query
          name: event_type
          description: 'Filter by event type ID (EVENT_TYPE)'
          example: 4
          required: false
          schema:
            type: integer
            description: 'Filter by event type ID (EVENT_TYPE)'
            example: 4
        -
          in: query
          name: created_from
          description: 'Filter events created on or after this date/datetime (TIME column)'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter events created on or after this date/datetime (TIME column)'
            example: '2024-01-01'
        -
          in: query
          name: created_to
          description: 'Filter events created on or before this date/datetime (TIME column)'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter events created on or before this date/datetime (TIME column)'
            example: '2024-12-31'
        -
          in: query
          name: search
          description: 'Search by event note title (partial match on NOTE_TITLE)'
          example: Aktivace
          required: false
          schema:
            type: string
            description: 'Search by event note title (partial match on NOTE_TITLE)'
            example: Aktivace
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 779485313
                      USER_ID: 2878
                      SERVICE_ID: 0
                      USER_SERVICE_ID: 0
                      TIME: '2026-01-25 18:27:49'
                      CHANGE_TIME: '2006-09-20'
                      EVENT_TYPE: 3
                      PRICE: null
                      PAYMENT_DEPRECATED: null
                      SH_PERIOD: none
                      NOTE_TITLE: null
                      NOTE_BODY: null
                      ADD_PARAM: null
                      AUTHOR: 0
                      SH_TRANSFER: 0
                      SH_CRM_CHANNEL: null
                      SH_DR_ID: null
                      SH_SELFCARE: 0
                      params:
                        -
                          SHP_ID: 20477919
                          SHP_SH_ID: 779485313
                          SHP_NAME: qui
                          SHP_VALUE: 'Incidunt iure odit et et modi ipsum.'
                    -
                      ID: 779485314
                      USER_ID: 6877
                      SERVICE_ID: 0
                      USER_SERVICE_ID: 0
                      TIME: '2026-01-21 11:27:33'
                      CHANGE_TIME: '2009-07-27'
                      EVENT_TYPE: 7
                      PRICE: null
                      PAYMENT_DEPRECATED: null
                      SH_PERIOD: none
                      NOTE_TITLE: null
                      NOTE_BODY: null
                      ADD_PARAM: null
                      AUTHOR: 0
                      SH_TRANSFER: 0
                      SH_CRM_CHANNEL: null
                      SH_DR_ID: null
                      SH_SELFCARE: 0
                      params:
                        -
                          SHP_ID: 20477920
                          SHP_SH_ID: 779485314
                          SHP_NAME: consequatur
                          SHP_VALUE: 'Dolores enim non facere tempora.'
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 779485313
                        USER_ID: 2878
                        SERVICE_ID: 0
                        USER_SERVICE_ID: 0
                        TIME: '2026-01-25 18:27:49'
                        CHANGE_TIME: '2006-09-20'
                        EVENT_TYPE: 3
                        PRICE: null
                        PAYMENT_DEPRECATED: null
                        SH_PERIOD: none
                        NOTE_TITLE: null
                        NOTE_BODY: null
                        ADD_PARAM: null
                        AUTHOR: 0
                        SH_TRANSFER: 0
                        SH_CRM_CHANNEL: null
                        SH_DR_ID: null
                        SH_SELFCARE: 0
                        params:
                          -
                            SHP_ID: 20477919
                            SHP_SH_ID: 779485313
                            SHP_NAME: qui
                            SHP_VALUE: 'Incidunt iure odit et et modi ipsum.'
                      -
                        ID: 779485314
                        USER_ID: 6877
                        SERVICE_ID: 0
                        USER_SERVICE_ID: 0
                        TIME: '2026-01-21 11:27:33'
                        CHANGE_TIME: '2009-07-27'
                        EVENT_TYPE: 7
                        PRICE: null
                        PAYMENT_DEPRECATED: null
                        SH_PERIOD: none
                        NOTE_TITLE: null
                        NOTE_BODY: null
                        ADD_PARAM: null
                        AUTHOR: 0
                        SH_TRANSFER: 0
                        SH_CRM_CHANNEL: null
                        SH_DR_ID: null
                        SH_SELFCARE: 0
                        params:
                          -
                            SHP_ID: 20477920
                            SHP_SH_ID: 779485314
                            SHP_NAME: consequatur
                            SHP_VALUE: 'Dolores enim non facere tempora.'
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 779485313
                          description: 'Unique service history event identifier.'
                        USER_ID:
                          type: integer
                          example: 2878
                          description: 'Customer ID. See GET /v3/customers/{id}.'
                        SERVICE_ID:
                          type: integer
                          example: 0
                          description: 'Service definition ID. See GET /v3/service-definitions/{id}.'
                        USER_SERVICE_ID:
                          type: integer
                          example: 0
                          description: 'Active service instance ID. See GET /v3/customer-services/{id}.'
                        TIME:
                          type: string
                          example: '2026-01-25 18:27:49'
                          description: 'Event creation timestamp (datetime).'
                        CHANGE_TIME:
                          type: string
                          example: '2006-09-20'
                          description: 'Event effective/validity date.'
                        EVENT_TYPE:
                          type: integer
                          example: 3
                          description: 'Event type ID. See GET /v3/customer-service-event-types.'
                        PRICE:
                          type: string
                          example: null
                          description: 'Event-related price value.'
                          nullable: true
                        PAYMENT_DEPRECATED:
                          type: string
                          example: null
                          nullable: true
                        SH_PERIOD:
                          type: string
                          example: none
                          description: 'Billing period associated with this event.'
                        NOTE_TITLE:
                          type: string
                          example: null
                          description: 'Event note title / short description.'
                          nullable: true
                        NOTE_BODY:
                          type: string
                          example: null
                          description: 'Event detailed description (long text).'
                          nullable: true
                        ADD_PARAM:
                          type: string
                          example: null
                          description: 'Additional parameter string.'
                          nullable: true
                        AUTHOR:
                          type: integer
                          example: 0
                          description: 'Login ID of the operator who created this event.'
                        SH_TRANSFER:
                          type: integer
                          example: 0
                          description: 'Transfer flag.'
                          nullable: true
                        SH_CRM_CHANNEL:
                          type: string
                          example: null
                          description: 'CRM/sales channel identifier.'
                          nullable: true
                        SH_DR_ID:
                          type: string
                          example: null
                          description: 'Debt recovery process ID.'
                          nullable: true
                        SH_SELFCARE:
                          type: integer
                          example: 0
                          description: 'Whether the event originated from selfcare (end-user portal).'
                        params:
                          type: array
                          example:
                            -
                              SHP_ID: 20477919
                              SHP_SH_ID: 779485313
                              SHP_NAME: qui
                              SHP_VALUE: 'Incidunt iure odit et et modi ipsum.'
                          description: 'Historical parameter snapshots associated with this event.'
                          items:
                            type: object
                            properties:
                              SHP_ID:
                                type: integer
                                example: 20477919
                              SHP_SH_ID:
                                type: integer
                                example: 779485313
                              SHP_NAME:
                                type: string
                                example: qui
                              SHP_VALUE:
                                type: string
                                example: 'Incidunt iure odit et et modi ipsum.'
                    required:
                      - ID
                      - USER_ID
                      - SERVICE_ID
                      - USER_SERVICE_ID
                      - TIME
                      - CHANGE_TIME
                      - EVENT_TYPE
                      - PRICE
                      - SH_PERIOD
                      - NOTE_TITLE
                      - NOTE_BODY
                      - ADD_PARAM
                      - AUTHOR
                      - SH_TRANSFER
                      - SH_CRM_CHANNEL
                      - SH_DR_ID
                      - SH_SELFCARE
                      - params
      tags:
        - 'Customer Service History'
  '/api/v3/customer-service-history/{id}':
    get:
      summary: 'Get Service History Event'
      operationId: getServiceHistoryEvent
      description: 'Retrieve a specific service history event by ID, including its parameter snapshots.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 779485315
                    USER_ID: 2878
                    SERVICE_ID: 0
                    USER_SERVICE_ID: 0
                    TIME: '2026-01-25 18:24:08'
                    CHANGE_TIME: '2006-09-20'
                    EVENT_TYPE: 3
                    PRICE: null
                    PAYMENT_DEPRECATED: null
                    SH_PERIOD: none
                    NOTE_TITLE: null
                    NOTE_BODY: null
                    ADD_PARAM: null
                    AUTHOR: 0
                    SH_TRANSFER: 0
                    SH_CRM_CHANNEL: null
                    SH_DR_ID: null
                    SH_SELFCARE: 0
                    params:
                      -
                        SHP_ID: 20477921
                        SHP_SH_ID: 779485315
                        SHP_NAME: qui
                        SHP_VALUE: 'Incidunt iure odit et et modi ipsum.'
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 779485315
                        description: 'Unique service history event identifier.'
                      USER_ID:
                        type: integer
                        example: 2878
                        description: 'Customer ID. See GET /v3/customers/{id}.'
                      SERVICE_ID:
                        type: integer
                        example: 0
                        description: 'Service definition ID. See GET /v3/service-definitions/{id}.'
                      USER_SERVICE_ID:
                        type: integer
                        example: 0
                        description: 'Active service instance ID. See GET /v3/customer-services/{id}.'
                      TIME:
                        type: string
                        example: '2026-01-25 18:24:08'
                        description: 'Event creation timestamp (datetime).'
                      CHANGE_TIME:
                        type: string
                        example: '2006-09-20'
                        description: 'Event effective/validity date.'
                      EVENT_TYPE:
                        type: integer
                        example: 3
                        description: 'Event type ID. See GET /v3/customer-service-event-types.'
                      PRICE:
                        type: string
                        example: null
                        description: 'Event-related price value.'
                        nullable: true
                      PAYMENT_DEPRECATED:
                        type: string
                        example: null
                        nullable: true
                      SH_PERIOD:
                        type: string
                        example: none
                        description: 'Billing period associated with this event.'
                      NOTE_TITLE:
                        type: string
                        example: null
                        description: 'Event note title / short description.'
                        nullable: true
                      NOTE_BODY:
                        type: string
                        example: null
                        description: 'Event detailed description (long text).'
                        nullable: true
                      ADD_PARAM:
                        type: string
                        example: null
                        description: 'Additional parameter string.'
                        nullable: true
                      AUTHOR:
                        type: integer
                        example: 0
                        description: 'Login ID of the operator who created this event.'
                      SH_TRANSFER:
                        type: integer
                        example: 0
                        description: 'Transfer flag.'
                        nullable: true
                      SH_CRM_CHANNEL:
                        type: string
                        example: null
                        description: 'CRM/sales channel identifier.'
                        nullable: true
                      SH_DR_ID:
                        type: string
                        example: null
                        description: 'Debt recovery process ID.'
                        nullable: true
                      SH_SELFCARE:
                        type: integer
                        example: 0
                        description: 'Whether the event originated from selfcare (end-user portal).'
                      params:
                        type: array
                        example:
                          -
                            SHP_ID: 20477921
                            SHP_SH_ID: 779485315
                            SHP_NAME: qui
                            SHP_VALUE: 'Incidunt iure odit et et modi ipsum.'
                        description: 'Historical parameter snapshots associated with this event.'
                        items:
                          type: object
                          properties:
                            SHP_ID:
                              type: integer
                              example: 20477921
                            SHP_SH_ID:
                              type: integer
                              example: 779485315
                            SHP_NAME:
                              type: string
                              example: qui
                            SHP_VALUE:
                              type: string
                              example: 'Incidunt iure odit et et modi ipsum.'
                    required:
                      - ID
                      - USER_ID
                      - SERVICE_ID
                      - USER_SERVICE_ID
                      - TIME
                      - CHANGE_TIME
                      - EVENT_TYPE
                      - PRICE
                      - SH_PERIOD
                      - NOTE_TITLE
                      - NOTE_BODY
                      - ADD_PARAM
                      - AUTHOR
                      - SH_TRANSFER
                      - SH_CRM_CHANNEL
                      - SH_DR_ID
                      - SH_SELFCARE
                      - params
      tags:
        - 'Customer Service History'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer service history.'
        example: 123
        required: true
        schema:
          type: integer
  /api/v3/customer-services:
    get:
      summary: 'List Customer Services'
      operationId: listCustomerServices
      description: "Returns a paginated list of customer services.\nBy default, cancelled services (state 02) are excluded."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated service IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated service IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: user
          description: 'Filter by customer (user) ID'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID'
            example: 100
        -
          in: query
          name: state
          description: 'Filter by comma-separated state codes. Default: excludes cancelled (02)'
          example: '01,03'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated state codes. Default: excludes cancelled (02)'
            example: '01,03'
        -
          in: query
          name: periodic
          description: 'Filter by periodic billing: true = monthly (TYPE=M), false = one-time (TYPE=S)'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by periodic billing: true = monthly (TYPE=M), false = one-time (TYPE=S)'
            example: 'true'
        -
          in: query
          name: dependent
          description: 'Filter by dependency: true = dependent services, false = base services'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by dependency: true = dependent services, false = base services'
            example: 'true'
        -
          in: query
          name: base_service
          description: 'Filter dependent services linked to a specific base service ID'
          example: 500
          required: false
          schema:
            type: integer
            description: 'Filter dependent services linked to a specific base service ID'
            example: 500
        -
          in: query
          name: device
          description: 'Filter services linked to a specific device (node) ID'
          example: 200
          required: false
          schema:
            type: integer
            description: 'Filter services linked to a specific device (node) ID'
            example: 200
        -
          in: query
          name: provider
          description: 'Filter by provider user ID'
          example: 500
          required: false
          schema:
            type: integer
            description: 'Filter by provider user ID'
            example: 500
        -
          in: query
          name: service_definition
          description: 'Filter by comma-separated service definition IDs'
          example: '10,20,30'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated service definition IDs'
            example: '10,20,30'
        -
          in: query
          name: billing_plan
          description: 'Filter by current billing plan ID'
          example: 42
          required: false
          schema:
            type: integer
            description: 'Filter by current billing plan ID'
            example: 42
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 4597998
                      USER_ID: '02878'
                      SERVICE_ID: '2839'
                      PRICE: '3668.8918'
                      DATE_START: '2015-01-19'
                      DATE_END: null
                      STATE: '01'
                      PAYMENT_DEPRECATED: null
                      ACCOUNT_FROM: '2022-12-10'
                      ACCOUNT_TO: null
                      DUE_DATE: 30
                      VAR_SYMBOL: null
                      ACCORD_NUM: null
                      TRADING_LIMIT: null
                      SA_TRADING_LIMIT_ALERTED: 0
                      CUSTOMER_CHANGE_DEPRECATED: null
                      SA_PERIOD: cyear
                      SA_LOCATION: null
                      SA_TAX_CLOSURE: null
                      SA_TAX_PREV_CLOSURE: null
                      NOTE: null
                      SA_INV_NOTE: null
                      SA_P_ID: null
                      SA_CANCEL_REASON: null
                      SA_AGREEMENT_DATE: null
                      SA_NEEDS_PROCESS: null
                      SA_CREATED: '2026-04-20 09:25:47'
                      SA_SALESMAN_ID: null
                      SA_MOVING: 0
                      SA_MOVE_DATA: null
                      SA_BOND_START: null
                      SA_NODEAVAIL_SGD_ID: null
                      SA_NAME: null
                      SA_PROVIDER_USER_ID: null
                      SA_PAY_TO: null
                      SA_DATE_BASE: null
                      params:
                        -
                          SP_ID: '0003572868'
                          SP_SRV_ID: 4597998
                          SP_NAME: msisdn
                          SP_VALID_FROM: '1973-12-12'
                          SP_VALID_TO: null
                          SP_VALUE: ipsum
                          SP_CREATED: '2026-01-07 20:24:45'
                          SP_L_ID: '007018'
                      discounts:
                        -
                          SAD_ID: 309741
                          SAD_U_ID: 4486
                          SAD_SA_ID: 4597998
                          SAD_SD_ID: 50
                          SAD_DEP_SA_IDS: null
                          SAD_TYPE: points
                          SAD_VALUE: '72.9772'
                          SAD_START: '1997-06-16'
                          SAD_STOP: null
                          SAD_CREATED: '2026-01-09 22:22:49'
                          SAD_CREATOR_L_ID: 2327
                          SAD_STATUS: FINISHED
                          SAD_POINTS: null
                          SAD_SD_START_RECREATE: null
                          SAD_SADG_ID: null
                          SAD_END_NOTIFIED: null
                          SAD_STOP_FLOATING: null
                    -
                      ID: 4597999
                      USER_ID: '05468'
                      SERVICE_ID: '5937'
                      PRICE: '8661.9358'
                      DATE_START: '2023-08-06'
                      DATE_END: null
                      STATE: '02'
                      PAYMENT_DEPRECATED: null
                      ACCOUNT_FROM: '1975-04-26'
                      ACCOUNT_TO: null
                      DUE_DATE: 30
                      VAR_SYMBOL: null
                      ACCORD_NUM: null
                      TRADING_LIMIT: null
                      SA_TRADING_LIMIT_ALERTED: 0
                      CUSTOMER_CHANGE_DEPRECATED: null
                      SA_PERIOD: none
                      SA_LOCATION: Daphneview
                      SA_TAX_CLOSURE: null
                      SA_TAX_PREV_CLOSURE: null
                      NOTE: 'Libero aliquam veniam corporis dolorem mollitia deleniti.'
                      SA_INV_NOTE: null
                      SA_P_ID: null
                      SA_CANCEL_REASON: null
                      SA_AGREEMENT_DATE: null
                      SA_NEEDS_PROCESS: null
                      SA_CREATED: '2026-04-20 09:25:47'
                      SA_SALESMAN_ID: null
                      SA_MOVING: 0
                      SA_MOVE_DATA: null
                      SA_BOND_START: null
                      SA_NODEAVAIL_SGD_ID: null
                      SA_NAME: null
                      SA_PROVIDER_USER_ID: null
                      SA_PAY_TO: null
                      SA_DATE_BASE: null
                      params:
                        -
                          SP_ID: '0003572869'
                          SP_SRV_ID: 4597999
                          SP_NAME: msisdn
                          SP_VALID_FROM: '1976-08-28'
                          SP_VALID_TO: null
                          SP_VALUE: officia
                          SP_CREATED: '2026-01-09 08:20:25'
                          SP_L_ID: '008925'
                      discounts:
                        -
                          SAD_ID: 309742
                          SAD_U_ID: 2531
                          SAD_SA_ID: 4597999
                          SAD_SD_ID: 50
                          SAD_DEP_SA_IDS: null
                          SAD_TYPE: points
                          SAD_VALUE: '88.4282'
                          SAD_START: null
                          SAD_STOP: null
                          SAD_CREATED: '2026-01-24 01:36:45'
                          SAD_CREATOR_L_ID: 5560
                          SAD_STATUS: WAITING
                          SAD_POINTS: null
                          SAD_SD_START_RECREATE: null
                          SAD_SADG_ID: null
                          SAD_END_NOTIFIED: null
                          SAD_STOP_FLOATING: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 4597998
                        USER_ID: '02878'
                        SERVICE_ID: '2839'
                        PRICE: '3668.8918'
                        DATE_START: '2015-01-19'
                        DATE_END: null
                        STATE: '01'
                        PAYMENT_DEPRECATED: null
                        ACCOUNT_FROM: '2022-12-10'
                        ACCOUNT_TO: null
                        DUE_DATE: 30
                        VAR_SYMBOL: null
                        ACCORD_NUM: null
                        TRADING_LIMIT: null
                        SA_TRADING_LIMIT_ALERTED: 0
                        CUSTOMER_CHANGE_DEPRECATED: null
                        SA_PERIOD: cyear
                        SA_LOCATION: null
                        SA_TAX_CLOSURE: null
                        SA_TAX_PREV_CLOSURE: null
                        NOTE: null
                        SA_INV_NOTE: null
                        SA_P_ID: null
                        SA_CANCEL_REASON: null
                        SA_AGREEMENT_DATE: null
                        SA_NEEDS_PROCESS: null
                        SA_CREATED: '2026-04-20 09:25:47'
                        SA_SALESMAN_ID: null
                        SA_MOVING: 0
                        SA_MOVE_DATA: null
                        SA_BOND_START: null
                        SA_NODEAVAIL_SGD_ID: null
                        SA_NAME: null
                        SA_PROVIDER_USER_ID: null
                        SA_PAY_TO: null
                        SA_DATE_BASE: null
                        params:
                          -
                            SP_ID: '0003572868'
                            SP_SRV_ID: 4597998
                            SP_NAME: msisdn
                            SP_VALID_FROM: '1973-12-12'
                            SP_VALID_TO: null
                            SP_VALUE: ipsum
                            SP_CREATED: '2026-01-07 20:24:45'
                            SP_L_ID: '007018'
                        discounts:
                          -
                            SAD_ID: 309741
                            SAD_U_ID: 4486
                            SAD_SA_ID: 4597998
                            SAD_SD_ID: 50
                            SAD_DEP_SA_IDS: null
                            SAD_TYPE: points
                            SAD_VALUE: '72.9772'
                            SAD_START: '1997-06-16'
                            SAD_STOP: null
                            SAD_CREATED: '2026-01-09 22:22:49'
                            SAD_CREATOR_L_ID: 2327
                            SAD_STATUS: FINISHED
                            SAD_POINTS: null
                            SAD_SD_START_RECREATE: null
                            SAD_SADG_ID: null
                            SAD_END_NOTIFIED: null
                            SAD_STOP_FLOATING: null
                      -
                        ID: 4597999
                        USER_ID: '05468'
                        SERVICE_ID: '5937'
                        PRICE: '8661.9358'
                        DATE_START: '2023-08-06'
                        DATE_END: null
                        STATE: '02'
                        PAYMENT_DEPRECATED: null
                        ACCOUNT_FROM: '1975-04-26'
                        ACCOUNT_TO: null
                        DUE_DATE: 30
                        VAR_SYMBOL: null
                        ACCORD_NUM: null
                        TRADING_LIMIT: null
                        SA_TRADING_LIMIT_ALERTED: 0
                        CUSTOMER_CHANGE_DEPRECATED: null
                        SA_PERIOD: none
                        SA_LOCATION: Daphneview
                        SA_TAX_CLOSURE: null
                        SA_TAX_PREV_CLOSURE: null
                        NOTE: 'Libero aliquam veniam corporis dolorem mollitia deleniti.'
                        SA_INV_NOTE: null
                        SA_P_ID: null
                        SA_CANCEL_REASON: null
                        SA_AGREEMENT_DATE: null
                        SA_NEEDS_PROCESS: null
                        SA_CREATED: '2026-04-20 09:25:47'
                        SA_SALESMAN_ID: null
                        SA_MOVING: 0
                        SA_MOVE_DATA: null
                        SA_BOND_START: null
                        SA_NODEAVAIL_SGD_ID: null
                        SA_NAME: null
                        SA_PROVIDER_USER_ID: null
                        SA_PAY_TO: null
                        SA_DATE_BASE: null
                        params:
                          -
                            SP_ID: '0003572869'
                            SP_SRV_ID: 4597999
                            SP_NAME: msisdn
                            SP_VALID_FROM: '1976-08-28'
                            SP_VALID_TO: null
                            SP_VALUE: officia
                            SP_CREATED: '2026-01-09 08:20:25'
                            SP_L_ID: '008925'
                        discounts:
                          -
                            SAD_ID: 309742
                            SAD_U_ID: 2531
                            SAD_SA_ID: 4597999
                            SAD_SD_ID: 50
                            SAD_DEP_SA_IDS: null
                            SAD_TYPE: points
                            SAD_VALUE: '88.4282'
                            SAD_START: null
                            SAD_STOP: null
                            SAD_CREATED: '2026-01-24 01:36:45'
                            SAD_CREATOR_L_ID: 5560
                            SAD_STATUS: WAITING
                            SAD_POINTS: null
                            SAD_SD_START_RECREATE: null
                            SAD_SADG_ID: null
                            SAD_END_NOTIFIED: null
                            SAD_STOP_FLOATING: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 4597998
                          description: 'Active service ID (primary key).'
                        USER_ID:
                          type: string
                          example: '02878'
                          description: 'Customer ID. The customer who owns this service. See GET /v3/customers/{id}.'
                        SERVICE_ID:
                          type: string
                          example: '2839'
                          description: 'Service definition ID. The definition this active service is based on. See GET /v3/service-definitions/{id}.'
                        PRICE:
                          type: string
                          example: '3668.8918'
                          description: 'Price with VAT for this active service (one-time or per billing period).'
                        DATE_START:
                          type: string
                          example: '2015-01-19'
                          description: 'Service provision start date (YYYY-MM-DD).'
                        DATE_END:
                          type: string
                          example: null
                          description: 'Service provision end date (YYYY-MM-DD). Null if the service is still active (open-ended).'
                          nullable: true
                        STATE:
                          type: string
                          example: '01'
                          description: 'Service state. 0 = blocked, 1 = active, 2 = cancelled, 3 = not connected (pending provisioning).'
                        PAYMENT_DEPRECATED:
                          type: string
                          example: null
                          description: 'Deprecated payment field. No longer in active use.'
                          nullable: true
                        ACCOUNT_FROM:
                          type: string
                          example: '2022-12-10'
                          description: 'Billing start date (YYYY-MM-DD). Charges begin from this date.'
                        ACCOUNT_TO:
                          type: string
                          example: null
                          description: 'Billing end date (YYYY-MM-DD). Null while billing is ongoing.'
                          nullable: true
                        DUE_DATE:
                          type: integer
                          example: 30
                          description: 'Payment due period in days. Default: 30.'
                        VAR_SYMBOL:
                          type: string
                          example: null
                          description: 'Variable symbol (payment identifier) for this service.'
                          nullable: true
                        ACCORD_NUM:
                          type: string
                          example: null
                          description: 'Accord number (agreement/contract reference).'
                          nullable: true
                        TRADING_LIMIT:
                          type: string
                          example: null
                          description: 'Minimum commitment (bond) expiration date (YYYY-MM-DD).'
                          nullable: true
                        SA_TRADING_LIMIT_ALERTED:
                          type: integer
                          example: 0
                          description: 'Flag indicating the TRADING_LIMIT has been changed but not yet alerted. 1 = change pending alert.'
                        CUSTOMER_CHANGE_DEPRECATED:
                          type: string
                          example: null
                          description: 'Deprecated customer change flag. No longer in active use.'
                          nullable: true
                        SA_PERIOD:
                          type: string
                          example: cyear
                          description: "Billing period. Possible values: 'month', 'cquarter', 'chalfyear', 'cyear', 'cyears2', 'cyears3', 'cmonths18', 'vmonth', 'vquarter', 'vhalfyear', 'vyear', 'vyears2', 'vyears3', 'vmonths18', 'all', 'none'. Prefix 'c' = calendar-aligned, 'v' = anniversary-aligned."
                          enum:
                            - all
                            - chalfyear
                            - cquarter
                            - cyear
                            - month
                            - none
                            - vhalfyear
                            - vmonth
                            - vquarter
                            - vyear
                            - cyears2
                            - cyears3
                            - cmonths18
                            - vyears2
                            - vyears3
                            - vmonths18
                        SA_LOCATION:
                          type: string
                          example: null
                          description: 'Service location identifier (free-text).'
                          nullable: true
                        SA_TAX_CLOSURE:
                          type: string
                          example: null
                          description: 'Last billing closure date for this service (YYYY-MM-DD).'
                          nullable: true
                        SA_TAX_PREV_CLOSURE:
                          type: string
                          example: null
                          description: 'Previous billing closure date, before the last closure (YYYY-MM-DD).'
                          nullable: true
                        NOTE:
                          type: string
                          example: null
                          description: 'Note / remark for this service.'
                          nullable: true
                        SA_INV_NOTE:
                          type: string
                          example: null
                          description: 'Invoice note. Text printed on invoices for this service.'
                          nullable: true
                        SA_P_ID:
                          type: string
                          example: null
                          description: 'Premise ID (point of presence / service delivery location).'
                          nullable: true
                        SA_CANCEL_REASON:
                          type: string
                          example: null
                          description: 'Cancellation reason code (code list entry ID).'
                          nullable: true
                        SA_AGREEMENT_DATE:
                          type: string
                          example: null
                          description: 'Agreement (contract) date for this service (YYYY-MM-DD).'
                          nullable: true
                        SA_NEEDS_PROCESS:
                          type: string
                          example: null
                          description: 'Process (maintenance ticket) ID required for provisioning this service.'
                          nullable: true
                        SA_CREATED:
                          type: string
                          example: '2026-04-20 09:25:47'
                          description: 'Timestamp when this service was activated/created.'
                        SA_SALESMAN_ID:
                          type: string
                          example: null
                          description: 'Salesman (admin/operator) ID who activated or manages this service.'
                          nullable: true
                        SA_MOVING:
                          type: integer
                          example: 0
                          description: 'Moving flag. 1 = service is in the moving (relocation) processing phase. Relevant when the base service definition has SN_MOVE_SPLITTED = 1.'
                        SA_MOVE_DATA:
                          type: string
                          example: null
                          description: 'Additional data for the service move operation.'
                          nullable: true
                        SA_BOND_START:
                          type: string
                          example: null
                          description: 'Minimum commitment (bond) start date (YYYY-MM-DD). Preserved across service transfers.'
                          nullable: true
                        SA_NODEAVAIL_SGD_ID:
                          type: string
                          example: null
                          description: 'Node availability service group definition ID (process/technology group). See GET /v3/service-groups.'
                          nullable: true
                        SA_NAME:
                          type: string
                          example: null
                          description: 'Commercial (custom) service name. Overrides the default service definition name when set.'
                          nullable: true
                        SA_PROVIDER_USER_ID:
                          type: string
                          example: null
                          description: 'Provider (operator) customer ID. See GET /v3/customers/{id}.'
                          nullable: true
                        SA_PAY_TO:
                          type: string
                          example: null
                          description: 'Service prepaid expiration date (YYYY-MM-DD). Paid until this date.'
                          nullable: true
                        SA_DATE_BASE:
                          type: string
                          example: null
                          description: 'Base date for anniversary-based billing period calculations (YYYY-MM-DD).'
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              SP_ID: '0003572868'
                              SP_SRV_ID: 4597998
                              SP_NAME: msisdn
                              SP_VALID_FROM: '1973-12-12'
                              SP_VALID_TO: null
                              SP_VALUE: ipsum
                              SP_CREATED: '2026-01-07 20:24:45'
                              SP_L_ID: '007018'
                          description: 'Service parameter key-value pairs.'
                          items:
                            type: object
                            properties:
                              SP_ID:
                                type: string
                                example: '0003572868'
                              SP_SRV_ID:
                                type: integer
                                example: 4597998
                              SP_NAME:
                                type: string
                                example: msisdn
                              SP_VALID_FROM:
                                type: string
                                example: '1973-12-12'
                              SP_VALID_TO:
                                type: string
                                example: null
                                nullable: true
                              SP_VALUE:
                                type: string
                                example: ipsum
                              SP_CREATED:
                                type: string
                                example: '2026-01-07 20:24:45'
                              SP_L_ID:
                                type: string
                                example: '007018'
                        discounts:
                          type: array
                          example:
                            -
                              SAD_ID: 309741
                              SAD_U_ID: 4486
                              SAD_SA_ID: 4597998
                              SAD_SD_ID: 50
                              SAD_DEP_SA_IDS: null
                              SAD_TYPE: points
                              SAD_VALUE: '72.9772'
                              SAD_START: '1997-06-16'
                              SAD_STOP: null
                              SAD_CREATED: '2026-01-09 22:22:49'
                              SAD_CREATOR_L_ID: 2327
                              SAD_STATUS: FINISHED
                              SAD_POINTS: null
                              SAD_SD_START_RECREATE: null
                              SAD_SADG_ID: null
                              SAD_END_NOTIFIED: null
                              SAD_STOP_FLOATING: null
                          description: 'Active discounts applied to this service.'
                          items:
                            type: object
                            properties:
                              SAD_ID:
                                type: integer
                                example: 309741
                              SAD_U_ID:
                                type: integer
                                example: 4486
                              SAD_SA_ID:
                                type: integer
                                example: 4597998
                              SAD_SD_ID:
                                type: integer
                                example: 50
                              SAD_DEP_SA_IDS:
                                type: string
                                example: null
                                nullable: true
                              SAD_TYPE:
                                type: string
                                example: points
                              SAD_VALUE:
                                type: string
                                example: '72.9772'
                              SAD_START:
                                type: string
                                example: '1997-06-16'
                              SAD_STOP:
                                type: string
                                example: null
                                nullable: true
                              SAD_CREATED:
                                type: string
                                example: '2026-01-09 22:22:49'
                              SAD_CREATOR_L_ID:
                                type: integer
                                example: 2327
                              SAD_STATUS:
                                type: string
                                example: FINISHED
                              SAD_POINTS:
                                type: string
                                example: null
                                nullable: true
                              SAD_SD_START_RECREATE:
                                type: string
                                example: null
                                nullable: true
                              SAD_SADG_ID:
                                type: string
                                example: null
                                nullable: true
                              SAD_END_NOTIFIED:
                                type: string
                                example: null
                                nullable: true
                              SAD_STOP_FLOATING:
                                type: string
                                example: null
                                nullable: true
                    required:
                      - ID
                      - USER_ID
                      - SERVICE_ID
                      - PRICE
                      - DATE_START
                      - DATE_END
                      - STATE
                      - PAYMENT_DEPRECATED
                      - ACCOUNT_FROM
                      - ACCOUNT_TO
                      - DUE_DATE
                      - VAR_SYMBOL
                      - ACCORD_NUM
                      - TRADING_LIMIT
                      - SA_TRADING_LIMIT_ALERTED
                      - CUSTOMER_CHANGE_DEPRECATED
                      - SA_PERIOD
                      - SA_LOCATION
                      - SA_TAX_CLOSURE
                      - SA_TAX_PREV_CLOSURE
                      - NOTE
                      - SA_INV_NOTE
                      - SA_P_ID
                      - SA_CANCEL_REASON
                      - SA_AGREEMENT_DATE
                      - SA_NEEDS_PROCESS
                      - SA_CREATED
                      - SA_SALESMAN_ID
                      - SA_MOVING
                      - SA_MOVE_DATA
                      - SA_BOND_START
                      - SA_NODEAVAIL_SGD_ID
                      - SA_NAME
                      - SA_PROVIDER_USER_ID
                      - SA_PAY_TO
                      - SA_DATE_BASE
                      - params
                      - discounts
      tags:
        - 'Customer Services'
    post:
      summary: 'Activate Customer Service'
      operationId: activateCustomerService
      description: 'Activates (creates) a new customer service.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 4598000
                    USER_ID: '02938'
                    SERVICE_ID: '4027'
                    PRICE: '6356.1332'
                    DATE_START: '1973-04-11'
                    DATE_END: null
                    STATE: '01'
                    PAYMENT_DEPRECATED: null
                    ACCOUNT_FROM: '2020-08-02'
                    ACCOUNT_TO: null
                    DUE_DATE: 30
                    VAR_SYMBOL: null
                    ACCORD_NUM: null
                    TRADING_LIMIT: null
                    SA_TRADING_LIMIT_ALERTED: 0
                    CUSTOMER_CHANGE_DEPRECATED: null
                    SA_PERIOD: vyear
                    SA_LOCATION: null
                    SA_TAX_CLOSURE: null
                    SA_TAX_PREV_CLOSURE: null
                    NOTE: 'Harum mollitia modi deserunt aut ab provident perspiciatis quo.'
                    SA_INV_NOTE: null
                    SA_P_ID: null
                    SA_CANCEL_REASON: null
                    SA_AGREEMENT_DATE: null
                    SA_NEEDS_PROCESS: null
                    SA_CREATED: '2026-04-20 09:25:47'
                    SA_SALESMAN_ID: null
                    SA_MOVING: 0
                    SA_MOVE_DATA: null
                    SA_BOND_START: null
                    SA_NODEAVAIL_SGD_ID: null
                    SA_NAME: null
                    SA_PROVIDER_USER_ID: null
                    SA_PAY_TO: null
                    SA_DATE_BASE: null
                    params:
                      -
                        SP_ID: '0003572870'
                        SP_SRV_ID: 4598000
                        SP_NAME: msisdn
                        SP_VALID_FROM: '1981-11-20'
                        SP_VALID_TO: null
                        SP_VALUE: adipisci
                        SP_CREATED: '2026-03-05 07:44:29'
                        SP_L_ID: '002617'
                    discounts:
                      -
                        SAD_ID: 309743
                        SAD_U_ID: 8015
                        SAD_SA_ID: 4598000
                        SAD_SD_ID: 50
                        SAD_DEP_SA_IDS: null
                        SAD_TYPE: credit
                        SAD_VALUE: '19.6504'
                        SAD_START: null
                        SAD_STOP: null
                        SAD_CREATED: '2026-02-18 15:02:14'
                        SAD_CREATOR_L_ID: 1839
                        SAD_STATUS: WAITING
                        SAD_POINTS: null
                        SAD_SD_START_RECREATE: null
                        SAD_SADG_ID: null
                        SAD_END_NOTIFIED: null
                        SAD_STOP_FLOATING: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 4598000
                        description: 'Active service ID (primary key).'
                      USER_ID:
                        type: string
                        example: '02938'
                        description: 'Customer ID. The customer who owns this service. See GET /v3/customers/{id}.'
                      SERVICE_ID:
                        type: string
                        example: '4027'
                        description: 'Service definition ID. The definition this active service is based on. See GET /v3/service-definitions/{id}.'
                      PRICE:
                        type: string
                        example: '6356.1332'
                        description: 'Price with VAT for this active service (one-time or per billing period).'
                      DATE_START:
                        type: string
                        example: '1973-04-11'
                        description: 'Service provision start date (YYYY-MM-DD).'
                      DATE_END:
                        type: string
                        example: null
                        description: 'Service provision end date (YYYY-MM-DD). Null if the service is still active (open-ended).'
                        nullable: true
                      STATE:
                        type: string
                        example: '01'
                        description: 'Service state. 0 = blocked, 1 = active, 2 = cancelled, 3 = not connected (pending provisioning).'
                      PAYMENT_DEPRECATED:
                        type: string
                        example: null
                        description: 'Deprecated payment field. No longer in active use.'
                        nullable: true
                      ACCOUNT_FROM:
                        type: string
                        example: '2020-08-02'
                        description: 'Billing start date (YYYY-MM-DD). Charges begin from this date.'
                      ACCOUNT_TO:
                        type: string
                        example: null
                        description: 'Billing end date (YYYY-MM-DD). Null while billing is ongoing.'
                        nullable: true
                      DUE_DATE:
                        type: integer
                        example: 30
                        description: 'Payment due period in days. Default: 30.'
                      VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol (payment identifier) for this service.'
                        nullable: true
                      ACCORD_NUM:
                        type: string
                        example: null
                        description: 'Accord number (agreement/contract reference).'
                        nullable: true
                      TRADING_LIMIT:
                        type: string
                        example: null
                        description: 'Minimum commitment (bond) expiration date (YYYY-MM-DD).'
                        nullable: true
                      SA_TRADING_LIMIT_ALERTED:
                        type: integer
                        example: 0
                        description: 'Flag indicating the TRADING_LIMIT has been changed but not yet alerted. 1 = change pending alert.'
                      CUSTOMER_CHANGE_DEPRECATED:
                        type: string
                        example: null
                        description: 'Deprecated customer change flag. No longer in active use.'
                        nullable: true
                      SA_PERIOD:
                        type: string
                        example: vyear
                        description: "Billing period. Possible values: 'month', 'cquarter', 'chalfyear', 'cyear', 'cyears2', 'cyears3', 'cmonths18', 'vmonth', 'vquarter', 'vhalfyear', 'vyear', 'vyears2', 'vyears3', 'vmonths18', 'all', 'none'. Prefix 'c' = calendar-aligned, 'v' = anniversary-aligned."
                        enum:
                          - all
                          - chalfyear
                          - cquarter
                          - cyear
                          - month
                          - none
                          - vhalfyear
                          - vmonth
                          - vquarter
                          - vyear
                          - cyears2
                          - cyears3
                          - cmonths18
                          - vyears2
                          - vyears3
                          - vmonths18
                      SA_LOCATION:
                        type: string
                        example: null
                        description: 'Service location identifier (free-text).'
                        nullable: true
                      SA_TAX_CLOSURE:
                        type: string
                        example: null
                        description: 'Last billing closure date for this service (YYYY-MM-DD).'
                        nullable: true
                      SA_TAX_PREV_CLOSURE:
                        type: string
                        example: null
                        description: 'Previous billing closure date, before the last closure (YYYY-MM-DD).'
                        nullable: true
                      NOTE:
                        type: string
                        example: 'Harum mollitia modi deserunt aut ab provident perspiciatis quo.'
                        description: 'Note / remark for this service.'
                        nullable: true
                      SA_INV_NOTE:
                        type: string
                        example: null
                        description: 'Invoice note. Text printed on invoices for this service.'
                        nullable: true
                      SA_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (point of presence / service delivery location).'
                        nullable: true
                      SA_CANCEL_REASON:
                        type: string
                        example: null
                        description: 'Cancellation reason code (code list entry ID).'
                        nullable: true
                      SA_AGREEMENT_DATE:
                        type: string
                        example: null
                        description: 'Agreement (contract) date for this service (YYYY-MM-DD).'
                        nullable: true
                      SA_NEEDS_PROCESS:
                        type: string
                        example: null
                        description: 'Process (maintenance ticket) ID required for provisioning this service.'
                        nullable: true
                      SA_CREATED:
                        type: string
                        example: '2026-04-20 09:25:47'
                        description: 'Timestamp when this service was activated/created.'
                      SA_SALESMAN_ID:
                        type: string
                        example: null
                        description: 'Salesman (admin/operator) ID who activated or manages this service.'
                        nullable: true
                      SA_MOVING:
                        type: integer
                        example: 0
                        description: 'Moving flag. 1 = service is in the moving (relocation) processing phase. Relevant when the base service definition has SN_MOVE_SPLITTED = 1.'
                      SA_MOVE_DATA:
                        type: string
                        example: null
                        description: 'Additional data for the service move operation.'
                        nullable: true
                      SA_BOND_START:
                        type: string
                        example: null
                        description: 'Minimum commitment (bond) start date (YYYY-MM-DD). Preserved across service transfers.'
                        nullable: true
                      SA_NODEAVAIL_SGD_ID:
                        type: string
                        example: null
                        description: 'Node availability service group definition ID (process/technology group). See GET /v3/service-groups.'
                        nullable: true
                      SA_NAME:
                        type: string
                        example: null
                        description: 'Commercial (custom) service name. Overrides the default service definition name when set.'
                        nullable: true
                      SA_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider (operator) customer ID. See GET /v3/customers/{id}.'
                        nullable: true
                      SA_PAY_TO:
                        type: string
                        example: null
                        description: 'Service prepaid expiration date (YYYY-MM-DD). Paid until this date.'
                        nullable: true
                      SA_DATE_BASE:
                        type: string
                        example: null
                        description: 'Base date for anniversary-based billing period calculations (YYYY-MM-DD).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            SP_ID: '0003572870'
                            SP_SRV_ID: 4598000
                            SP_NAME: msisdn
                            SP_VALID_FROM: '1981-11-20'
                            SP_VALID_TO: null
                            SP_VALUE: adipisci
                            SP_CREATED: '2026-03-05 07:44:29'
                            SP_L_ID: '002617'
                        description: 'Service parameter key-value pairs.'
                        items:
                          type: object
                          properties:
                            SP_ID:
                              type: string
                              example: '0003572870'
                            SP_SRV_ID:
                              type: integer
                              example: 4598000
                            SP_NAME:
                              type: string
                              example: msisdn
                            SP_VALID_FROM:
                              type: string
                              example: '1981-11-20'
                            SP_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            SP_VALUE:
                              type: string
                              example: adipisci
                            SP_CREATED:
                              type: string
                              example: '2026-03-05 07:44:29'
                            SP_L_ID:
                              type: string
                              example: '002617'
                      discounts:
                        type: array
                        example:
                          -
                            SAD_ID: 309743
                            SAD_U_ID: 8015
                            SAD_SA_ID: 4598000
                            SAD_SD_ID: 50
                            SAD_DEP_SA_IDS: null
                            SAD_TYPE: credit
                            SAD_VALUE: '19.6504'
                            SAD_START: null
                            SAD_STOP: null
                            SAD_CREATED: '2026-02-18 15:02:14'
                            SAD_CREATOR_L_ID: 1839
                            SAD_STATUS: WAITING
                            SAD_POINTS: null
                            SAD_SD_START_RECREATE: null
                            SAD_SADG_ID: null
                            SAD_END_NOTIFIED: null
                            SAD_STOP_FLOATING: null
                        description: 'Active discounts applied to this service.'
                        items:
                          type: object
                          properties:
                            SAD_ID:
                              type: integer
                              example: 309743
                            SAD_U_ID:
                              type: integer
                              example: 8015
                            SAD_SA_ID:
                              type: integer
                              example: 4598000
                            SAD_SD_ID:
                              type: integer
                              example: 50
                            SAD_DEP_SA_IDS:
                              type: string
                              example: null
                              nullable: true
                            SAD_TYPE:
                              type: string
                              example: credit
                            SAD_VALUE:
                              type: string
                              example: '19.6504'
                            SAD_START:
                              type: string
                              example: null
                              nullable: true
                            SAD_STOP:
                              type: string
                              example: null
                              nullable: true
                            SAD_CREATED:
                              type: string
                              example: '2026-02-18 15:02:14'
                            SAD_CREATOR_L_ID:
                              type: integer
                              example: 1839
                            SAD_STATUS:
                              type: string
                              example: WAITING
                            SAD_POINTS:
                              type: string
                              example: null
                              nullable: true
                            SAD_SD_START_RECREATE:
                              type: string
                              example: null
                              nullable: true
                            SAD_SADG_ID:
                              type: string
                              example: null
                              nullable: true
                            SAD_END_NOTIFIED:
                              type: string
                              example: null
                              nullable: true
                            SAD_STOP_FLOATING:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - USER_ID
                      - SERVICE_ID
                      - PRICE
                      - DATE_START
                      - DATE_END
                      - STATE
                      - PAYMENT_DEPRECATED
                      - ACCOUNT_FROM
                      - ACCOUNT_TO
                      - DUE_DATE
                      - VAR_SYMBOL
                      - ACCORD_NUM
                      - TRADING_LIMIT
                      - SA_TRADING_LIMIT_ALERTED
                      - CUSTOMER_CHANGE_DEPRECATED
                      - SA_PERIOD
                      - SA_LOCATION
                      - SA_TAX_CLOSURE
                      - SA_TAX_PREV_CLOSURE
                      - NOTE
                      - SA_INV_NOTE
                      - SA_P_ID
                      - SA_CANCEL_REASON
                      - SA_AGREEMENT_DATE
                      - SA_NEEDS_PROCESS
                      - SA_CREATED
                      - SA_SALESMAN_ID
                      - SA_MOVING
                      - SA_MOVE_DATA
                      - SA_BOND_START
                      - SA_NODEAVAIL_SGD_ID
                      - SA_NAME
                      - SA_PROVIDER_USER_ID
                      - SA_PAY_TO
                      - SA_DATE_BASE
                      - params
                      - discounts
      tags:
        - 'Customer Services'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: integer
                  description: 'Customer (user) ID'
                  example: 100
                date_start:
                  type: date
                  description: 'Service start date'
                  example: '2026-01-01'
                date_from:
                  type: date
                  description: 'Billing start date'
                  example: '2026-01-01'
                service_id:
                  type: integer
                  description: 'Service definition ID (FK to services_name)'
                  example: 50
                date_min:
                  type: date
                  description: 'Minimum contract date'
                  example: architecto
                price:
                  type: number
                  description: 'Service price'
                  example: 299.0
                bp_id:
                  type: integer
                  description: 'Billing plan ID'
                  example: 16
                billing_data:
                  type: object
                  description: 'Billing data as key-value pairs'
                  example: []
                  properties: {  }
                period:
                  type: string
                  description: 'Billing period'
                  example: month
                location:
                  type: string
                  description: 'Service location'
                  example: architecto
                note:
                  type: string
                  description: Note
                  example: architecto
                service_params:
                  type: object
                  description: 'Service parameters as key-value pairs'
                  example: []
                  properties: {  }
                invoice_note:
                  type: string
                  description: 'Invoice note'
                  example: architecto
                not_use_connect:
                  type: integer
                  description: 'Do not use connect'
                  example: 16
                due_days:
                  type: string
                  description: 'Due days'
                  example: architecto
                premise_id:
                  type: integer
                  description: 'Premise ID'
                  example: 16
                add_param:
                  type: string
                  description: 'Additional parameter'
                  example: architecto
                node_id:
                  type: integer
                  description: 'Device (node) ID'
                  example: 16
                needs_process:
                  type: integer
                  description: 'Needs processing flag'
                  example: 16
                salesman_id:
                  type: integer
                  description: 'Salesman ID'
                  example: 16
                agreement_date:
                  type: date
                  description: 'Agreement date'
                  example: architecto
                crm_channel:
                  type: integer
                  description: 'CRM channel'
                  example: 16
                base_service_id:
                  type: integer
                  description: 'Base service ID (for dependent services)'
                  example: 16
                unicredit_assign:
                  type: integer
                  description: 'UniCredit assign flag'
                  example: 16
                autoconnect:
                  type: integer
                  description: 'Auto-connect flag'
                  example: 16
                uc_type:
                  type: string
                  description: 'UniCredit type'
                  example: architecto
                nodeavail_sgd_id:
                  type: integer
                  description: 'Node availability SGD ID'
                  example: 16
                name:
                  type: string
                  description: 'Service name override'
                  example: architecto
                bp_user_default_change:
                  type: integer
                  description: 'Billing plan user default change flag'
                  example: 16
                snd_id:
                  type: integer
                  description: 'Service name detail ID'
                  example: 16
                provider_user_id:
                  type: integer
                  description: 'Provider user ID'
                  example: 16
              required:
                - user_id
                - date_start
                - date_from
                - service_id
  '/api/v3/customer-services/{id}':
    get:
      summary: 'Get Customer Service'
      operationId: getCustomerService
      description: 'Returns a single customer service by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 4598001
                    USER_ID: '02878'
                    SERVICE_ID: '2839'
                    PRICE: '3668.8918'
                    DATE_START: '2015-01-19'
                    DATE_END: null
                    STATE: '01'
                    PAYMENT_DEPRECATED: null
                    ACCOUNT_FROM: '2022-12-10'
                    ACCOUNT_TO: null
                    DUE_DATE: 30
                    VAR_SYMBOL: null
                    ACCORD_NUM: null
                    TRADING_LIMIT: null
                    SA_TRADING_LIMIT_ALERTED: 0
                    CUSTOMER_CHANGE_DEPRECATED: null
                    SA_PERIOD: cyear
                    SA_LOCATION: null
                    SA_TAX_CLOSURE: null
                    SA_TAX_PREV_CLOSURE: null
                    NOTE: null
                    SA_INV_NOTE: null
                    SA_P_ID: null
                    SA_CANCEL_REASON: null
                    SA_AGREEMENT_DATE: null
                    SA_NEEDS_PROCESS: null
                    SA_CREATED: '2026-04-20 09:25:47'
                    SA_SALESMAN_ID: null
                    SA_MOVING: 0
                    SA_MOVE_DATA: null
                    SA_BOND_START: null
                    SA_NODEAVAIL_SGD_ID: null
                    SA_NAME: null
                    SA_PROVIDER_USER_ID: null
                    SA_PAY_TO: null
                    SA_DATE_BASE: null
                    params:
                      -
                        SP_ID: '0003572871'
                        SP_SRV_ID: 4598001
                        SP_NAME: msisdn
                        SP_VALID_FROM: '1973-12-12'
                        SP_VALID_TO: null
                        SP_VALUE: ipsum
                        SP_CREATED: '2026-01-07 20:24:45'
                        SP_L_ID: '007018'
                    discounts:
                      -
                        SAD_ID: 309744
                        SAD_U_ID: 4486
                        SAD_SA_ID: 4598001
                        SAD_SD_ID: 50
                        SAD_DEP_SA_IDS: null
                        SAD_TYPE: points
                        SAD_VALUE: '72.9772'
                        SAD_START: '1997-06-16'
                        SAD_STOP: null
                        SAD_CREATED: '2026-01-09 22:22:49'
                        SAD_CREATOR_L_ID: 2327
                        SAD_STATUS: FINISHED
                        SAD_POINTS: null
                        SAD_SD_START_RECREATE: null
                        SAD_SADG_ID: null
                        SAD_END_NOTIFIED: null
                        SAD_STOP_FLOATING: null
                    dependent_services:
                      -
                        SAL_ID: '00000198177'
                        SAL_TYPE: fixed
                        SAL_SA_ID: 4598001
                        SAL_LINKED_SA_ID: 7048
                        SAL_VALID_FROM: null
                        SAL_VALID_TO: null
                        SAL_SAD_ID: null
                        SAL_CREATED: '2026-04-14 02:06:12'
                        SAL_CREATOR_ID: '007602'
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 4598001
                        description: 'Active service ID (primary key).'
                      USER_ID:
                        type: string
                        example: '02878'
                        description: 'Customer ID. The customer who owns this service. See GET /v3/customers/{id}.'
                      SERVICE_ID:
                        type: string
                        example: '2839'
                        description: 'Service definition ID. The definition this active service is based on. See GET /v3/service-definitions/{id}.'
                      PRICE:
                        type: string
                        example: '3668.8918'
                        description: 'Price with VAT for this active service (one-time or per billing period).'
                      DATE_START:
                        type: string
                        example: '2015-01-19'
                        description: 'Service provision start date (YYYY-MM-DD).'
                      DATE_END:
                        type: string
                        example: null
                        description: 'Service provision end date (YYYY-MM-DD). Null if the service is still active (open-ended).'
                        nullable: true
                      STATE:
                        type: string
                        example: '01'
                        description: 'Service state. 0 = blocked, 1 = active, 2 = cancelled, 3 = not connected (pending provisioning).'
                      PAYMENT_DEPRECATED:
                        type: string
                        example: null
                        description: 'Deprecated payment field. No longer in active use.'
                        nullable: true
                      ACCOUNT_FROM:
                        type: string
                        example: '2022-12-10'
                        description: 'Billing start date (YYYY-MM-DD). Charges begin from this date.'
                      ACCOUNT_TO:
                        type: string
                        example: null
                        description: 'Billing end date (YYYY-MM-DD). Null while billing is ongoing.'
                        nullable: true
                      DUE_DATE:
                        type: integer
                        example: 30
                        description: 'Payment due period in days. Default: 30.'
                      VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol (payment identifier) for this service.'
                        nullable: true
                      ACCORD_NUM:
                        type: string
                        example: null
                        description: 'Accord number (agreement/contract reference).'
                        nullable: true
                      TRADING_LIMIT:
                        type: string
                        example: null
                        description: 'Minimum commitment (bond) expiration date (YYYY-MM-DD).'
                        nullable: true
                      SA_TRADING_LIMIT_ALERTED:
                        type: integer
                        example: 0
                        description: 'Flag indicating the TRADING_LIMIT has been changed but not yet alerted. 1 = change pending alert.'
                      CUSTOMER_CHANGE_DEPRECATED:
                        type: string
                        example: null
                        description: 'Deprecated customer change flag. No longer in active use.'
                        nullable: true
                      SA_PERIOD:
                        type: string
                        example: cyear
                        description: "Billing period. Possible values: 'month', 'cquarter', 'chalfyear', 'cyear', 'cyears2', 'cyears3', 'cmonths18', 'vmonth', 'vquarter', 'vhalfyear', 'vyear', 'vyears2', 'vyears3', 'vmonths18', 'all', 'none'. Prefix 'c' = calendar-aligned, 'v' = anniversary-aligned."
                        enum:
                          - all
                          - chalfyear
                          - cquarter
                          - cyear
                          - month
                          - none
                          - vhalfyear
                          - vmonth
                          - vquarter
                          - vyear
                          - cyears2
                          - cyears3
                          - cmonths18
                          - vyears2
                          - vyears3
                          - vmonths18
                      SA_LOCATION:
                        type: string
                        example: null
                        description: 'Service location identifier (free-text).'
                        nullable: true
                      SA_TAX_CLOSURE:
                        type: string
                        example: null
                        description: 'Last billing closure date for this service (YYYY-MM-DD).'
                        nullable: true
                      SA_TAX_PREV_CLOSURE:
                        type: string
                        example: null
                        description: 'Previous billing closure date, before the last closure (YYYY-MM-DD).'
                        nullable: true
                      NOTE:
                        type: string
                        example: null
                        description: 'Note / remark for this service.'
                        nullable: true
                      SA_INV_NOTE:
                        type: string
                        example: null
                        description: 'Invoice note. Text printed on invoices for this service.'
                        nullable: true
                      SA_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (point of presence / service delivery location).'
                        nullable: true
                      SA_CANCEL_REASON:
                        type: string
                        example: null
                        description: 'Cancellation reason code (code list entry ID).'
                        nullable: true
                      SA_AGREEMENT_DATE:
                        type: string
                        example: null
                        description: 'Agreement (contract) date for this service (YYYY-MM-DD).'
                        nullable: true
                      SA_NEEDS_PROCESS:
                        type: string
                        example: null
                        description: 'Process (maintenance ticket) ID required for provisioning this service.'
                        nullable: true
                      SA_CREATED:
                        type: string
                        example: '2026-04-20 09:25:47'
                        description: 'Timestamp when this service was activated/created.'
                      SA_SALESMAN_ID:
                        type: string
                        example: null
                        description: 'Salesman (admin/operator) ID who activated or manages this service.'
                        nullable: true
                      SA_MOVING:
                        type: integer
                        example: 0
                        description: 'Moving flag. 1 = service is in the moving (relocation) processing phase. Relevant when the base service definition has SN_MOVE_SPLITTED = 1.'
                      SA_MOVE_DATA:
                        type: string
                        example: null
                        description: 'Additional data for the service move operation.'
                        nullable: true
                      SA_BOND_START:
                        type: string
                        example: null
                        description: 'Minimum commitment (bond) start date (YYYY-MM-DD). Preserved across service transfers.'
                        nullable: true
                      SA_NODEAVAIL_SGD_ID:
                        type: string
                        example: null
                        description: 'Node availability service group definition ID (process/technology group). See GET /v3/service-groups.'
                        nullable: true
                      SA_NAME:
                        type: string
                        example: null
                        description: 'Commercial (custom) service name. Overrides the default service definition name when set.'
                        nullable: true
                      SA_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider (operator) customer ID. See GET /v3/customers/{id}.'
                        nullable: true
                      SA_PAY_TO:
                        type: string
                        example: null
                        description: 'Service prepaid expiration date (YYYY-MM-DD). Paid until this date.'
                        nullable: true
                      SA_DATE_BASE:
                        type: string
                        example: null
                        description: 'Base date for anniversary-based billing period calculations (YYYY-MM-DD).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            SP_ID: '0003572871'
                            SP_SRV_ID: 4598001
                            SP_NAME: msisdn
                            SP_VALID_FROM: '1973-12-12'
                            SP_VALID_TO: null
                            SP_VALUE: ipsum
                            SP_CREATED: '2026-01-07 20:24:45'
                            SP_L_ID: '007018'
                        description: 'Service parameter key-value pairs.'
                        items:
                          type: object
                          properties:
                            SP_ID:
                              type: string
                              example: '0003572871'
                            SP_SRV_ID:
                              type: integer
                              example: 4598001
                            SP_NAME:
                              type: string
                              example: msisdn
                            SP_VALID_FROM:
                              type: string
                              example: '1973-12-12'
                            SP_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            SP_VALUE:
                              type: string
                              example: ipsum
                            SP_CREATED:
                              type: string
                              example: '2026-01-07 20:24:45'
                            SP_L_ID:
                              type: string
                              example: '007018'
                      discounts:
                        type: array
                        example:
                          -
                            SAD_ID: 309744
                            SAD_U_ID: 4486
                            SAD_SA_ID: 4598001
                            SAD_SD_ID: 50
                            SAD_DEP_SA_IDS: null
                            SAD_TYPE: points
                            SAD_VALUE: '72.9772'
                            SAD_START: '1997-06-16'
                            SAD_STOP: null
                            SAD_CREATED: '2026-01-09 22:22:49'
                            SAD_CREATOR_L_ID: 2327
                            SAD_STATUS: FINISHED
                            SAD_POINTS: null
                            SAD_SD_START_RECREATE: null
                            SAD_SADG_ID: null
                            SAD_END_NOTIFIED: null
                            SAD_STOP_FLOATING: null
                        description: 'Active discounts applied to this service.'
                        items:
                          type: object
                          properties:
                            SAD_ID:
                              type: integer
                              example: 309744
                            SAD_U_ID:
                              type: integer
                              example: 4486
                            SAD_SA_ID:
                              type: integer
                              example: 4598001
                            SAD_SD_ID:
                              type: integer
                              example: 50
                            SAD_DEP_SA_IDS:
                              type: string
                              example: null
                              nullable: true
                            SAD_TYPE:
                              type: string
                              example: points
                            SAD_VALUE:
                              type: string
                              example: '72.9772'
                            SAD_START:
                              type: string
                              example: '1997-06-16'
                            SAD_STOP:
                              type: string
                              example: null
                              nullable: true
                            SAD_CREATED:
                              type: string
                              example: '2026-01-09 22:22:49'
                            SAD_CREATOR_L_ID:
                              type: integer
                              example: 2327
                            SAD_STATUS:
                              type: string
                              example: FINISHED
                            SAD_POINTS:
                              type: string
                              example: null
                              nullable: true
                            SAD_SD_START_RECREATE:
                              type: string
                              example: null
                              nullable: true
                            SAD_SADG_ID:
                              type: string
                              example: null
                              nullable: true
                            SAD_END_NOTIFIED:
                              type: string
                              example: null
                              nullable: true
                            SAD_STOP_FLOATING:
                              type: string
                              example: null
                              nullable: true
                      dependent_services:
                        type: array
                        example:
                          -
                            SAL_ID: '00000198177'
                            SAL_TYPE: fixed
                            SAL_SA_ID: 4598001
                            SAL_LINKED_SA_ID: 7048
                            SAL_VALID_FROM: null
                            SAL_VALID_TO: null
                            SAL_SAD_ID: null
                            SAL_CREATED: '2026-04-14 02:06:12'
                            SAL_CREATOR_ID: '007602'
                        description: 'Dependent (linked) services. Only included in single-resource (show) responses.'
                        items:
                          type: object
                          properties:
                            SAL_ID:
                              type: string
                              example: '00000198177'
                            SAL_TYPE:
                              type: string
                              example: fixed
                            SAL_SA_ID:
                              type: integer
                              example: 4598001
                            SAL_LINKED_SA_ID:
                              type: integer
                              example: 7048
                            SAL_VALID_FROM:
                              type: string
                              example: null
                              nullable: true
                            SAL_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            SAL_SAD_ID:
                              type: string
                              example: null
                              nullable: true
                            SAL_CREATED:
                              type: string
                              example: '2026-04-14 02:06:12'
                            SAL_CREATOR_ID:
                              type: string
                              example: '007602'
                    required:
                      - ID
                      - USER_ID
                      - SERVICE_ID
                      - PRICE
                      - DATE_START
                      - DATE_END
                      - STATE
                      - PAYMENT_DEPRECATED
                      - ACCOUNT_FROM
                      - ACCOUNT_TO
                      - DUE_DATE
                      - VAR_SYMBOL
                      - ACCORD_NUM
                      - TRADING_LIMIT
                      - SA_TRADING_LIMIT_ALERTED
                      - CUSTOMER_CHANGE_DEPRECATED
                      - SA_PERIOD
                      - SA_LOCATION
                      - SA_TAX_CLOSURE
                      - SA_TAX_PREV_CLOSURE
                      - NOTE
                      - SA_INV_NOTE
                      - SA_P_ID
                      - SA_CANCEL_REASON
                      - SA_AGREEMENT_DATE
                      - SA_NEEDS_PROCESS
                      - SA_CREATED
                      - SA_SALESMAN_ID
                      - SA_MOVING
                      - SA_MOVE_DATA
                      - SA_BOND_START
                      - SA_NODEAVAIL_SGD_ID
                      - SA_NAME
                      - SA_PROVIDER_USER_ID
                      - SA_PAY_TO
                      - SA_DATE_BASE
                      - params
                      - discounts
                      - dependent_services
      tags:
        - 'Customer Services'
    put:
      summary: 'Change Customer Service'
      operationId: changeCustomerService
      description: 'Changes (edits) an existing customer service via services_active_change.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 4598002
                    USER_ID: '02938'
                    SERVICE_ID: '4027'
                    PRICE: '6356.1332'
                    DATE_START: '1973-04-11'
                    DATE_END: null
                    STATE: '01'
                    PAYMENT_DEPRECATED: null
                    ACCOUNT_FROM: '2020-08-02'
                    ACCOUNT_TO: null
                    DUE_DATE: 30
                    VAR_SYMBOL: null
                    ACCORD_NUM: null
                    TRADING_LIMIT: null
                    SA_TRADING_LIMIT_ALERTED: 0
                    CUSTOMER_CHANGE_DEPRECATED: null
                    SA_PERIOD: vyear
                    SA_LOCATION: null
                    SA_TAX_CLOSURE: null
                    SA_TAX_PREV_CLOSURE: null
                    NOTE: 'Harum mollitia modi deserunt aut ab provident perspiciatis quo.'
                    SA_INV_NOTE: null
                    SA_P_ID: null
                    SA_CANCEL_REASON: null
                    SA_AGREEMENT_DATE: null
                    SA_NEEDS_PROCESS: null
                    SA_CREATED: '2026-04-20 09:25:47'
                    SA_SALESMAN_ID: null
                    SA_MOVING: 0
                    SA_MOVE_DATA: null
                    SA_BOND_START: null
                    SA_NODEAVAIL_SGD_ID: null
                    SA_NAME: null
                    SA_PROVIDER_USER_ID: null
                    SA_PAY_TO: null
                    SA_DATE_BASE: null
                    params:
                      -
                        SP_ID: '0003572872'
                        SP_SRV_ID: 4598002
                        SP_NAME: msisdn
                        SP_VALID_FROM: '1981-11-20'
                        SP_VALID_TO: null
                        SP_VALUE: adipisci
                        SP_CREATED: '2026-03-05 07:44:29'
                        SP_L_ID: '002617'
                    discounts:
                      -
                        SAD_ID: 309745
                        SAD_U_ID: 8015
                        SAD_SA_ID: 4598002
                        SAD_SD_ID: 50
                        SAD_DEP_SA_IDS: null
                        SAD_TYPE: credit
                        SAD_VALUE: '19.6504'
                        SAD_START: null
                        SAD_STOP: null
                        SAD_CREATED: '2026-02-18 15:02:14'
                        SAD_CREATOR_L_ID: 1839
                        SAD_STATUS: WAITING
                        SAD_POINTS: null
                        SAD_SD_START_RECREATE: null
                        SAD_SADG_ID: null
                        SAD_END_NOTIFIED: null
                        SAD_STOP_FLOATING: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 4598002
                        description: 'Active service ID (primary key).'
                      USER_ID:
                        type: string
                        example: '02938'
                        description: 'Customer ID. The customer who owns this service. See GET /v3/customers/{id}.'
                      SERVICE_ID:
                        type: string
                        example: '4027'
                        description: 'Service definition ID. The definition this active service is based on. See GET /v3/service-definitions/{id}.'
                      PRICE:
                        type: string
                        example: '6356.1332'
                        description: 'Price with VAT for this active service (one-time or per billing period).'
                      DATE_START:
                        type: string
                        example: '1973-04-11'
                        description: 'Service provision start date (YYYY-MM-DD).'
                      DATE_END:
                        type: string
                        example: null
                        description: 'Service provision end date (YYYY-MM-DD). Null if the service is still active (open-ended).'
                        nullable: true
                      STATE:
                        type: string
                        example: '01'
                        description: 'Service state. 0 = blocked, 1 = active, 2 = cancelled, 3 = not connected (pending provisioning).'
                      PAYMENT_DEPRECATED:
                        type: string
                        example: null
                        description: 'Deprecated payment field. No longer in active use.'
                        nullable: true
                      ACCOUNT_FROM:
                        type: string
                        example: '2020-08-02'
                        description: 'Billing start date (YYYY-MM-DD). Charges begin from this date.'
                      ACCOUNT_TO:
                        type: string
                        example: null
                        description: 'Billing end date (YYYY-MM-DD). Null while billing is ongoing.'
                        nullable: true
                      DUE_DATE:
                        type: integer
                        example: 30
                        description: 'Payment due period in days. Default: 30.'
                      VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol (payment identifier) for this service.'
                        nullable: true
                      ACCORD_NUM:
                        type: string
                        example: null
                        description: 'Accord number (agreement/contract reference).'
                        nullable: true
                      TRADING_LIMIT:
                        type: string
                        example: null
                        description: 'Minimum commitment (bond) expiration date (YYYY-MM-DD).'
                        nullable: true
                      SA_TRADING_LIMIT_ALERTED:
                        type: integer
                        example: 0
                        description: 'Flag indicating the TRADING_LIMIT has been changed but not yet alerted. 1 = change pending alert.'
                      CUSTOMER_CHANGE_DEPRECATED:
                        type: string
                        example: null
                        description: 'Deprecated customer change flag. No longer in active use.'
                        nullable: true
                      SA_PERIOD:
                        type: string
                        example: vyear
                        description: "Billing period. Possible values: 'month', 'cquarter', 'chalfyear', 'cyear', 'cyears2', 'cyears3', 'cmonths18', 'vmonth', 'vquarter', 'vhalfyear', 'vyear', 'vyears2', 'vyears3', 'vmonths18', 'all', 'none'. Prefix 'c' = calendar-aligned, 'v' = anniversary-aligned."
                        enum:
                          - all
                          - chalfyear
                          - cquarter
                          - cyear
                          - month
                          - none
                          - vhalfyear
                          - vmonth
                          - vquarter
                          - vyear
                          - cyears2
                          - cyears3
                          - cmonths18
                          - vyears2
                          - vyears3
                          - vmonths18
                      SA_LOCATION:
                        type: string
                        example: null
                        description: 'Service location identifier (free-text).'
                        nullable: true
                      SA_TAX_CLOSURE:
                        type: string
                        example: null
                        description: 'Last billing closure date for this service (YYYY-MM-DD).'
                        nullable: true
                      SA_TAX_PREV_CLOSURE:
                        type: string
                        example: null
                        description: 'Previous billing closure date, before the last closure (YYYY-MM-DD).'
                        nullable: true
                      NOTE:
                        type: string
                        example: 'Harum mollitia modi deserunt aut ab provident perspiciatis quo.'
                        description: 'Note / remark for this service.'
                        nullable: true
                      SA_INV_NOTE:
                        type: string
                        example: null
                        description: 'Invoice note. Text printed on invoices for this service.'
                        nullable: true
                      SA_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (point of presence / service delivery location).'
                        nullable: true
                      SA_CANCEL_REASON:
                        type: string
                        example: null
                        description: 'Cancellation reason code (code list entry ID).'
                        nullable: true
                      SA_AGREEMENT_DATE:
                        type: string
                        example: null
                        description: 'Agreement (contract) date for this service (YYYY-MM-DD).'
                        nullable: true
                      SA_NEEDS_PROCESS:
                        type: string
                        example: null
                        description: 'Process (maintenance ticket) ID required for provisioning this service.'
                        nullable: true
                      SA_CREATED:
                        type: string
                        example: '2026-04-20 09:25:47'
                        description: 'Timestamp when this service was activated/created.'
                      SA_SALESMAN_ID:
                        type: string
                        example: null
                        description: 'Salesman (admin/operator) ID who activated or manages this service.'
                        nullable: true
                      SA_MOVING:
                        type: integer
                        example: 0
                        description: 'Moving flag. 1 = service is in the moving (relocation) processing phase. Relevant when the base service definition has SN_MOVE_SPLITTED = 1.'
                      SA_MOVE_DATA:
                        type: string
                        example: null
                        description: 'Additional data for the service move operation.'
                        nullable: true
                      SA_BOND_START:
                        type: string
                        example: null
                        description: 'Minimum commitment (bond) start date (YYYY-MM-DD). Preserved across service transfers.'
                        nullable: true
                      SA_NODEAVAIL_SGD_ID:
                        type: string
                        example: null
                        description: 'Node availability service group definition ID (process/technology group). See GET /v3/service-groups.'
                        nullable: true
                      SA_NAME:
                        type: string
                        example: null
                        description: 'Commercial (custom) service name. Overrides the default service definition name when set.'
                        nullable: true
                      SA_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider (operator) customer ID. See GET /v3/customers/{id}.'
                        nullable: true
                      SA_PAY_TO:
                        type: string
                        example: null
                        description: 'Service prepaid expiration date (YYYY-MM-DD). Paid until this date.'
                        nullable: true
                      SA_DATE_BASE:
                        type: string
                        example: null
                        description: 'Base date for anniversary-based billing period calculations (YYYY-MM-DD).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            SP_ID: '0003572872'
                            SP_SRV_ID: 4598002
                            SP_NAME: msisdn
                            SP_VALID_FROM: '1981-11-20'
                            SP_VALID_TO: null
                            SP_VALUE: adipisci
                            SP_CREATED: '2026-03-05 07:44:29'
                            SP_L_ID: '002617'
                        description: 'Service parameter key-value pairs.'
                        items:
                          type: object
                          properties:
                            SP_ID:
                              type: string
                              example: '0003572872'
                            SP_SRV_ID:
                              type: integer
                              example: 4598002
                            SP_NAME:
                              type: string
                              example: msisdn
                            SP_VALID_FROM:
                              type: string
                              example: '1981-11-20'
                            SP_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            SP_VALUE:
                              type: string
                              example: adipisci
                            SP_CREATED:
                              type: string
                              example: '2026-03-05 07:44:29'
                            SP_L_ID:
                              type: string
                              example: '002617'
                      discounts:
                        type: array
                        example:
                          -
                            SAD_ID: 309745
                            SAD_U_ID: 8015
                            SAD_SA_ID: 4598002
                            SAD_SD_ID: 50
                            SAD_DEP_SA_IDS: null
                            SAD_TYPE: credit
                            SAD_VALUE: '19.6504'
                            SAD_START: null
                            SAD_STOP: null
                            SAD_CREATED: '2026-02-18 15:02:14'
                            SAD_CREATOR_L_ID: 1839
                            SAD_STATUS: WAITING
                            SAD_POINTS: null
                            SAD_SD_START_RECREATE: null
                            SAD_SADG_ID: null
                            SAD_END_NOTIFIED: null
                            SAD_STOP_FLOATING: null
                        description: 'Active discounts applied to this service.'
                        items:
                          type: object
                          properties:
                            SAD_ID:
                              type: integer
                              example: 309745
                            SAD_U_ID:
                              type: integer
                              example: 8015
                            SAD_SA_ID:
                              type: integer
                              example: 4598002
                            SAD_SD_ID:
                              type: integer
                              example: 50
                            SAD_DEP_SA_IDS:
                              type: string
                              example: null
                              nullable: true
                            SAD_TYPE:
                              type: string
                              example: credit
                            SAD_VALUE:
                              type: string
                              example: '19.6504'
                            SAD_START:
                              type: string
                              example: null
                              nullable: true
                            SAD_STOP:
                              type: string
                              example: null
                              nullable: true
                            SAD_CREATED:
                              type: string
                              example: '2026-02-18 15:02:14'
                            SAD_CREATOR_L_ID:
                              type: integer
                              example: 1839
                            SAD_STATUS:
                              type: string
                              example: WAITING
                            SAD_POINTS:
                              type: string
                              example: null
                              nullable: true
                            SAD_SD_START_RECREATE:
                              type: string
                              example: null
                              nullable: true
                            SAD_SADG_ID:
                              type: string
                              example: null
                              nullable: true
                            SAD_END_NOTIFIED:
                              type: string
                              example: null
                              nullable: true
                            SAD_STOP_FLOATING:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - USER_ID
                      - SERVICE_ID
                      - PRICE
                      - DATE_START
                      - DATE_END
                      - STATE
                      - PAYMENT_DEPRECATED
                      - ACCOUNT_FROM
                      - ACCOUNT_TO
                      - DUE_DATE
                      - VAR_SYMBOL
                      - ACCORD_NUM
                      - TRADING_LIMIT
                      - SA_TRADING_LIMIT_ALERTED
                      - CUSTOMER_CHANGE_DEPRECATED
                      - SA_PERIOD
                      - SA_LOCATION
                      - SA_TAX_CLOSURE
                      - SA_TAX_PREV_CLOSURE
                      - NOTE
                      - SA_INV_NOTE
                      - SA_P_ID
                      - SA_CANCEL_REASON
                      - SA_AGREEMENT_DATE
                      - SA_NEEDS_PROCESS
                      - SA_CREATED
                      - SA_SALESMAN_ID
                      - SA_MOVING
                      - SA_MOVE_DATA
                      - SA_BOND_START
                      - SA_NODEAVAIL_SGD_ID
                      - SA_NAME
                      - SA_PROVIDER_USER_ID
                      - SA_PAY_TO
                      - SA_DATE_BASE
                      - params
                      - discounts
      tags:
        - 'Customer Services'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: date
                  description: 'Change effective date'
                  example: '2026-01-01'
                price:
                  type: number
                  description: 'New price'
                  example: 399.0
                bp_id:
                  type: integer
                  description: 'Billing plan ID'
                  example: 16
                billing_data:
                  type: object
                  description: 'Billing data as key-value pairs'
                  example: []
                  properties: {  }
                period:
                  type: string
                  description: 'Billing period'
                  example: month
                note:
                  type: string
                  description: Note
                  example: architecto
                service_params:
                  type: object
                  description: 'Service parameters as key-value pairs'
                  example: []
                  properties: {  }
                date_min:
                  type: date
                  description: 'Minimum contract date'
                  example: architecto
                nodeavail_sgd_id:
                  type: integer
                  description: 'Node availability SGD ID'
                  example: 16
                salesman_id:
                  type: integer
                  description: 'Salesman ID'
                  example: 16
                name:
                  type: string
                  description: 'Service name override'
                  example: architecto
                bp_user_default_change:
                  type: integer
                  description: 'Billing plan user default change flag'
                  example: 16
                period_dep:
                  type: integer
                  description: 'Period dependency flag'
                  example: 16
    delete:
      summary: 'Cancel Customer Service'
      operationId: cancelCustomerService
      description: 'Cancels (deactivates) a customer service. This is a soft cancel, not a hard delete.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Customer Services'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer service.'
        example: 105
        required: true
        schema:
          type: integer
  '/api/v3/customer-services/{id}/block':
    post:
      summary: 'Block Customer Service'
      operationId: blockCustomerService
      description: 'Blocks an active customer service.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Customer Services'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: date
                  description: 'Block effective date'
                  example: '2026-01-01'
                note:
                  type: string
                  description: Note
                  example: architecto
                interrupt:
                  type: integer
                  description: 'Interrupt flag'
                  example: 16
                blocked_billing:
                  type: integer
                  description: 'Block billing flag'
                  example: 16
                blocked_auto:
                  type: integer
                  description: 'Auto-block flag'
                  example: 16
                credit_create:
                  type: integer
                  description: 'Create credit flag'
                  example: 16
              required:
                - date
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer service.'
        example: 105
        required: true
        schema:
          type: integer
  '/api/v3/customer-services/{id}/unblock':
    post:
      summary: 'Unblock Customer Service'
      operationId: unblockCustomerService
      description: 'Unblocks a blocked customer service.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Customer Services'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                date:
                  type: date
                  description: 'Unblock effective date'
                  example: architecto
                note:
                  type: string
                  description: Note
                  example: architecto
                interrupt:
                  type: integer
                  description: 'Interrupt flag'
                  example: 16
                blocked_billing:
                  type: integer
                  description: 'Blocked billing flag'
                  example: 16
                sn_id_list:
                  type: array
                  description: 'List of service name IDs to unblock'
                  example:
                    - 16
                  items:
                    type: integer
                blocked_auto:
                  type: integer
                  description: 'Auto-blocked flag'
                  example: 16
                create_credit:
                  type: integer
                  description: 'Create credit flag'
                  example: 16
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer service.'
        example: 105
        required: true
        schema:
          type: integer
  /api/v3/customer-units:
    get:
      summary: 'List Customer Units'
      operationId: listCustomerUnits
      description: "   Retrieve a paginated list of customer units (residential/business premises).\n   Customer units are connection points in the network where customer services are delivered."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated customer unit IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated customer unit IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer ID — returns units linked to this customer via nodes_services.'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer ID — returns units linked to this customer via nodes_services.'
            example: 100
        -
          in: query
          name: customer_service
          description: 'Filter by customer service ID — returns units linked to this service via nodes_services.'
          example: 500
          required: false
          schema:
            type: integer
            description: 'Filter by customer service ID — returns units linked to this service via nodes_services.'
            example: 500
        -
          in: query
          name: unit_city
          description: 'Filter by UIR city ID (via uir_city_parts registry).'
          example: 1234
          required: false
          schema:
            type: integer
            description: 'Filter by UIR city ID (via uir_city_parts registry).'
            example: 1234
        -
          in: query
          name: unit_citypart
          description: 'Filter by UIR city part ID (N_UCP_ID).'
          example: 5678
          required: false
          schema:
            type: integer
            description: 'Filter by UIR city part ID (N_UCP_ID).'
            example: 5678
        -
          in: query
          name: unit_street
          description: 'Filter by UIR street ID (N_US_ID).'
          example: 9012
          required: false
          schema:
            type: integer
            description: 'Filter by UIR street ID (N_US_ID).'
            example: 9012
        -
          in: query
          name: unit_address
          description: 'Filter by UIR address ID (N_UA_ID).'
          example: 3456
          required: false
          schema:
            type: integer
            description: 'Filter by UIR address ID (N_UA_ID).'
            example: 3456
        -
          in: query
          name: region
          description: 'Filter by address region group ID (groups_address). Matches units whose UIR address falls within the region.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Filter by address region group ID (groups_address). Matches units whose UIR address falls within the region.'
            example: 10
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 1793161
                      NAME: UNIT-uwpwlv
                      NOTE: 'Odit et et modi.'
                      MANAGED: 0
                      MANAG_IP: null
                      PARENT_NODE: null
                      F_TYPE: null
                      N_TYPE: BLK_DEVICE
                      N_DEVICE_TYPE: blk_device
                      N_CUSTOMER: 1
                      USER_SERVICE_ID: 0
                      CUSTOMER_PARENT: 1
                      CUSTOMER_TYPE: null
                      CUSTOMER_LOCATION: 0
                      MAC: null
                      UPDATE_FLAG: 0
                      AGR_GROUP: null
                      STREET: null
                      HOUSE_ID: null
                      N_ZIP: null
                      N_CITY: null
                      SOCKET: null
                      N_COUNTER_ID: 0
                      N_PRODUCER: null
                      N_SERIAL_NUM: null
                      N_LAST_RESPONSE: null
                      N_CT: 76
                      N_CREATED: null
                      N_L_ID: 568
                      N_GPS_LATITUDE: null
                      N_GPS_LONGITUDE: null
                      N_UCP_ID: null
                      N_US_ID: null
                      N_UA_ID: null
                      N_CACHE_NAME: omnis
                      N_CACHE_LAST_WS_ID: null
                      N_DELETED: null
                      params:
                        -
                          ID: 301407055
                          NODE_ID: 1793161
                          NI_NPI_ID: 0
                          PAR_NAME: blkdevice_flat_number
                          PAR_INDEX: 0
                          VALUE: null
                          CONTENT: null
                          TEXT_CONTENT: null
                      customer_service_devices:
                        -
                          NS_ID: 2150080
                          NS_N_ID: 1793161
                          NS_U_ID: 1038
                          NS_SA_ID: null
                          NS_TIME: '2026-02-23 16:34:45'
                          NS_L_ID: 1
                          NS_NEEDS_UPDATE: 0
                    -
                      ID: 1793162
                      NAME: UNIT-snrwtu
                      NOTE: 'Quis adipisci molestias fugit deleniti distinctio eum.'
                      MANAGED: 0
                      MANAG_IP: null
                      PARENT_NODE: null
                      F_TYPE: null
                      N_TYPE: BLK_DEVICE
                      N_DEVICE_TYPE: blk_device
                      N_CUSTOMER: 1
                      USER_SERVICE_ID: 0
                      CUSTOMER_PARENT: 1
                      CUSTOMER_TYPE: null
                      CUSTOMER_LOCATION: 0
                      MAC: null
                      UPDATE_FLAG: 0
                      AGR_GROUP: null
                      STREET: null
                      HOUSE_ID: null
                      N_ZIP: null
                      N_CITY: null
                      SOCKET: null
                      N_COUNTER_ID: 0
                      N_PRODUCER: null
                      N_SERIAL_NUM: null
                      N_LAST_RESPONSE: null
                      N_CT: 74
                      N_CREATED: null
                      N_L_ID: 535
                      N_GPS_LATITUDE: null
                      N_GPS_LONGITUDE: null
                      N_UCP_ID: null
                      N_US_ID: null
                      N_UA_ID: null
                      N_CACHE_NAME: aut
                      N_CACHE_LAST_WS_ID: null
                      N_DELETED: null
                      params:
                        -
                          ID: 301407056
                          NODE_ID: 1793162
                          NI_NPI_ID: 0
                          PAR_NAME: blkdevice_connection_type
                          PAR_INDEX: 0
                          VALUE: null
                          CONTENT: null
                          TEXT_CONTENT: null
                      customer_service_devices:
                        -
                          NS_ID: 2150081
                          NS_N_ID: 1793162
                          NS_U_ID: 1038
                          NS_SA_ID: null
                          NS_TIME: '2026-02-25 19:51:53'
                          NS_L_ID: 1
                          NS_NEEDS_UPDATE: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 1793161
                        NAME: UNIT-uwpwlv
                        NOTE: 'Odit et et modi.'
                        MANAGED: 0
                        MANAG_IP: null
                        PARENT_NODE: null
                        F_TYPE: null
                        N_TYPE: BLK_DEVICE
                        N_DEVICE_TYPE: blk_device
                        N_CUSTOMER: 1
                        USER_SERVICE_ID: 0
                        CUSTOMER_PARENT: 1
                        CUSTOMER_TYPE: null
                        CUSTOMER_LOCATION: 0
                        MAC: null
                        UPDATE_FLAG: 0
                        AGR_GROUP: null
                        STREET: null
                        HOUSE_ID: null
                        N_ZIP: null
                        N_CITY: null
                        SOCKET: null
                        N_COUNTER_ID: 0
                        N_PRODUCER: null
                        N_SERIAL_NUM: null
                        N_LAST_RESPONSE: null
                        N_CT: 76
                        N_CREATED: null
                        N_L_ID: 568
                        N_GPS_LATITUDE: null
                        N_GPS_LONGITUDE: null
                        N_UCP_ID: null
                        N_US_ID: null
                        N_UA_ID: null
                        N_CACHE_NAME: omnis
                        N_CACHE_LAST_WS_ID: null
                        N_DELETED: null
                        params:
                          -
                            ID: 301407055
                            NODE_ID: 1793161
                            NI_NPI_ID: 0
                            PAR_NAME: blkdevice_flat_number
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        customer_service_devices:
                          -
                            NS_ID: 2150080
                            NS_N_ID: 1793161
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-02-23 16:34:45'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                      -
                        ID: 1793162
                        NAME: UNIT-snrwtu
                        NOTE: 'Quis adipisci molestias fugit deleniti distinctio eum.'
                        MANAGED: 0
                        MANAG_IP: null
                        PARENT_NODE: null
                        F_TYPE: null
                        N_TYPE: BLK_DEVICE
                        N_DEVICE_TYPE: blk_device
                        N_CUSTOMER: 1
                        USER_SERVICE_ID: 0
                        CUSTOMER_PARENT: 1
                        CUSTOMER_TYPE: null
                        CUSTOMER_LOCATION: 0
                        MAC: null
                        UPDATE_FLAG: 0
                        AGR_GROUP: null
                        STREET: null
                        HOUSE_ID: null
                        N_ZIP: null
                        N_CITY: null
                        SOCKET: null
                        N_COUNTER_ID: 0
                        N_PRODUCER: null
                        N_SERIAL_NUM: null
                        N_LAST_RESPONSE: null
                        N_CT: 74
                        N_CREATED: null
                        N_L_ID: 535
                        N_GPS_LATITUDE: null
                        N_GPS_LONGITUDE: null
                        N_UCP_ID: null
                        N_US_ID: null
                        N_UA_ID: null
                        N_CACHE_NAME: aut
                        N_CACHE_LAST_WS_ID: null
                        N_DELETED: null
                        params:
                          -
                            ID: 301407056
                            NODE_ID: 1793162
                            NI_NPI_ID: 0
                            PAR_NAME: blkdevice_connection_type
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        customer_service_devices:
                          -
                            NS_ID: 2150081
                            NS_N_ID: 1793162
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-02-25 19:51:53'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 1793161
                          description: 'Unique customer unit identifier (primary key).'
                        NAME:
                          type: string
                          example: UNIT-uwpwlv
                          description: 'Unit name (up to 30 characters).'
                        NOTE:
                          type: string
                          example: 'Odit et et modi.'
                          description: 'Free-text note.'
                          nullable: true
                        MANAGED:
                          type: integer
                          example: 0
                          description: 'Flag indicating the unit is managed (configured) by the Mango system. 1 = managed.'
                        MANAG_IP:
                          type: string
                          example: null
                          description: 'Management IP address.'
                          nullable: true
                        PARENT_NODE:
                          type: string
                          example: null
                          description: 'ID of the parent device in the network topology.'
                          nullable: true
                        F_TYPE:
                          type: string
                          example: null
                          description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                          nullable: true
                        N_TYPE:
                          type: string
                          example: BLK_DEVICE
                          description: "Node type. Always 'BLK_DEVICE' for customer units."
                        N_DEVICE_TYPE:
                          type: string
                          example: blk_device
                          description: 'Specific unit/device type identifier (references nodes_device_types).'
                        N_CUSTOMER:
                          type: integer
                          example: 1
                          description: 'Customer device flag. Always 1 for customer units.'
                        USER_SERVICE_ID:
                          type: integer
                          example: 0
                          description: 'ID of the associated customer service.'
                          nullable: true
                        CUSTOMER_PARENT:
                          type: integer
                          example: 1
                          description: 'Flag indicating this unit can host child devices (CPE). 1 = open for customer connections.'
                        CUSTOMER_TYPE:
                          type: string
                          example: null
                          description: 'Customer device sub-type classification.'
                          nullable: true
                        CUSTOMER_LOCATION:
                          type: integer
                          example: 0
                          description: 'Deprecated. Former customer location reference (now via nodes_cust_locations).'
                          nullable: true
                        MAC:
                          type: string
                          example: null
                          description: 'MAC address.'
                          nullable: true
                        UPDATE_FLAG:
                          type: integer
                          example: 0
                          description: 'Flag indicating configuration needs to be pushed/updated. 1 = update pending.'
                        AGR_GROUP:
                          type: string
                          example: null
                          description: 'Deprecated. Former aggregation group reference.'
                          nullable: true
                        STREET:
                          type: string
                          example: null
                          description: 'Street name of the unit location.'
                          nullable: true
                        HOUSE_ID:
                          type: string
                          example: null
                          description: 'House number (cislo popisne).'
                          nullable: true
                        N_ZIP:
                          type: string
                          example: null
                          description: 'ZIP / postal code (up to 5 characters).'
                          nullable: true
                        N_CITY:
                          type: string
                          example: null
                          description: 'City of the unit location.'
                          nullable: true
                        SOCKET:
                          type: string
                          example: null
                          description: 'Apartment/socket identifier at the address.'
                          nullable: true
                        N_COUNTER_ID:
                          type: integer
                          example: 0
                          description: 'Deprecated. Former counter ID (now stored as a unit parameter).'
                          nullable: true
                        N_PRODUCER:
                          type: string
                          example: null
                          description: 'Device manufacturer / producer.'
                          nullable: true
                        N_SERIAL_NUM:
                          type: string
                          example: null
                          description: 'Serial number.'
                          nullable: true
                        N_LAST_RESPONSE:
                          type: string
                          example: null
                          description: 'Datetime of the last successful SNMP monitoring response.'
                          nullable: true
                        N_CT:
                          type: integer
                          example: 76
                          description: 'Location / installation (CT) identifier.'
                        N_CREATED:
                          type: string
                          example: null
                          description: 'Datetime when the unit record was created.'
                          nullable: true
                        N_L_ID:
                          type: integer
                          example: 568
                          description: 'ID of the operator (login) who last modified this unit.'
                        N_GPS_LATITUDE:
                          type: string
                          example: null
                          description: 'GPS latitude.'
                          nullable: true
                        N_GPS_LONGITUDE:
                          type: string
                          example: null
                          description: 'GPS longitude.'
                          nullable: true
                        N_UCP_ID:
                          type: string
                          example: null
                          description: 'UIR registry city part ID.'
                          nullable: true
                        N_US_ID:
                          type: string
                          example: null
                          description: 'UIR registry street ID.'
                          nullable: true
                        N_UA_ID:
                          type: string
                          example: null
                          description: 'UIR registry address ID (RUIAN code).'
                          nullable: true
                        N_CACHE_NAME:
                          type: string
                          example: omnis
                          description: 'Cached display name combining class, type and unit name.'
                        N_CACHE_LAST_WS_ID:
                          type: string
                          example: null
                          description: 'Cached ID of the last work session that touched this unit.'
                          nullable: true
                        N_DELETED:
                          type: string
                          example: null
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              ID: 301407055
                              NODE_ID: 1793161
                              NI_NPI_ID: 0
                              PAR_NAME: blkdevice_flat_number
                              PAR_INDEX: 0
                              VALUE: null
                              CONTENT: null
                              TEXT_CONTENT: null
                          description: 'Unit parameters — collection of key-value pairs from the node_info table.'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 301407055
                              NODE_ID:
                                type: integer
                                example: 1793161
                              NI_NPI_ID:
                                type: integer
                                example: 0
                              PAR_NAME:
                                type: string
                                example: blkdevice_flat_number
                              PAR_INDEX:
                                type: integer
                                example: 0
                              VALUE:
                                type: string
                                example: null
                                nullable: true
                              CONTENT:
                                type: string
                                example: null
                                nullable: true
                              TEXT_CONTENT:
                                type: string
                                example: null
                                nullable: true
                        customer_service_devices:
                          type: array
                          example:
                            -
                              NS_ID: 2150080
                              NS_N_ID: 1793161
                              NS_U_ID: 1038
                              NS_SA_ID: null
                              NS_TIME: '2026-02-23 16:34:45'
                              NS_L_ID: 1
                              NS_NEEDS_UPDATE: 0
                          description: 'Services bound to this unit — junction records linking units to customers and their services.'
                          items:
                            type: object
                            properties:
                              NS_ID:
                                type: integer
                                example: 2150080
                              NS_N_ID:
                                type: integer
                                example: 1793161
                              NS_U_ID:
                                type: integer
                                example: 1038
                              NS_SA_ID:
                                type: string
                                example: null
                                nullable: true
                              NS_TIME:
                                type: string
                                example: '2026-02-23 16:34:45'
                              NS_L_ID:
                                type: integer
                                example: 1
                              NS_NEEDS_UPDATE:
                                type: integer
                                example: 0
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
      tags:
        - 'Customer Units'
  '/api/v3/customer-units/{id}':
    get:
      summary: 'Get Customer Unit'
      operationId: getCustomerUnit
      description: '   Retrieve a specific customer unit by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1793163
                    NAME: UNIT-qwrsit
                    NOTE: null
                    MANAGED: 0
                    MANAG_IP: null
                    PARENT_NODE: null
                    F_TYPE: null
                    N_TYPE: BLK_DEVICE
                    N_DEVICE_TYPE: blk_device
                    N_CUSTOMER: 1
                    USER_SERVICE_ID: 0
                    CUSTOMER_PARENT: 1
                    CUSTOMER_TYPE: null
                    CUSTOMER_LOCATION: 0
                    MAC: null
                    UPDATE_FLAG: 0
                    AGR_GROUP: null
                    STREET: null
                    HOUSE_ID: null
                    N_ZIP: null
                    N_CITY: null
                    SOCKET: null
                    N_COUNTER_ID: 0
                    N_PRODUCER: null
                    N_SERIAL_NUM: null
                    N_LAST_RESPONSE: null
                    N_CT: 46
                    N_CREATED: null
                    N_L_ID: 646
                    N_GPS_LATITUDE: null
                    N_GPS_LONGITUDE: null
                    N_UCP_ID: null
                    N_US_ID: null
                    N_UA_ID: null
                    N_CACHE_NAME: autem
                    N_CACHE_LAST_WS_ID: null
                    N_DELETED: null
                    params:
                      -
                        ID: 301407057
                        NODE_ID: 1793163
                        NI_NPI_ID: 0
                        PAR_NAME: blkdevice_connection_type
                        PAR_INDEX: 0
                        VALUE: null
                        CONTENT: null
                        TEXT_CONTENT: null
                    customer_service_devices:
                      -
                        NS_ID: 2150082
                        NS_N_ID: 1793163
                        NS_U_ID: 1038
                        NS_SA_ID: null
                        NS_TIME: '2026-03-12 18:51:31'
                        NS_L_ID: 1
                        NS_NEEDS_UPDATE: 0
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1793163
                        description: 'Unique customer unit identifier (primary key).'
                      NAME:
                        type: string
                        example: UNIT-qwrsit
                        description: 'Unit name (up to 30 characters).'
                      NOTE:
                        type: string
                        example: null
                        description: 'Free-text note.'
                        nullable: true
                      MANAGED:
                        type: integer
                        example: 0
                        description: 'Flag indicating the unit is managed (configured) by the Mango system. 1 = managed.'
                      MANAG_IP:
                        type: string
                        example: null
                        description: 'Management IP address.'
                        nullable: true
                      PARENT_NODE:
                        type: string
                        example: null
                        description: 'ID of the parent device in the network topology.'
                        nullable: true
                      F_TYPE:
                        type: string
                        example: null
                        description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                        nullable: true
                      N_TYPE:
                        type: string
                        example: BLK_DEVICE
                        description: "Node type. Always 'BLK_DEVICE' for customer units."
                      N_DEVICE_TYPE:
                        type: string
                        example: blk_device
                        description: 'Specific unit/device type identifier (references nodes_device_types).'
                      N_CUSTOMER:
                        type: integer
                        example: 1
                        description: 'Customer device flag. Always 1 for customer units.'
                      USER_SERVICE_ID:
                        type: integer
                        example: 0
                        description: 'ID of the associated customer service.'
                        nullable: true
                      CUSTOMER_PARENT:
                        type: integer
                        example: 1
                        description: 'Flag indicating this unit can host child devices (CPE). 1 = open for customer connections.'
                      CUSTOMER_TYPE:
                        type: string
                        example: null
                        description: 'Customer device sub-type classification.'
                        nullable: true
                      CUSTOMER_LOCATION:
                        type: integer
                        example: 0
                        description: 'Deprecated. Former customer location reference (now via nodes_cust_locations).'
                        nullable: true
                      MAC:
                        type: string
                        example: null
                        description: 'MAC address.'
                        nullable: true
                      UPDATE_FLAG:
                        type: integer
                        example: 0
                        description: 'Flag indicating configuration needs to be pushed/updated. 1 = update pending.'
                      AGR_GROUP:
                        type: string
                        example: null
                        description: 'Deprecated. Former aggregation group reference.'
                        nullable: true
                      STREET:
                        type: string
                        example: null
                        description: 'Street name of the unit location.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: null
                        description: 'House number (cislo popisne).'
                        nullable: true
                      N_ZIP:
                        type: string
                        example: null
                        description: 'ZIP / postal code (up to 5 characters).'
                        nullable: true
                      N_CITY:
                        type: string
                        example: null
                        description: 'City of the unit location.'
                        nullable: true
                      SOCKET:
                        type: string
                        example: null
                        description: 'Apartment/socket identifier at the address.'
                        nullable: true
                      N_COUNTER_ID:
                        type: integer
                        example: 0
                        description: 'Deprecated. Former counter ID (now stored as a unit parameter).'
                        nullable: true
                      N_PRODUCER:
                        type: string
                        example: null
                        description: 'Device manufacturer / producer.'
                        nullable: true
                      N_SERIAL_NUM:
                        type: string
                        example: null
                        description: 'Serial number.'
                        nullable: true
                      N_LAST_RESPONSE:
                        type: string
                        example: null
                        description: 'Datetime of the last successful SNMP monitoring response.'
                        nullable: true
                      N_CT:
                        type: integer
                        example: 46
                        description: 'Location / installation (CT) identifier.'
                      N_CREATED:
                        type: string
                        example: null
                        description: 'Datetime when the unit record was created.'
                        nullable: true
                      N_L_ID:
                        type: integer
                        example: 646
                        description: 'ID of the operator (login) who last modified this unit.'
                      N_GPS_LATITUDE:
                        type: string
                        example: null
                        description: 'GPS latitude.'
                        nullable: true
                      N_GPS_LONGITUDE:
                        type: string
                        example: null
                        description: 'GPS longitude.'
                        nullable: true
                      N_UCP_ID:
                        type: string
                        example: null
                        description: 'UIR registry city part ID.'
                        nullable: true
                      N_US_ID:
                        type: string
                        example: null
                        description: 'UIR registry street ID.'
                        nullable: true
                      N_UA_ID:
                        type: string
                        example: null
                        description: 'UIR registry address ID (RUIAN code).'
                        nullable: true
                      N_CACHE_NAME:
                        type: string
                        example: autem
                        description: 'Cached display name combining class, type and unit name.'
                      N_CACHE_LAST_WS_ID:
                        type: string
                        example: null
                        description: 'Cached ID of the last work session that touched this unit.'
                        nullable: true
                      N_DELETED:
                        type: string
                        example: null
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            ID: 301407057
                            NODE_ID: 1793163
                            NI_NPI_ID: 0
                            PAR_NAME: blkdevice_connection_type
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        description: 'Unit parameters — collection of key-value pairs from the node_info table.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 301407057
                            NODE_ID:
                              type: integer
                              example: 1793163
                            NI_NPI_ID:
                              type: integer
                              example: 0
                            PAR_NAME:
                              type: string
                              example: blkdevice_connection_type
                            PAR_INDEX:
                              type: integer
                              example: 0
                            VALUE:
                              type: string
                              example: null
                              nullable: true
                            CONTENT:
                              type: string
                              example: null
                              nullable: true
                            TEXT_CONTENT:
                              type: string
                              example: null
                              nullable: true
                      customer_service_devices:
                        type: array
                        example:
                          -
                            NS_ID: 2150082
                            NS_N_ID: 1793163
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-03-12 18:51:31'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        description: 'Services bound to this unit — junction records linking units to customers and their services.'
                        items:
                          type: object
                          properties:
                            NS_ID:
                              type: integer
                              example: 2150082
                            NS_N_ID:
                              type: integer
                              example: 1793163
                            NS_U_ID:
                              type: integer
                              example: 1038
                            NS_SA_ID:
                              type: string
                              example: null
                              nullable: true
                            NS_TIME:
                              type: string
                              example: '2026-03-12 18:51:31'
                            NS_L_ID:
                              type: integer
                              example: 1
                            NS_NEEDS_UPDATE:
                              type: integer
                              example: 0
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
      tags:
        - 'Customer Units'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer unit.'
        example: 116416
        required: true
        schema:
          type: integer
  /api/v3/customers:
    get:
      summary: 'List Customers'
      operationId: listCustomers
      description: "   This endpoint gets a list of customers.\n   The list can be filtered and sorted."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of users to return per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of users to return per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: active
          description: 'Filter by active status'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by active status'
            example: 'true'
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: search
          description: 'Full-text search across FIRST_NAME, LAST_NAME, COMPANY (case-insensitive LIKE)'
          example: Smith
          required: false
          schema:
            type: string
            description: 'Full-text search across FIRST_NAME, LAST_NAME, COMPANY (case-insensitive LIKE)'
            example: Smith
        -
          in: query
          name: groups_all
          description: 'Filter customers who are members of ALL specified group IDs (comma-separated, AND logic)'
          example: '1,2'
          required: false
          schema:
            type: string
            description: 'Filter customers who are members of ALL specified group IDs (comma-separated, AND logic)'
            example: '1,2'
        -
          in: query
          name: groups_any
          description: 'Filter customers who are members of ANY of the specified group IDs (comma-separated, OR logic)'
          example: '1,2'
          required: false
          schema:
            type: string
            description: 'Filter customers who are members of ANY of the specified group IDs (comma-separated, OR logic)'
            example: '1,2'
        -
          in: query
          name: device
          description: 'Filter customers linked to a specific device (node) ID via nodes_services'
          example: 4967
          required: false
          schema:
            type: integer
            description: 'Filter customers linked to a specific device (node) ID via nodes_services'
            example: 4967
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      USER_ID: 1987391
                      LOGIN: nelda10
                      PASSWORD: '"=B]*3=S>''z_|>N]l'
                      U_PASS_QUESTION: null
                      U_PASS_ANSWER: dicta
                      TYPE: S
                      P_TITLE: Prof.
                      FIRST_NAME: Hardy
                      LAST_NAME: Trantow
                      COMPANY: Runolfsson-Funk
                      STREET: 'Kuhic Squares'
                      HOUSE_ID: '976'
                      CITY: 'East Emmanuelleland'
                      ZIP: '01285'
                      U_UC_ID: null
                      U_US_ID: null
                      U_UA_ID: null
                      U_CL_ID: null
                      ADR2: null
                      U_RECIPIENT2: null
                      STREET2: null
                      HOUSE_ID2: null
                      CITY2: null
                      ZIP2: null
                      U_UC_ID2: null
                      U_US_ID2: null
                      U_UA_ID2: null
                      U_CL_ID2: null
                      ADR3: null
                      U_RECIPIENT3: null
                      STREET3: null
                      HOUSE_ID3: null
                      CITY3: null
                      ZIP3: null
                      U_UC_ID3: null
                      U_US_ID3: null
                      U_UA_ID3: null
                      U_CL_ID3: null
                      FAX: null
                      SERVICES: nisi
                      COMP_ID: null
                      COMP_FID: null
                      ACTIVATION: '1900-01-01 00:00:00'
                      U_ACTIVATION_LAST: '2026-02-16 15:02:04'
                      INFO_MAIL: 1
                      INFO_POST: null
                      USER_NOTE: null
                      INTERNAL_NOTE: null
                      CT: '000'
                      FLAT: null
                      NOTE1: null
                      NOTE2: null
                      NOTE3: null
                      NOTE4: null
                      NOTE5: null
                      NOTE6: null
                      NOTE7: null
                      NOTE8: null
                      SIPO_NUM: null
                      DATE_BEGIN: null
                      DATE_END: null
                      SIPO_DATE_FROM: null
                      GROUP_ID: null
                      VAR_SYMBOL: null
                      AGR_NAME: null
                      PERSON_ID_NUMBER: null
                      U_BIRTHDAY: null
                      U_PERSONAL_NUMBER: null
                      U_DOCUMENT_NUMBER: null
                      ACCOUNT_PRE_NUMBER: null
                      ACCOUNT_NUMBER: null
                      ACCOUNT_BANK: null
                      U_IBAN: null
                      U_ACCOUNT_ATTACH: null
                      U_ACCOUNT_SPECSYM: null
                      SALESMAN: null
                      U_BIRTH_NUMBER: null
                      U_TECH_LOC: null
                      U_FLAT_TYPE: null
                      U_TECH_NAME: null
                      U_PREMISES: 0
                      U_INV_NOTE: null
                      U_CODENAME: null
                      U_ACTIVE: 1
                      LOG_LEVEL: INFO
                      U_INFO_SMS: 0
                      U_PERSON_ID: null
                      U_STATUTARY: null
                      U_COMP_VATID: null
                      U_DEFAULT_BP_ID: null
                      U_EU_FIRST_LOGIN: 1
                      U_PASS_EXPIRE: null
                      U_PASS_CHANGE: null
                      U_REGENERATE: null
                      U_REGENERATE_L_ID: null
                      U_REGENERATE_PAYMENTS: null
                      U_REGENERATE_PAYMENTS_L_ID: null
                      U_PROV_LEVEL: 10
                      U_DEGREE_BEHIND: null
                      U_PROVISIONING: 0
                      U_CODE_REFERENCES: null
                      U_BATCH: null
                      U_VALUATION: null
                      U_PROVIDER_USER_ID: null
                      U_PROVIDER_TYPE: NONE
                      U_PROVIDER_LABEL: null
                      U_PROVIDER_ACTIVE: null
                      U_INFO_MARKETING: null
                      U_OFF_LIMIT: null
                      U_LAST_USAGE: null
                      U_LAST_CHANGE: null
                      U_DEBTS_GENERATE: 0
                      U_EXTRA_WORK_DETAIL: 0
                      U_WORKS_COUNT_STRATEGY: MINS
                      U_GROUP_COMP_FID: 0
                      params:
                        -
                          UP_ID: '0000988737'
                          UP_USER_ID: 1987391
                          UP_NAME: param_sexl
                          UP_VALID_FROM: '2026-01-12'
                          UP_VALID_TO: null
                          UP_VALUE: 'Esse et.'
                          UP_CONTENT: null
                          UP_CREATED: '2026-01-27 16:22:26'
                          UP_L_ID: '000862'
                      contact_phone_numbers:
                        -
                          CPN_ID: 1110426
                          CPN_SUBJ_ID: 1987391
                          CPN_VALID: 0
                          CPN_PHONE: 128884238
                          CPN_L_ID: 8475
                          CPN_LAST_UPDATE: '2026-01-07 01:28:08'
                      contact_email_addresses:
                        -
                          CEA_ID: 446325
                          CEA_SUBJ_ID: 1987391
                          CEA_VALID: 1
                          CEA_EMAIL: wbartell@example.com
                          CEA_L_ID: 6243
                          CEA_LAST_UPDATE: '2026-02-10 06:20:53'
                    -
                      USER_ID: 1987392
                      LOGIN: bobbie.flatley
                      PASSWORD: 'zJTD&s?7l4'
                      U_PASS_QUESTION: null
                      U_PASS_ANSWER: earum
                      TYPE: S
                      P_TITLE: null
                      FIRST_NAME: Korbin
                      LAST_NAME: Jenkins
                      COMPANY: 'Reinger, Koelpin and Nitzsche'
                      STREET: 'Wolff Radial'
                      HOUSE_ID: '590'
                      CITY: Watsicashire
                      ZIP: 60553-
                      U_UC_ID: null
                      U_US_ID: null
                      U_UA_ID: null
                      U_CL_ID: null
                      ADR2: null
                      U_RECIPIENT2: null
                      STREET2: null
                      HOUSE_ID2: null
                      CITY2: null
                      ZIP2: null
                      U_UC_ID2: null
                      U_US_ID2: null
                      U_UA_ID2: null
                      U_CL_ID2: null
                      ADR3: null
                      U_RECIPIENT3: null
                      STREET3: null
                      HOUSE_ID3: null
                      CITY3: null
                      ZIP3: null
                      U_UC_ID3: null
                      U_US_ID3: null
                      U_UA_ID3: null
                      U_CL_ID3: null
                      FAX: null
                      SERVICES: est
                      COMP_ID: null
                      COMP_FID: null
                      ACTIVATION: '1900-01-01 00:00:00'
                      U_ACTIVATION_LAST: '2026-03-17 04:51:02'
                      INFO_MAIL: 1
                      INFO_POST: null
                      USER_NOTE: null
                      INTERNAL_NOTE: null
                      CT: '010'
                      FLAT: null
                      NOTE1: null
                      NOTE2: null
                      NOTE3: null
                      NOTE4: null
                      NOTE5: null
                      NOTE6: null
                      NOTE7: null
                      NOTE8: null
                      SIPO_NUM: null
                      DATE_BEGIN: null
                      DATE_END: null
                      SIPO_DATE_FROM: null
                      GROUP_ID: null
                      VAR_SYMBOL: null
                      AGR_NAME: null
                      PERSON_ID_NUMBER: null
                      U_BIRTHDAY: null
                      U_PERSONAL_NUMBER: null
                      U_DOCUMENT_NUMBER: null
                      ACCOUNT_PRE_NUMBER: null
                      ACCOUNT_NUMBER: null
                      ACCOUNT_BANK: null
                      U_IBAN: null
                      U_ACCOUNT_ATTACH: null
                      U_ACCOUNT_SPECSYM: null
                      SALESMAN: null
                      U_BIRTH_NUMBER: null
                      U_TECH_LOC: null
                      U_FLAT_TYPE: null
                      U_TECH_NAME: null
                      U_PREMISES: 0
                      U_INV_NOTE: null
                      U_CODENAME: null
                      U_ACTIVE: 1
                      LOG_LEVEL: INFO
                      U_INFO_SMS: 0
                      U_PERSON_ID: null
                      U_STATUTARY: null
                      U_COMP_VATID: null
                      U_DEFAULT_BP_ID: null
                      U_EU_FIRST_LOGIN: 1
                      U_PASS_EXPIRE: null
                      U_PASS_CHANGE: null
                      U_REGENERATE: null
                      U_REGENERATE_L_ID: null
                      U_REGENERATE_PAYMENTS: null
                      U_REGENERATE_PAYMENTS_L_ID: null
                      U_PROV_LEVEL: 10
                      U_DEGREE_BEHIND: null
                      U_PROVISIONING: 0
                      U_CODE_REFERENCES: null
                      U_BATCH: null
                      U_VALUATION: null
                      U_PROVIDER_USER_ID: null
                      U_PROVIDER_TYPE: NONE
                      U_PROVIDER_LABEL: null
                      U_PROVIDER_ACTIVE: null
                      U_INFO_MARKETING: null
                      U_OFF_LIMIT: null
                      U_LAST_USAGE: null
                      U_LAST_CHANGE: null
                      U_DEBTS_GENERATE: 0
                      U_EXTRA_WORK_DETAIL: 0
                      U_WORKS_COUNT_STRATEGY: MINS
                      U_GROUP_COMP_FID: 0
                      params:
                        -
                          UP_ID: '0000988738'
                          UP_USER_ID: 1987392
                          UP_NAME: param_nopf
                          UP_VALID_FROM: '2026-01-17'
                          UP_VALID_TO: null
                          UP_VALUE: 'Doloremque quam molestiae voluptatem.'
                          UP_CONTENT: 'Eveniet odit sequi iure totam velit dolorum praesentium. Ea voluptatem blanditiis nam vel sed. Est quasi alias aliquam autem sequi atque omnis. Quidem voluptatem ducimus enim quam sit. Omnis vitae sapiente inventore minus omnis.'
                          UP_CREATED: '2026-01-20 17:18:15'
                          UP_L_ID: '000365'
                      contact_phone_numbers:
                        -
                          CPN_ID: 1110427
                          CPN_SUBJ_ID: 1987392
                          CPN_VALID: 1
                          CPN_PHONE: 132182068
                          CPN_L_ID: 2336
                          CPN_LAST_UPDATE: '2026-03-20 08:37:38'
                      contact_email_addresses:
                        -
                          CEA_ID: 446326
                          CEA_SUBJ_ID: 1987392
                          CEA_VALID: 1
                          CEA_EMAIL: lmurphy@example.org
                          CEA_L_ID: 7106
                          CEA_LAST_UPDATE: '2026-02-28 10:32:17'
                properties:
                  data:
                    type: array
                    example:
                      -
                        USER_ID: 1987391
                        LOGIN: nelda10
                        PASSWORD: '"=B]*3=S>''z_|>N]l'
                        U_PASS_QUESTION: null
                        U_PASS_ANSWER: dicta
                        TYPE: S
                        P_TITLE: Prof.
                        FIRST_NAME: Hardy
                        LAST_NAME: Trantow
                        COMPANY: Runolfsson-Funk
                        STREET: 'Kuhic Squares'
                        HOUSE_ID: '976'
                        CITY: 'East Emmanuelleland'
                        ZIP: '01285'
                        U_UC_ID: null
                        U_US_ID: null
                        U_UA_ID: null
                        U_CL_ID: null
                        ADR2: null
                        U_RECIPIENT2: null
                        STREET2: null
                        HOUSE_ID2: null
                        CITY2: null
                        ZIP2: null
                        U_UC_ID2: null
                        U_US_ID2: null
                        U_UA_ID2: null
                        U_CL_ID2: null
                        ADR3: null
                        U_RECIPIENT3: null
                        STREET3: null
                        HOUSE_ID3: null
                        CITY3: null
                        ZIP3: null
                        U_UC_ID3: null
                        U_US_ID3: null
                        U_UA_ID3: null
                        U_CL_ID3: null
                        FAX: null
                        SERVICES: nisi
                        COMP_ID: null
                        COMP_FID: null
                        ACTIVATION: '1900-01-01 00:00:00'
                        U_ACTIVATION_LAST: '2026-02-16 15:02:04'
                        INFO_MAIL: 1
                        INFO_POST: null
                        USER_NOTE: null
                        INTERNAL_NOTE: null
                        CT: '000'
                        FLAT: null
                        NOTE1: null
                        NOTE2: null
                        NOTE3: null
                        NOTE4: null
                        NOTE5: null
                        NOTE6: null
                        NOTE7: null
                        NOTE8: null
                        SIPO_NUM: null
                        DATE_BEGIN: null
                        DATE_END: null
                        SIPO_DATE_FROM: null
                        GROUP_ID: null
                        VAR_SYMBOL: null
                        AGR_NAME: null
                        PERSON_ID_NUMBER: null
                        U_BIRTHDAY: null
                        U_PERSONAL_NUMBER: null
                        U_DOCUMENT_NUMBER: null
                        ACCOUNT_PRE_NUMBER: null
                        ACCOUNT_NUMBER: null
                        ACCOUNT_BANK: null
                        U_IBAN: null
                        U_ACCOUNT_ATTACH: null
                        U_ACCOUNT_SPECSYM: null
                        SALESMAN: null
                        U_BIRTH_NUMBER: null
                        U_TECH_LOC: null
                        U_FLAT_TYPE: null
                        U_TECH_NAME: null
                        U_PREMISES: 0
                        U_INV_NOTE: null
                        U_CODENAME: null
                        U_ACTIVE: 1
                        LOG_LEVEL: INFO
                        U_INFO_SMS: 0
                        U_PERSON_ID: null
                        U_STATUTARY: null
                        U_COMP_VATID: null
                        U_DEFAULT_BP_ID: null
                        U_EU_FIRST_LOGIN: 1
                        U_PASS_EXPIRE: null
                        U_PASS_CHANGE: null
                        U_REGENERATE: null
                        U_REGENERATE_L_ID: null
                        U_REGENERATE_PAYMENTS: null
                        U_REGENERATE_PAYMENTS_L_ID: null
                        U_PROV_LEVEL: 10
                        U_DEGREE_BEHIND: null
                        U_PROVISIONING: 0
                        U_CODE_REFERENCES: null
                        U_BATCH: null
                        U_VALUATION: null
                        U_PROVIDER_USER_ID: null
                        U_PROVIDER_TYPE: NONE
                        U_PROVIDER_LABEL: null
                        U_PROVIDER_ACTIVE: null
                        U_INFO_MARKETING: null
                        U_OFF_LIMIT: null
                        U_LAST_USAGE: null
                        U_LAST_CHANGE: null
                        U_DEBTS_GENERATE: 0
                        U_EXTRA_WORK_DETAIL: 0
                        U_WORKS_COUNT_STRATEGY: MINS
                        U_GROUP_COMP_FID: 0
                        params:
                          -
                            UP_ID: '0000988737'
                            UP_USER_ID: 1987391
                            UP_NAME: param_sexl
                            UP_VALID_FROM: '2026-01-12'
                            UP_VALID_TO: null
                            UP_VALUE: 'Esse et.'
                            UP_CONTENT: null
                            UP_CREATED: '2026-01-27 16:22:26'
                            UP_L_ID: '000862'
                        contact_phone_numbers:
                          -
                            CPN_ID: 1110426
                            CPN_SUBJ_ID: 1987391
                            CPN_VALID: 0
                            CPN_PHONE: 128884238
                            CPN_L_ID: 8475
                            CPN_LAST_UPDATE: '2026-01-07 01:28:08'
                        contact_email_addresses:
                          -
                            CEA_ID: 446325
                            CEA_SUBJ_ID: 1987391
                            CEA_VALID: 1
                            CEA_EMAIL: wbartell@example.com
                            CEA_L_ID: 6243
                            CEA_LAST_UPDATE: '2026-02-10 06:20:53'
                      -
                        USER_ID: 1987392
                        LOGIN: bobbie.flatley
                        PASSWORD: 'zJTD&s?7l4'
                        U_PASS_QUESTION: null
                        U_PASS_ANSWER: earum
                        TYPE: S
                        P_TITLE: null
                        FIRST_NAME: Korbin
                        LAST_NAME: Jenkins
                        COMPANY: 'Reinger, Koelpin and Nitzsche'
                        STREET: 'Wolff Radial'
                        HOUSE_ID: '590'
                        CITY: Watsicashire
                        ZIP: 60553-
                        U_UC_ID: null
                        U_US_ID: null
                        U_UA_ID: null
                        U_CL_ID: null
                        ADR2: null
                        U_RECIPIENT2: null
                        STREET2: null
                        HOUSE_ID2: null
                        CITY2: null
                        ZIP2: null
                        U_UC_ID2: null
                        U_US_ID2: null
                        U_UA_ID2: null
                        U_CL_ID2: null
                        ADR3: null
                        U_RECIPIENT3: null
                        STREET3: null
                        HOUSE_ID3: null
                        CITY3: null
                        ZIP3: null
                        U_UC_ID3: null
                        U_US_ID3: null
                        U_UA_ID3: null
                        U_CL_ID3: null
                        FAX: null
                        SERVICES: est
                        COMP_ID: null
                        COMP_FID: null
                        ACTIVATION: '1900-01-01 00:00:00'
                        U_ACTIVATION_LAST: '2026-03-17 04:51:02'
                        INFO_MAIL: 1
                        INFO_POST: null
                        USER_NOTE: null
                        INTERNAL_NOTE: null
                        CT: '010'
                        FLAT: null
                        NOTE1: null
                        NOTE2: null
                        NOTE3: null
                        NOTE4: null
                        NOTE5: null
                        NOTE6: null
                        NOTE7: null
                        NOTE8: null
                        SIPO_NUM: null
                        DATE_BEGIN: null
                        DATE_END: null
                        SIPO_DATE_FROM: null
                        GROUP_ID: null
                        VAR_SYMBOL: null
                        AGR_NAME: null
                        PERSON_ID_NUMBER: null
                        U_BIRTHDAY: null
                        U_PERSONAL_NUMBER: null
                        U_DOCUMENT_NUMBER: null
                        ACCOUNT_PRE_NUMBER: null
                        ACCOUNT_NUMBER: null
                        ACCOUNT_BANK: null
                        U_IBAN: null
                        U_ACCOUNT_ATTACH: null
                        U_ACCOUNT_SPECSYM: null
                        SALESMAN: null
                        U_BIRTH_NUMBER: null
                        U_TECH_LOC: null
                        U_FLAT_TYPE: null
                        U_TECH_NAME: null
                        U_PREMISES: 0
                        U_INV_NOTE: null
                        U_CODENAME: null
                        U_ACTIVE: 1
                        LOG_LEVEL: INFO
                        U_INFO_SMS: 0
                        U_PERSON_ID: null
                        U_STATUTARY: null
                        U_COMP_VATID: null
                        U_DEFAULT_BP_ID: null
                        U_EU_FIRST_LOGIN: 1
                        U_PASS_EXPIRE: null
                        U_PASS_CHANGE: null
                        U_REGENERATE: null
                        U_REGENERATE_L_ID: null
                        U_REGENERATE_PAYMENTS: null
                        U_REGENERATE_PAYMENTS_L_ID: null
                        U_PROV_LEVEL: 10
                        U_DEGREE_BEHIND: null
                        U_PROVISIONING: 0
                        U_CODE_REFERENCES: null
                        U_BATCH: null
                        U_VALUATION: null
                        U_PROVIDER_USER_ID: null
                        U_PROVIDER_TYPE: NONE
                        U_PROVIDER_LABEL: null
                        U_PROVIDER_ACTIVE: null
                        U_INFO_MARKETING: null
                        U_OFF_LIMIT: null
                        U_LAST_USAGE: null
                        U_LAST_CHANGE: null
                        U_DEBTS_GENERATE: 0
                        U_EXTRA_WORK_DETAIL: 0
                        U_WORKS_COUNT_STRATEGY: MINS
                        U_GROUP_COMP_FID: 0
                        params:
                          -
                            UP_ID: '0000988738'
                            UP_USER_ID: 1987392
                            UP_NAME: param_nopf
                            UP_VALID_FROM: '2026-01-17'
                            UP_VALID_TO: null
                            UP_VALUE: 'Doloremque quam molestiae voluptatem.'
                            UP_CONTENT: 'Eveniet odit sequi iure totam velit dolorum praesentium. Ea voluptatem blanditiis nam vel sed. Est quasi alias aliquam autem sequi atque omnis. Quidem voluptatem ducimus enim quam sit. Omnis vitae sapiente inventore minus omnis.'
                            UP_CREATED: '2026-01-20 17:18:15'
                            UP_L_ID: '000365'
                        contact_phone_numbers:
                          -
                            CPN_ID: 1110427
                            CPN_SUBJ_ID: 1987392
                            CPN_VALID: 1
                            CPN_PHONE: 132182068
                            CPN_L_ID: 2336
                            CPN_LAST_UPDATE: '2026-03-20 08:37:38'
                        contact_email_addresses:
                          -
                            CEA_ID: 446326
                            CEA_SUBJ_ID: 1987392
                            CEA_VALID: 1
                            CEA_EMAIL: lmurphy@example.org
                            CEA_L_ID: 7106
                            CEA_LAST_UPDATE: '2026-02-28 10:32:17'
                    items:
                      type: object
                      properties:
                        USER_ID:
                          type: integer
                          example: 1987391
                          description: 'Unique customer identifier (primary key).'
                        LOGIN:
                          type: string
                          example: nelda10
                          description: 'Login name for the customer portal (SelfCare).'
                          nullable: true
                        PASSWORD:
                          type: string
                          example: '"=B]*3=S>''z_|>N]l'
                          description: 'Password hash (MD5, 32 chars).'
                          nullable: true
                        U_PASS_QUESTION:
                          type: string
                          example: null
                          description: 'Password recovery question number (a code list entry ID).'
                          nullable: true
                        U_PASS_ANSWER:
                          type: string
                          example: dicta
                          description: 'Answer to the password recovery question.'
                          nullable: true
                        TYPE:
                          type: string
                          example: S
                          description: "Customer type. 'S' = private person, 'F' = self-employed / natural person with business, 'P' = legal entity / company."
                          enum:
                            - S
                            - F
                            - P
                        P_TITLE:
                          type: string
                          example: Prof.
                          description: 'Title before name (e.g. Ing., Mgr.).'
                          nullable: true
                        FIRST_NAME:
                          type: string
                          example: Hardy
                          description: "Customer's first name."
                          nullable: true
                        LAST_NAME:
                          type: string
                          example: Trantow
                          description: "Customer's last name (surname)."
                          nullable: true
                        COMPANY:
                          type: string
                          example: Runolfsson-Funk
                          description: "Company or organization name. Used as display name for TYPE 'P' and 'F'."
                          nullable: true
                        STREET:
                          type: string
                          example: 'Kuhic Squares'
                          description: 'Primary address — street name.'
                          nullable: true
                        HOUSE_ID:
                          type: string
                          example: '976'
                          description: 'Primary address — house number (číslo popisné).'
                          nullable: true
                        CITY:
                          type: string
                          example: 'East Emmanuelleland'
                          description: 'Primary address — city.'
                          nullable: true
                        ZIP:
                          type: string
                          example: '01285'
                          description: 'Primary address — postal code (PSČ).'
                          nullable: true
                        U_UC_ID:
                          type: string
                          example: null
                          description: 'Primary address — UIR registry city ID.'
                          nullable: true
                        U_US_ID:
                          type: string
                          example: null
                          description: 'Primary address — UIR registry street ID.'
                          nullable: true
                        U_UA_ID:
                          type: string
                          example: null
                          description: 'Primary address — UIR registry address ID.'
                          nullable: true
                        U_CL_ID:
                          type: string
                          example: null
                          description: 'Primary address — code list reference ID.'
                          nullable: true
                        ADR2:
                          type: string
                          example: null
                          description: "Shipping/mailing address mode. 'AS1' = same as primary address, 'OWN' = custom address."
                          nullable: true
                          enum:
                            - AS1
                            - OWN
                        U_RECIPIENT2:
                          type: string
                          example: null
                          description: 'Shipping address — recipient name.'
                          nullable: true
                        STREET2:
                          type: string
                          example: null
                          description: 'Shipping address — street name.'
                          nullable: true
                        HOUSE_ID2:
                          type: string
                          example: null
                          description: 'Shipping address — house number.'
                          nullable: true
                        CITY2:
                          type: string
                          example: null
                          description: 'Shipping address — city.'
                          nullable: true
                        ZIP2:
                          type: string
                          example: null
                          description: 'Shipping address — postal code (PSČ).'
                          nullable: true
                        U_UC_ID2:
                          type: string
                          example: null
                          description: 'Shipping address — UIR registry city ID.'
                          nullable: true
                        U_US_ID2:
                          type: string
                          example: null
                          description: 'Shipping address — UIR registry street ID.'
                          nullable: true
                        U_UA_ID2:
                          type: string
                          example: null
                          description: 'Shipping address — UIR registry address ID.'
                          nullable: true
                        U_CL_ID2:
                          type: string
                          example: null
                          description: 'Shipping address — code list reference ID.'
                          nullable: true
                        ADR3:
                          type: string
                          example: null
                          description: "Invoice address mode. 'AS1' = same as primary, 'AS2' = same as shipping, 'OWN' = custom address."
                          nullable: true
                          enum:
                            - AS1
                            - AS2
                            - OWN
                        U_RECIPIENT3:
                          type: string
                          example: null
                          description: 'Invoice address — recipient name.'
                          nullable: true
                        STREET3:
                          type: string
                          example: null
                          description: 'Invoice address — street name.'
                          nullable: true
                        HOUSE_ID3:
                          type: string
                          example: null
                          description: 'Invoice address — house number.'
                          nullable: true
                        CITY3:
                          type: string
                          example: null
                          description: 'Invoice address — city.'
                          nullable: true
                        ZIP3:
                          type: string
                          example: null
                          description: 'Invoice address — postal code (PSČ).'
                          nullable: true
                        U_UC_ID3:
                          type: string
                          example: null
                          description: 'Invoice address — UIR registry city ID.'
                          nullable: true
                        U_US_ID3:
                          type: string
                          example: null
                          description: 'Invoice address — UIR registry street ID.'
                          nullable: true
                        U_UA_ID3:
                          type: string
                          example: null
                          description: 'Invoice address — UIR registry address ID.'
                          nullable: true
                        U_CL_ID3:
                          type: string
                          example: null
                          description: 'Invoice address — code list reference ID.'
                          nullable: true
                        FAX:
                          type: string
                          example: null
                          description: 'Fax number.'
                          nullable: true
                        SERVICES:
                          type: string
                          example: nisi
                          description: 'Comma-separated list of service identifiers associated with the customer.'
                        COMP_ID:
                          type: string
                          example: null
                          description: 'Company registration number (IČO).'
                          nullable: true
                        COMP_FID:
                          type: string
                          example: null
                          description: 'Tax identification number (DIČ).'
                          nullable: true
                        ACTIVATION:
                          type: string
                          example: '1900-01-01 00:00:00'
                          description: "Datetime of the customer's initial activation."
                        U_ACTIVATION_LAST:
                          type: string
                          example: '2026-02-16 15:02:04'
                          description: "Datetime of the customer's most recent activation."
                        INFO_MAIL:
                          type: integer
                          example: 1
                          description: 'Email notification consent flag. 1 = opted in.'
                          nullable: true
                        INFO_POST:
                          type: string
                          example: null
                          description: 'Postal (print) notification flag.'
                        USER_NOTE:
                          type: string
                          example: null
                          description: 'Customer-visible note.'
                          nullable: true
                        INTERNAL_NOTE:
                          type: string
                          example: null
                          description: 'Internal note — visible only to operators, not to the customer.'
                          nullable: true
                        CT:
                          type: string
                          example: '000'
                          description: 'Company/tenant identifier — multi-tenant discriminator.'
                        FLAT:
                          type: string
                          example: null
                          description: 'Primary address — flat/apartment number.'
                          nullable: true
                        NOTE1:
                          type: string
                          example: null
                          description: 'Custom note field 1.'
                          nullable: true
                        NOTE2:
                          type: string
                          example: null
                          description: 'Custom note field 2.'
                          nullable: true
                        NOTE3:
                          type: string
                          example: null
                          description: 'Custom note field 3.'
                          nullable: true
                        NOTE4:
                          type: string
                          example: null
                          description: 'Custom note field 4.'
                          nullable: true
                        NOTE5:
                          type: string
                          example: null
                          description: 'Custom note field 5.'
                          nullable: true
                        NOTE6:
                          type: string
                          example: null
                          description: 'Custom note field 6.'
                          nullable: true
                        NOTE7:
                          type: string
                          example: null
                          description: 'Custom note field 7.'
                          nullable: true
                        NOTE8:
                          type: string
                          example: null
                          description: 'Custom note field 8.'
                          nullable: true
                        SIPO_NUM:
                          type: string
                          example: null
                          description: 'SIPO number — postal payment connector number for recurring payments.'
                          nullable: true
                        DATE_BEGIN:
                          type: string
                          example: null
                          description: 'Contract start date (YYYY-MM-DD).'
                          nullable: true
                        DATE_END:
                          type: string
                          example: null
                          description: 'Contract end date (YYYY-MM-DD).'
                          nullable: true
                        SIPO_DATE_FROM:
                          type: string
                          example: null
                          description: 'SIPO effective start datetime.'
                          nullable: true
                        GROUP_ID:
                          type: string
                          example: null
                          description: 'Customer group identifier.'
                          nullable: true
                        VAR_SYMBOL:
                          type: string
                          example: null
                          description: 'Variable symbol — unique payment identifier used in bank transfers.'
                          nullable: true
                        AGR_NAME:
                          type: string
                          example: null
                          description: 'Agreement/contract number.'
                          nullable: true
                        PERSON_ID_NUMBER:
                          type: string
                          example: null
                          description: 'National personal ID number.'
                          nullable: true
                        U_BIRTHDAY:
                          type: string
                          example: null
                          description: 'Date of birth (YYYY-MM-DD).'
                          nullable: true
                        U_PERSONAL_NUMBER:
                          type: string
                          example: null
                          description: 'Personal identification number (rodné číslo / birth number).'
                          nullable: true
                        U_DOCUMENT_NUMBER:
                          type: string
                          example: null
                          description: 'Identity document number (e.g. national ID card number).'
                          nullable: true
                        ACCOUNT_PRE_NUMBER:
                          type: string
                          example: null
                          description: 'Bank account prefix number (Czech format).'
                          nullable: true
                        ACCOUNT_NUMBER:
                          type: string
                          example: null
                          description: 'Bank account number.'
                          nullable: true
                        ACCOUNT_BANK:
                          type: string
                          example: null
                          description: 'Bank code (4-digit Czech bank code).'
                          nullable: true
                        U_IBAN:
                          type: string
                          example: null
                          description: 'International Bank Account Number (IBAN).'
                          nullable: true
                        U_ACCOUNT_ATTACH:
                          type: string
                          example: null
                          description: 'Attachment ID linked to the bank account record.'
                          nullable: true
                        U_ACCOUNT_SPECSYM:
                          type: string
                          example: null
                          description: 'Specific symbol associated with the bank account.'
                          nullable: true
                        SALESMAN:
                          type: string
                          example: null
                          description: 'Sales representative (admin user) ID.'
                          nullable: true
                        U_BIRTH_NUMBER:
                          type: string
                          example: null
                          description: 'Birth number (rodné číslo). Alternative field for personal identification.'
                          nullable: true
                        U_TECH_LOC:
                          type: string
                          example: null
                          description: 'Technical location identifier.'
                          nullable: true
                        U_FLAT_TYPE:
                          type: string
                          example: null
                          description: 'Type of flat/premises (e.g. apartment category).'
                          nullable: true
                        U_TECH_NAME:
                          type: string
                          example: null
                          description: 'Technical name / description of the location.'
                          nullable: true
                        U_PREMISES:
                          type: integer
                          example: 0
                          description: 'Business premises flag. 1 = customer has associated premises.'
                        U_INV_NOTE:
                          type: string
                          example: null
                          description: 'Note printed on invoices.'
                          nullable: true
                        U_CODENAME:
                          type: string
                          example: null
                          description: 'Code identifier used by automated processors (e.g. SMS request handling).'
                          nullable: true
                        U_ACTIVE:
                          type: integer
                          example: 1
                          description: 'Active customer flag. 1 = active, 0 = inactive.'
                        LOG_LEVEL:
                          type: string
                          example: INFO
                          description: 'Logging level for this customer.'
                          enum:
                            - EMERG
                            - ALERT
                            - CRIT
                            - ERR
                            - WARNING
                            - NOTICE
                            - INFO
                            - DEBUG
                        U_INFO_SMS:
                          type: integer
                          example: 0
                          description: 'SMS notification consent flag. 1 = opted in.'
                          nullable: true
                        U_PERSON_ID:
                          type: string
                          example: null
                          description: 'Person identifier (up to 12 chars).'
                          nullable: true
                        U_STATUTARY:
                          type: string
                          example: null
                          description: 'Statutory body / authorized signatory of the contract.'
                          nullable: true
                        U_COMP_VATID:
                          type: string
                          example: null
                          description: 'VAT identification number (IČ DPH).'
                          nullable: true
                        U_DEFAULT_BP_ID:
                          type: string
                          example: null
                          description: 'Default billing period ID.'
                          nullable: true
                        U_EU_FIRST_LOGIN:
                          type: integer
                          example: 1
                          description: 'Flag indicating the SelfCare account has not been authorized yet. 1 = not yet authorized.'
                        U_PASS_EXPIRE:
                          type: string
                          example: null
                          description: 'Password expiration setting (days).'
                          nullable: true
                        U_PASS_CHANGE:
                          type: string
                          example: null
                          description: 'Datetime of the last password change.'
                          nullable: true
                        U_REGENERATE:
                          type: string
                          example: null
                          description: 'Timestamp when user-dependent data regeneration started. Cleared after successful regeneration.'
                          nullable: true
                        U_REGENERATE_L_ID:
                          type: string
                          example: null
                          description: 'Operator ID who triggered the data regeneration.'
                          nullable: true
                        U_REGENERATE_PAYMENTS:
                          type: string
                          example: null
                          description: 'Timestamp when payment data regeneration started.'
                          nullable: true
                        U_REGENERATE_PAYMENTS_L_ID:
                          type: string
                          example: null
                          description: 'Operator ID who triggered the payment data regeneration.'
                          nullable: true
                        U_PROV_LEVEL:
                          type: integer
                          example: 10
                          description: 'Customer trust/provisioning level. Higher values indicate greater trust.'
                        U_DEGREE_BEHIND:
                          type: string
                          example: null
                          description: 'Academic degree after name (e.g. Ph.D., CSc.).'
                          nullable: true
                        U_PROVISIONING:
                          type: integer
                          example: 0
                          description: 'Provisioning status.'
                          nullable: true
                        U_CODE_REFERENCES:
                          type: string
                          example: null
                          description: 'Referral/recommendation code (VIP).'
                          nullable: true
                        U_BATCH:
                          type: string
                          example: null
                          description: 'Batch processing data.'
                          nullable: true
                        U_VALUATION:
                          type: string
                          example: null
                          description: 'Customer valuation in percent. Used for modifying prices in pricelist calculations.'
                          nullable: true
                        U_PROVIDER_USER_ID:
                          type: string
                          example: null
                          description: 'User ID of the associated location provider.'
                          nullable: true
                        U_PROVIDER_TYPE:
                          type: string
                          example: NONE
                          description: 'Provider type classification.'
                          enum:
                            - NONE
                            - PROVIDER
                            - DEFAULT_PROVIDER
                        U_PROVIDER_LABEL:
                          type: string
                          example: null
                          description: 'Provider label — used as a contract number or identifier when USER_ID range is too large.'
                          nullable: true
                        U_PROVIDER_ACTIVE:
                          type: string
                          example: null
                          description: 'Flag indicating whether the location provider is active.'
                          nullable: true
                        U_INFO_MARKETING:
                          type: string
                          example: null
                          description: 'Marketing communication consent flag.'
                          nullable: true
                        U_OFF_LIMIT:
                          type: string
                          example: null
                          description: 'Off-limit threshold value.'
                          nullable: true
                        U_LAST_USAGE:
                          type: string
                          example: null
                          description: "Date of the customer's last service usage (YYYY-MM-DD)."
                          nullable: true
                        U_LAST_CHANGE:
                          type: string
                          example: null
                          description: 'Datetime of the last modification to this customer record.'
                          nullable: true
                        U_DEBTS_GENERATE:
                          type: integer
                          example: 0
                          description: 'Debts generation flag. 1 = automatic debt generation enabled.'
                        U_EXTRA_WORK_DETAIL:
                          type: integer
                          example: 0
                          description: 'Flag enabling extra work detail tracking.'
                          nullable: true
                        U_WORKS_COUNT_STRATEGY:
                          type: string
                          example: MINS
                          description: 'Work time counting strategy.'
                          nullable: true
                          enum:
                            - MINS
                            - COMM_15
                            - COMM_30
                            - COMM_60
                            - ROUND_15
                            - ROUND_30
                            - ROUND_60
                        U_GROUP_COMP_FID:
                          type: integer
                          example: 0
                          description: 'Flag indicating a group tax ID (skupinové DIČ). 1 = group DIČ is used.'
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              UP_ID: '0000988737'
                              UP_USER_ID: 1987391
                              UP_NAME: param_sexl
                              UP_VALID_FROM: '2026-01-12'
                              UP_VALID_TO: null
                              UP_VALUE: 'Esse et.'
                              UP_CONTENT: null
                              UP_CREATED: '2026-01-27 16:22:26'
                              UP_L_ID: '000862'
                          description: 'Customer parameters — collection of key-value pairs.'
                          items:
                            type: object
                            properties:
                              UP_ID:
                                type: string
                                example: '0000988737'
                              UP_USER_ID:
                                type: integer
                                example: 1987391
                              UP_NAME:
                                type: string
                                example: param_sexl
                              UP_VALID_FROM:
                                type: string
                                example: '2026-01-12'
                              UP_VALID_TO:
                                type: string
                                example: null
                                nullable: true
                              UP_VALUE:
                                type: string
                                example: 'Esse et.'
                              UP_CONTENT:
                                type: string
                                example: null
                                nullable: true
                              UP_CREATED:
                                type: string
                                example: '2026-01-27 16:22:26'
                              UP_L_ID:
                                type: string
                                example: '000862'
                        contact_phone_numbers:
                          type: array
                          example:
                            -
                              CPN_ID: 1110426
                              CPN_SUBJ_ID: 1987391
                              CPN_VALID: 0
                              CPN_PHONE: 128884238
                              CPN_L_ID: 8475
                              CPN_LAST_UPDATE: '2026-01-07 01:28:08'
                          description: "Collection of customer's contact phone numbers."
                          items:
                            type: object
                            properties:
                              CPN_ID:
                                type: integer
                                example: 1110426
                              CPN_SUBJ_ID:
                                type: integer
                                example: 1987391
                              CPN_VALID:
                                type: integer
                                example: 0
                              CPN_PHONE:
                                type: integer
                                example: 128884238
                              CPN_L_ID:
                                type: integer
                                example: 8475
                              CPN_LAST_UPDATE:
                                type: string
                                example: '2026-01-07 01:28:08'
                        contact_email_addresses:
                          type: array
                          example:
                            -
                              CEA_ID: 446325
                              CEA_SUBJ_ID: 1987391
                              CEA_VALID: 1
                              CEA_EMAIL: wbartell@example.com
                              CEA_L_ID: 6243
                              CEA_LAST_UPDATE: '2026-02-10 06:20:53'
                          description: "Collection of customer's contact email addresses."
                          items:
                            type: object
                            properties:
                              CEA_ID:
                                type: integer
                                example: 446325
                              CEA_SUBJ_ID:
                                type: integer
                                example: 1987391
                              CEA_VALID:
                                type: integer
                                example: 1
                              CEA_EMAIL:
                                type: string
                                example: wbartell@example.com
                              CEA_L_ID:
                                type: integer
                                example: 6243
                              CEA_LAST_UPDATE:
                                type: string
                                example: '2026-02-10 06:20:53'
                    required:
                      - USER_ID
                      - LOGIN
                      - PASSWORD
                      - U_PASS_QUESTION
                      - U_PASS_ANSWER
                      - TYPE
                      - P_TITLE
                      - FIRST_NAME
                      - LAST_NAME
                      - COMPANY
                      - STREET
                      - HOUSE_ID
                      - CITY
                      - ZIP
                      - U_UC_ID
                      - U_US_ID
                      - U_UA_ID
                      - U_CL_ID
                      - ADR2
                      - U_RECIPIENT2
                      - STREET2
                      - HOUSE_ID2
                      - CITY2
                      - ZIP2
                      - U_UC_ID2
                      - U_US_ID2
                      - U_UA_ID2
                      - U_CL_ID2
                      - ADR3
                      - U_RECIPIENT3
                      - STREET3
                      - HOUSE_ID3
                      - CITY3
                      - ZIP3
                      - U_UC_ID3
                      - U_US_ID3
                      - U_UA_ID3
                      - U_CL_ID3
                      - FAX
                      - SERVICES
                      - COMP_ID
                      - COMP_FID
                      - ACTIVATION
                      - U_ACTIVATION_LAST
                      - INFO_MAIL
                      - INFO_POST
                      - USER_NOTE
                      - INTERNAL_NOTE
                      - CT
                      - FLAT
                      - NOTE1
                      - NOTE2
                      - NOTE3
                      - NOTE4
                      - NOTE5
                      - NOTE6
                      - NOTE7
                      - NOTE8
                      - SIPO_NUM
                      - DATE_BEGIN
                      - DATE_END
                      - SIPO_DATE_FROM
                      - GROUP_ID
                      - VAR_SYMBOL
                      - AGR_NAME
                      - PERSON_ID_NUMBER
                      - U_BIRTHDAY
                      - U_PERSONAL_NUMBER
                      - U_DOCUMENT_NUMBER
                      - ACCOUNT_PRE_NUMBER
                      - ACCOUNT_NUMBER
                      - ACCOUNT_BANK
                      - U_IBAN
                      - U_ACCOUNT_ATTACH
                      - U_ACCOUNT_SPECSYM
                      - SALESMAN
                      - U_BIRTH_NUMBER
                      - U_TECH_LOC
                      - U_FLAT_TYPE
                      - U_TECH_NAME
                      - U_PREMISES
                      - U_INV_NOTE
                      - U_CODENAME
                      - U_ACTIVE
                      - LOG_LEVEL
                      - U_INFO_SMS
                      - U_PERSON_ID
                      - U_STATUTARY
                      - U_COMP_VATID
                      - U_DEFAULT_BP_ID
                      - U_EU_FIRST_LOGIN
                      - U_PASS_EXPIRE
                      - U_PASS_CHANGE
                      - U_REGENERATE
                      - U_REGENERATE_L_ID
                      - U_REGENERATE_PAYMENTS
                      - U_REGENERATE_PAYMENTS_L_ID
                      - U_PROV_LEVEL
                      - U_DEGREE_BEHIND
                      - U_PROVISIONING
                      - U_CODE_REFERENCES
                      - U_BATCH
                      - U_VALUATION
                      - U_PROVIDER_USER_ID
                      - U_PROVIDER_TYPE
                      - U_PROVIDER_LABEL
                      - U_PROVIDER_ACTIVE
                      - U_INFO_MARKETING
                      - U_OFF_LIMIT
                      - U_LAST_USAGE
                      - U_LAST_CHANGE
                      - U_DEBTS_GENERATE
                      - U_EXTRA_WORK_DETAIL
                      - U_WORKS_COUNT_STRATEGY
                      - U_GROUP_COMP_FID
                      - params
                      - contact_phone_numbers
                      - contact_email_addresses
      tags:
        - Customers
    post:
      summary: 'Create Customer'
      operationId: createCustomer
      description: '   This endpoint creates a new customer.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    USER_ID: 1987393
                    LOGIN: zbailey
                    PASSWORD: '+-0pBNvYgxwmi/#iw'
                    U_PASS_QUESTION: null
                    U_PASS_ANSWER: quidem
                    TYPE: S
                    P_TITLE: Mr.
                    FIRST_NAME: Alayna
                    LAST_NAME: Leuschke
                    COMPANY: "Fritsch-O'Keefe"
                    STREET: 'Carey Greens'
                    HOUSE_ID: '57515'
                    CITY: 'North Roderick'
                    ZIP: '06227'
                    U_UC_ID: null
                    U_US_ID: null
                    U_UA_ID: null
                    U_CL_ID: null
                    ADR2: null
                    U_RECIPIENT2: null
                    STREET2: null
                    HOUSE_ID2: null
                    CITY2: null
                    ZIP2: null
                    U_UC_ID2: null
                    U_US_ID2: null
                    U_UA_ID2: null
                    U_CL_ID2: null
                    ADR3: null
                    U_RECIPIENT3: null
                    STREET3: null
                    HOUSE_ID3: null
                    CITY3: null
                    ZIP3: null
                    U_UC_ID3: null
                    U_US_ID3: null
                    U_UA_ID3: null
                    U_CL_ID3: null
                    FAX: null
                    SERVICES: praesentium
                    COMP_ID: null
                    COMP_FID: null
                    ACTIVATION: '1900-01-01 00:00:00'
                    U_ACTIVATION_LAST: '2026-04-20 06:37:24'
                    INFO_MAIL: 1
                    INFO_POST: null
                    USER_NOTE: null
                    INTERNAL_NOTE: null
                    CT: '006'
                    FLAT: null
                    NOTE1: null
                    NOTE2: null
                    NOTE3: null
                    NOTE4: null
                    NOTE5: null
                    NOTE6: null
                    NOTE7: null
                    NOTE8: null
                    SIPO_NUM: null
                    DATE_BEGIN: null
                    DATE_END: null
                    SIPO_DATE_FROM: null
                    GROUP_ID: null
                    VAR_SYMBOL: null
                    AGR_NAME: null
                    PERSON_ID_NUMBER: null
                    U_BIRTHDAY: null
                    U_PERSONAL_NUMBER: null
                    U_DOCUMENT_NUMBER: null
                    ACCOUNT_PRE_NUMBER: null
                    ACCOUNT_NUMBER: null
                    ACCOUNT_BANK: null
                    U_IBAN: null
                    U_ACCOUNT_ATTACH: null
                    U_ACCOUNT_SPECSYM: null
                    SALESMAN: null
                    U_BIRTH_NUMBER: null
                    U_TECH_LOC: null
                    U_FLAT_TYPE: null
                    U_TECH_NAME: null
                    U_PREMISES: 0
                    U_INV_NOTE: null
                    U_CODENAME: null
                    U_ACTIVE: 1
                    LOG_LEVEL: INFO
                    U_INFO_SMS: 0
                    U_PERSON_ID: null
                    U_STATUTARY: null
                    U_COMP_VATID: null
                    U_DEFAULT_BP_ID: null
                    U_EU_FIRST_LOGIN: 1
                    U_PASS_EXPIRE: null
                    U_PASS_CHANGE: null
                    U_REGENERATE: null
                    U_REGENERATE_L_ID: null
                    U_REGENERATE_PAYMENTS: null
                    U_REGENERATE_PAYMENTS_L_ID: null
                    U_PROV_LEVEL: 10
                    U_DEGREE_BEHIND: null
                    U_PROVISIONING: 0
                    U_CODE_REFERENCES: null
                    U_BATCH: null
                    U_VALUATION: null
                    U_PROVIDER_USER_ID: null
                    U_PROVIDER_TYPE: NONE
                    U_PROVIDER_LABEL: null
                    U_PROVIDER_ACTIVE: null
                    U_INFO_MARKETING: null
                    U_OFF_LIMIT: null
                    U_LAST_USAGE: null
                    U_LAST_CHANGE: null
                    U_DEBTS_GENERATE: 0
                    U_EXTRA_WORK_DETAIL: 0
                    U_WORKS_COUNT_STRATEGY: MINS
                    U_GROUP_COMP_FID: 0
                    params:
                      -
                        UP_ID: '0000988739'
                        UP_USER_ID: 1987393
                        UP_NAME: param_xjkl
                        UP_VALID_FROM: '2026-04-17'
                        UP_VALID_TO: null
                        UP_VALUE: 'Id aut libero.'
                        UP_CONTENT: 'Dolorem mollitia deleniti nemo. Quia officia est dignissimos neque. Odio veritatis excepturi doloribus delectus fugit qui repudiandae. Est alias tenetur ratione.'
                        UP_CREATED: '2026-03-05 04:19:56'
                        UP_L_ID: '000868'
                    contact_phone_numbers:
                      -
                        CPN_ID: 1110428
                        CPN_SUBJ_ID: 1987393
                        CPN_VALID: 1
                        CPN_PHONE: 335213199
                        CPN_L_ID: 4860
                        CPN_LAST_UPDATE: '2026-04-13 17:20:32'
                    contact_email_addresses:
                      -
                        CEA_ID: 446327
                        CEA_SUBJ_ID: 1987393
                        CEA_VALID: 0
                        CEA_EMAIL: bernhard.kendra@example.net
                        CEA_L_ID: 6058
                        CEA_LAST_UPDATE: '2026-02-04 15:28:53'
                properties:
                  data:
                    type: object
                    properties:
                      USER_ID:
                        type: integer
                        example: 1987393
                        description: 'Unique customer identifier (primary key).'
                      LOGIN:
                        type: string
                        example: zbailey
                        description: 'Login name for the customer portal (SelfCare).'
                        nullable: true
                      PASSWORD:
                        type: string
                        example: '+-0pBNvYgxwmi/#iw'
                        description: 'Password hash (MD5, 32 chars).'
                        nullable: true
                      U_PASS_QUESTION:
                        type: string
                        example: null
                        description: 'Password recovery question number (a code list entry ID).'
                        nullable: true
                      U_PASS_ANSWER:
                        type: string
                        example: quidem
                        description: 'Answer to the password recovery question.'
                        nullable: true
                      TYPE:
                        type: string
                        example: S
                        description: "Customer type. 'S' = private person, 'F' = self-employed / natural person with business, 'P' = legal entity / company."
                        enum:
                          - S
                          - F
                          - P
                      P_TITLE:
                        type: string
                        example: Mr.
                        description: 'Title before name (e.g. Ing., Mgr.).'
                        nullable: true
                      FIRST_NAME:
                        type: string
                        example: Alayna
                        description: "Customer's first name."
                        nullable: true
                      LAST_NAME:
                        type: string
                        example: Leuschke
                        description: "Customer's last name (surname)."
                        nullable: true
                      COMPANY:
                        type: string
                        example: "Fritsch-O'Keefe"
                        description: "Company or organization name. Used as display name for TYPE 'P' and 'F'."
                        nullable: true
                      STREET:
                        type: string
                        example: 'Carey Greens'
                        description: 'Primary address — street name.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: '57515'
                        description: 'Primary address — house number (číslo popisné).'
                        nullable: true
                      CITY:
                        type: string
                        example: 'North Roderick'
                        description: 'Primary address — city.'
                        nullable: true
                      ZIP:
                        type: string
                        example: '06227'
                        description: 'Primary address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry city ID.'
                        nullable: true
                      U_US_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID:
                        type: string
                        example: null
                        description: 'Primary address — code list reference ID.'
                        nullable: true
                      ADR2:
                        type: string
                        example: null
                        description: "Shipping/mailing address mode. 'AS1' = same as primary address, 'OWN' = custom address."
                        nullable: true
                        enum:
                          - AS1
                          - OWN
                      U_RECIPIENT2:
                        type: string
                        example: null
                        description: 'Shipping address — recipient name.'
                        nullable: true
                      STREET2:
                        type: string
                        example: null
                        description: 'Shipping address — street name.'
                        nullable: true
                      HOUSE_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — house number.'
                        nullable: true
                      CITY2:
                        type: string
                        example: null
                        description: 'Shipping address — city.'
                        nullable: true
                      ZIP2:
                        type: string
                        example: null
                        description: 'Shipping address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry city ID.'
                        nullable: true
                      U_US_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — code list reference ID.'
                        nullable: true
                      ADR3:
                        type: string
                        example: null
                        description: "Invoice address mode. 'AS1' = same as primary, 'AS2' = same as shipping, 'OWN' = custom address."
                        nullable: true
                        enum:
                          - AS1
                          - AS2
                          - OWN
                      U_RECIPIENT3:
                        type: string
                        example: null
                        description: 'Invoice address — recipient name.'
                        nullable: true
                      STREET3:
                        type: string
                        example: null
                        description: 'Invoice address — street name.'
                        nullable: true
                      HOUSE_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — house number.'
                        nullable: true
                      CITY3:
                        type: string
                        example: null
                        description: 'Invoice address — city.'
                        nullable: true
                      ZIP3:
                        type: string
                        example: null
                        description: 'Invoice address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry city ID.'
                        nullable: true
                      U_US_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — code list reference ID.'
                        nullable: true
                      FAX:
                        type: string
                        example: null
                        description: 'Fax number.'
                        nullable: true
                      SERVICES:
                        type: string
                        example: praesentium
                        description: 'Comma-separated list of service identifiers associated with the customer.'
                      COMP_ID:
                        type: string
                        example: null
                        description: 'Company registration number (IČO).'
                        nullable: true
                      COMP_FID:
                        type: string
                        example: null
                        description: 'Tax identification number (DIČ).'
                        nullable: true
                      ACTIVATION:
                        type: string
                        example: '1900-01-01 00:00:00'
                        description: "Datetime of the customer's initial activation."
                      U_ACTIVATION_LAST:
                        type: string
                        example: '2026-04-20 06:37:24'
                        description: "Datetime of the customer's most recent activation."
                      INFO_MAIL:
                        type: integer
                        example: 1
                        description: 'Email notification consent flag. 1 = opted in.'
                        nullable: true
                      INFO_POST:
                        type: string
                        example: null
                        description: 'Postal (print) notification flag.'
                      USER_NOTE:
                        type: string
                        example: null
                        description: 'Customer-visible note.'
                        nullable: true
                      INTERNAL_NOTE:
                        type: string
                        example: null
                        description: 'Internal note — visible only to operators, not to the customer.'
                        nullable: true
                      CT:
                        type: string
                        example: '006'
                        description: 'Company/tenant identifier — multi-tenant discriminator.'
                      FLAT:
                        type: string
                        example: null
                        description: 'Primary address — flat/apartment number.'
                        nullable: true
                      NOTE1:
                        type: string
                        example: null
                        description: 'Custom note field 1.'
                        nullable: true
                      NOTE2:
                        type: string
                        example: null
                        description: 'Custom note field 2.'
                        nullable: true
                      NOTE3:
                        type: string
                        example: null
                        description: 'Custom note field 3.'
                        nullable: true
                      NOTE4:
                        type: string
                        example: null
                        description: 'Custom note field 4.'
                        nullable: true
                      NOTE5:
                        type: string
                        example: null
                        description: 'Custom note field 5.'
                        nullable: true
                      NOTE6:
                        type: string
                        example: null
                        description: 'Custom note field 6.'
                        nullable: true
                      NOTE7:
                        type: string
                        example: null
                        description: 'Custom note field 7.'
                        nullable: true
                      NOTE8:
                        type: string
                        example: null
                        description: 'Custom note field 8.'
                        nullable: true
                      SIPO_NUM:
                        type: string
                        example: null
                        description: 'SIPO number — postal payment connector number for recurring payments.'
                        nullable: true
                      DATE_BEGIN:
                        type: string
                        example: null
                        description: 'Contract start date (YYYY-MM-DD).'
                        nullable: true
                      DATE_END:
                        type: string
                        example: null
                        description: 'Contract end date (YYYY-MM-DD).'
                        nullable: true
                      SIPO_DATE_FROM:
                        type: string
                        example: null
                        description: 'SIPO effective start datetime.'
                        nullable: true
                      GROUP_ID:
                        type: string
                        example: null
                        description: 'Customer group identifier.'
                        nullable: true
                      VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol — unique payment identifier used in bank transfers.'
                        nullable: true
                      AGR_NAME:
                        type: string
                        example: null
                        description: 'Agreement/contract number.'
                        nullable: true
                      PERSON_ID_NUMBER:
                        type: string
                        example: null
                        description: 'National personal ID number.'
                        nullable: true
                      U_BIRTHDAY:
                        type: string
                        example: null
                        description: 'Date of birth (YYYY-MM-DD).'
                        nullable: true
                      U_PERSONAL_NUMBER:
                        type: string
                        example: null
                        description: 'Personal identification number (rodné číslo / birth number).'
                        nullable: true
                      U_DOCUMENT_NUMBER:
                        type: string
                        example: null
                        description: 'Identity document number (e.g. national ID card number).'
                        nullable: true
                      ACCOUNT_PRE_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account prefix number (Czech format).'
                        nullable: true
                      ACCOUNT_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account number.'
                        nullable: true
                      ACCOUNT_BANK:
                        type: string
                        example: null
                        description: 'Bank code (4-digit Czech bank code).'
                        nullable: true
                      U_IBAN:
                        type: string
                        example: null
                        description: 'International Bank Account Number (IBAN).'
                        nullable: true
                      U_ACCOUNT_ATTACH:
                        type: string
                        example: null
                        description: 'Attachment ID linked to the bank account record.'
                        nullable: true
                      U_ACCOUNT_SPECSYM:
                        type: string
                        example: null
                        description: 'Specific symbol associated with the bank account.'
                        nullable: true
                      SALESMAN:
                        type: string
                        example: null
                        description: 'Sales representative (admin user) ID.'
                        nullable: true
                      U_BIRTH_NUMBER:
                        type: string
                        example: null
                        description: 'Birth number (rodné číslo). Alternative field for personal identification.'
                        nullable: true
                      U_TECH_LOC:
                        type: string
                        example: null
                        description: 'Technical location identifier.'
                        nullable: true
                      U_FLAT_TYPE:
                        type: string
                        example: null
                        description: 'Type of flat/premises (e.g. apartment category).'
                        nullable: true
                      U_TECH_NAME:
                        type: string
                        example: null
                        description: 'Technical name / description of the location.'
                        nullable: true
                      U_PREMISES:
                        type: integer
                        example: 0
                        description: 'Business premises flag. 1 = customer has associated premises.'
                      U_INV_NOTE:
                        type: string
                        example: null
                        description: 'Note printed on invoices.'
                        nullable: true
                      U_CODENAME:
                        type: string
                        example: null
                        description: 'Code identifier used by automated processors (e.g. SMS request handling).'
                        nullable: true
                      U_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Active customer flag. 1 = active, 0 = inactive.'
                      LOG_LEVEL:
                        type: string
                        example: INFO
                        description: 'Logging level for this customer.'
                        enum:
                          - EMERG
                          - ALERT
                          - CRIT
                          - ERR
                          - WARNING
                          - NOTICE
                          - INFO
                          - DEBUG
                      U_INFO_SMS:
                        type: integer
                        example: 0
                        description: 'SMS notification consent flag. 1 = opted in.'
                        nullable: true
                      U_PERSON_ID:
                        type: string
                        example: null
                        description: 'Person identifier (up to 12 chars).'
                        nullable: true
                      U_STATUTARY:
                        type: string
                        example: null
                        description: 'Statutory body / authorized signatory of the contract.'
                        nullable: true
                      U_COMP_VATID:
                        type: string
                        example: null
                        description: 'VAT identification number (IČ DPH).'
                        nullable: true
                      U_DEFAULT_BP_ID:
                        type: string
                        example: null
                        description: 'Default billing period ID.'
                        nullable: true
                      U_EU_FIRST_LOGIN:
                        type: integer
                        example: 1
                        description: 'Flag indicating the SelfCare account has not been authorized yet. 1 = not yet authorized.'
                      U_PASS_EXPIRE:
                        type: string
                        example: null
                        description: 'Password expiration setting (days).'
                        nullable: true
                      U_PASS_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last password change.'
                        nullable: true
                      U_REGENERATE:
                        type: string
                        example: null
                        description: 'Timestamp when user-dependent data regeneration started. Cleared after successful regeneration.'
                        nullable: true
                      U_REGENERATE_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who triggered the data regeneration.'
                        nullable: true
                      U_REGENERATE_PAYMENTS:
                        type: string
                        example: null
                        description: 'Timestamp when payment data regeneration started.'
                        nullable: true
                      U_REGENERATE_PAYMENTS_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who triggered the payment data regeneration.'
                        nullable: true
                      U_PROV_LEVEL:
                        type: integer
                        example: 10
                        description: 'Customer trust/provisioning level. Higher values indicate greater trust.'
                      U_DEGREE_BEHIND:
                        type: string
                        example: null
                        description: 'Academic degree after name (e.g. Ph.D., CSc.).'
                        nullable: true
                      U_PROVISIONING:
                        type: integer
                        example: 0
                        description: 'Provisioning status.'
                        nullable: true
                      U_CODE_REFERENCES:
                        type: string
                        example: null
                        description: 'Referral/recommendation code (VIP).'
                        nullable: true
                      U_BATCH:
                        type: string
                        example: null
                        description: 'Batch processing data.'
                        nullable: true
                      U_VALUATION:
                        type: string
                        example: null
                        description: 'Customer valuation in percent. Used for modifying prices in pricelist calculations.'
                        nullable: true
                      U_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'User ID of the associated location provider.'
                        nullable: true
                      U_PROVIDER_TYPE:
                        type: string
                        example: NONE
                        description: 'Provider type classification.'
                        enum:
                          - NONE
                          - PROVIDER
                          - DEFAULT_PROVIDER
                      U_PROVIDER_LABEL:
                        type: string
                        example: null
                        description: 'Provider label — used as a contract number or identifier when USER_ID range is too large.'
                        nullable: true
                      U_PROVIDER_ACTIVE:
                        type: string
                        example: null
                        description: 'Flag indicating whether the location provider is active.'
                        nullable: true
                      U_INFO_MARKETING:
                        type: string
                        example: null
                        description: 'Marketing communication consent flag.'
                        nullable: true
                      U_OFF_LIMIT:
                        type: string
                        example: null
                        description: 'Off-limit threshold value.'
                        nullable: true
                      U_LAST_USAGE:
                        type: string
                        example: null
                        description: "Date of the customer's last service usage (YYYY-MM-DD)."
                        nullable: true
                      U_LAST_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last modification to this customer record.'
                        nullable: true
                      U_DEBTS_GENERATE:
                        type: integer
                        example: 0
                        description: 'Debts generation flag. 1 = automatic debt generation enabled.'
                      U_EXTRA_WORK_DETAIL:
                        type: integer
                        example: 0
                        description: 'Flag enabling extra work detail tracking.'
                        nullable: true
                      U_WORKS_COUNT_STRATEGY:
                        type: string
                        example: MINS
                        description: 'Work time counting strategy.'
                        nullable: true
                        enum:
                          - MINS
                          - COMM_15
                          - COMM_30
                          - COMM_60
                          - ROUND_15
                          - ROUND_30
                          - ROUND_60
                      U_GROUP_COMP_FID:
                        type: integer
                        example: 0
                        description: 'Flag indicating a group tax ID (skupinové DIČ). 1 = group DIČ is used.'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            UP_ID: '0000988739'
                            UP_USER_ID: 1987393
                            UP_NAME: param_xjkl
                            UP_VALID_FROM: '2026-04-17'
                            UP_VALID_TO: null
                            UP_VALUE: 'Id aut libero.'
                            UP_CONTENT: 'Dolorem mollitia deleniti nemo. Quia officia est dignissimos neque. Odio veritatis excepturi doloribus delectus fugit qui repudiandae. Est alias tenetur ratione.'
                            UP_CREATED: '2026-03-05 04:19:56'
                            UP_L_ID: '000868'
                        description: 'Customer parameters — collection of key-value pairs.'
                        items:
                          type: object
                          properties:
                            UP_ID:
                              type: string
                              example: '0000988739'
                            UP_USER_ID:
                              type: integer
                              example: 1987393
                            UP_NAME:
                              type: string
                              example: param_xjkl
                            UP_VALID_FROM:
                              type: string
                              example: '2026-04-17'
                            UP_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            UP_VALUE:
                              type: string
                              example: 'Id aut libero.'
                            UP_CONTENT:
                              type: string
                              example: 'Dolorem mollitia deleniti nemo. Quia officia est dignissimos neque. Odio veritatis excepturi doloribus delectus fugit qui repudiandae. Est alias tenetur ratione.'
                            UP_CREATED:
                              type: string
                              example: '2026-03-05 04:19:56'
                            UP_L_ID:
                              type: string
                              example: '000868'
                      contact_phone_numbers:
                        type: array
                        example:
                          -
                            CPN_ID: 1110428
                            CPN_SUBJ_ID: 1987393
                            CPN_VALID: 1
                            CPN_PHONE: 335213199
                            CPN_L_ID: 4860
                            CPN_LAST_UPDATE: '2026-04-13 17:20:32'
                        description: "Collection of customer's contact phone numbers."
                        items:
                          type: object
                          properties:
                            CPN_ID:
                              type: integer
                              example: 1110428
                            CPN_SUBJ_ID:
                              type: integer
                              example: 1987393
                            CPN_VALID:
                              type: integer
                              example: 1
                            CPN_PHONE:
                              type: integer
                              example: 335213199
                            CPN_L_ID:
                              type: integer
                              example: 4860
                            CPN_LAST_UPDATE:
                              type: string
                              example: '2026-04-13 17:20:32'
                      contact_email_addresses:
                        type: array
                        example:
                          -
                            CEA_ID: 446327
                            CEA_SUBJ_ID: 1987393
                            CEA_VALID: 0
                            CEA_EMAIL: bernhard.kendra@example.net
                            CEA_L_ID: 6058
                            CEA_LAST_UPDATE: '2026-02-04 15:28:53'
                        description: "Collection of customer's contact email addresses."
                        items:
                          type: object
                          properties:
                            CEA_ID:
                              type: integer
                              example: 446327
                            CEA_SUBJ_ID:
                              type: integer
                              example: 1987393
                            CEA_VALID:
                              type: integer
                              example: 0
                            CEA_EMAIL:
                              type: string
                              example: bernhard.kendra@example.net
                            CEA_L_ID:
                              type: integer
                              example: 6058
                            CEA_LAST_UPDATE:
                              type: string
                              example: '2026-02-04 15:28:53'
                    required:
                      - USER_ID
                      - LOGIN
                      - PASSWORD
                      - U_PASS_QUESTION
                      - U_PASS_ANSWER
                      - TYPE
                      - P_TITLE
                      - FIRST_NAME
                      - LAST_NAME
                      - COMPANY
                      - STREET
                      - HOUSE_ID
                      - CITY
                      - ZIP
                      - U_UC_ID
                      - U_US_ID
                      - U_UA_ID
                      - U_CL_ID
                      - ADR2
                      - U_RECIPIENT2
                      - STREET2
                      - HOUSE_ID2
                      - CITY2
                      - ZIP2
                      - U_UC_ID2
                      - U_US_ID2
                      - U_UA_ID2
                      - U_CL_ID2
                      - ADR3
                      - U_RECIPIENT3
                      - STREET3
                      - HOUSE_ID3
                      - CITY3
                      - ZIP3
                      - U_UC_ID3
                      - U_US_ID3
                      - U_UA_ID3
                      - U_CL_ID3
                      - FAX
                      - SERVICES
                      - COMP_ID
                      - COMP_FID
                      - ACTIVATION
                      - U_ACTIVATION_LAST
                      - INFO_MAIL
                      - INFO_POST
                      - USER_NOTE
                      - INTERNAL_NOTE
                      - CT
                      - FLAT
                      - NOTE1
                      - NOTE2
                      - NOTE3
                      - NOTE4
                      - NOTE5
                      - NOTE6
                      - NOTE7
                      - NOTE8
                      - SIPO_NUM
                      - DATE_BEGIN
                      - DATE_END
                      - SIPO_DATE_FROM
                      - GROUP_ID
                      - VAR_SYMBOL
                      - AGR_NAME
                      - PERSON_ID_NUMBER
                      - U_BIRTHDAY
                      - U_PERSONAL_NUMBER
                      - U_DOCUMENT_NUMBER
                      - ACCOUNT_PRE_NUMBER
                      - ACCOUNT_NUMBER
                      - ACCOUNT_BANK
                      - U_IBAN
                      - U_ACCOUNT_ATTACH
                      - U_ACCOUNT_SPECSYM
                      - SALESMAN
                      - U_BIRTH_NUMBER
                      - U_TECH_LOC
                      - U_FLAT_TYPE
                      - U_TECH_NAME
                      - U_PREMISES
                      - U_INV_NOTE
                      - U_CODENAME
                      - U_ACTIVE
                      - LOG_LEVEL
                      - U_INFO_SMS
                      - U_PERSON_ID
                      - U_STATUTARY
                      - U_COMP_VATID
                      - U_DEFAULT_BP_ID
                      - U_EU_FIRST_LOGIN
                      - U_PASS_EXPIRE
                      - U_PASS_CHANGE
                      - U_REGENERATE
                      - U_REGENERATE_L_ID
                      - U_REGENERATE_PAYMENTS
                      - U_REGENERATE_PAYMENTS_L_ID
                      - U_PROV_LEVEL
                      - U_DEGREE_BEHIND
                      - U_PROVISIONING
                      - U_CODE_REFERENCES
                      - U_BATCH
                      - U_VALUATION
                      - U_PROVIDER_USER_ID
                      - U_PROVIDER_TYPE
                      - U_PROVIDER_LABEL
                      - U_PROVIDER_ACTIVE
                      - U_INFO_MARKETING
                      - U_OFF_LIMIT
                      - U_LAST_USAGE
                      - U_LAST_CHANGE
                      - U_DEBTS_GENERATE
                      - U_EXTRA_WORK_DETAIL
                      - U_WORKS_COUNT_STRATEGY
                      - U_GROUP_COMP_FID
                      - params
                      - contact_phone_numbers
                      - contact_email_addresses
      tags:
        - Customers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                login:
                  type: string
                  description: 'Login name of the customer'
                  example: john.doe
                password:
                  type: string
                  description: 'Password of the customer'
                  example: secret123
                type:
                  type: string
                  description: 'Type of the customer (S, F, P)'
                  example: S
                first_name:
                  type: string
                  description: 'First name of the customer'
                  example: John
                last_name:
                  type: string
                  description: 'Last name of the customer'
                  example: Doe
                company:
                  type: string
                  description: 'Company name (required for type P)'
                  example: 'Doe Corp'
                street:
                  type: string
                  description: 'Street address'
                  example: 'Main Street 1'
                house_id:
                  type: string
                  description: 'House ID or number'
                  example: 12A
                city:
                  type: string
                  description: 'City of the customer'
                  example: 'New York'
                zip:
                  type: string
                  description: 'ZIP Code'
                  example: '10001'
                phones:
                  type: array
                  description: 'Phone numbers of the customer'
                  example:
                    - architecto
                  items:
                    type: string
                emails:
                  type: array
                  description: 'Email addresses of the customer'
                  example:
                    - architecto
                  items:
                    type: string
                comp_id:
                  type: string
                  description: 'Company ID (ICO)'
                  example: '12345678'
                comp_fid:
                  type: string
                  description: 'Company Tax ID (DIC)'
                  example: CZ12345678
                comp_vatid:
                  type: string
                  description: 'Company VAT ID (IC DPH)'
                  example: SK1234567890
                active:
                  type: integer
                  description: 'Is customer active? 1=yes, 0=no'
                  example: 1
              required:
                - type
  '/api/v3/customers/{id}':
    get:
      summary: 'Get Customer'
      operationId: getCustomer
      description: '   This endpoint retrieves a specific customer by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    USER_ID: 1987394
                    LOGIN: price.amber
                    PASSWORD: '<m5L[)~'
                    U_PASS_QUESTION: null
                    U_PASS_ANSWER: null
                    TYPE: S
                    P_TITLE: null
                    FIRST_NAME: Bailee
                    LAST_NAME: Leffler
                    COMPANY: Mitchell-VonRueden
                    STREET: 'Vesta Coves'
                    HOUSE_ID: '47809'
                    CITY: Considinehaven
                    ZIP: 36080-
                    U_UC_ID: null
                    U_US_ID: null
                    U_UA_ID: null
                    U_CL_ID: null
                    ADR2: null
                    U_RECIPIENT2: null
                    STREET2: null
                    HOUSE_ID2: null
                    CITY2: null
                    ZIP2: null
                    U_UC_ID2: null
                    U_US_ID2: null
                    U_UA_ID2: null
                    U_CL_ID2: null
                    ADR3: null
                    U_RECIPIENT3: null
                    STREET3: null
                    HOUSE_ID3: null
                    CITY3: null
                    ZIP3: null
                    U_UC_ID3: null
                    U_US_ID3: null
                    U_UA_ID3: null
                    U_CL_ID3: null
                    FAX: null
                    SERVICES: doloremque
                    COMP_ID: null
                    COMP_FID: null
                    ACTIVATION: '1900-01-01 00:00:00'
                    U_ACTIVATION_LAST: '2026-01-17 23:13:21'
                    INFO_MAIL: 1
                    INFO_POST: null
                    USER_NOTE: null
                    INTERNAL_NOTE: null
                    CT: '008'
                    FLAT: null
                    NOTE1: null
                    NOTE2: null
                    NOTE3: null
                    NOTE4: null
                    NOTE5: null
                    NOTE6: null
                    NOTE7: null
                    NOTE8: null
                    SIPO_NUM: null
                    DATE_BEGIN: null
                    DATE_END: null
                    SIPO_DATE_FROM: null
                    GROUP_ID: null
                    VAR_SYMBOL: null
                    AGR_NAME: null
                    PERSON_ID_NUMBER: null
                    U_BIRTHDAY: null
                    U_PERSONAL_NUMBER: null
                    U_DOCUMENT_NUMBER: null
                    ACCOUNT_PRE_NUMBER: null
                    ACCOUNT_NUMBER: null
                    ACCOUNT_BANK: null
                    U_IBAN: null
                    U_ACCOUNT_ATTACH: null
                    U_ACCOUNT_SPECSYM: null
                    SALESMAN: null
                    U_BIRTH_NUMBER: null
                    U_TECH_LOC: null
                    U_FLAT_TYPE: null
                    U_TECH_NAME: null
                    U_PREMISES: 0
                    U_INV_NOTE: null
                    U_CODENAME: null
                    U_ACTIVE: 1
                    LOG_LEVEL: INFO
                    U_INFO_SMS: 0
                    U_PERSON_ID: null
                    U_STATUTARY: null
                    U_COMP_VATID: null
                    U_DEFAULT_BP_ID: null
                    U_EU_FIRST_LOGIN: 1
                    U_PASS_EXPIRE: null
                    U_PASS_CHANGE: null
                    U_REGENERATE: null
                    U_REGENERATE_L_ID: null
                    U_REGENERATE_PAYMENTS: null
                    U_REGENERATE_PAYMENTS_L_ID: null
                    U_PROV_LEVEL: 10
                    U_DEGREE_BEHIND: null
                    U_PROVISIONING: 0
                    U_CODE_REFERENCES: null
                    U_BATCH: null
                    U_VALUATION: null
                    U_PROVIDER_USER_ID: null
                    U_PROVIDER_TYPE: NONE
                    U_PROVIDER_LABEL: null
                    U_PROVIDER_ACTIVE: null
                    U_INFO_MARKETING: null
                    U_OFF_LIMIT: null
                    U_LAST_USAGE: null
                    U_LAST_CHANGE: null
                    U_DEBTS_GENERATE: 0
                    U_EXTRA_WORK_DETAIL: 0
                    U_WORKS_COUNT_STRATEGY: MINS
                    U_GROUP_COMP_FID: 0
                    params:
                      -
                        UP_ID: '0000988740'
                        UP_USER_ID: 1987394
                        UP_NAME: param_qbew
                        UP_VALID_FROM: '2026-02-25'
                        UP_VALID_TO: null
                        UP_VALUE: 'Deleniti nemo odit.'
                        UP_CONTENT: null
                        UP_CREATED: '2026-01-20 04:43:49'
                        UP_L_ID: '000488'
                    contact_phone_numbers:
                      -
                        CPN_ID: 1110429
                        CPN_SUBJ_ID: 1987394
                        CPN_VALID: 1
                        CPN_PHONE: 608371679
                        CPN_L_ID: 3465
                        CPN_LAST_UPDATE: '2026-03-16 18:15:16'
                    contact_email_addresses:
                      -
                        CEA_ID: 446328
                        CEA_SUBJ_ID: 1987394
                        CEA_VALID: 1
                        CEA_EMAIL: pagac.skylar@example.org
                        CEA_L_ID: 6144
                        CEA_LAST_UPDATE: '2026-01-23 02:39:01'
                properties:
                  data:
                    type: object
                    properties:
                      USER_ID:
                        type: integer
                        example: 1987394
                        description: 'Unique customer identifier (primary key).'
                      LOGIN:
                        type: string
                        example: price.amber
                        description: 'Login name for the customer portal (SelfCare).'
                        nullable: true
                      PASSWORD:
                        type: string
                        example: '<m5L[)~'
                        description: 'Password hash (MD5, 32 chars).'
                        nullable: true
                      U_PASS_QUESTION:
                        type: string
                        example: null
                        description: 'Password recovery question number (a code list entry ID).'
                        nullable: true
                      U_PASS_ANSWER:
                        type: string
                        example: null
                        description: 'Answer to the password recovery question.'
                        nullable: true
                      TYPE:
                        type: string
                        example: S
                        description: "Customer type. 'S' = private person, 'F' = self-employed / natural person with business, 'P' = legal entity / company."
                        enum:
                          - S
                          - F
                          - P
                      P_TITLE:
                        type: string
                        example: null
                        description: 'Title before name (e.g. Ing., Mgr.).'
                        nullable: true
                      FIRST_NAME:
                        type: string
                        example: Bailee
                        description: "Customer's first name."
                        nullable: true
                      LAST_NAME:
                        type: string
                        example: Leffler
                        description: "Customer's last name (surname)."
                        nullable: true
                      COMPANY:
                        type: string
                        example: Mitchell-VonRueden
                        description: "Company or organization name. Used as display name for TYPE 'P' and 'F'."
                        nullable: true
                      STREET:
                        type: string
                        example: 'Vesta Coves'
                        description: 'Primary address — street name.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: '47809'
                        description: 'Primary address — house number (číslo popisné).'
                        nullable: true
                      CITY:
                        type: string
                        example: Considinehaven
                        description: 'Primary address — city.'
                        nullable: true
                      ZIP:
                        type: string
                        example: 36080-
                        description: 'Primary address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry city ID.'
                        nullable: true
                      U_US_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID:
                        type: string
                        example: null
                        description: 'Primary address — code list reference ID.'
                        nullable: true
                      ADR2:
                        type: string
                        example: null
                        description: "Shipping/mailing address mode. 'AS1' = same as primary address, 'OWN' = custom address."
                        nullable: true
                        enum:
                          - AS1
                          - OWN
                      U_RECIPIENT2:
                        type: string
                        example: null
                        description: 'Shipping address — recipient name.'
                        nullable: true
                      STREET2:
                        type: string
                        example: null
                        description: 'Shipping address — street name.'
                        nullable: true
                      HOUSE_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — house number.'
                        nullable: true
                      CITY2:
                        type: string
                        example: null
                        description: 'Shipping address — city.'
                        nullable: true
                      ZIP2:
                        type: string
                        example: null
                        description: 'Shipping address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry city ID.'
                        nullable: true
                      U_US_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — code list reference ID.'
                        nullable: true
                      ADR3:
                        type: string
                        example: null
                        description: "Invoice address mode. 'AS1' = same as primary, 'AS2' = same as shipping, 'OWN' = custom address."
                        nullable: true
                        enum:
                          - AS1
                          - AS2
                          - OWN
                      U_RECIPIENT3:
                        type: string
                        example: null
                        description: 'Invoice address — recipient name.'
                        nullable: true
                      STREET3:
                        type: string
                        example: null
                        description: 'Invoice address — street name.'
                        nullable: true
                      HOUSE_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — house number.'
                        nullable: true
                      CITY3:
                        type: string
                        example: null
                        description: 'Invoice address — city.'
                        nullable: true
                      ZIP3:
                        type: string
                        example: null
                        description: 'Invoice address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry city ID.'
                        nullable: true
                      U_US_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — code list reference ID.'
                        nullable: true
                      FAX:
                        type: string
                        example: null
                        description: 'Fax number.'
                        nullable: true
                      SERVICES:
                        type: string
                        example: doloremque
                        description: 'Comma-separated list of service identifiers associated with the customer.'
                      COMP_ID:
                        type: string
                        example: null
                        description: 'Company registration number (IČO).'
                        nullable: true
                      COMP_FID:
                        type: string
                        example: null
                        description: 'Tax identification number (DIČ).'
                        nullable: true
                      ACTIVATION:
                        type: string
                        example: '1900-01-01 00:00:00'
                        description: "Datetime of the customer's initial activation."
                      U_ACTIVATION_LAST:
                        type: string
                        example: '2026-01-17 23:13:21'
                        description: "Datetime of the customer's most recent activation."
                      INFO_MAIL:
                        type: integer
                        example: 1
                        description: 'Email notification consent flag. 1 = opted in.'
                        nullable: true
                      INFO_POST:
                        type: string
                        example: null
                        description: 'Postal (print) notification flag.'
                      USER_NOTE:
                        type: string
                        example: null
                        description: 'Customer-visible note.'
                        nullable: true
                      INTERNAL_NOTE:
                        type: string
                        example: null
                        description: 'Internal note — visible only to operators, not to the customer.'
                        nullable: true
                      CT:
                        type: string
                        example: '008'
                        description: 'Company/tenant identifier — multi-tenant discriminator.'
                      FLAT:
                        type: string
                        example: null
                        description: 'Primary address — flat/apartment number.'
                        nullable: true
                      NOTE1:
                        type: string
                        example: null
                        description: 'Custom note field 1.'
                        nullable: true
                      NOTE2:
                        type: string
                        example: null
                        description: 'Custom note field 2.'
                        nullable: true
                      NOTE3:
                        type: string
                        example: null
                        description: 'Custom note field 3.'
                        nullable: true
                      NOTE4:
                        type: string
                        example: null
                        description: 'Custom note field 4.'
                        nullable: true
                      NOTE5:
                        type: string
                        example: null
                        description: 'Custom note field 5.'
                        nullable: true
                      NOTE6:
                        type: string
                        example: null
                        description: 'Custom note field 6.'
                        nullable: true
                      NOTE7:
                        type: string
                        example: null
                        description: 'Custom note field 7.'
                        nullable: true
                      NOTE8:
                        type: string
                        example: null
                        description: 'Custom note field 8.'
                        nullable: true
                      SIPO_NUM:
                        type: string
                        example: null
                        description: 'SIPO number — postal payment connector number for recurring payments.'
                        nullable: true
                      DATE_BEGIN:
                        type: string
                        example: null
                        description: 'Contract start date (YYYY-MM-DD).'
                        nullable: true
                      DATE_END:
                        type: string
                        example: null
                        description: 'Contract end date (YYYY-MM-DD).'
                        nullable: true
                      SIPO_DATE_FROM:
                        type: string
                        example: null
                        description: 'SIPO effective start datetime.'
                        nullable: true
                      GROUP_ID:
                        type: string
                        example: null
                        description: 'Customer group identifier.'
                        nullable: true
                      VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol — unique payment identifier used in bank transfers.'
                        nullable: true
                      AGR_NAME:
                        type: string
                        example: null
                        description: 'Agreement/contract number.'
                        nullable: true
                      PERSON_ID_NUMBER:
                        type: string
                        example: null
                        description: 'National personal ID number.'
                        nullable: true
                      U_BIRTHDAY:
                        type: string
                        example: null
                        description: 'Date of birth (YYYY-MM-DD).'
                        nullable: true
                      U_PERSONAL_NUMBER:
                        type: string
                        example: null
                        description: 'Personal identification number (rodné číslo / birth number).'
                        nullable: true
                      U_DOCUMENT_NUMBER:
                        type: string
                        example: null
                        description: 'Identity document number (e.g. national ID card number).'
                        nullable: true
                      ACCOUNT_PRE_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account prefix number (Czech format).'
                        nullable: true
                      ACCOUNT_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account number.'
                        nullable: true
                      ACCOUNT_BANK:
                        type: string
                        example: null
                        description: 'Bank code (4-digit Czech bank code).'
                        nullable: true
                      U_IBAN:
                        type: string
                        example: null
                        description: 'International Bank Account Number (IBAN).'
                        nullable: true
                      U_ACCOUNT_ATTACH:
                        type: string
                        example: null
                        description: 'Attachment ID linked to the bank account record.'
                        nullable: true
                      U_ACCOUNT_SPECSYM:
                        type: string
                        example: null
                        description: 'Specific symbol associated with the bank account.'
                        nullable: true
                      SALESMAN:
                        type: string
                        example: null
                        description: 'Sales representative (admin user) ID.'
                        nullable: true
                      U_BIRTH_NUMBER:
                        type: string
                        example: null
                        description: 'Birth number (rodné číslo). Alternative field for personal identification.'
                        nullable: true
                      U_TECH_LOC:
                        type: string
                        example: null
                        description: 'Technical location identifier.'
                        nullable: true
                      U_FLAT_TYPE:
                        type: string
                        example: null
                        description: 'Type of flat/premises (e.g. apartment category).'
                        nullable: true
                      U_TECH_NAME:
                        type: string
                        example: null
                        description: 'Technical name / description of the location.'
                        nullable: true
                      U_PREMISES:
                        type: integer
                        example: 0
                        description: 'Business premises flag. 1 = customer has associated premises.'
                      U_INV_NOTE:
                        type: string
                        example: null
                        description: 'Note printed on invoices.'
                        nullable: true
                      U_CODENAME:
                        type: string
                        example: null
                        description: 'Code identifier used by automated processors (e.g. SMS request handling).'
                        nullable: true
                      U_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Active customer flag. 1 = active, 0 = inactive.'
                      LOG_LEVEL:
                        type: string
                        example: INFO
                        description: 'Logging level for this customer.'
                        enum:
                          - EMERG
                          - ALERT
                          - CRIT
                          - ERR
                          - WARNING
                          - NOTICE
                          - INFO
                          - DEBUG
                      U_INFO_SMS:
                        type: integer
                        example: 0
                        description: 'SMS notification consent flag. 1 = opted in.'
                        nullable: true
                      U_PERSON_ID:
                        type: string
                        example: null
                        description: 'Person identifier (up to 12 chars).'
                        nullable: true
                      U_STATUTARY:
                        type: string
                        example: null
                        description: 'Statutory body / authorized signatory of the contract.'
                        nullable: true
                      U_COMP_VATID:
                        type: string
                        example: null
                        description: 'VAT identification number (IČ DPH).'
                        nullable: true
                      U_DEFAULT_BP_ID:
                        type: string
                        example: null
                        description: 'Default billing period ID.'
                        nullable: true
                      U_EU_FIRST_LOGIN:
                        type: integer
                        example: 1
                        description: 'Flag indicating the SelfCare account has not been authorized yet. 1 = not yet authorized.'
                      U_PASS_EXPIRE:
                        type: string
                        example: null
                        description: 'Password expiration setting (days).'
                        nullable: true
                      U_PASS_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last password change.'
                        nullable: true
                      U_REGENERATE:
                        type: string
                        example: null
                        description: 'Timestamp when user-dependent data regeneration started. Cleared after successful regeneration.'
                        nullable: true
                      U_REGENERATE_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who triggered the data regeneration.'
                        nullable: true
                      U_REGENERATE_PAYMENTS:
                        type: string
                        example: null
                        description: 'Timestamp when payment data regeneration started.'
                        nullable: true
                      U_REGENERATE_PAYMENTS_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who triggered the payment data regeneration.'
                        nullable: true
                      U_PROV_LEVEL:
                        type: integer
                        example: 10
                        description: 'Customer trust/provisioning level. Higher values indicate greater trust.'
                      U_DEGREE_BEHIND:
                        type: string
                        example: null
                        description: 'Academic degree after name (e.g. Ph.D., CSc.).'
                        nullable: true
                      U_PROVISIONING:
                        type: integer
                        example: 0
                        description: 'Provisioning status.'
                        nullable: true
                      U_CODE_REFERENCES:
                        type: string
                        example: null
                        description: 'Referral/recommendation code (VIP).'
                        nullable: true
                      U_BATCH:
                        type: string
                        example: null
                        description: 'Batch processing data.'
                        nullable: true
                      U_VALUATION:
                        type: string
                        example: null
                        description: 'Customer valuation in percent. Used for modifying prices in pricelist calculations.'
                        nullable: true
                      U_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'User ID of the associated location provider.'
                        nullable: true
                      U_PROVIDER_TYPE:
                        type: string
                        example: NONE
                        description: 'Provider type classification.'
                        enum:
                          - NONE
                          - PROVIDER
                          - DEFAULT_PROVIDER
                      U_PROVIDER_LABEL:
                        type: string
                        example: null
                        description: 'Provider label — used as a contract number or identifier when USER_ID range is too large.'
                        nullable: true
                      U_PROVIDER_ACTIVE:
                        type: string
                        example: null
                        description: 'Flag indicating whether the location provider is active.'
                        nullable: true
                      U_INFO_MARKETING:
                        type: string
                        example: null
                        description: 'Marketing communication consent flag.'
                        nullable: true
                      U_OFF_LIMIT:
                        type: string
                        example: null
                        description: 'Off-limit threshold value.'
                        nullable: true
                      U_LAST_USAGE:
                        type: string
                        example: null
                        description: "Date of the customer's last service usage (YYYY-MM-DD)."
                        nullable: true
                      U_LAST_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last modification to this customer record.'
                        nullable: true
                      U_DEBTS_GENERATE:
                        type: integer
                        example: 0
                        description: 'Debts generation flag. 1 = automatic debt generation enabled.'
                      U_EXTRA_WORK_DETAIL:
                        type: integer
                        example: 0
                        description: 'Flag enabling extra work detail tracking.'
                        nullable: true
                      U_WORKS_COUNT_STRATEGY:
                        type: string
                        example: MINS
                        description: 'Work time counting strategy.'
                        nullable: true
                        enum:
                          - MINS
                          - COMM_15
                          - COMM_30
                          - COMM_60
                          - ROUND_15
                          - ROUND_30
                          - ROUND_60
                      U_GROUP_COMP_FID:
                        type: integer
                        example: 0
                        description: 'Flag indicating a group tax ID (skupinové DIČ). 1 = group DIČ is used.'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            UP_ID: '0000988740'
                            UP_USER_ID: 1987394
                            UP_NAME: param_qbew
                            UP_VALID_FROM: '2026-02-25'
                            UP_VALID_TO: null
                            UP_VALUE: 'Deleniti nemo odit.'
                            UP_CONTENT: null
                            UP_CREATED: '2026-01-20 04:43:49'
                            UP_L_ID: '000488'
                        description: 'Customer parameters — collection of key-value pairs.'
                        items:
                          type: object
                          properties:
                            UP_ID:
                              type: string
                              example: '0000988740'
                            UP_USER_ID:
                              type: integer
                              example: 1987394
                            UP_NAME:
                              type: string
                              example: param_qbew
                            UP_VALID_FROM:
                              type: string
                              example: '2026-02-25'
                            UP_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            UP_VALUE:
                              type: string
                              example: 'Deleniti nemo odit.'
                            UP_CONTENT:
                              type: string
                              example: null
                              nullable: true
                            UP_CREATED:
                              type: string
                              example: '2026-01-20 04:43:49'
                            UP_L_ID:
                              type: string
                              example: '000488'
                      contact_phone_numbers:
                        type: array
                        example:
                          -
                            CPN_ID: 1110429
                            CPN_SUBJ_ID: 1987394
                            CPN_VALID: 1
                            CPN_PHONE: 608371679
                            CPN_L_ID: 3465
                            CPN_LAST_UPDATE: '2026-03-16 18:15:16'
                        description: "Collection of customer's contact phone numbers."
                        items:
                          type: object
                          properties:
                            CPN_ID:
                              type: integer
                              example: 1110429
                            CPN_SUBJ_ID:
                              type: integer
                              example: 1987394
                            CPN_VALID:
                              type: integer
                              example: 1
                            CPN_PHONE:
                              type: integer
                              example: 608371679
                            CPN_L_ID:
                              type: integer
                              example: 3465
                            CPN_LAST_UPDATE:
                              type: string
                              example: '2026-03-16 18:15:16'
                      contact_email_addresses:
                        type: array
                        example:
                          -
                            CEA_ID: 446328
                            CEA_SUBJ_ID: 1987394
                            CEA_VALID: 1
                            CEA_EMAIL: pagac.skylar@example.org
                            CEA_L_ID: 6144
                            CEA_LAST_UPDATE: '2026-01-23 02:39:01'
                        description: "Collection of customer's contact email addresses."
                        items:
                          type: object
                          properties:
                            CEA_ID:
                              type: integer
                              example: 446328
                            CEA_SUBJ_ID:
                              type: integer
                              example: 1987394
                            CEA_VALID:
                              type: integer
                              example: 1
                            CEA_EMAIL:
                              type: string
                              example: pagac.skylar@example.org
                            CEA_L_ID:
                              type: integer
                              example: 6144
                            CEA_LAST_UPDATE:
                              type: string
                              example: '2026-01-23 02:39:01'
                    required:
                      - USER_ID
                      - LOGIN
                      - PASSWORD
                      - U_PASS_QUESTION
                      - U_PASS_ANSWER
                      - TYPE
                      - P_TITLE
                      - FIRST_NAME
                      - LAST_NAME
                      - COMPANY
                      - STREET
                      - HOUSE_ID
                      - CITY
                      - ZIP
                      - U_UC_ID
                      - U_US_ID
                      - U_UA_ID
                      - U_CL_ID
                      - ADR2
                      - U_RECIPIENT2
                      - STREET2
                      - HOUSE_ID2
                      - CITY2
                      - ZIP2
                      - U_UC_ID2
                      - U_US_ID2
                      - U_UA_ID2
                      - U_CL_ID2
                      - ADR3
                      - U_RECIPIENT3
                      - STREET3
                      - HOUSE_ID3
                      - CITY3
                      - ZIP3
                      - U_UC_ID3
                      - U_US_ID3
                      - U_UA_ID3
                      - U_CL_ID3
                      - FAX
                      - SERVICES
                      - COMP_ID
                      - COMP_FID
                      - ACTIVATION
                      - U_ACTIVATION_LAST
                      - INFO_MAIL
                      - INFO_POST
                      - USER_NOTE
                      - INTERNAL_NOTE
                      - CT
                      - FLAT
                      - NOTE1
                      - NOTE2
                      - NOTE3
                      - NOTE4
                      - NOTE5
                      - NOTE6
                      - NOTE7
                      - NOTE8
                      - SIPO_NUM
                      - DATE_BEGIN
                      - DATE_END
                      - SIPO_DATE_FROM
                      - GROUP_ID
                      - VAR_SYMBOL
                      - AGR_NAME
                      - PERSON_ID_NUMBER
                      - U_BIRTHDAY
                      - U_PERSONAL_NUMBER
                      - U_DOCUMENT_NUMBER
                      - ACCOUNT_PRE_NUMBER
                      - ACCOUNT_NUMBER
                      - ACCOUNT_BANK
                      - U_IBAN
                      - U_ACCOUNT_ATTACH
                      - U_ACCOUNT_SPECSYM
                      - SALESMAN
                      - U_BIRTH_NUMBER
                      - U_TECH_LOC
                      - U_FLAT_TYPE
                      - U_TECH_NAME
                      - U_PREMISES
                      - U_INV_NOTE
                      - U_CODENAME
                      - U_ACTIVE
                      - LOG_LEVEL
                      - U_INFO_SMS
                      - U_PERSON_ID
                      - U_STATUTARY
                      - U_COMP_VATID
                      - U_DEFAULT_BP_ID
                      - U_EU_FIRST_LOGIN
                      - U_PASS_EXPIRE
                      - U_PASS_CHANGE
                      - U_REGENERATE
                      - U_REGENERATE_L_ID
                      - U_REGENERATE_PAYMENTS
                      - U_REGENERATE_PAYMENTS_L_ID
                      - U_PROV_LEVEL
                      - U_DEGREE_BEHIND
                      - U_PROVISIONING
                      - U_CODE_REFERENCES
                      - U_BATCH
                      - U_VALUATION
                      - U_PROVIDER_USER_ID
                      - U_PROVIDER_TYPE
                      - U_PROVIDER_LABEL
                      - U_PROVIDER_ACTIVE
                      - U_INFO_MARKETING
                      - U_OFF_LIMIT
                      - U_LAST_USAGE
                      - U_LAST_CHANGE
                      - U_DEBTS_GENERATE
                      - U_EXTRA_WORK_DETAIL
                      - U_WORKS_COUNT_STRATEGY
                      - U_GROUP_COMP_FID
                      - params
                      - contact_phone_numbers
                      - contact_email_addresses
      tags:
        - Customers
    put:
      summary: 'Update Customer'
      operationId: updateCustomer
      description: '   This endpoint updates an existing customer.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    USER_ID: 1987395
                    LOGIN: imclaughlin
                    PASSWORD: '=NG5a:x&S$hSn'
                    U_PASS_QUESTION: null
                    U_PASS_ANSWER: praesentium
                    TYPE: S
                    P_TITLE: null
                    FIRST_NAME: Annabelle
                    LAST_NAME: Kshlerin
                    COMPANY: 'Hettinger, Nitzsche and Ankunding'
                    STREET: 'Verlie Manors'
                    HOUSE_ID: '651'
                    CITY: 'Lake Noahberg'
                    ZIP: 40837-
                    U_UC_ID: null
                    U_US_ID: null
                    U_UA_ID: null
                    U_CL_ID: null
                    ADR2: null
                    U_RECIPIENT2: null
                    STREET2: null
                    HOUSE_ID2: null
                    CITY2: null
                    ZIP2: null
                    U_UC_ID2: null
                    U_US_ID2: null
                    U_UA_ID2: null
                    U_CL_ID2: null
                    ADR3: null
                    U_RECIPIENT3: null
                    STREET3: null
                    HOUSE_ID3: null
                    CITY3: null
                    ZIP3: null
                    U_UC_ID3: null
                    U_US_ID3: null
                    U_UA_ID3: null
                    U_CL_ID3: null
                    FAX: null
                    SERVICES: blanditiis
                    COMP_ID: null
                    COMP_FID: null
                    ACTIVATION: '1900-01-01 00:00:00'
                    U_ACTIVATION_LAST: '2026-03-16 18:15:16'
                    INFO_MAIL: 1
                    INFO_POST: null
                    USER_NOTE: null
                    INTERNAL_NOTE: null
                    CT: '008'
                    FLAT: null
                    NOTE1: null
                    NOTE2: null
                    NOTE3: null
                    NOTE4: null
                    NOTE5: null
                    NOTE6: null
                    NOTE7: null
                    NOTE8: null
                    SIPO_NUM: null
                    DATE_BEGIN: null
                    DATE_END: null
                    SIPO_DATE_FROM: null
                    GROUP_ID: null
                    VAR_SYMBOL: null
                    AGR_NAME: null
                    PERSON_ID_NUMBER: null
                    U_BIRTHDAY: null
                    U_PERSONAL_NUMBER: null
                    U_DOCUMENT_NUMBER: null
                    ACCOUNT_PRE_NUMBER: null
                    ACCOUNT_NUMBER: null
                    ACCOUNT_BANK: null
                    U_IBAN: null
                    U_ACCOUNT_ATTACH: null
                    U_ACCOUNT_SPECSYM: null
                    SALESMAN: null
                    U_BIRTH_NUMBER: null
                    U_TECH_LOC: null
                    U_FLAT_TYPE: null
                    U_TECH_NAME: null
                    U_PREMISES: 0
                    U_INV_NOTE: null
                    U_CODENAME: null
                    U_ACTIVE: 1
                    LOG_LEVEL: INFO
                    U_INFO_SMS: 0
                    U_PERSON_ID: null
                    U_STATUTARY: null
                    U_COMP_VATID: null
                    U_DEFAULT_BP_ID: null
                    U_EU_FIRST_LOGIN: 1
                    U_PASS_EXPIRE: null
                    U_PASS_CHANGE: null
                    U_REGENERATE: null
                    U_REGENERATE_L_ID: null
                    U_REGENERATE_PAYMENTS: null
                    U_REGENERATE_PAYMENTS_L_ID: null
                    U_PROV_LEVEL: 10
                    U_DEGREE_BEHIND: null
                    U_PROVISIONING: 0
                    U_CODE_REFERENCES: null
                    U_BATCH: null
                    U_VALUATION: null
                    U_PROVIDER_USER_ID: null
                    U_PROVIDER_TYPE: NONE
                    U_PROVIDER_LABEL: null
                    U_PROVIDER_ACTIVE: null
                    U_INFO_MARKETING: null
                    U_OFF_LIMIT: null
                    U_LAST_USAGE: null
                    U_LAST_CHANGE: null
                    U_DEBTS_GENERATE: 0
                    U_EXTRA_WORK_DETAIL: 0
                    U_WORKS_COUNT_STRATEGY: MINS
                    U_GROUP_COMP_FID: 0
                    params:
                      -
                        UP_ID: '0000988741'
                        UP_USER_ID: 1987395
                        UP_NAME: param_cvip
                        UP_VALID_FROM: '2026-01-15'
                        UP_VALID_TO: null
                        UP_VALUE: 'Laboriosam est alias.'
                        UP_CONTENT: null
                        UP_CREATED: '2026-01-23 23:31:09'
                        UP_L_ID: '000425'
                    contact_phone_numbers:
                      -
                        CPN_ID: 1110430
                        CPN_SUBJ_ID: 1987395
                        CPN_VALID: 0
                        CPN_PHONE: 590549722
                        CPN_L_ID: 1012
                        CPN_LAST_UPDATE: '2026-03-17 04:27:26'
                    contact_email_addresses:
                      -
                        CEA_ID: 446329
                        CEA_SUBJ_ID: 1987395
                        CEA_VALID: 1
                        CEA_EMAIL: modesta58@example.net
                        CEA_L_ID: 1846
                        CEA_LAST_UPDATE: '2026-04-03 15:38:08'
                properties:
                  data:
                    type: object
                    properties:
                      USER_ID:
                        type: integer
                        example: 1987395
                        description: 'Unique customer identifier (primary key).'
                      LOGIN:
                        type: string
                        example: imclaughlin
                        description: 'Login name for the customer portal (SelfCare).'
                        nullable: true
                      PASSWORD:
                        type: string
                        example: '=NG5a:x&S$hSn'
                        description: 'Password hash (MD5, 32 chars).'
                        nullable: true
                      U_PASS_QUESTION:
                        type: string
                        example: null
                        description: 'Password recovery question number (a code list entry ID).'
                        nullable: true
                      U_PASS_ANSWER:
                        type: string
                        example: praesentium
                        description: 'Answer to the password recovery question.'
                        nullable: true
                      TYPE:
                        type: string
                        example: S
                        description: "Customer type. 'S' = private person, 'F' = self-employed / natural person with business, 'P' = legal entity / company."
                        enum:
                          - S
                          - F
                          - P
                      P_TITLE:
                        type: string
                        example: null
                        description: 'Title before name (e.g. Ing., Mgr.).'
                        nullable: true
                      FIRST_NAME:
                        type: string
                        example: Annabelle
                        description: "Customer's first name."
                        nullable: true
                      LAST_NAME:
                        type: string
                        example: Kshlerin
                        description: "Customer's last name (surname)."
                        nullable: true
                      COMPANY:
                        type: string
                        example: 'Hettinger, Nitzsche and Ankunding'
                        description: "Company or organization name. Used as display name for TYPE 'P' and 'F'."
                        nullable: true
                      STREET:
                        type: string
                        example: 'Verlie Manors'
                        description: 'Primary address — street name.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: '651'
                        description: 'Primary address — house number (číslo popisné).'
                        nullable: true
                      CITY:
                        type: string
                        example: 'Lake Noahberg'
                        description: 'Primary address — city.'
                        nullable: true
                      ZIP:
                        type: string
                        example: 40837-
                        description: 'Primary address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry city ID.'
                        nullable: true
                      U_US_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID:
                        type: string
                        example: null
                        description: 'Primary address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID:
                        type: string
                        example: null
                        description: 'Primary address — code list reference ID.'
                        nullable: true
                      ADR2:
                        type: string
                        example: null
                        description: "Shipping/mailing address mode. 'AS1' = same as primary address, 'OWN' = custom address."
                        nullable: true
                        enum:
                          - AS1
                          - OWN
                      U_RECIPIENT2:
                        type: string
                        example: null
                        description: 'Shipping address — recipient name.'
                        nullable: true
                      STREET2:
                        type: string
                        example: null
                        description: 'Shipping address — street name.'
                        nullable: true
                      HOUSE_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — house number.'
                        nullable: true
                      CITY2:
                        type: string
                        example: null
                        description: 'Shipping address — city.'
                        nullable: true
                      ZIP2:
                        type: string
                        example: null
                        description: 'Shipping address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry city ID.'
                        nullable: true
                      U_US_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID2:
                        type: string
                        example: null
                        description: 'Shipping address — code list reference ID.'
                        nullable: true
                      ADR3:
                        type: string
                        example: null
                        description: "Invoice address mode. 'AS1' = same as primary, 'AS2' = same as shipping, 'OWN' = custom address."
                        nullable: true
                        enum:
                          - AS1
                          - AS2
                          - OWN
                      U_RECIPIENT3:
                        type: string
                        example: null
                        description: 'Invoice address — recipient name.'
                        nullable: true
                      STREET3:
                        type: string
                        example: null
                        description: 'Invoice address — street name.'
                        nullable: true
                      HOUSE_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — house number.'
                        nullable: true
                      CITY3:
                        type: string
                        example: null
                        description: 'Invoice address — city.'
                        nullable: true
                      ZIP3:
                        type: string
                        example: null
                        description: 'Invoice address — postal code (PSČ).'
                        nullable: true
                      U_UC_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry city ID.'
                        nullable: true
                      U_US_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry street ID.'
                        nullable: true
                      U_UA_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — UIR registry address ID.'
                        nullable: true
                      U_CL_ID3:
                        type: string
                        example: null
                        description: 'Invoice address — code list reference ID.'
                        nullable: true
                      FAX:
                        type: string
                        example: null
                        description: 'Fax number.'
                        nullable: true
                      SERVICES:
                        type: string
                        example: blanditiis
                        description: 'Comma-separated list of service identifiers associated with the customer.'
                      COMP_ID:
                        type: string
                        example: null
                        description: 'Company registration number (IČO).'
                        nullable: true
                      COMP_FID:
                        type: string
                        example: null
                        description: 'Tax identification number (DIČ).'
                        nullable: true
                      ACTIVATION:
                        type: string
                        example: '1900-01-01 00:00:00'
                        description: "Datetime of the customer's initial activation."
                      U_ACTIVATION_LAST:
                        type: string
                        example: '2026-03-16 18:15:16'
                        description: "Datetime of the customer's most recent activation."
                      INFO_MAIL:
                        type: integer
                        example: 1
                        description: 'Email notification consent flag. 1 = opted in.'
                        nullable: true
                      INFO_POST:
                        type: string
                        example: null
                        description: 'Postal (print) notification flag.'
                      USER_NOTE:
                        type: string
                        example: null
                        description: 'Customer-visible note.'
                        nullable: true
                      INTERNAL_NOTE:
                        type: string
                        example: null
                        description: 'Internal note — visible only to operators, not to the customer.'
                        nullable: true
                      CT:
                        type: string
                        example: '008'
                        description: 'Company/tenant identifier — multi-tenant discriminator.'
                      FLAT:
                        type: string
                        example: null
                        description: 'Primary address — flat/apartment number.'
                        nullable: true
                      NOTE1:
                        type: string
                        example: null
                        description: 'Custom note field 1.'
                        nullable: true
                      NOTE2:
                        type: string
                        example: null
                        description: 'Custom note field 2.'
                        nullable: true
                      NOTE3:
                        type: string
                        example: null
                        description: 'Custom note field 3.'
                        nullable: true
                      NOTE4:
                        type: string
                        example: null
                        description: 'Custom note field 4.'
                        nullable: true
                      NOTE5:
                        type: string
                        example: null
                        description: 'Custom note field 5.'
                        nullable: true
                      NOTE6:
                        type: string
                        example: null
                        description: 'Custom note field 6.'
                        nullable: true
                      NOTE7:
                        type: string
                        example: null
                        description: 'Custom note field 7.'
                        nullable: true
                      NOTE8:
                        type: string
                        example: null
                        description: 'Custom note field 8.'
                        nullable: true
                      SIPO_NUM:
                        type: string
                        example: null
                        description: 'SIPO number — postal payment connector number for recurring payments.'
                        nullable: true
                      DATE_BEGIN:
                        type: string
                        example: null
                        description: 'Contract start date (YYYY-MM-DD).'
                        nullable: true
                      DATE_END:
                        type: string
                        example: null
                        description: 'Contract end date (YYYY-MM-DD).'
                        nullable: true
                      SIPO_DATE_FROM:
                        type: string
                        example: null
                        description: 'SIPO effective start datetime.'
                        nullable: true
                      GROUP_ID:
                        type: string
                        example: null
                        description: 'Customer group identifier.'
                        nullable: true
                      VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol — unique payment identifier used in bank transfers.'
                        nullable: true
                      AGR_NAME:
                        type: string
                        example: null
                        description: 'Agreement/contract number.'
                        nullable: true
                      PERSON_ID_NUMBER:
                        type: string
                        example: null
                        description: 'National personal ID number.'
                        nullable: true
                      U_BIRTHDAY:
                        type: string
                        example: null
                        description: 'Date of birth (YYYY-MM-DD).'
                        nullable: true
                      U_PERSONAL_NUMBER:
                        type: string
                        example: null
                        description: 'Personal identification number (rodné číslo / birth number).'
                        nullable: true
                      U_DOCUMENT_NUMBER:
                        type: string
                        example: null
                        description: 'Identity document number (e.g. national ID card number).'
                        nullable: true
                      ACCOUNT_PRE_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account prefix number (Czech format).'
                        nullable: true
                      ACCOUNT_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account number.'
                        nullable: true
                      ACCOUNT_BANK:
                        type: string
                        example: null
                        description: 'Bank code (4-digit Czech bank code).'
                        nullable: true
                      U_IBAN:
                        type: string
                        example: null
                        description: 'International Bank Account Number (IBAN).'
                        nullable: true
                      U_ACCOUNT_ATTACH:
                        type: string
                        example: null
                        description: 'Attachment ID linked to the bank account record.'
                        nullable: true
                      U_ACCOUNT_SPECSYM:
                        type: string
                        example: null
                        description: 'Specific symbol associated with the bank account.'
                        nullable: true
                      SALESMAN:
                        type: string
                        example: null
                        description: 'Sales representative (admin user) ID.'
                        nullable: true
                      U_BIRTH_NUMBER:
                        type: string
                        example: null
                        description: 'Birth number (rodné číslo). Alternative field for personal identification.'
                        nullable: true
                      U_TECH_LOC:
                        type: string
                        example: null
                        description: 'Technical location identifier.'
                        nullable: true
                      U_FLAT_TYPE:
                        type: string
                        example: null
                        description: 'Type of flat/premises (e.g. apartment category).'
                        nullable: true
                      U_TECH_NAME:
                        type: string
                        example: null
                        description: 'Technical name / description of the location.'
                        nullable: true
                      U_PREMISES:
                        type: integer
                        example: 0
                        description: 'Business premises flag. 1 = customer has associated premises.'
                      U_INV_NOTE:
                        type: string
                        example: null
                        description: 'Note printed on invoices.'
                        nullable: true
                      U_CODENAME:
                        type: string
                        example: null
                        description: 'Code identifier used by automated processors (e.g. SMS request handling).'
                        nullable: true
                      U_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Active customer flag. 1 = active, 0 = inactive.'
                      LOG_LEVEL:
                        type: string
                        example: INFO
                        description: 'Logging level for this customer.'
                        enum:
                          - EMERG
                          - ALERT
                          - CRIT
                          - ERR
                          - WARNING
                          - NOTICE
                          - INFO
                          - DEBUG
                      U_INFO_SMS:
                        type: integer
                        example: 0
                        description: 'SMS notification consent flag. 1 = opted in.'
                        nullable: true
                      U_PERSON_ID:
                        type: string
                        example: null
                        description: 'Person identifier (up to 12 chars).'
                        nullable: true
                      U_STATUTARY:
                        type: string
                        example: null
                        description: 'Statutory body / authorized signatory of the contract.'
                        nullable: true
                      U_COMP_VATID:
                        type: string
                        example: null
                        description: 'VAT identification number (IČ DPH).'
                        nullable: true
                      U_DEFAULT_BP_ID:
                        type: string
                        example: null
                        description: 'Default billing period ID.'
                        nullable: true
                      U_EU_FIRST_LOGIN:
                        type: integer
                        example: 1
                        description: 'Flag indicating the SelfCare account has not been authorized yet. 1 = not yet authorized.'
                      U_PASS_EXPIRE:
                        type: string
                        example: null
                        description: 'Password expiration setting (days).'
                        nullable: true
                      U_PASS_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last password change.'
                        nullable: true
                      U_REGENERATE:
                        type: string
                        example: null
                        description: 'Timestamp when user-dependent data regeneration started. Cleared after successful regeneration.'
                        nullable: true
                      U_REGENERATE_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who triggered the data regeneration.'
                        nullable: true
                      U_REGENERATE_PAYMENTS:
                        type: string
                        example: null
                        description: 'Timestamp when payment data regeneration started.'
                        nullable: true
                      U_REGENERATE_PAYMENTS_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who triggered the payment data regeneration.'
                        nullable: true
                      U_PROV_LEVEL:
                        type: integer
                        example: 10
                        description: 'Customer trust/provisioning level. Higher values indicate greater trust.'
                      U_DEGREE_BEHIND:
                        type: string
                        example: null
                        description: 'Academic degree after name (e.g. Ph.D., CSc.).'
                        nullable: true
                      U_PROVISIONING:
                        type: integer
                        example: 0
                        description: 'Provisioning status.'
                        nullable: true
                      U_CODE_REFERENCES:
                        type: string
                        example: null
                        description: 'Referral/recommendation code (VIP).'
                        nullable: true
                      U_BATCH:
                        type: string
                        example: null
                        description: 'Batch processing data.'
                        nullable: true
                      U_VALUATION:
                        type: string
                        example: null
                        description: 'Customer valuation in percent. Used for modifying prices in pricelist calculations.'
                        nullable: true
                      U_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'User ID of the associated location provider.'
                        nullable: true
                      U_PROVIDER_TYPE:
                        type: string
                        example: NONE
                        description: 'Provider type classification.'
                        enum:
                          - NONE
                          - PROVIDER
                          - DEFAULT_PROVIDER
                      U_PROVIDER_LABEL:
                        type: string
                        example: null
                        description: 'Provider label — used as a contract number or identifier when USER_ID range is too large.'
                        nullable: true
                      U_PROVIDER_ACTIVE:
                        type: string
                        example: null
                        description: 'Flag indicating whether the location provider is active.'
                        nullable: true
                      U_INFO_MARKETING:
                        type: string
                        example: null
                        description: 'Marketing communication consent flag.'
                        nullable: true
                      U_OFF_LIMIT:
                        type: string
                        example: null
                        description: 'Off-limit threshold value.'
                        nullable: true
                      U_LAST_USAGE:
                        type: string
                        example: null
                        description: "Date of the customer's last service usage (YYYY-MM-DD)."
                        nullable: true
                      U_LAST_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last modification to this customer record.'
                        nullable: true
                      U_DEBTS_GENERATE:
                        type: integer
                        example: 0
                        description: 'Debts generation flag. 1 = automatic debt generation enabled.'
                      U_EXTRA_WORK_DETAIL:
                        type: integer
                        example: 0
                        description: 'Flag enabling extra work detail tracking.'
                        nullable: true
                      U_WORKS_COUNT_STRATEGY:
                        type: string
                        example: MINS
                        description: 'Work time counting strategy.'
                        nullable: true
                        enum:
                          - MINS
                          - COMM_15
                          - COMM_30
                          - COMM_60
                          - ROUND_15
                          - ROUND_30
                          - ROUND_60
                      U_GROUP_COMP_FID:
                        type: integer
                        example: 0
                        description: 'Flag indicating a group tax ID (skupinové DIČ). 1 = group DIČ is used.'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            UP_ID: '0000988741'
                            UP_USER_ID: 1987395
                            UP_NAME: param_cvip
                            UP_VALID_FROM: '2026-01-15'
                            UP_VALID_TO: null
                            UP_VALUE: 'Laboriosam est alias.'
                            UP_CONTENT: null
                            UP_CREATED: '2026-01-23 23:31:09'
                            UP_L_ID: '000425'
                        description: 'Customer parameters — collection of key-value pairs.'
                        items:
                          type: object
                          properties:
                            UP_ID:
                              type: string
                              example: '0000988741'
                            UP_USER_ID:
                              type: integer
                              example: 1987395
                            UP_NAME:
                              type: string
                              example: param_cvip
                            UP_VALID_FROM:
                              type: string
                              example: '2026-01-15'
                            UP_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            UP_VALUE:
                              type: string
                              example: 'Laboriosam est alias.'
                            UP_CONTENT:
                              type: string
                              example: null
                              nullable: true
                            UP_CREATED:
                              type: string
                              example: '2026-01-23 23:31:09'
                            UP_L_ID:
                              type: string
                              example: '000425'
                      contact_phone_numbers:
                        type: array
                        example:
                          -
                            CPN_ID: 1110430
                            CPN_SUBJ_ID: 1987395
                            CPN_VALID: 0
                            CPN_PHONE: 590549722
                            CPN_L_ID: 1012
                            CPN_LAST_UPDATE: '2026-03-17 04:27:26'
                        description: "Collection of customer's contact phone numbers."
                        items:
                          type: object
                          properties:
                            CPN_ID:
                              type: integer
                              example: 1110430
                            CPN_SUBJ_ID:
                              type: integer
                              example: 1987395
                            CPN_VALID:
                              type: integer
                              example: 0
                            CPN_PHONE:
                              type: integer
                              example: 590549722
                            CPN_L_ID:
                              type: integer
                              example: 1012
                            CPN_LAST_UPDATE:
                              type: string
                              example: '2026-03-17 04:27:26'
                      contact_email_addresses:
                        type: array
                        example:
                          -
                            CEA_ID: 446329
                            CEA_SUBJ_ID: 1987395
                            CEA_VALID: 1
                            CEA_EMAIL: modesta58@example.net
                            CEA_L_ID: 1846
                            CEA_LAST_UPDATE: '2026-04-03 15:38:08'
                        description: "Collection of customer's contact email addresses."
                        items:
                          type: object
                          properties:
                            CEA_ID:
                              type: integer
                              example: 446329
                            CEA_SUBJ_ID:
                              type: integer
                              example: 1987395
                            CEA_VALID:
                              type: integer
                              example: 1
                            CEA_EMAIL:
                              type: string
                              example: modesta58@example.net
                            CEA_L_ID:
                              type: integer
                              example: 1846
                            CEA_LAST_UPDATE:
                              type: string
                              example: '2026-04-03 15:38:08'
                    required:
                      - USER_ID
                      - LOGIN
                      - PASSWORD
                      - U_PASS_QUESTION
                      - U_PASS_ANSWER
                      - TYPE
                      - P_TITLE
                      - FIRST_NAME
                      - LAST_NAME
                      - COMPANY
                      - STREET
                      - HOUSE_ID
                      - CITY
                      - ZIP
                      - U_UC_ID
                      - U_US_ID
                      - U_UA_ID
                      - U_CL_ID
                      - ADR2
                      - U_RECIPIENT2
                      - STREET2
                      - HOUSE_ID2
                      - CITY2
                      - ZIP2
                      - U_UC_ID2
                      - U_US_ID2
                      - U_UA_ID2
                      - U_CL_ID2
                      - ADR3
                      - U_RECIPIENT3
                      - STREET3
                      - HOUSE_ID3
                      - CITY3
                      - ZIP3
                      - U_UC_ID3
                      - U_US_ID3
                      - U_UA_ID3
                      - U_CL_ID3
                      - FAX
                      - SERVICES
                      - COMP_ID
                      - COMP_FID
                      - ACTIVATION
                      - U_ACTIVATION_LAST
                      - INFO_MAIL
                      - INFO_POST
                      - USER_NOTE
                      - INTERNAL_NOTE
                      - CT
                      - FLAT
                      - NOTE1
                      - NOTE2
                      - NOTE3
                      - NOTE4
                      - NOTE5
                      - NOTE6
                      - NOTE7
                      - NOTE8
                      - SIPO_NUM
                      - DATE_BEGIN
                      - DATE_END
                      - SIPO_DATE_FROM
                      - GROUP_ID
                      - VAR_SYMBOL
                      - AGR_NAME
                      - PERSON_ID_NUMBER
                      - U_BIRTHDAY
                      - U_PERSONAL_NUMBER
                      - U_DOCUMENT_NUMBER
                      - ACCOUNT_PRE_NUMBER
                      - ACCOUNT_NUMBER
                      - ACCOUNT_BANK
                      - U_IBAN
                      - U_ACCOUNT_ATTACH
                      - U_ACCOUNT_SPECSYM
                      - SALESMAN
                      - U_BIRTH_NUMBER
                      - U_TECH_LOC
                      - U_FLAT_TYPE
                      - U_TECH_NAME
                      - U_PREMISES
                      - U_INV_NOTE
                      - U_CODENAME
                      - U_ACTIVE
                      - LOG_LEVEL
                      - U_INFO_SMS
                      - U_PERSON_ID
                      - U_STATUTARY
                      - U_COMP_VATID
                      - U_DEFAULT_BP_ID
                      - U_EU_FIRST_LOGIN
                      - U_PASS_EXPIRE
                      - U_PASS_CHANGE
                      - U_REGENERATE
                      - U_REGENERATE_L_ID
                      - U_REGENERATE_PAYMENTS
                      - U_REGENERATE_PAYMENTS_L_ID
                      - U_PROV_LEVEL
                      - U_DEGREE_BEHIND
                      - U_PROVISIONING
                      - U_CODE_REFERENCES
                      - U_BATCH
                      - U_VALUATION
                      - U_PROVIDER_USER_ID
                      - U_PROVIDER_TYPE
                      - U_PROVIDER_LABEL
                      - U_PROVIDER_ACTIVE
                      - U_INFO_MARKETING
                      - U_OFF_LIMIT
                      - U_LAST_USAGE
                      - U_LAST_CHANGE
                      - U_DEBTS_GENERATE
                      - U_EXTRA_WORK_DETAIL
                      - U_WORKS_COUNT_STRATEGY
                      - U_GROUP_COMP_FID
                      - params
                      - contact_phone_numbers
                      - contact_email_addresses
      tags:
        - Customers
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                login:
                  type: string
                  description: 'Login name of the customer'
                  example: john.doe
                password:
                  type: string
                  description: 'Password of the customer'
                  example: secret123
                type:
                  type: string
                  description: 'Type of the customer (S, F, P)'
                  example: S
                first_name:
                  type: string
                  description: 'First name of the customer'
                  example: John
                last_name:
                  type: string
                  description: 'Last name of the customer'
                  example: Doe
                company:
                  type: string
                  description: 'Company name'
                  example: 'Doe Corp'
                street:
                  type: string
                  description: 'Street address'
                  example: 'Main Street 1'
                house_id:
                  type: string
                  description: 'House ID or number'
                  example: 12A
                city:
                  type: string
                  description: 'City of the customer'
                  example: 'New York'
                zip:
                  type: string
                  description: 'ZIP Code'
                  example: '10001'
                comp_id:
                  type: string
                  description: 'Company ID (ICO)'
                  example: '12345678'
                comp_fid:
                  type: string
                  description: 'Company Tax ID (DIC)'
                  example: CZ12345678
                comp_vatid:
                  type: string
                  description: 'Company VAT ID (IC DPH)'
                  example: SK1234567890
                active:
                  type: integer
                  description: 'Is customer active? 1=yes, 0=no, -1=deleted'
                  example: 1
    delete:
      summary: 'Delete Customer'
      operationId: deleteCustomer
      description: '   This endpoint deletes a customer.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Customers
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the customer.'
        example: 68
        required: true
        schema:
          type: integer
  '/api/v3/devices/{device_id}/interfaces':
    get:
      summary: 'List Device Interfaces'
      operationId: listDeviceInterfaces
      description: '   Retrieve a paginated list of physical network interfaces for a specific device.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      NPI_ID: 3314518
                      NPI_N_ID: 353
                      NPI_TYPE: 6
                      NPI_NAME: ethp
                      NPI_L_ID: 556
                      NPI_CREATED: '2026-04-05 16:28:28'
                      NPI_CHANGED: null
                      NPI_NOTE: ''
                    -
                      NPI_ID: 3314519
                      NPI_N_ID: 353
                      NPI_TYPE: 9
                      NPI_NAME: ethq
                      NPI_L_ID: 274
                      NPI_CREATED: '2026-01-03 00:16:14'
                      NPI_CHANGED: null
                      NPI_NOTE: ''
                properties:
                  data:
                    type: array
                    example:
                      -
                        NPI_ID: 3314518
                        NPI_N_ID: 353
                        NPI_TYPE: 6
                        NPI_NAME: ethp
                        NPI_L_ID: 556
                        NPI_CREATED: '2026-04-05 16:28:28'
                        NPI_CHANGED: null
                        NPI_NOTE: ''
                      -
                        NPI_ID: 3314519
                        NPI_N_ID: 353
                        NPI_TYPE: 9
                        NPI_NAME: ethq
                        NPI_L_ID: 274
                        NPI_CREATED: '2026-01-03 00:16:14'
                        NPI_CHANGED: null
                        NPI_NOTE: ''
                    items:
                      type: object
                      properties:
                        NPI_ID:
                          type: integer
                          example: 3314518
                          description: 'Unique interface identifier (primary key).'
                        NPI_N_ID:
                          type: integer
                          example: 353
                          description: 'ID of the parent device (references nodes.ID). See GET /v3/devices/{id}.'
                        NPI_TYPE:
                          type: integer
                          example: 6
                          description: 'Interface type code (references code_list NODES_INT_TYPES). Common values: 1=Ethernet, 2=Wireless, 3=Optical.'
                        NPI_NAME:
                          type: string
                          example: ethp
                          description: 'Interface name (e.g. eth0, wlan1, pon0). Up to 80 characters.'
                          nullable: true
                        NPI_L_ID:
                          type: integer
                          example: 556
                          description: 'ID of the operator (login session) who last modified this interface.'
                        NPI_CREATED:
                          type: string
                          example: '2026-04-05 16:28:28'
                          description: 'Datetime when the interface record was created (YYYY-MM-DD HH:MM:SS).'
                          nullable: true
                        NPI_CHANGED:
                          type: string
                          example: null
                          description: 'Datetime when the interface record was last modified (YYYY-MM-DD HH:MM:SS).'
                          nullable: true
                        NPI_NOTE:
                          type: string
                          example: ''
                          description: 'Free-text note for the interface (up to 255 characters).'
                    required:
                      - NPI_ID
                      - NPI_N_ID
                      - NPI_TYPE
                      - NPI_NAME
                      - NPI_L_ID
                      - NPI_CREATED
                      - NPI_CHANGED
                      - NPI_NOTE
      tags:
        - 'Device Interfaces'
    post:
      summary: 'Create Device Interface'
      operationId: createDeviceInterface
      description: "   Create a new physical network interface on a device.\n   The interface type cannot be changed after creation.\n   Validates uniqueness of name per device and type, and checks interface count limits."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    NPI_ID: 3314520
                    NPI_N_ID: 353
                    NPI_TYPE: 9
                    NPI_NAME: ethr
                    NPI_L_ID: 765
                    NPI_CREATED: '2026-03-08 19:21:56'
                    NPI_CHANGED: null
                    NPI_NOTE: ''
                properties:
                  data:
                    type: object
                    properties:
                      NPI_ID:
                        type: integer
                        example: 3314520
                        description: 'Unique interface identifier (primary key).'
                      NPI_N_ID:
                        type: integer
                        example: 353
                        description: 'ID of the parent device (references nodes.ID). See GET /v3/devices/{id}.'
                      NPI_TYPE:
                        type: integer
                        example: 9
                        description: 'Interface type code (references code_list NODES_INT_TYPES). Common values: 1=Ethernet, 2=Wireless, 3=Optical.'
                      NPI_NAME:
                        type: string
                        example: ethr
                        description: 'Interface name (e.g. eth0, wlan1, pon0). Up to 80 characters.'
                        nullable: true
                      NPI_L_ID:
                        type: integer
                        example: 765
                        description: 'ID of the operator (login session) who last modified this interface.'
                      NPI_CREATED:
                        type: string
                        example: '2026-03-08 19:21:56'
                        description: 'Datetime when the interface record was created (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NPI_CHANGED:
                        type: string
                        example: null
                        description: 'Datetime when the interface record was last modified (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NPI_NOTE:
                        type: string
                        example: ''
                        description: 'Free-text note for the interface (up to 255 characters).'
                    required:
                      - NPI_ID
                      - NPI_N_ID
                      - NPI_TYPE
                      - NPI_NAME
                      - NPI_L_ID
                      - NPI_CREATED
                      - NPI_CHANGED
                      - NPI_NOTE
      tags:
        - 'Device Interfaces'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: integer
                  description: 'Interface type code (references NODES_INT_TYPES code list). Common values: 1=Ethernet, 2=Wireless, 3=Optical.'
                  example: 1
                name:
                  type: string
                  description: 'Interface name (e.g. eth0, wlan1, pon0). Must be unique per device and type.'
                  example: eth0
                note:
                  type: string
                  description: 'Free-text note for the interface'
                  example: 'Uplink port'
              required:
                - type
                - name
    parameters:
      -
        in: path
        name: device_id
        description: 'The ID of the device.'
        example: 48
        required: true
        schema:
          type: integer
      -
        in: path
        name: device
        description: 'The device ID'
        example: 39015
        required: true
        schema:
          type: integer
  '/api/v3/devices/{device_id}/interfaces/{id}':
    get:
      summary: 'Get Device Interface'
      operationId: getDeviceInterface
      description: '   Retrieve a specific physical network interface by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    NPI_ID: 3314521
                    NPI_N_ID: 353
                    NPI_TYPE: 10
                    NPI_NAME: ethi
                    NPI_L_ID: 752
                    NPI_CREATED: '2026-01-29 01:49:06'
                    NPI_CHANGED: null
                    NPI_NOTE: ''
                properties:
                  data:
                    type: object
                    properties:
                      NPI_ID:
                        type: integer
                        example: 3314521
                        description: 'Unique interface identifier (primary key).'
                      NPI_N_ID:
                        type: integer
                        example: 353
                        description: 'ID of the parent device (references nodes.ID). See GET /v3/devices/{id}.'
                      NPI_TYPE:
                        type: integer
                        example: 10
                        description: 'Interface type code (references code_list NODES_INT_TYPES). Common values: 1=Ethernet, 2=Wireless, 3=Optical.'
                      NPI_NAME:
                        type: string
                        example: ethi
                        description: 'Interface name (e.g. eth0, wlan1, pon0). Up to 80 characters.'
                        nullable: true
                      NPI_L_ID:
                        type: integer
                        example: 752
                        description: 'ID of the operator (login session) who last modified this interface.'
                      NPI_CREATED:
                        type: string
                        example: '2026-01-29 01:49:06'
                        description: 'Datetime when the interface record was created (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NPI_CHANGED:
                        type: string
                        example: null
                        description: 'Datetime when the interface record was last modified (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NPI_NOTE:
                        type: string
                        example: ''
                        description: 'Free-text note for the interface (up to 255 characters).'
                    required:
                      - NPI_ID
                      - NPI_N_ID
                      - NPI_TYPE
                      - NPI_NAME
                      - NPI_L_ID
                      - NPI_CREATED
                      - NPI_CHANGED
                      - NPI_NOTE
      tags:
        - 'Device Interfaces'
    put:
      summary: 'Update Device Interface'
      operationId: updateDeviceInterface
      description: "   Update a physical network interface. Only name and note can be changed;\n   the interface type is immutable after creation."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    NPI_ID: 3314522
                    NPI_N_ID: 353
                    NPI_TYPE: 10
                    NPI_NAME: etht
                    NPI_L_ID: 247
                    NPI_CREATED: '2026-01-07 20:24:15'
                    NPI_CHANGED: null
                    NPI_NOTE: ''
                properties:
                  data:
                    type: object
                    properties:
                      NPI_ID:
                        type: integer
                        example: 3314522
                        description: 'Unique interface identifier (primary key).'
                      NPI_N_ID:
                        type: integer
                        example: 353
                        description: 'ID of the parent device (references nodes.ID). See GET /v3/devices/{id}.'
                      NPI_TYPE:
                        type: integer
                        example: 10
                        description: 'Interface type code (references code_list NODES_INT_TYPES). Common values: 1=Ethernet, 2=Wireless, 3=Optical.'
                      NPI_NAME:
                        type: string
                        example: etht
                        description: 'Interface name (e.g. eth0, wlan1, pon0). Up to 80 characters.'
                        nullable: true
                      NPI_L_ID:
                        type: integer
                        example: 247
                        description: 'ID of the operator (login session) who last modified this interface.'
                      NPI_CREATED:
                        type: string
                        example: '2026-01-07 20:24:15'
                        description: 'Datetime when the interface record was created (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NPI_CHANGED:
                        type: string
                        example: null
                        description: 'Datetime when the interface record was last modified (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NPI_NOTE:
                        type: string
                        example: ''
                        description: 'Free-text note for the interface (up to 255 characters).'
                    required:
                      - NPI_ID
                      - NPI_N_ID
                      - NPI_TYPE
                      - NPI_NAME
                      - NPI_L_ID
                      - NPI_CREATED
                      - NPI_CHANGED
                      - NPI_NOTE
      tags:
        - 'Device Interfaces'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Interface name (e.g. eth0, wlan1, pon0). Must be unique per device and type.'
                  example: eth1
                note:
                  type: string
                  description: 'Free-text note for the interface'
                  example: 'Updated uplink port'
    delete:
      summary: 'Delete Device Interface'
      operationId: deleteDeviceInterface
      description: "   Delete a physical network interface from a device.\n   Fails if the interface has active connections or if deleting would violate\n   minimum interface count requirements."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Device Interfaces'
    parameters:
      -
        in: path
        name: device_id
        description: 'The ID of the device.'
        example: 48
        required: true
        schema:
          type: integer
      -
        in: path
        name: id
        description: 'The ID of the interface.'
        example: architecto
        required: true
        schema:
          type: string
      -
        in: path
        name: device
        description: 'The device ID'
        example: 39015
        required: true
        schema:
          type: integer
      -
        in: path
        name: interface
        description: 'The interface ID'
        example: 18
        required: true
        schema:
          type: integer
  /api/v3/device-param-definitions:
    get:
      summary: 'List Device Param Definitions'
      operationId: listDeviceParamDefinitions
      description: "Retrieve a paginated list of device parameter definitions.\nThese define the schema (name, type, constraints, visibility) of parameters\nthat can be set on devices of a given type.\nGlobal definitions (NP_CT IS NULL) are always included alongside\nlocation-specific ones."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of definitions to return per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of definitions to return per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated definition IDs'
          example: '1,8,15'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated definition IDs'
            example: '1,8,15'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Returns global definitions (NP_CT IS NULL) plus definitions for the specified CTs. Overrides X-CT header default.'
          example: '12,101'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Returns global definitions (NP_CT IS NULL) plus definitions for the specified CTs. Overrides X-CT header default.'
            example: '12,101'
        -
          in: query
          name: device_kind
          description: 'Filter by device type (N_TYPE). Accepts a single device type string. Same concept as "kind" filter on /devices endpoint.'
          example: MIKROTIK
          required: false
          schema:
            type: string
            description: 'Filter by device type (N_TYPE). Accepts a single device type string. Same concept as "kind" filter on /devices endpoint.'
            example: MIKROTIK
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 4335
                      NP_NPG_ID: null
                      PAR_NAME: COMMODI
                      PAR_TYPE: CHAR
                      NN_TITLE: 'iure odit'
                      N_TYPE: WIFI
                      NP_INTERFACE: null
                      NP_CT: 45
                      INDEXED: 0
                      NP_DISTINCT: 1
                      NP_DOMAIN: null
                      NP_NOTNULL: 0
                      NP_UNIQUE: ''
                      DEFAULT_VALUE: null
                      NP_CREATE: 1
                      NP_EDITABLE: 1
                      TYPE: AUTO
                      NP_PARENT_PARAM: null
                      NP_PARENT_N_TYPE: null
                      NP_NOTE: null
                      DOC_VAR_NAME: null
                      NP_VIEW: ''
                      NP_UPDATE_NODE: 1
                      NP_ORDER: null
                      NP_GROUP_NAME: null
                      NP_DEPENDENCY: null
                    -
                      ID: 4336
                      NP_NPG_ID: null
                      PAR_NAME: MODI
                      PAR_TYPE: CHAR
                      NN_TITLE: 'nostrum omnis'
                      N_TYPE: ONT
                      NP_INTERFACE: null
                      NP_CT: 167
                      INDEXED: 0
                      NP_DISTINCT: 1
                      NP_DOMAIN: null
                      NP_NOTNULL: 0
                      NP_UNIQUE: ''
                      DEFAULT_VALUE: null
                      NP_CREATE: 1
                      NP_EDITABLE: 1
                      TYPE: AUTO
                      NP_PARENT_PARAM: null
                      NP_PARENT_N_TYPE: null
                      NP_NOTE: null
                      DOC_VAR_NAME: null
                      NP_VIEW: ''
                      NP_UPDATE_NODE: 1
                      NP_ORDER: null
                      NP_GROUP_NAME: null
                      NP_DEPENDENCY: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 4335
                        NP_NPG_ID: null
                        PAR_NAME: COMMODI
                        PAR_TYPE: CHAR
                        NN_TITLE: 'iure odit'
                        N_TYPE: WIFI
                        NP_INTERFACE: null
                        NP_CT: 45
                        INDEXED: 0
                        NP_DISTINCT: 1
                        NP_DOMAIN: null
                        NP_NOTNULL: 0
                        NP_UNIQUE: ''
                        DEFAULT_VALUE: null
                        NP_CREATE: 1
                        NP_EDITABLE: 1
                        TYPE: AUTO
                        NP_PARENT_PARAM: null
                        NP_PARENT_N_TYPE: null
                        NP_NOTE: null
                        DOC_VAR_NAME: null
                        NP_VIEW: ''
                        NP_UPDATE_NODE: 1
                        NP_ORDER: null
                        NP_GROUP_NAME: null
                        NP_DEPENDENCY: null
                      -
                        ID: 4336
                        NP_NPG_ID: null
                        PAR_NAME: MODI
                        PAR_TYPE: CHAR
                        NN_TITLE: 'nostrum omnis'
                        N_TYPE: ONT
                        NP_INTERFACE: null
                        NP_CT: 167
                        INDEXED: 0
                        NP_DISTINCT: 1
                        NP_DOMAIN: null
                        NP_NOTNULL: 0
                        NP_UNIQUE: ''
                        DEFAULT_VALUE: null
                        NP_CREATE: 1
                        NP_EDITABLE: 1
                        TYPE: AUTO
                        NP_PARENT_PARAM: null
                        NP_PARENT_N_TYPE: null
                        NP_NOTE: null
                        DOC_VAR_NAME: null
                        NP_VIEW: ''
                        NP_UPDATE_NODE: 1
                        NP_ORDER: null
                        NP_GROUP_NAME: null
                        NP_DEPENDENCY: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 4335
                          description: 'Unique parameter definition ID (primary key).'
                        NP_NPG_ID:
                          type: string
                          example: null
                          description: 'Parameter group ID (FK to node_param_groups). Groups parameters visually/logically.'
                          nullable: true
                        PAR_NAME:
                          type: string
                          example: COMMODI
                          description: 'Parameter name/key (e.g. IP_ADDRESS, MAC_ADDRESS, SERVICE_STATE). Unique within a device type + CT scope.'
                          nullable: true
                        PAR_TYPE:
                          type: string
                          example: CHAR
                          description: 'Value data type: CHAR, NUM, IP, MAC, STRING, TEXT, FILE, FLOAT, etc. Determines storage location in device parameter values.'
                        NN_TITLE:
                          type: string
                          example: 'iure odit'
                          description: 'Display label shown in the UI (human-readable name).'
                          nullable: true
                        N_TYPE:
                          type: string
                          example: WIFI
                          description: "Device type this definition applies to (e.g. 'MIKROTIK', 'ONT', 'SWITCH'). Same concept as 'kind' on /devices."
                        NP_INTERFACE:
                          type: string
                          example: null
                          description: 'Interface type FK to code_list. NULL = applies to whole device, 8 = any interface.'
                          nullable: true
                        NP_CT:
                          type: integer
                          example: 45
                          description: 'Location (installation) ID this definition belongs to. NULL = global definition available to all locations.'
                          nullable: true
                        INDEXED:
                          type: integer
                          example: 0
                          description: 'Whether parameter can have multiple instances per device/interface (via PAR_INDEX).'
                        NP_DISTINCT:
                          type: integer
                          example: 1
                          description: 'Whether parameter value is distinct per device/interface (default 1).'
                        NP_DOMAIN:
                          type: string
                          example: null
                          description: 'Value domain/constraints (e.g. list of allowed values for select-type parameters).'
                          nullable: true
                        NP_NOTNULL:
                          type: integer
                          example: 0
                          description: 'Whether this parameter is required (1 = mandatory, 0 = optional).'
                        NP_UNIQUE:
                          type: string
                          example: ''
                          description: 'Uniqueness constraint scope.'
                          enum:
                            - ''
                            - location
                            - cp
                            - global
                            - poolbranch
                        DEFAULT_VALUE:
                          type: string
                          example: null
                          description: 'Default value for new parameter instances.'
                          nullable: true
                        NP_CREATE:
                          type: integer
                          example: 1
                          description: 'Whether to auto-create this parameter when creating a new device (1 = yes).'
                        NP_EDITABLE:
                          type: integer
                          example: 1
                          description: 'Editability: 0 = never, 1 = always, 2 = not while in service, 3 = not while in maintenance.'
                        TYPE:
                          type: string
                          example: AUTO
                          description: 'Update type: how the parameter value is managed.'
                          enum:
                            - AUTO
                            - MANUAL
                            - AUTO_REFRESH
                        NP_PARENT_PARAM:
                          type: string
                          example: null
                          description: 'Parent parameter name for value inheritance from another device type.'
                          nullable: true
                        NP_PARENT_N_TYPE:
                          type: string
                          example: null
                          description: 'Device type to copy parent parameter value from.'
                          nullable: true
                        NP_NOTE:
                          type: string
                          example: null
                          description: 'Documentation note about this parameter.'
                          nullable: true
                        DOC_VAR_NAME:
                          type: string
                          example: null
                          description: 'Variable name used in document templates.'
                          nullable: true
                        NP_VIEW:
                          type: string
                          example: ''
                          description: 'Comma-separated visibility flags: helpdesk_info, nodes_last, export, link_external, templates, wizard, selfcare, ni_history, etc.'
                        NP_UPDATE_NODE:
                          type: integer
                          example: 1
                          description: 'Whether changing this parameter triggers a device update action (1 = yes).'
                        NP_ORDER:
                          type: string
                          example: null
                          description: 'Display order among other parameters of the same device type.'
                          nullable: true
                        NP_GROUP_NAME:
                          type: string
                          example: null
                          description: 'Parameter group name (text identifier for logical grouping).'
                          nullable: true
                        NP_DEPENDENCY:
                          type: string
                          example: null
                          description: "Dependency spec for conditional visibility (format: 'PARAM_NAME;VAL1,VAL2,...')."
                          nullable: true
                    required:
                      - ID
                      - NP_NPG_ID
                      - PAR_NAME
                      - PAR_TYPE
                      - NN_TITLE
                      - N_TYPE
                      - NP_INTERFACE
                      - NP_CT
                      - INDEXED
                      - NP_DISTINCT
                      - NP_DOMAIN
                      - NP_NOTNULL
                      - NP_UNIQUE
                      - DEFAULT_VALUE
                      - NP_CREATE
                      - NP_EDITABLE
                      - TYPE
                      - NP_PARENT_PARAM
                      - NP_PARENT_N_TYPE
                      - NP_NOTE
                      - DOC_VAR_NAME
                      - NP_VIEW
                      - NP_UPDATE_NODE
                      - NP_ORDER
                      - NP_GROUP_NAME
                      - NP_DEPENDENCY
      tags:
        - 'Device Param Definitions'
  /api/v3/device-service-history:
    get:
      summary: 'List Device Service History'
      operationId: listDeviceServiceHistory
      description: "Retrieve a paginated list of device service history events.\nAt least one identifying filter (customer, device, or customer_service) is required."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page (optional).'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of results per page (optional).'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional).'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated device service history IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated device service history IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer ID (NSH_U_ID).'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer ID (NSH_U_ID).'
            example: 100
        -
          in: query
          name: device
          description: 'Filter by device (node) ID (NSH_N_ID).'
          example: 40022
          required: false
          schema:
            type: integer
            description: 'Filter by device (node) ID (NSH_N_ID).'
            example: 40022
        -
          in: query
          name: customer_service
          description: 'Filter by active service instance ID (NSH_SA_ID).'
          example: 200
          required: false
          schema:
            type: integer
            description: 'Filter by active service instance ID (NSH_SA_ID).'
            example: 200
        -
          in: query
          name: from
          description: 'Filter events on or after this date/datetime (NSH_TIME column).'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter events on or after this date/datetime (NSH_TIME column).'
            example: '2024-01-01'
        -
          in: query
          name: to
          description: 'Filter events on or before this date/datetime (NSH_TIME column).'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter events on or before this date/datetime (NSH_TIME column).'
            example: '2024-12-31'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      NSH_ID: 3402921
                      NSH_N_ID: 759832
                      NSH_U_ID: null
                      NSH_SA_ID: null
                      NSH_EVENT: 20
                      NSH_L_ID: 339
                      NSH_TIME: '2026-02-15 21:57:12'
                      NSH_CREATED: '2026-04-05 16:01:33'
                      NSH_NOTE: null
                      NSH_NOTE_BODY: null
                    -
                      NSH_ID: 3402922
                      NSH_N_ID: 314167
                      NSH_U_ID: null
                      NSH_SA_ID: null
                      NSH_EVENT: 18
                      NSH_L_ID: 274
                      NSH_TIME: '2026-01-02 23:54:59'
                      NSH_CREATED: '2026-02-18 14:58:54'
                      NSH_NOTE: null
                      NSH_NOTE_BODY: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        NSH_ID: 3402921
                        NSH_N_ID: 759832
                        NSH_U_ID: null
                        NSH_SA_ID: null
                        NSH_EVENT: 20
                        NSH_L_ID: 339
                        NSH_TIME: '2026-02-15 21:57:12'
                        NSH_CREATED: '2026-04-05 16:01:33'
                        NSH_NOTE: null
                        NSH_NOTE_BODY: null
                      -
                        NSH_ID: 3402922
                        NSH_N_ID: 314167
                        NSH_U_ID: null
                        NSH_SA_ID: null
                        NSH_EVENT: 18
                        NSH_L_ID: 274
                        NSH_TIME: '2026-01-02 23:54:59'
                        NSH_CREATED: '2026-02-18 14:58:54'
                        NSH_NOTE: null
                        NSH_NOTE_BODY: null
                    items:
                      type: object
                      properties:
                        NSH_ID:
                          type: integer
                          example: 3402921
                          description: 'Unique device service history event identifier.'
                        NSH_N_ID:
                          type: integer
                          example: 759832
                          description: 'Device (node) ID. See GET /v3/devices/{id}.'
                        NSH_U_ID:
                          type: string
                          example: null
                          description: 'Customer ID. See GET /v3/customers/{id}.'
                          nullable: true
                        NSH_SA_ID:
                          type: string
                          example: null
                          description: 'Active service instance ID. See GET /v3/customer-services/{id}.'
                          nullable: true
                        NSH_EVENT:
                          type: integer
                          example: 20
                          description: 'Event type code (numeric). See event_name for the symbolic key.'
                        NSH_L_ID:
                          type: integer
                          example: 339
                          description: 'Login ID of the operator who created this event.'
                        NSH_TIME:
                          type: string
                          example: '2026-02-15 21:57:12'
                          description: 'Event timestamp (datetime).'
                        NSH_CREATED:
                          type: string
                          example: '2026-04-05 16:01:33'
                          description: 'Record creation timestamp (datetime).'
                        NSH_NOTE:
                          type: string
                          example: null
                          description: 'Short note / event description.'
                          nullable: true
                        NSH_NOTE_BODY:
                          type: string
                          example: null
                          description: 'Extended note body (long text).'
                          nullable: true
                    required:
                      - NSH_ID
                      - NSH_N_ID
                      - NSH_U_ID
                      - NSH_SA_ID
                      - NSH_EVENT
                      - NSH_L_ID
                      - NSH_TIME
                      - NSH_CREATED
                      - NSH_NOTE
                      - NSH_NOTE_BODY
      tags:
        - 'Device Service History'
  '/api/v3/device-service-history/{id}':
    get:
      summary: 'Get Device Service History Event'
      operationId: getDeviceServiceHistoryEvent
      description: 'Retrieve a specific device service history event by ID, including the resolved event name.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    NSH_ID: 3402923
                    NSH_N_ID: 759832
                    NSH_U_ID: null
                    NSH_SA_ID: null
                    NSH_EVENT: 20
                    NSH_L_ID: 339
                    NSH_TIME: '2026-02-15 21:54:42'
                    NSH_CREATED: '2026-04-05 15:56:10'
                    NSH_NOTE: null
                    NSH_NOTE_BODY: null
                properties:
                  data:
                    type: object
                    properties:
                      NSH_ID:
                        type: integer
                        example: 3402923
                        description: 'Unique device service history event identifier.'
                      NSH_N_ID:
                        type: integer
                        example: 759832
                        description: 'Device (node) ID. See GET /v3/devices/{id}.'
                      NSH_U_ID:
                        type: string
                        example: null
                        description: 'Customer ID. See GET /v3/customers/{id}.'
                        nullable: true
                      NSH_SA_ID:
                        type: string
                        example: null
                        description: 'Active service instance ID. See GET /v3/customer-services/{id}.'
                        nullable: true
                      NSH_EVENT:
                        type: integer
                        example: 20
                        description: 'Event type code (numeric). See event_name for the symbolic key.'
                      NSH_L_ID:
                        type: integer
                        example: 339
                        description: 'Login ID of the operator who created this event.'
                      NSH_TIME:
                        type: string
                        example: '2026-02-15 21:54:42'
                        description: 'Event timestamp (datetime).'
                      NSH_CREATED:
                        type: string
                        example: '2026-04-05 15:56:10'
                        description: 'Record creation timestamp (datetime).'
                      NSH_NOTE:
                        type: string
                        example: null
                        description: 'Short note / event description.'
                        nullable: true
                      NSH_NOTE_BODY:
                        type: string
                        example: null
                        description: 'Extended note body (long text).'
                        nullable: true
                    required:
                      - NSH_ID
                      - NSH_N_ID
                      - NSH_U_ID
                      - NSH_SA_ID
                      - NSH_EVENT
                      - NSH_L_ID
                      - NSH_TIME
                      - NSH_CREATED
                      - NSH_NOTE
                      - NSH_NOTE_BODY
      tags:
        - 'Device Service History'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the device service history.'
        example: 1
        required: true
        schema:
          type: integer
  /api/v3/devices:
    get:
      summary: 'List Devices'
      operationId: listDevices
      description: "   Retrieve a paginated list of devices.\n   Supports complex CT filtering (customer devices by N_CT, infrastructure by infra_loc param)."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated device IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated device IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Uses complex device CT logic.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Uses complex device CT logic.'
            example: '1,2,3'
        -
          in: query
          name: kind
          description: 'Filter by device type (N_TYPE)'
          example: AP
          required: false
          schema:
            type: string
            description: 'Filter by device type (N_TYPE)'
            example: AP
        -
          in: query
          name: parent_id
          description: 'Filter by parent device ID (devices connected under this parent)'
          example: '100'
          required: false
          schema:
            type: integer
            description: 'Filter by parent device ID (devices connected under this parent)'
            example: '100'
        -
          in: query
          name: child_id
          description: 'Filter by child device ID (returns the parent device above this child)'
          example: '200'
          required: false
          schema:
            type: integer
            description: 'Filter by child device ID (returns the parent device above this child)'
            example: '200'
        -
          in: query
          name: groups
          description: 'Filter by device group ID(s), comma-separated'
          example: '5,10'
          required: false
          schema:
            type: string
            description: 'Filter by device group ID(s), comma-separated'
            example: '5,10'
        -
          in: query
          name: service_ids
          description: 'Filter by service IDs (comma-separated), devices linked to these services'
          example: '1,2'
          required: false
          schema:
            type: string
            description: 'Filter by service IDs (comma-separated), devices linked to these services'
            example: '1,2'
        -
          in: query
          name: user_id
          description: 'Filter by customer ID, devices linked to this customer via nodes_services'
          example: '100'
          required: false
          schema:
            type: integer
            description: 'Filter by customer ID, devices linked to this customer via nodes_services'
            example: '100'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 1793154
                      NAME: DEV-kpafdx
                      NOTE: 'At est distinctio ipsa neque est.'
                      MANAGED: 0
                      MANAG_IP: null
                      PARENT_NODE: null
                      F_TYPE: OLT
                      N_TYPE: MIKROTIK
                      N_DEVICE_TYPE: ap
                      N_CUSTOMER: 0
                      USER_SERVICE_ID: 0
                      CUSTOMER_PARENT: 0
                      CUSTOMER_TYPE: null
                      CUSTOMER_LOCATION: 0
                      MAC: null
                      UPDATE_FLAG: 0
                      AGR_GROUP: null
                      STREET: null
                      HOUSE_ID: null
                      N_ZIP: null
                      N_CITY: null
                      SOCKET: null
                      N_COUNTER_ID: '000000'
                      N_PRODUCER: null
                      N_SERIAL_NUM: null
                      N_LAST_RESPONSE: null
                      N_CT: '073'
                      N_CREATED: null
                      N_L_ID: '000327'
                      N_GPS_LATITUDE: null
                      N_GPS_LONGITUDE: null
                      N_UCP_ID: null
                      N_US_ID: null
                      N_UA_ID: null
                      N_CACHE_NAME: fugiat
                      N_CACHE_LAST_WS_ID: null
                      N_DELETED: null
                      params:
                        -
                          ID: 301407048
                          NODE_ID: 1793154
                          NI_NPI_ID: 0
                          PAR_NAME: IP_ADDRESS
                          PAR_INDEX: 0
                          VALUE: null
                          CONTENT: null
                          TEXT_CONTENT: null
                      customer_service_devices:
                        -
                          NS_ID: 2150073
                          NS_N_ID: 1793154
                          NS_U_ID: 1038
                          NS_SA_ID: null
                          NS_TIME: '2026-04-14 14:34:56'
                          NS_L_ID: 1
                          NS_NEEDS_UPDATE: 0
                      interfaces:
                        -
                          NPI_ID: 3314511
                          NPI_N_ID: 1793154
                          NPI_TYPE: 1411
                          NPI_NAME: ethh
                          NPI_L_ID: 526
                          NPI_CREATED: '2026-04-01 14:56:21'
                          NPI_CHANGED: null
                          NPI_NOTE: ''
                    -
                      ID: 1793155
                      NAME: DEV-evivpe
                      NOTE: 'Nulla harum sunt est voluptatem.'
                      MANAGED: 1
                      MANAG_IP: 80.163.161.248
                      PARENT_NODE: null
                      F_TYPE: AP
                      N_TYPE: CISCO
                      N_DEVICE_TYPE: switch
                      N_CUSTOMER: 1
                      USER_SERVICE_ID: 0
                      CUSTOMER_PARENT: 0
                      CUSTOMER_TYPE: null
                      CUSTOMER_LOCATION: 0
                      MAC: null
                      UPDATE_FLAG: 0
                      AGR_GROUP: null
                      STREET: null
                      HOUSE_ID: null
                      N_ZIP: null
                      N_CITY: null
                      SOCKET: null
                      N_COUNTER_ID: '000000'
                      N_PRODUCER: null
                      N_SERIAL_NUM: null
                      N_LAST_RESPONSE: null
                      N_CT: '014'
                      N_CREATED: null
                      N_L_ID: '000889'
                      N_GPS_LATITUDE: null
                      N_GPS_LONGITUDE: null
                      N_UCP_ID: null
                      N_US_ID: null
                      N_UA_ID: null
                      N_CACHE_NAME: ut
                      N_CACHE_LAST_WS_ID: null
                      N_DELETED: null
                      params:
                        -
                          ID: 301407049
                          NODE_ID: 1793155
                          NI_NPI_ID: 0
                          PAR_NAME: DATA_COUNTER
                          PAR_INDEX: 0
                          VALUE: null
                          CONTENT: null
                          TEXT_CONTENT: null
                      customer_service_devices:
                        -
                          NS_ID: 2150074
                          NS_N_ID: 1793155
                          NS_U_ID: 1038
                          NS_SA_ID: null
                          NS_TIME: '2026-01-26 12:32:21'
                          NS_L_ID: 1
                          NS_NEEDS_UPDATE: 0
                      interfaces:
                        -
                          NPI_ID: 3314512
                          NPI_N_ID: 1793155
                          NPI_TYPE: 10
                          NPI_NAME: ethu
                          NPI_L_ID: 526
                          NPI_CREATED: '2026-01-01 18:41:49'
                          NPI_CHANGED: null
                          NPI_NOTE: ''
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 1793154
                        NAME: DEV-kpafdx
                        NOTE: 'At est distinctio ipsa neque est.'
                        MANAGED: 0
                        MANAG_IP: null
                        PARENT_NODE: null
                        F_TYPE: OLT
                        N_TYPE: MIKROTIK
                        N_DEVICE_TYPE: ap
                        N_CUSTOMER: 0
                        USER_SERVICE_ID: 0
                        CUSTOMER_PARENT: 0
                        CUSTOMER_TYPE: null
                        CUSTOMER_LOCATION: 0
                        MAC: null
                        UPDATE_FLAG: 0
                        AGR_GROUP: null
                        STREET: null
                        HOUSE_ID: null
                        N_ZIP: null
                        N_CITY: null
                        SOCKET: null
                        N_COUNTER_ID: '000000'
                        N_PRODUCER: null
                        N_SERIAL_NUM: null
                        N_LAST_RESPONSE: null
                        N_CT: '073'
                        N_CREATED: null
                        N_L_ID: '000327'
                        N_GPS_LATITUDE: null
                        N_GPS_LONGITUDE: null
                        N_UCP_ID: null
                        N_US_ID: null
                        N_UA_ID: null
                        N_CACHE_NAME: fugiat
                        N_CACHE_LAST_WS_ID: null
                        N_DELETED: null
                        params:
                          -
                            ID: 301407048
                            NODE_ID: 1793154
                            NI_NPI_ID: 0
                            PAR_NAME: IP_ADDRESS
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        customer_service_devices:
                          -
                            NS_ID: 2150073
                            NS_N_ID: 1793154
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-04-14 14:34:56'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        interfaces:
                          -
                            NPI_ID: 3314511
                            NPI_N_ID: 1793154
                            NPI_TYPE: 1411
                            NPI_NAME: ethh
                            NPI_L_ID: 526
                            NPI_CREATED: '2026-04-01 14:56:21'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                      -
                        ID: 1793155
                        NAME: DEV-evivpe
                        NOTE: 'Nulla harum sunt est voluptatem.'
                        MANAGED: 1
                        MANAG_IP: 80.163.161.248
                        PARENT_NODE: null
                        F_TYPE: AP
                        N_TYPE: CISCO
                        N_DEVICE_TYPE: switch
                        N_CUSTOMER: 1
                        USER_SERVICE_ID: 0
                        CUSTOMER_PARENT: 0
                        CUSTOMER_TYPE: null
                        CUSTOMER_LOCATION: 0
                        MAC: null
                        UPDATE_FLAG: 0
                        AGR_GROUP: null
                        STREET: null
                        HOUSE_ID: null
                        N_ZIP: null
                        N_CITY: null
                        SOCKET: null
                        N_COUNTER_ID: '000000'
                        N_PRODUCER: null
                        N_SERIAL_NUM: null
                        N_LAST_RESPONSE: null
                        N_CT: '014'
                        N_CREATED: null
                        N_L_ID: '000889'
                        N_GPS_LATITUDE: null
                        N_GPS_LONGITUDE: null
                        N_UCP_ID: null
                        N_US_ID: null
                        N_UA_ID: null
                        N_CACHE_NAME: ut
                        N_CACHE_LAST_WS_ID: null
                        N_DELETED: null
                        params:
                          -
                            ID: 301407049
                            NODE_ID: 1793155
                            NI_NPI_ID: 0
                            PAR_NAME: DATA_COUNTER
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        customer_service_devices:
                          -
                            NS_ID: 2150074
                            NS_N_ID: 1793155
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-01-26 12:32:21'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        interfaces:
                          -
                            NPI_ID: 3314512
                            NPI_N_ID: 1793155
                            NPI_TYPE: 10
                            NPI_NAME: ethu
                            NPI_L_ID: 526
                            NPI_CREATED: '2026-01-01 18:41:49'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 1793154
                          description: 'Unique device identifier (primary key, zero-filled to 6 digits).'
                        NAME:
                          type: string
                          example: DEV-kpafdx
                          description: 'Device name (up to 30 characters).'
                        NOTE:
                          type: string
                          example: 'At est distinctio ipsa neque est.'
                          description: 'Free-text note.'
                          nullable: true
                        MANAGED:
                          type: integer
                          example: 0
                          description: 'Flag indicating the device is managed (configured) by the Mango system. 1 = managed.'
                        MANAG_IP:
                          type: string
                          example: null
                          description: 'Management IP address of the device.'
                          nullable: true
                        PARENT_NODE:
                          type: string
                          example: null
                          description: 'ID of the parent device in the network topology. See GET /v3/devices/{id}.'
                          nullable: true
                        F_TYPE:
                          type: string
                          example: OLT
                          description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                          nullable: true
                        N_TYPE:
                          type: string
                          example: MIKROTIK
                          description: 'Device class / node type (e.g. LINUX, MIKROTIK, SWITCH, ONT, WIFI, CISCO, DOCSIS, …). Defines the parameter schema available for the device.'
                        N_DEVICE_TYPE:
                          type: string
                          example: ap
                          description: "Specific device model or hardware type (e.g. 'MikroTik RB750', 'UBNT NanoStation', …)."
                        N_CUSTOMER:
                          type: integer
                          example: 0
                          description: 'Customer device flag. 1 = end-user device (CPE), 0 = infrastructure device.'
                        USER_SERVICE_ID:
                          type: integer
                          example: 0
                          description: 'ID of the associated customer service. See GET /v3/customer-services/{id}.'
                          nullable: true
                        CUSTOMER_PARENT:
                          type: integer
                          example: 0
                          description: 'Flag indicating this infrastructure device can host customer (end-user) devices. 1 = open for customer connections.'
                        CUSTOMER_TYPE:
                          type: string
                          example: null
                          description: 'Customer device sub-type (only relevant when N_CUSTOMER=1). E.g. LINUX, NIC, WIFI, DECODER, DS_MODEM, SIP_DEVICE, CIBSROUTER, etc.'
                          nullable: true
                        CUSTOMER_LOCATION:
                          type: integer
                          example: 0
                          description: 'Deprecated. Former customer location reference (now handled via nodes_cust_locations).'
                          nullable: true
                        MAC:
                          type: string
                          example: null
                          description: 'MAC address of the device.'
                          nullable: true
                        UPDATE_FLAG:
                          type: integer
                          example: 0
                          description: 'Flag indicating the device configuration needs to be pushed/updated. 1 = update pending.'
                        AGR_GROUP:
                          type: string
                          example: null
                          description: 'Deprecated. Former aggregation group reference.'
                          nullable: true
                        STREET:
                          type: string
                          example: null
                          description: 'Street name of the device location.'
                          nullable: true
                        HOUSE_ID:
                          type: string
                          example: null
                          description: 'House number (číslo popisné) of the device location.'
                          nullable: true
                        N_ZIP:
                          type: string
                          example: null
                          description: 'ZIP / postal code (up to 5 characters).'
                          nullable: true
                        N_CITY:
                          type: string
                          example: null
                          description: 'City of the device location.'
                          nullable: true
                        SOCKET:
                          type: string
                          example: null
                          description: 'Socket / apartment identifier at the device location.'
                          nullable: true
                        N_COUNTER_ID:
                          type: string
                          example: '000000'
                          description: 'Deprecated. Former counter ID (now stored as a device parameter).'
                          nullable: true
                        N_PRODUCER:
                          type: string
                          example: null
                          description: 'Device manufacturer / producer.'
                          nullable: true
                        N_SERIAL_NUM:
                          type: string
                          example: null
                          description: 'Serial number of the device.'
                          nullable: true
                        N_LAST_RESPONSE:
                          type: string
                          example: null
                          description: 'Datetime of the last successful SNMP monitoring response.'
                          nullable: true
                        N_CT:
                          type: string
                          example: '073'
                          description: 'Location / installation CT ID (for customer devices when N_CUSTOMER=1).'
                        N_CREATED:
                          type: string
                          example: null
                          description: 'Datetime when the device record was created.'
                          nullable: true
                        N_L_ID:
                          type: string
                          example: '000327'
                          description: 'ID of the operator (login session) who last modified this device.'
                        N_GPS_LATITUDE:
                          type: string
                          example: null
                          description: 'GPS latitude of the device.'
                          nullable: true
                        N_GPS_LONGITUDE:
                          type: string
                          example: null
                          description: 'GPS longitude of the device.'
                          nullable: true
                        N_UCP_ID:
                          type: string
                          example: null
                          description: 'UIR registry city part ID.'
                          nullable: true
                        N_US_ID:
                          type: string
                          example: null
                          description: 'UIR registry street ID.'
                          nullable: true
                        N_UA_ID:
                          type: string
                          example: null
                          description: 'UIR registry address ID.'
                          nullable: true
                        N_CACHE_NAME:
                          type: string
                          example: fugiat
                          description: 'Cached display name combining class, type and device name for quick lookups.'
                        N_CACHE_LAST_WS_ID:
                          type: string
                          example: null
                          description: 'Cached ID of the last work session that touched this device.'
                          nullable: true
                        N_DELETED:
                          type: string
                          example: null
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              ID: 301407048
                              NODE_ID: 1793154
                              NI_NPI_ID: 0
                              PAR_NAME: IP_ADDRESS
                              PAR_INDEX: 0
                              VALUE: null
                              CONTENT: null
                              TEXT_CONTENT: null
                          description: 'Device parameters — collection of key-value pairs from the node_info table.'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 301407048
                              NODE_ID:
                                type: integer
                                example: 1793154
                              NI_NPI_ID:
                                type: integer
                                example: 0
                              PAR_NAME:
                                type: string
                                example: IP_ADDRESS
                              PAR_INDEX:
                                type: integer
                                example: 0
                              VALUE:
                                type: string
                                example: null
                                nullable: true
                              CONTENT:
                                type: string
                                example: null
                                nullable: true
                              TEXT_CONTENT:
                                type: string
                                example: null
                                nullable: true
                        customer_service_devices:
                          type: array
                          example:
                            -
                              NS_ID: 2150073
                              NS_N_ID: 1793154
                              NS_U_ID: 1038
                              NS_SA_ID: null
                              NS_TIME: '2026-04-14 14:34:56'
                              NS_L_ID: 1
                              NS_NEEDS_UPDATE: 0
                          description: 'Services bound to this device — collection of customer-service-device bindings from the nodes_services table.'
                          items:
                            type: object
                            properties:
                              NS_ID:
                                type: integer
                                example: 2150073
                              NS_N_ID:
                                type: integer
                                example: 1793154
                              NS_U_ID:
                                type: integer
                                example: 1038
                              NS_SA_ID:
                                type: string
                                example: null
                                nullable: true
                              NS_TIME:
                                type: string
                                example: '2026-04-14 14:34:56'
                              NS_L_ID:
                                type: integer
                                example: 1
                              NS_NEEDS_UPDATE:
                                type: integer
                                example: 0
                        interfaces:
                          type: array
                          example:
                            -
                              NPI_ID: 3314511
                              NPI_N_ID: 1793154
                              NPI_TYPE: 1411
                              NPI_NAME: ethh
                              NPI_L_ID: 526
                              NPI_CREATED: '2026-04-01 14:56:21'
                              NPI_CHANGED: null
                              NPI_NOTE: ''
                          description: 'Physical network interfaces — collection of interface records from the nodes_physical_interfaces table.'
                          items:
                            type: object
                            properties:
                              NPI_ID:
                                type: integer
                                example: 3314511
                              NPI_N_ID:
                                type: integer
                                example: 1793154
                              NPI_TYPE:
                                type: integer
                                example: 1411
                              NPI_NAME:
                                type: string
                                example: ethh
                              NPI_L_ID:
                                type: integer
                                example: 526
                              NPI_CREATED:
                                type: string
                                example: '2026-04-01 14:56:21'
                              NPI_CHANGED:
                                type: string
                                example: null
                                nullable: true
                              NPI_NOTE:
                                type: string
                                example: ''
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
                      - interfaces
      tags:
        - Devices
    post:
      summary: 'Create Device'
      operationId: createDevice
      description: '   Create a new device.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1793156
                    NAME: DEV-ngzmiy
                    NOTE: 'Nihil accusantium harum mollitia modi deserunt.'
                    MANAGED: 0
                    MANAG_IP: null
                    PARENT_NODE: null
                    F_TYPE: OLT
                    N_TYPE: CISCO
                    N_DEVICE_TYPE: router
                    N_CUSTOMER: 0
                    USER_SERVICE_ID: 0
                    CUSTOMER_PARENT: 0
                    CUSTOMER_TYPE: null
                    CUSTOMER_LOCATION: 0
                    MAC: null
                    UPDATE_FLAG: 0
                    AGR_GROUP: null
                    STREET: null
                    HOUSE_ID: null
                    N_ZIP: null
                    N_CITY: null
                    SOCKET: null
                    N_COUNTER_ID: '000000'
                    N_PRODUCER: null
                    N_SERIAL_NUM: null
                    N_LAST_RESPONSE: null
                    N_CT: '007'
                    N_CREATED: null
                    N_L_ID: '000592'
                    N_GPS_LATITUDE: null
                    N_GPS_LONGITUDE: null
                    N_UCP_ID: null
                    N_US_ID: null
                    N_UA_ID: null
                    N_CACHE_NAME: adipisci
                    N_CACHE_LAST_WS_ID: null
                    N_DELETED: null
                    params:
                      -
                        ID: 301407050
                        NODE_ID: 1793156
                        NI_NPI_ID: 0
                        PAR_NAME: SERVICE_STATE
                        PAR_INDEX: 0
                        VALUE: null
                        CONTENT: null
                        TEXT_CONTENT: null
                    customer_service_devices:
                      -
                        NS_ID: 2150075
                        NS_N_ID: 1793156
                        NS_U_ID: 1038
                        NS_SA_ID: null
                        NS_TIME: '2026-01-28 06:01:42'
                        NS_L_ID: 1
                        NS_NEEDS_UPDATE: 0
                    interfaces:
                      -
                        NPI_ID: 3314513
                        NPI_N_ID: 1793156
                        NPI_TYPE: 4111
                        NPI_NAME: ethw
                        NPI_L_ID: 12
                        NPI_CREATED: '2026-02-18 15:01:24'
                        NPI_CHANGED: null
                        NPI_NOTE: ''
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1793156
                        description: 'Unique device identifier (primary key, zero-filled to 6 digits).'
                      NAME:
                        type: string
                        example: DEV-ngzmiy
                        description: 'Device name (up to 30 characters).'
                      NOTE:
                        type: string
                        example: 'Nihil accusantium harum mollitia modi deserunt.'
                        description: 'Free-text note.'
                        nullable: true
                      MANAGED:
                        type: integer
                        example: 0
                        description: 'Flag indicating the device is managed (configured) by the Mango system. 1 = managed.'
                      MANAG_IP:
                        type: string
                        example: null
                        description: 'Management IP address of the device.'
                        nullable: true
                      PARENT_NODE:
                        type: string
                        example: null
                        description: 'ID of the parent device in the network topology. See GET /v3/devices/{id}.'
                        nullable: true
                      F_TYPE:
                        type: string
                        example: OLT
                        description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                        nullable: true
                      N_TYPE:
                        type: string
                        example: CISCO
                        description: 'Device class / node type (e.g. LINUX, MIKROTIK, SWITCH, ONT, WIFI, CISCO, DOCSIS, …). Defines the parameter schema available for the device.'
                      N_DEVICE_TYPE:
                        type: string
                        example: router
                        description: "Specific device model or hardware type (e.g. 'MikroTik RB750', 'UBNT NanoStation', …)."
                      N_CUSTOMER:
                        type: integer
                        example: 0
                        description: 'Customer device flag. 1 = end-user device (CPE), 0 = infrastructure device.'
                      USER_SERVICE_ID:
                        type: integer
                        example: 0
                        description: 'ID of the associated customer service. See GET /v3/customer-services/{id}.'
                        nullable: true
                      CUSTOMER_PARENT:
                        type: integer
                        example: 0
                        description: 'Flag indicating this infrastructure device can host customer (end-user) devices. 1 = open for customer connections.'
                      CUSTOMER_TYPE:
                        type: string
                        example: null
                        description: 'Customer device sub-type (only relevant when N_CUSTOMER=1). E.g. LINUX, NIC, WIFI, DECODER, DS_MODEM, SIP_DEVICE, CIBSROUTER, etc.'
                        nullable: true
                      CUSTOMER_LOCATION:
                        type: integer
                        example: 0
                        description: 'Deprecated. Former customer location reference (now handled via nodes_cust_locations).'
                        nullable: true
                      MAC:
                        type: string
                        example: null
                        description: 'MAC address of the device.'
                        nullable: true
                      UPDATE_FLAG:
                        type: integer
                        example: 0
                        description: 'Flag indicating the device configuration needs to be pushed/updated. 1 = update pending.'
                      AGR_GROUP:
                        type: string
                        example: null
                        description: 'Deprecated. Former aggregation group reference.'
                        nullable: true
                      STREET:
                        type: string
                        example: null
                        description: 'Street name of the device location.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: null
                        description: 'House number (číslo popisné) of the device location.'
                        nullable: true
                      N_ZIP:
                        type: string
                        example: null
                        description: 'ZIP / postal code (up to 5 characters).'
                        nullable: true
                      N_CITY:
                        type: string
                        example: null
                        description: 'City of the device location.'
                        nullable: true
                      SOCKET:
                        type: string
                        example: null
                        description: 'Socket / apartment identifier at the device location.'
                        nullable: true
                      N_COUNTER_ID:
                        type: string
                        example: '000000'
                        description: 'Deprecated. Former counter ID (now stored as a device parameter).'
                        nullable: true
                      N_PRODUCER:
                        type: string
                        example: null
                        description: 'Device manufacturer / producer.'
                        nullable: true
                      N_SERIAL_NUM:
                        type: string
                        example: null
                        description: 'Serial number of the device.'
                        nullable: true
                      N_LAST_RESPONSE:
                        type: string
                        example: null
                        description: 'Datetime of the last successful SNMP monitoring response.'
                        nullable: true
                      N_CT:
                        type: string
                        example: '007'
                        description: 'Location / installation CT ID (for customer devices when N_CUSTOMER=1).'
                      N_CREATED:
                        type: string
                        example: null
                        description: 'Datetime when the device record was created.'
                        nullable: true
                      N_L_ID:
                        type: string
                        example: '000592'
                        description: 'ID of the operator (login session) who last modified this device.'
                      N_GPS_LATITUDE:
                        type: string
                        example: null
                        description: 'GPS latitude of the device.'
                        nullable: true
                      N_GPS_LONGITUDE:
                        type: string
                        example: null
                        description: 'GPS longitude of the device.'
                        nullable: true
                      N_UCP_ID:
                        type: string
                        example: null
                        description: 'UIR registry city part ID.'
                        nullable: true
                      N_US_ID:
                        type: string
                        example: null
                        description: 'UIR registry street ID.'
                        nullable: true
                      N_UA_ID:
                        type: string
                        example: null
                        description: 'UIR registry address ID.'
                        nullable: true
                      N_CACHE_NAME:
                        type: string
                        example: adipisci
                        description: 'Cached display name combining class, type and device name for quick lookups.'
                      N_CACHE_LAST_WS_ID:
                        type: string
                        example: null
                        description: 'Cached ID of the last work session that touched this device.'
                        nullable: true
                      N_DELETED:
                        type: string
                        example: null
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            ID: 301407050
                            NODE_ID: 1793156
                            NI_NPI_ID: 0
                            PAR_NAME: SERVICE_STATE
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        description: 'Device parameters — collection of key-value pairs from the node_info table.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 301407050
                            NODE_ID:
                              type: integer
                              example: 1793156
                            NI_NPI_ID:
                              type: integer
                              example: 0
                            PAR_NAME:
                              type: string
                              example: SERVICE_STATE
                            PAR_INDEX:
                              type: integer
                              example: 0
                            VALUE:
                              type: string
                              example: null
                              nullable: true
                            CONTENT:
                              type: string
                              example: null
                              nullable: true
                            TEXT_CONTENT:
                              type: string
                              example: null
                              nullable: true
                      customer_service_devices:
                        type: array
                        example:
                          -
                            NS_ID: 2150075
                            NS_N_ID: 1793156
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-01-28 06:01:42'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        description: 'Services bound to this device — collection of customer-service-device bindings from the nodes_services table.'
                        items:
                          type: object
                          properties:
                            NS_ID:
                              type: integer
                              example: 2150075
                            NS_N_ID:
                              type: integer
                              example: 1793156
                            NS_U_ID:
                              type: integer
                              example: 1038
                            NS_SA_ID:
                              type: string
                              example: null
                              nullable: true
                            NS_TIME:
                              type: string
                              example: '2026-01-28 06:01:42'
                            NS_L_ID:
                              type: integer
                              example: 1
                            NS_NEEDS_UPDATE:
                              type: integer
                              example: 0
                      interfaces:
                        type: array
                        example:
                          -
                            NPI_ID: 3314513
                            NPI_N_ID: 1793156
                            NPI_TYPE: 4111
                            NPI_NAME: ethw
                            NPI_L_ID: 12
                            NPI_CREATED: '2026-02-18 15:01:24'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                        description: 'Physical network interfaces — collection of interface records from the nodes_physical_interfaces table.'
                        items:
                          type: object
                          properties:
                            NPI_ID:
                              type: integer
                              example: 3314513
                            NPI_N_ID:
                              type: integer
                              example: 1793156
                            NPI_TYPE:
                              type: integer
                              example: 4111
                            NPI_NAME:
                              type: string
                              example: ethw
                            NPI_L_ID:
                              type: integer
                              example: 12
                            NPI_CREATED:
                              type: string
                              example: '2026-02-18 15:01:24'
                            NPI_CHANGED:
                              type: string
                              example: null
                              nullable: true
                            NPI_NOTE:
                              type: string
                              example: ''
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
                      - interfaces
      tags:
        - Devices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                customer:
                  type: integer
                  description: 'Device kind: 0=infrastructure, 1=customer (CPE)'
                  example: 1
                type:
                  type: string
                  description: 'Node type (NIC, DSL_MODEM, NG_MODEM, ONT, AP, SWITCH, etc.)'
                  example: AP
                device_type:
                  type: string
                  description: 'Specific device type'
                  example: 'MikroTik RB750'
                name:
                  type: string
                  description: 'Device name'
                  example: 'AP Roof'
                interface:
                  type: string
                  description: 'Interface name'
                  example: eth0
                parent_node:
                  type: integer
                  description: 'Parent node ID'
                  example: 100
                parent_interface:
                  type: integer
                  description: 'Parent interface ID'
                  example: 16
                premise_id:
                  type: integer
                  description: 'Premise ID'
                  example: 16
                serial_num:
                  type: string
                  description: 'Serial number'
                  example: SN123456
                ct:
                  type: integer
                  description: 'Location/installation ID (for customer devices)'
                  example: 5
                user_id:
                  type: integer
                  description: 'Customer ID to bind'
                  example: 16
                services:
                  type: array
                  description: 'Service IDs to bind (array of SA_IDs)'
                  example:
                    - 16
                  items:
                    type: integer
                street:
                  type: string
                  description: 'Street address'
                  example: 'Main Street'
                house_id:
                  type: string
                  description: 'House number'
                  example: 12A
                zip:
                  type: string
                  description: 'ZIP code'
                  example: '56001'
                city:
                  type: string
                  description: City
                  example: Prague
                socket:
                  type: string
                  description: 'Socket identifier'
                  example: architecto
                note:
                  type: string
                  description: Notes
                  example: architecto
                gps_latitude:
                  type: number
                  description: 'GPS latitude'
                  example: 49.8175
                gps_longitude:
                  type: number
                  description: 'GPS longitude'
                  example: 15.473
                params:
                  type: array
                  description: 'Parameters as array of {name, value}'
                  example:
                    - []
                  items:
                    type: object
                ucp_id:
                  type: integer
                  description: 'UIR city part ID'
                  example: 16
                us_id:
                  type: integer
                  description: 'UIR street ID'
                  example: 16
                ua_id:
                  type: integer
                  description: 'UIR address ID'
                  example: 16
              required:
                - customer
                - type
                - device_type
                - name
  '/api/v3/devices/{id}':
    get:
      summary: 'Get Device'
      operationId: getDevice
      description: '   Retrieve a specific device by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1793157
                    NAME: DEV-uwpwlv
                    NOTE: 'Odit et et modi.'
                    MANAGED: 0
                    MANAG_IP: null
                    PARENT_NODE: null
                    F_TYPE: OLT
                    N_TYPE: CISCO
                    N_DEVICE_TYPE: switch
                    N_CUSTOMER: 1
                    USER_SERVICE_ID: 0
                    CUSTOMER_PARENT: 0
                    CUSTOMER_TYPE: null
                    CUSTOMER_LOCATION: 0
                    MAC: null
                    UPDATE_FLAG: 0
                    AGR_GROUP: null
                    STREET: null
                    HOUSE_ID: null
                    N_ZIP: null
                    N_CITY: null
                    SOCKET: null
                    N_COUNTER_ID: '000000'
                    N_PRODUCER: null
                    N_SERIAL_NUM: null
                    N_LAST_RESPONSE: null
                    N_CT: '085'
                    N_CREATED: null
                    N_L_ID: '000607'
                    N_GPS_LATITUDE: null
                    N_GPS_LONGITUDE: null
                    N_UCP_ID: null
                    N_US_ID: null
                    N_UA_ID: null
                    N_CACHE_NAME: enim
                    N_CACHE_LAST_WS_ID: null
                    N_DELETED: null
                    params:
                      -
                        ID: 301407051
                        NODE_ID: 1793157
                        NI_NPI_ID: 0
                        PAR_NAME: SERVICE_STATE
                        PAR_INDEX: 0
                        VALUE: ex
                        CONTENT: null
                        TEXT_CONTENT: null
                    customer_service_devices:
                      -
                        NS_ID: 2150076
                        NS_N_ID: 1793157
                        NS_U_ID: 1038
                        NS_SA_ID: null
                        NS_TIME: '2026-01-05 00:57:07'
                        NS_L_ID: 1
                        NS_NEEDS_UPDATE: 0
                    interfaces:
                      -
                        NPI_ID: 3314514
                        NPI_N_ID: 1793157
                        NPI_TYPE: 5
                        NPI_NAME: ethv
                        NPI_L_ID: 130
                        NPI_CREATED: '2026-02-24 07:38:03'
                        NPI_CHANGED: null
                        NPI_NOTE: ''
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1793157
                        description: 'Unique device identifier (primary key, zero-filled to 6 digits).'
                      NAME:
                        type: string
                        example: DEV-uwpwlv
                        description: 'Device name (up to 30 characters).'
                      NOTE:
                        type: string
                        example: 'Odit et et modi.'
                        description: 'Free-text note.'
                        nullable: true
                      MANAGED:
                        type: integer
                        example: 0
                        description: 'Flag indicating the device is managed (configured) by the Mango system. 1 = managed.'
                      MANAG_IP:
                        type: string
                        example: null
                        description: 'Management IP address of the device.'
                        nullable: true
                      PARENT_NODE:
                        type: string
                        example: null
                        description: 'ID of the parent device in the network topology. See GET /v3/devices/{id}.'
                        nullable: true
                      F_TYPE:
                        type: string
                        example: OLT
                        description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                        nullable: true
                      N_TYPE:
                        type: string
                        example: CISCO
                        description: 'Device class / node type (e.g. LINUX, MIKROTIK, SWITCH, ONT, WIFI, CISCO, DOCSIS, …). Defines the parameter schema available for the device.'
                      N_DEVICE_TYPE:
                        type: string
                        example: switch
                        description: "Specific device model or hardware type (e.g. 'MikroTik RB750', 'UBNT NanoStation', …)."
                      N_CUSTOMER:
                        type: integer
                        example: 1
                        description: 'Customer device flag. 1 = end-user device (CPE), 0 = infrastructure device.'
                      USER_SERVICE_ID:
                        type: integer
                        example: 0
                        description: 'ID of the associated customer service. See GET /v3/customer-services/{id}.'
                        nullable: true
                      CUSTOMER_PARENT:
                        type: integer
                        example: 0
                        description: 'Flag indicating this infrastructure device can host customer (end-user) devices. 1 = open for customer connections.'
                      CUSTOMER_TYPE:
                        type: string
                        example: null
                        description: 'Customer device sub-type (only relevant when N_CUSTOMER=1). E.g. LINUX, NIC, WIFI, DECODER, DS_MODEM, SIP_DEVICE, CIBSROUTER, etc.'
                        nullable: true
                      CUSTOMER_LOCATION:
                        type: integer
                        example: 0
                        description: 'Deprecated. Former customer location reference (now handled via nodes_cust_locations).'
                        nullable: true
                      MAC:
                        type: string
                        example: null
                        description: 'MAC address of the device.'
                        nullable: true
                      UPDATE_FLAG:
                        type: integer
                        example: 0
                        description: 'Flag indicating the device configuration needs to be pushed/updated. 1 = update pending.'
                      AGR_GROUP:
                        type: string
                        example: null
                        description: 'Deprecated. Former aggregation group reference.'
                        nullable: true
                      STREET:
                        type: string
                        example: null
                        description: 'Street name of the device location.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: null
                        description: 'House number (číslo popisné) of the device location.'
                        nullable: true
                      N_ZIP:
                        type: string
                        example: null
                        description: 'ZIP / postal code (up to 5 characters).'
                        nullable: true
                      N_CITY:
                        type: string
                        example: null
                        description: 'City of the device location.'
                        nullable: true
                      SOCKET:
                        type: string
                        example: null
                        description: 'Socket / apartment identifier at the device location.'
                        nullable: true
                      N_COUNTER_ID:
                        type: string
                        example: '000000'
                        description: 'Deprecated. Former counter ID (now stored as a device parameter).'
                        nullable: true
                      N_PRODUCER:
                        type: string
                        example: null
                        description: 'Device manufacturer / producer.'
                        nullable: true
                      N_SERIAL_NUM:
                        type: string
                        example: null
                        description: 'Serial number of the device.'
                        nullable: true
                      N_LAST_RESPONSE:
                        type: string
                        example: null
                        description: 'Datetime of the last successful SNMP monitoring response.'
                        nullable: true
                      N_CT:
                        type: string
                        example: '085'
                        description: 'Location / installation CT ID (for customer devices when N_CUSTOMER=1).'
                      N_CREATED:
                        type: string
                        example: null
                        description: 'Datetime when the device record was created.'
                        nullable: true
                      N_L_ID:
                        type: string
                        example: '000607'
                        description: 'ID of the operator (login session) who last modified this device.'
                      N_GPS_LATITUDE:
                        type: string
                        example: null
                        description: 'GPS latitude of the device.'
                        nullable: true
                      N_GPS_LONGITUDE:
                        type: string
                        example: null
                        description: 'GPS longitude of the device.'
                        nullable: true
                      N_UCP_ID:
                        type: string
                        example: null
                        description: 'UIR registry city part ID.'
                        nullable: true
                      N_US_ID:
                        type: string
                        example: null
                        description: 'UIR registry street ID.'
                        nullable: true
                      N_UA_ID:
                        type: string
                        example: null
                        description: 'UIR registry address ID.'
                        nullable: true
                      N_CACHE_NAME:
                        type: string
                        example: enim
                        description: 'Cached display name combining class, type and device name for quick lookups.'
                      N_CACHE_LAST_WS_ID:
                        type: string
                        example: null
                        description: 'Cached ID of the last work session that touched this device.'
                        nullable: true
                      N_DELETED:
                        type: string
                        example: null
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            ID: 301407051
                            NODE_ID: 1793157
                            NI_NPI_ID: 0
                            PAR_NAME: SERVICE_STATE
                            PAR_INDEX: 0
                            VALUE: ex
                            CONTENT: null
                            TEXT_CONTENT: null
                        description: 'Device parameters — collection of key-value pairs from the node_info table.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 301407051
                            NODE_ID:
                              type: integer
                              example: 1793157
                            NI_NPI_ID:
                              type: integer
                              example: 0
                            PAR_NAME:
                              type: string
                              example: SERVICE_STATE
                            PAR_INDEX:
                              type: integer
                              example: 0
                            VALUE:
                              type: string
                              example: ex
                            CONTENT:
                              type: string
                              example: null
                              nullable: true
                            TEXT_CONTENT:
                              type: string
                              example: null
                              nullable: true
                      customer_service_devices:
                        type: array
                        example:
                          -
                            NS_ID: 2150076
                            NS_N_ID: 1793157
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-01-05 00:57:07'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        description: 'Services bound to this device — collection of customer-service-device bindings from the nodes_services table.'
                        items:
                          type: object
                          properties:
                            NS_ID:
                              type: integer
                              example: 2150076
                            NS_N_ID:
                              type: integer
                              example: 1793157
                            NS_U_ID:
                              type: integer
                              example: 1038
                            NS_SA_ID:
                              type: string
                              example: null
                              nullable: true
                            NS_TIME:
                              type: string
                              example: '2026-01-05 00:57:07'
                            NS_L_ID:
                              type: integer
                              example: 1
                            NS_NEEDS_UPDATE:
                              type: integer
                              example: 0
                      interfaces:
                        type: array
                        example:
                          -
                            NPI_ID: 3314514
                            NPI_N_ID: 1793157
                            NPI_TYPE: 5
                            NPI_NAME: ethv
                            NPI_L_ID: 130
                            NPI_CREATED: '2026-02-24 07:38:03'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                        description: 'Physical network interfaces — collection of interface records from the nodes_physical_interfaces table.'
                        items:
                          type: object
                          properties:
                            NPI_ID:
                              type: integer
                              example: 3314514
                            NPI_N_ID:
                              type: integer
                              example: 1793157
                            NPI_TYPE:
                              type: integer
                              example: 5
                            NPI_NAME:
                              type: string
                              example: ethv
                            NPI_L_ID:
                              type: integer
                              example: 130
                            NPI_CREATED:
                              type: string
                              example: '2026-02-24 07:38:03'
                            NPI_CHANGED:
                              type: string
                              example: null
                              nullable: true
                            NPI_NOTE:
                              type: string
                              example: ''
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
                      - interfaces
      tags:
        - Devices
    put:
      summary: 'Update Device'
      operationId: updateDevice
      description: '   Update an existing device.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1793158
                    NAME: DEV-vdljni
                    NOTE: null
                    MANAGED: 1
                    MANAG_IP: 41.168.31.124
                    PARENT_NODE: null
                    F_TYPE: AP
                    N_TYPE: CISCO
                    N_DEVICE_TYPE: router
                    N_CUSTOMER: 0
                    USER_SERVICE_ID: 0
                    CUSTOMER_PARENT: 0
                    CUSTOMER_TYPE: null
                    CUSTOMER_LOCATION: 0
                    MAC: null
                    UPDATE_FLAG: 0
                    AGR_GROUP: null
                    STREET: null
                    HOUSE_ID: null
                    N_ZIP: null
                    N_CITY: null
                    SOCKET: null
                    N_COUNTER_ID: '000000'
                    N_PRODUCER: null
                    N_SERIAL_NUM: null
                    N_LAST_RESPONSE: null
                    N_CT: '007'
                    N_CREATED: null
                    N_L_ID: '000751'
                    N_GPS_LATITUDE: null
                    N_GPS_LONGITUDE: null
                    N_UCP_ID: null
                    N_US_ID: null
                    N_UA_ID: null
                    N_CACHE_NAME: quidem
                    N_CACHE_LAST_WS_ID: null
                    N_DELETED: null
                    params:
                      -
                        ID: 301407052
                        NODE_ID: 1793158
                        NI_NPI_ID: 0
                        PAR_NAME: DATA_COUNTER
                        PAR_INDEX: 0
                        VALUE: incidunt
                        CONTENT: null
                        TEXT_CONTENT: null
                    customer_service_devices:
                      -
                        NS_ID: 2150077
                        NS_N_ID: 1793158
                        NS_U_ID: 1038
                        NS_SA_ID: null
                        NS_TIME: '2026-01-03 00:16:14'
                        NS_L_ID: 1
                        NS_NEEDS_UPDATE: 0
                    interfaces:
                      -
                        NPI_ID: 3314515
                        NPI_N_ID: 1793158
                        NPI_TYPE: 7
                        NPI_NAME: eths
                        NPI_L_ID: 633
                        NPI_CREATED: '2026-01-17 21:31:16'
                        NPI_CHANGED: null
                        NPI_NOTE: ''
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1793158
                        description: 'Unique device identifier (primary key, zero-filled to 6 digits).'
                      NAME:
                        type: string
                        example: DEV-vdljni
                        description: 'Device name (up to 30 characters).'
                      NOTE:
                        type: string
                        example: null
                        description: 'Free-text note.'
                        nullable: true
                      MANAGED:
                        type: integer
                        example: 1
                        description: 'Flag indicating the device is managed (configured) by the Mango system. 1 = managed.'
                      MANAG_IP:
                        type: string
                        example: 41.168.31.124
                        description: 'Management IP address of the device.'
                        nullable: true
                      PARENT_NODE:
                        type: string
                        example: null
                        description: 'ID of the parent device in the network topology. See GET /v3/devices/{id}.'
                        nullable: true
                      F_TYPE:
                        type: string
                        example: AP
                        description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                        nullable: true
                      N_TYPE:
                        type: string
                        example: CISCO
                        description: 'Device class / node type (e.g. LINUX, MIKROTIK, SWITCH, ONT, WIFI, CISCO, DOCSIS, …). Defines the parameter schema available for the device.'
                      N_DEVICE_TYPE:
                        type: string
                        example: router
                        description: "Specific device model or hardware type (e.g. 'MikroTik RB750', 'UBNT NanoStation', …)."
                      N_CUSTOMER:
                        type: integer
                        example: 0
                        description: 'Customer device flag. 1 = end-user device (CPE), 0 = infrastructure device.'
                      USER_SERVICE_ID:
                        type: integer
                        example: 0
                        description: 'ID of the associated customer service. See GET /v3/customer-services/{id}.'
                        nullable: true
                      CUSTOMER_PARENT:
                        type: integer
                        example: 0
                        description: 'Flag indicating this infrastructure device can host customer (end-user) devices. 1 = open for customer connections.'
                      CUSTOMER_TYPE:
                        type: string
                        example: null
                        description: 'Customer device sub-type (only relevant when N_CUSTOMER=1). E.g. LINUX, NIC, WIFI, DECODER, DS_MODEM, SIP_DEVICE, CIBSROUTER, etc.'
                        nullable: true
                      CUSTOMER_LOCATION:
                        type: integer
                        example: 0
                        description: 'Deprecated. Former customer location reference (now handled via nodes_cust_locations).'
                        nullable: true
                      MAC:
                        type: string
                        example: null
                        description: 'MAC address of the device.'
                        nullable: true
                      UPDATE_FLAG:
                        type: integer
                        example: 0
                        description: 'Flag indicating the device configuration needs to be pushed/updated. 1 = update pending.'
                      AGR_GROUP:
                        type: string
                        example: null
                        description: 'Deprecated. Former aggregation group reference.'
                        nullable: true
                      STREET:
                        type: string
                        example: null
                        description: 'Street name of the device location.'
                        nullable: true
                      HOUSE_ID:
                        type: string
                        example: null
                        description: 'House number (číslo popisné) of the device location.'
                        nullable: true
                      N_ZIP:
                        type: string
                        example: null
                        description: 'ZIP / postal code (up to 5 characters).'
                        nullable: true
                      N_CITY:
                        type: string
                        example: null
                        description: 'City of the device location.'
                        nullable: true
                      SOCKET:
                        type: string
                        example: null
                        description: 'Socket / apartment identifier at the device location.'
                        nullable: true
                      N_COUNTER_ID:
                        type: string
                        example: '000000'
                        description: 'Deprecated. Former counter ID (now stored as a device parameter).'
                        nullable: true
                      N_PRODUCER:
                        type: string
                        example: null
                        description: 'Device manufacturer / producer.'
                        nullable: true
                      N_SERIAL_NUM:
                        type: string
                        example: null
                        description: 'Serial number of the device.'
                        nullable: true
                      N_LAST_RESPONSE:
                        type: string
                        example: null
                        description: 'Datetime of the last successful SNMP monitoring response.'
                        nullable: true
                      N_CT:
                        type: string
                        example: '007'
                        description: 'Location / installation CT ID (for customer devices when N_CUSTOMER=1).'
                      N_CREATED:
                        type: string
                        example: null
                        description: 'Datetime when the device record was created.'
                        nullable: true
                      N_L_ID:
                        type: string
                        example: '000751'
                        description: 'ID of the operator (login session) who last modified this device.'
                      N_GPS_LATITUDE:
                        type: string
                        example: null
                        description: 'GPS latitude of the device.'
                        nullable: true
                      N_GPS_LONGITUDE:
                        type: string
                        example: null
                        description: 'GPS longitude of the device.'
                        nullable: true
                      N_UCP_ID:
                        type: string
                        example: null
                        description: 'UIR registry city part ID.'
                        nullable: true
                      N_US_ID:
                        type: string
                        example: null
                        description: 'UIR registry street ID.'
                        nullable: true
                      N_UA_ID:
                        type: string
                        example: null
                        description: 'UIR registry address ID.'
                        nullable: true
                      N_CACHE_NAME:
                        type: string
                        example: quidem
                        description: 'Cached display name combining class, type and device name for quick lookups.'
                      N_CACHE_LAST_WS_ID:
                        type: string
                        example: null
                        description: 'Cached ID of the last work session that touched this device.'
                        nullable: true
                      N_DELETED:
                        type: string
                        example: null
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            ID: 301407052
                            NODE_ID: 1793158
                            NI_NPI_ID: 0
                            PAR_NAME: DATA_COUNTER
                            PAR_INDEX: 0
                            VALUE: incidunt
                            CONTENT: null
                            TEXT_CONTENT: null
                        description: 'Device parameters — collection of key-value pairs from the node_info table.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 301407052
                            NODE_ID:
                              type: integer
                              example: 1793158
                            NI_NPI_ID:
                              type: integer
                              example: 0
                            PAR_NAME:
                              type: string
                              example: DATA_COUNTER
                            PAR_INDEX:
                              type: integer
                              example: 0
                            VALUE:
                              type: string
                              example: incidunt
                            CONTENT:
                              type: string
                              example: null
                              nullable: true
                            TEXT_CONTENT:
                              type: string
                              example: null
                              nullable: true
                      customer_service_devices:
                        type: array
                        example:
                          -
                            NS_ID: 2150077
                            NS_N_ID: 1793158
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-01-03 00:16:14'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        description: 'Services bound to this device — collection of customer-service-device bindings from the nodes_services table.'
                        items:
                          type: object
                          properties:
                            NS_ID:
                              type: integer
                              example: 2150077
                            NS_N_ID:
                              type: integer
                              example: 1793158
                            NS_U_ID:
                              type: integer
                              example: 1038
                            NS_SA_ID:
                              type: string
                              example: null
                              nullable: true
                            NS_TIME:
                              type: string
                              example: '2026-01-03 00:16:14'
                            NS_L_ID:
                              type: integer
                              example: 1
                            NS_NEEDS_UPDATE:
                              type: integer
                              example: 0
                      interfaces:
                        type: array
                        example:
                          -
                            NPI_ID: 3314515
                            NPI_N_ID: 1793158
                            NPI_TYPE: 7
                            NPI_NAME: eths
                            NPI_L_ID: 633
                            NPI_CREATED: '2026-01-17 21:31:16'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                        description: 'Physical network interfaces — collection of interface records from the nodes_physical_interfaces table.'
                        items:
                          type: object
                          properties:
                            NPI_ID:
                              type: integer
                              example: 3314515
                            NPI_N_ID:
                              type: integer
                              example: 1793158
                            NPI_TYPE:
                              type: integer
                              example: 7
                            NPI_NAME:
                              type: string
                              example: eths
                            NPI_L_ID:
                              type: integer
                              example: 633
                            NPI_CREATED:
                              type: string
                              example: '2026-01-17 21:31:16'
                            NPI_CHANGED:
                              type: string
                              example: null
                              nullable: true
                            NPI_NOTE:
                              type: string
                              example: ''
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
                      - interfaces
      tags:
        - Devices
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                customer:
                  type: integer
                  description: 'Device kind: 0=infrastructure, 1=customer (CPE)'
                  example: 1
                device_type:
                  type: string
                  description: 'Specific device type'
                  example: 'MikroTik RB750'
                name:
                  type: string
                  description: 'Device name'
                  example: 'AP Roof'
                premise_id:
                  type: integer
                  description: 'Premise ID'
                  example: 16
                serial_num:
                  type: string
                  description: 'Serial number'
                  example: SN123456
                ct:
                  type: integer
                  description: 'Location/installation ID'
                  example: 5
                user_id:
                  type: integer
                  description: 'Customer ID to bind'
                  example: 16
                services:
                  type: array
                  description: 'Service IDs to bind (array of SA_IDs)'
                  example:
                    - 16
                  items:
                    type: integer
                street:
                  type: string
                  description: 'Street address'
                  example: 'Main Street'
                house_id:
                  type: string
                  description: 'House number'
                  example: 12A
                zip:
                  type: string
                  description: 'ZIP code'
                  example: '56001'
                city:
                  type: string
                  description: City
                  example: Prague
                socket:
                  type: string
                  description: 'Socket identifier'
                  example: architecto
                note:
                  type: string
                  description: Notes
                  example: architecto
                gps_latitude:
                  type: string
                  description: 'GPS latitude (string to allow NULL)'
                  example: '49.8175'
                gps_longitude:
                  type: string
                  description: 'GPS longitude (string to allow NULL)'
                  example: '15.473'
                params:
                  type: array
                  description: 'Parameters as array of {name, value}'
                  example:
                    - []
                  items:
                    type: object
                ucp_id:
                  type: integer
                  description: 'UIR city part ID'
                  example: 16
                us_id:
                  type: integer
                  description: 'UIR street ID'
                  example: 16
                ua_id:
                  type: integer
                  description: 'UIR address ID'
                  example: 16
    delete:
      summary: 'Delete Device'
      operationId: deleteDevice
      description: '   Delete a device (soft-delete).'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Devices
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the device.'
        example: 48
        required: true
        schema:
          type: integer
  '/api/v3/devices/{device}/children':
    get:
      summary: 'List Device Children'
      operationId: listDeviceChildren
      description: "   Retrieve child devices of the specified device.\n   Returns the same structure as the main device list endpoint."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated device IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated device IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Uses complex device CT logic.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default. Uses complex device CT logic.'
            example: '1,2,3'
        -
          in: query
          name: kind
          description: 'Filter by device type (N_TYPE)'
          example: AP
          required: false
          schema:
            type: string
            description: 'Filter by device type (N_TYPE)'
            example: AP
        -
          in: query
          name: parent_id
          description: 'Filter by parent device ID (devices connected under this parent)'
          example: '100'
          required: false
          schema:
            type: integer
            description: 'Filter by parent device ID (devices connected under this parent)'
            example: '100'
        -
          in: query
          name: child_id
          description: 'Filter by child device ID (returns the parent device above this child)'
          example: '200'
          required: false
          schema:
            type: integer
            description: 'Filter by child device ID (returns the parent device above this child)'
            example: '200'
        -
          in: query
          name: groups
          description: 'Filter by device group ID(s), comma-separated'
          example: '5,10'
          required: false
          schema:
            type: string
            description: 'Filter by device group ID(s), comma-separated'
            example: '5,10'
        -
          in: query
          name: service_ids
          description: 'Filter by service IDs (comma-separated), devices linked to these services'
          example: '1,2'
          required: false
          schema:
            type: string
            description: 'Filter by service IDs (comma-separated), devices linked to these services'
            example: '1,2'
        -
          in: query
          name: user_id
          description: 'Filter by customer ID, devices linked to this customer via nodes_services'
          example: '100'
          required: false
          schema:
            type: integer
            description: 'Filter by customer ID, devices linked to this customer via nodes_services'
            example: '100'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 1793159
                      NAME: DEV-qwrsit
                      NOTE: null
                      MANAGED: 1
                      MANAG_IP: null
                      PARENT_NODE: null
                      F_TYPE: SWITCH
                      N_TYPE: CISCO
                      N_DEVICE_TYPE: switch
                      N_CUSTOMER: 1
                      USER_SERVICE_ID: 0
                      CUSTOMER_PARENT: 0
                      CUSTOMER_TYPE: null
                      CUSTOMER_LOCATION: 0
                      MAC: null
                      UPDATE_FLAG: 0
                      AGR_GROUP: null
                      STREET: null
                      HOUSE_ID: null
                      N_ZIP: null
                      N_CITY: null
                      SOCKET: null
                      N_COUNTER_ID: '000000'
                      N_PRODUCER: null
                      N_SERIAL_NUM: null
                      N_LAST_RESPONSE: null
                      N_CT: '085'
                      N_CREATED: null
                      N_L_ID: '000185'
                      N_GPS_LATITUDE: null
                      N_GPS_LONGITUDE: null
                      N_UCP_ID: null
                      N_US_ID: null
                      N_UA_ID: null
                      N_CACHE_NAME: non
                      N_CACHE_LAST_WS_ID: null
                      N_DELETED: null
                      params:
                        -
                          ID: 301407053
                          NODE_ID: 1793159
                          NI_NPI_ID: 0
                          PAR_NAME: infra_loc
                          PAR_INDEX: 0
                          VALUE: voluptatem
                          CONTENT: null
                          TEXT_CONTENT: null
                      customer_service_devices:
                        -
                          NS_ID: 2150078
                          NS_N_ID: 1793159
                          NS_U_ID: 1038
                          NS_SA_ID: null
                          NS_TIME: '2026-04-14 01:57:18'
                          NS_L_ID: 1
                          NS_NEEDS_UPDATE: 0
                      interfaces:
                        -
                          NPI_ID: 3314516
                          NPI_N_ID: 1793159
                          NPI_TYPE: 4111
                          NPI_NAME: ethl
                          NPI_L_ID: 763
                          NPI_CREATED: '2026-03-01 14:14:55'
                          NPI_CHANGED: null
                          NPI_NOTE: ''
                    -
                      ID: 1793160
                      NAME: DEV-klqppw
                      NOTE: 'Veniam corporis dolorem mollitia.'
                      MANAGED: 1
                      MANAG_IP: 246.107.107.140
                      PARENT_NODE: null
                      F_TYPE: ONU
                      N_TYPE: MIKROTIK
                      N_DEVICE_TYPE: ap
                      N_CUSTOMER: 1
                      USER_SERVICE_ID: 0
                      CUSTOMER_PARENT: 0
                      CUSTOMER_TYPE: null
                      CUSTOMER_LOCATION: 0
                      MAC: null
                      UPDATE_FLAG: 0
                      AGR_GROUP: null
                      STREET: null
                      HOUSE_ID: null
                      N_ZIP: null
                      N_CITY: null
                      SOCKET: null
                      N_COUNTER_ID: '000000'
                      N_PRODUCER: null
                      N_SERIAL_NUM: null
                      N_LAST_RESPONSE: null
                      N_CT: '099'
                      N_CREATED: null
                      N_L_ID: '000737'
                      N_GPS_LATITUDE: null
                      N_GPS_LONGITUDE: null
                      N_UCP_ID: null
                      N_US_ID: null
                      N_UA_ID: null
                      N_CACHE_NAME: veritatis
                      N_CACHE_LAST_WS_ID: null
                      N_DELETED: null
                      params:
                        -
                          ID: 301407054
                          NODE_ID: 1793160
                          NI_NPI_ID: 0
                          PAR_NAME: infra_loc
                          PAR_INDEX: 0
                          VALUE: null
                          CONTENT: null
                          TEXT_CONTENT: null
                      customer_service_devices:
                        -
                          NS_ID: 2150079
                          NS_N_ID: 1793160
                          NS_U_ID: 1038
                          NS_SA_ID: null
                          NS_TIME: '2026-01-14 23:52:52'
                          NS_L_ID: 1
                          NS_NEEDS_UPDATE: 0
                      interfaces:
                        -
                          NPI_ID: 3314517
                          NPI_N_ID: 1793160
                          NPI_TYPE: 32
                          NPI_NAME: ethj
                          NPI_L_ID: 760
                          NPI_CREATED: '2026-02-26 18:59:57'
                          NPI_CHANGED: null
                          NPI_NOTE: ''
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 1793159
                        NAME: DEV-qwrsit
                        NOTE: null
                        MANAGED: 1
                        MANAG_IP: null
                        PARENT_NODE: null
                        F_TYPE: SWITCH
                        N_TYPE: CISCO
                        N_DEVICE_TYPE: switch
                        N_CUSTOMER: 1
                        USER_SERVICE_ID: 0
                        CUSTOMER_PARENT: 0
                        CUSTOMER_TYPE: null
                        CUSTOMER_LOCATION: 0
                        MAC: null
                        UPDATE_FLAG: 0
                        AGR_GROUP: null
                        STREET: null
                        HOUSE_ID: null
                        N_ZIP: null
                        N_CITY: null
                        SOCKET: null
                        N_COUNTER_ID: '000000'
                        N_PRODUCER: null
                        N_SERIAL_NUM: null
                        N_LAST_RESPONSE: null
                        N_CT: '085'
                        N_CREATED: null
                        N_L_ID: '000185'
                        N_GPS_LATITUDE: null
                        N_GPS_LONGITUDE: null
                        N_UCP_ID: null
                        N_US_ID: null
                        N_UA_ID: null
                        N_CACHE_NAME: non
                        N_CACHE_LAST_WS_ID: null
                        N_DELETED: null
                        params:
                          -
                            ID: 301407053
                            NODE_ID: 1793159
                            NI_NPI_ID: 0
                            PAR_NAME: infra_loc
                            PAR_INDEX: 0
                            VALUE: voluptatem
                            CONTENT: null
                            TEXT_CONTENT: null
                        customer_service_devices:
                          -
                            NS_ID: 2150078
                            NS_N_ID: 1793159
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-04-14 01:57:18'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        interfaces:
                          -
                            NPI_ID: 3314516
                            NPI_N_ID: 1793159
                            NPI_TYPE: 4111
                            NPI_NAME: ethl
                            NPI_L_ID: 763
                            NPI_CREATED: '2026-03-01 14:14:55'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                      -
                        ID: 1793160
                        NAME: DEV-klqppw
                        NOTE: 'Veniam corporis dolorem mollitia.'
                        MANAGED: 1
                        MANAG_IP: 246.107.107.140
                        PARENT_NODE: null
                        F_TYPE: ONU
                        N_TYPE: MIKROTIK
                        N_DEVICE_TYPE: ap
                        N_CUSTOMER: 1
                        USER_SERVICE_ID: 0
                        CUSTOMER_PARENT: 0
                        CUSTOMER_TYPE: null
                        CUSTOMER_LOCATION: 0
                        MAC: null
                        UPDATE_FLAG: 0
                        AGR_GROUP: null
                        STREET: null
                        HOUSE_ID: null
                        N_ZIP: null
                        N_CITY: null
                        SOCKET: null
                        N_COUNTER_ID: '000000'
                        N_PRODUCER: null
                        N_SERIAL_NUM: null
                        N_LAST_RESPONSE: null
                        N_CT: '099'
                        N_CREATED: null
                        N_L_ID: '000737'
                        N_GPS_LATITUDE: null
                        N_GPS_LONGITUDE: null
                        N_UCP_ID: null
                        N_US_ID: null
                        N_UA_ID: null
                        N_CACHE_NAME: veritatis
                        N_CACHE_LAST_WS_ID: null
                        N_DELETED: null
                        params:
                          -
                            ID: 301407054
                            NODE_ID: 1793160
                            NI_NPI_ID: 0
                            PAR_NAME: infra_loc
                            PAR_INDEX: 0
                            VALUE: null
                            CONTENT: null
                            TEXT_CONTENT: null
                        customer_service_devices:
                          -
                            NS_ID: 2150079
                            NS_N_ID: 1793160
                            NS_U_ID: 1038
                            NS_SA_ID: null
                            NS_TIME: '2026-01-14 23:52:52'
                            NS_L_ID: 1
                            NS_NEEDS_UPDATE: 0
                        interfaces:
                          -
                            NPI_ID: 3314517
                            NPI_N_ID: 1793160
                            NPI_TYPE: 32
                            NPI_NAME: ethj
                            NPI_L_ID: 760
                            NPI_CREATED: '2026-02-26 18:59:57'
                            NPI_CHANGED: null
                            NPI_NOTE: ''
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 1793159
                          description: 'Unique device identifier (primary key, zero-filled to 6 digits).'
                        NAME:
                          type: string
                          example: DEV-qwrsit
                          description: 'Device name (up to 30 characters).'
                        NOTE:
                          type: string
                          example: null
                          description: 'Free-text note.'
                          nullable: true
                        MANAGED:
                          type: integer
                          example: 1
                          description: 'Flag indicating the device is managed (configured) by the Mango system. 1 = managed.'
                        MANAG_IP:
                          type: string
                          example: null
                          description: 'Management IP address of the device.'
                          nullable: true
                        PARENT_NODE:
                          type: string
                          example: null
                          description: 'ID of the parent device in the network topology. See GET /v3/devices/{id}.'
                          nullable: true
                        F_TYPE:
                          type: string
                          example: SWITCH
                          description: 'Functional type. Possible values: AP, BRIDGE, IP, OLT, ONU, ROUTER, SIP, SWITCH.'
                          nullable: true
                        N_TYPE:
                          type: string
                          example: CISCO
                          description: 'Device class / node type (e.g. LINUX, MIKROTIK, SWITCH, ONT, WIFI, CISCO, DOCSIS, …). Defines the parameter schema available for the device.'
                        N_DEVICE_TYPE:
                          type: string
                          example: switch
                          description: "Specific device model or hardware type (e.g. 'MikroTik RB750', 'UBNT NanoStation', …)."
                        N_CUSTOMER:
                          type: integer
                          example: 1
                          description: 'Customer device flag. 1 = end-user device (CPE), 0 = infrastructure device.'
                        USER_SERVICE_ID:
                          type: integer
                          example: 0
                          description: 'ID of the associated customer service. See GET /v3/customer-services/{id}.'
                          nullable: true
                        CUSTOMER_PARENT:
                          type: integer
                          example: 0
                          description: 'Flag indicating this infrastructure device can host customer (end-user) devices. 1 = open for customer connections.'
                        CUSTOMER_TYPE:
                          type: string
                          example: null
                          description: 'Customer device sub-type (only relevant when N_CUSTOMER=1). E.g. LINUX, NIC, WIFI, DECODER, DS_MODEM, SIP_DEVICE, CIBSROUTER, etc.'
                          nullable: true
                        CUSTOMER_LOCATION:
                          type: integer
                          example: 0
                          description: 'Deprecated. Former customer location reference (now handled via nodes_cust_locations).'
                          nullable: true
                        MAC:
                          type: string
                          example: null
                          description: 'MAC address of the device.'
                          nullable: true
                        UPDATE_FLAG:
                          type: integer
                          example: 0
                          description: 'Flag indicating the device configuration needs to be pushed/updated. 1 = update pending.'
                        AGR_GROUP:
                          type: string
                          example: null
                          description: 'Deprecated. Former aggregation group reference.'
                          nullable: true
                        STREET:
                          type: string
                          example: null
                          description: 'Street name of the device location.'
                          nullable: true
                        HOUSE_ID:
                          type: string
                          example: null
                          description: 'House number (číslo popisné) of the device location.'
                          nullable: true
                        N_ZIP:
                          type: string
                          example: null
                          description: 'ZIP / postal code (up to 5 characters).'
                          nullable: true
                        N_CITY:
                          type: string
                          example: null
                          description: 'City of the device location.'
                          nullable: true
                        SOCKET:
                          type: string
                          example: null
                          description: 'Socket / apartment identifier at the device location.'
                          nullable: true
                        N_COUNTER_ID:
                          type: string
                          example: '000000'
                          description: 'Deprecated. Former counter ID (now stored as a device parameter).'
                          nullable: true
                        N_PRODUCER:
                          type: string
                          example: null
                          description: 'Device manufacturer / producer.'
                          nullable: true
                        N_SERIAL_NUM:
                          type: string
                          example: null
                          description: 'Serial number of the device.'
                          nullable: true
                        N_LAST_RESPONSE:
                          type: string
                          example: null
                          description: 'Datetime of the last successful SNMP monitoring response.'
                          nullable: true
                        N_CT:
                          type: string
                          example: '085'
                          description: 'Location / installation CT ID (for customer devices when N_CUSTOMER=1).'
                        N_CREATED:
                          type: string
                          example: null
                          description: 'Datetime when the device record was created.'
                          nullable: true
                        N_L_ID:
                          type: string
                          example: '000185'
                          description: 'ID of the operator (login session) who last modified this device.'
                        N_GPS_LATITUDE:
                          type: string
                          example: null
                          description: 'GPS latitude of the device.'
                          nullable: true
                        N_GPS_LONGITUDE:
                          type: string
                          example: null
                          description: 'GPS longitude of the device.'
                          nullable: true
                        N_UCP_ID:
                          type: string
                          example: null
                          description: 'UIR registry city part ID.'
                          nullable: true
                        N_US_ID:
                          type: string
                          example: null
                          description: 'UIR registry street ID.'
                          nullable: true
                        N_UA_ID:
                          type: string
                          example: null
                          description: 'UIR registry address ID.'
                          nullable: true
                        N_CACHE_NAME:
                          type: string
                          example: non
                          description: 'Cached display name combining class, type and device name for quick lookups.'
                        N_CACHE_LAST_WS_ID:
                          type: string
                          example: null
                          description: 'Cached ID of the last work session that touched this device.'
                          nullable: true
                        N_DELETED:
                          type: string
                          example: null
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              ID: 301407053
                              NODE_ID: 1793159
                              NI_NPI_ID: 0
                              PAR_NAME: infra_loc
                              PAR_INDEX: 0
                              VALUE: voluptatem
                              CONTENT: null
                              TEXT_CONTENT: null
                          description: 'Device parameters — collection of key-value pairs from the node_info table.'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 301407053
                              NODE_ID:
                                type: integer
                                example: 1793159
                              NI_NPI_ID:
                                type: integer
                                example: 0
                              PAR_NAME:
                                type: string
                                example: infra_loc
                              PAR_INDEX:
                                type: integer
                                example: 0
                              VALUE:
                                type: string
                                example: voluptatem
                              CONTENT:
                                type: string
                                example: null
                                nullable: true
                              TEXT_CONTENT:
                                type: string
                                example: null
                                nullable: true
                        customer_service_devices:
                          type: array
                          example:
                            -
                              NS_ID: 2150078
                              NS_N_ID: 1793159
                              NS_U_ID: 1038
                              NS_SA_ID: null
                              NS_TIME: '2026-04-14 01:57:18'
                              NS_L_ID: 1
                              NS_NEEDS_UPDATE: 0
                          description: 'Services bound to this device — collection of customer-service-device bindings from the nodes_services table.'
                          items:
                            type: object
                            properties:
                              NS_ID:
                                type: integer
                                example: 2150078
                              NS_N_ID:
                                type: integer
                                example: 1793159
                              NS_U_ID:
                                type: integer
                                example: 1038
                              NS_SA_ID:
                                type: string
                                example: null
                                nullable: true
                              NS_TIME:
                                type: string
                                example: '2026-04-14 01:57:18'
                              NS_L_ID:
                                type: integer
                                example: 1
                              NS_NEEDS_UPDATE:
                                type: integer
                                example: 0
                        interfaces:
                          type: array
                          example:
                            -
                              NPI_ID: 3314516
                              NPI_N_ID: 1793159
                              NPI_TYPE: 4111
                              NPI_NAME: ethl
                              NPI_L_ID: 763
                              NPI_CREATED: '2026-03-01 14:14:55'
                              NPI_CHANGED: null
                              NPI_NOTE: ''
                          description: 'Physical network interfaces — collection of interface records from the nodes_physical_interfaces table.'
                          items:
                            type: object
                            properties:
                              NPI_ID:
                                type: integer
                                example: 3314516
                              NPI_N_ID:
                                type: integer
                                example: 1793159
                              NPI_TYPE:
                                type: integer
                                example: 4111
                              NPI_NAME:
                                type: string
                                example: ethl
                              NPI_L_ID:
                                type: integer
                                example: 763
                              NPI_CREATED:
                                type: string
                                example: '2026-03-01 14:14:55'
                              NPI_CHANGED:
                                type: string
                                example: null
                                nullable: true
                              NPI_NOTE:
                                type: string
                                example: ''
                    required:
                      - ID
                      - NAME
                      - NOTE
                      - MANAGED
                      - MANAG_IP
                      - PARENT_NODE
                      - F_TYPE
                      - N_TYPE
                      - N_DEVICE_TYPE
                      - N_CUSTOMER
                      - USER_SERVICE_ID
                      - CUSTOMER_PARENT
                      - CUSTOMER_TYPE
                      - CUSTOMER_LOCATION
                      - MAC
                      - UPDATE_FLAG
                      - AGR_GROUP
                      - STREET
                      - HOUSE_ID
                      - N_ZIP
                      - N_CITY
                      - SOCKET
                      - N_COUNTER_ID
                      - N_PRODUCER
                      - N_SERIAL_NUM
                      - N_LAST_RESPONSE
                      - N_CT
                      - N_CREATED
                      - N_L_ID
                      - N_GPS_LATITUDE
                      - N_GPS_LONGITUDE
                      - N_UCP_ID
                      - N_US_ID
                      - N_UA_ID
                      - N_CACHE_NAME
                      - N_CACHE_LAST_WS_ID
                      - params
                      - customer_service_devices
                      - interfaces
      tags:
        - Devices
    parameters:
      -
        in: path
        name: device
        description: 'The device.'
        example: 48
        required: true
        schema:
          type: integer
  /api/v3/discount-definitions:
    get:
      summary: 'List Discount Definitions'
      operationId: listDiscountDefinitions
      description: "  Returns a paginated list of discount campaign definitions.\n  Filterable by type, service class, service, area, active status, and more."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page.'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated discount definition IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated discount definition IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: active_only
          description: 'When true, return only definitions whose validity has not expired (SD_VALID_TO is null or >= today).'
          example: true
          required: false
          schema:
            type: boolean
            description: 'When true, return only definitions whose validity has not expired (SD_VALID_TO is null or >= today).'
            example: true
        -
          in: query
          name: type
          description: 'Filter by discount type.'
          example: percentage
          required: false
          schema:
            type: string
            description: 'Filter by discount type.'
            example: percentage
        -
          in: query
          name: service_class
          description: 'Filter by service class ID (checks M:N pivot table).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by service class ID (checks M:N pivot table).'
            example: 1
        -
          in: query
          name: service
          description: 'Filter by service name ID (checks M:N pivot table).'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Filter by service name ID (checks M:N pivot table).'
            example: 10
        -
          in: query
          name: service_group
          description: 'Filter by service group definition ID (SD_SGD_ID).'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Filter by service group definition ID (SD_SGD_ID).'
            example: 5
        -
          in: query
          name: area
          description: 'Filter by address group / area ID (SD_GA_ID).'
          example: 3
          required: false
          schema:
            type: integer
            description: 'Filter by address group / area ID (SD_GA_ID).'
            example: 3
        -
          in: query
          name: applies_to_groups
          description: 'Filter by campaign mode. true = group campaigns only, false = standard campaigns only.'
          example: false
          required: false
          schema:
            type: boolean
            description: 'Filter by campaign mode. true = group campaigns only, false = standard campaigns only.'
            example: false
        -
          in: query
          name: search
          description: 'Search in discount name and note (partial match).'
          example: internet
          required: false
          schema:
            type: string
            description: 'Search in discount name and note (partial match).'
            example: internet
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      SD_ID: 1719
                      SD_NAME: 'aut adipisci quidem'
                      SD_GROUPS: none
                      SD_TYPE: info
                      SD_SC_ID: null
                      SD_SN_ID: null
                      SD_SNB_ID: null
                      SD_SND_IDS: null
                      SD_SGD_ID: null
                      SD_GA_ID: null
                      SD_VALUE: '42.5404'
                      SD_VARIABILITY: none
                      SD_CONDITION: null
                      SD_CONDITION_PERIOD: null
                      SD_TIME_LIMITED: null
                      SD_TRADING_LIMIT: null
                      SD_VALID_TO: null
                      SD_GROUP: null
                      SD_NOTE: null
                      SD_CREATED: '2026-03-22 08:52:51'
                      SD_L_ID: 709
                      SD_CT: 3
                      SD_START_DELAY: null
                      SD_CONDITION_END: pay_duly
                      SD_END_PENALTY: null
                      SD_CASH: null
                      SD_INVOICE: null
                      SD_PROFORMA: null
                      SD_START_RECREATE: 1
                      SD_BULK_TRANSFER: 0
                      SD_END_NOTIFY: null
                      SD_FORCED: null
                      SD_FLOATING: null
                      available_for_classes:
                        - 15
                      available_for_services:
                        - 28
                    -
                      SD_ID: 1720
                      SD_NAME: 'ipsum nostrum omnis'
                      SD_GROUPS: none
                      SD_TYPE: definite
                      SD_SC_ID: null
                      SD_SN_ID: null
                      SD_SNB_ID: null
                      SD_SND_IDS: null
                      SD_SGD_ID: null
                      SD_GA_ID: null
                      SD_VALUE: '76.5282'
                      SD_VARIABILITY: none
                      SD_CONDITION: null
                      SD_CONDITION_PERIOD: null
                      SD_TIME_LIMITED: null
                      SD_TRADING_LIMIT: null
                      SD_VALID_TO: null
                      SD_GROUP: null
                      SD_NOTE: null
                      SD_CREATED: '2026-04-16 17:00:40'
                      SD_L_ID: 94
                      SD_CT: 6
                      SD_START_DELAY: null
                      SD_CONDITION_END: pay_duly
                      SD_END_PENALTY: null
                      SD_CASH: null
                      SD_INVOICE: null
                      SD_PROFORMA: null
                      SD_START_RECREATE: 1
                      SD_BULK_TRANSFER: 0
                      SD_END_NOTIFY: null
                      SD_FORCED: null
                      SD_FLOATING: null
                      available_for_classes:
                        - 2
                      available_for_services:
                        - 25
                properties:
                  data:
                    type: array
                    example:
                      -
                        SD_ID: 1719
                        SD_NAME: 'aut adipisci quidem'
                        SD_GROUPS: none
                        SD_TYPE: info
                        SD_SC_ID: null
                        SD_SN_ID: null
                        SD_SNB_ID: null
                        SD_SND_IDS: null
                        SD_SGD_ID: null
                        SD_GA_ID: null
                        SD_VALUE: '42.5404'
                        SD_VARIABILITY: none
                        SD_CONDITION: null
                        SD_CONDITION_PERIOD: null
                        SD_TIME_LIMITED: null
                        SD_TRADING_LIMIT: null
                        SD_VALID_TO: null
                        SD_GROUP: null
                        SD_NOTE: null
                        SD_CREATED: '2026-03-22 08:52:51'
                        SD_L_ID: 709
                        SD_CT: 3
                        SD_START_DELAY: null
                        SD_CONDITION_END: pay_duly
                        SD_END_PENALTY: null
                        SD_CASH: null
                        SD_INVOICE: null
                        SD_PROFORMA: null
                        SD_START_RECREATE: 1
                        SD_BULK_TRANSFER: 0
                        SD_END_NOTIFY: null
                        SD_FORCED: null
                        SD_FLOATING: null
                        available_for_classes:
                          - 15
                        available_for_services:
                          - 28
                      -
                        SD_ID: 1720
                        SD_NAME: 'ipsum nostrum omnis'
                        SD_GROUPS: none
                        SD_TYPE: definite
                        SD_SC_ID: null
                        SD_SN_ID: null
                        SD_SNB_ID: null
                        SD_SND_IDS: null
                        SD_SGD_ID: null
                        SD_GA_ID: null
                        SD_VALUE: '76.5282'
                        SD_VARIABILITY: none
                        SD_CONDITION: null
                        SD_CONDITION_PERIOD: null
                        SD_TIME_LIMITED: null
                        SD_TRADING_LIMIT: null
                        SD_VALID_TO: null
                        SD_GROUP: null
                        SD_NOTE: null
                        SD_CREATED: '2026-04-16 17:00:40'
                        SD_L_ID: 94
                        SD_CT: 6
                        SD_START_DELAY: null
                        SD_CONDITION_END: pay_duly
                        SD_END_PENALTY: null
                        SD_CASH: null
                        SD_INVOICE: null
                        SD_PROFORMA: null
                        SD_START_RECREATE: 1
                        SD_BULK_TRANSFER: 0
                        SD_END_NOTIFY: null
                        SD_FORCED: null
                        SD_FLOATING: null
                        available_for_classes:
                          - 2
                        available_for_services:
                          - 25
                    items:
                      type: object
                      properties:
                        SD_ID:
                          type: integer
                          example: 1719
                          description: 'Unique discount definition identifier (primary key).'
                        SD_NAME:
                          type: string
                          example: 'aut adipisci quidem'
                          description: 'Campaign name.'
                        SD_GROUPS:
                          type: string
                          example: none
                          description: "Campaign mode. 'none' = standard, 'groups' = group campaign."
                          enum:
                            - none
                            - groups
                        SD_TYPE:
                          type: string
                          example: info
                          description: 'Discount type.'
                          enum:
                            - percentage
                            - definite
                            - info
                            - credit
                            - points
                        SD_SC_ID:
                          type: string
                          example: null
                          description: 'Legacy service class FK (prefer available_for_classes relation).'
                          nullable: true
                        SD_SN_ID:
                          type: string
                          example: null
                          description: 'Legacy service name FK (prefer available_for_services relation).'
                          nullable: true
                        SD_SNB_ID:
                          type: string
                          example: null
                          description: 'Base service ID for condition-based discounts (depending type).'
                          nullable: true
                        SD_SND_IDS:
                          type: string
                          example: null
                          description: 'Comma-separated dependent service IDs.'
                          nullable: true
                        SD_SGD_ID:
                          type: string
                          example: null
                          description: 'Service group definition ID.'
                          nullable: true
                        SD_GA_ID:
                          type: string
                          example: null
                          description: 'Address group (area) ID.'
                          nullable: true
                        SD_VALUE:
                          type: string
                          example: '42.5404'
                          description: 'Discount value (percentage or fixed amount depending on SD_TYPE). Decimal(12,4).'
                        SD_VARIABILITY:
                          type: string
                          example: none
                          description: 'Price variability.'
                          enum:
                            - none
                            - maximum
                            - minimum
                        SD_CONDITION:
                          type: string
                          example: null
                          description: 'Condition for granting the discount.'
                          nullable: true
                          enum:
                            - trading_limit
                            - motivation1
                            - pay_duly
                            - depending
                            - period
                        SD_CONDITION_PERIOD:
                          type: string
                          example: null
                          description: 'Condition period identifier.'
                          nullable: true
                        SD_TIME_LIMITED:
                          type: string
                          example: null
                          description: 'Duration limit in months.'
                          nullable: true
                        SD_TRADING_LIMIT:
                          type: string
                          example: null
                          description: 'Minimum contract commitment in months.'
                          nullable: true
                        SD_VALID_TO:
                          type: string
                          example: null
                          description: 'Campaign expiry date (YYYY-MM-DD). Null = no expiry.'
                          nullable: true
                        SD_GROUP:
                          type: string
                          example: null
                          description: 'Exclusivity group — discounts in the same group cannot be combined.'
                          nullable: true
                        SD_NOTE:
                          type: string
                          example: null
                          description: 'Free-text note.'
                          nullable: true
                        SD_CREATED:
                          type: string
                          example: '2026-03-22 08:52:51'
                          description: 'Creation timestamp (datetime).'
                        SD_L_ID:
                          type: integer
                          example: 709
                          description: 'Creator operator (login) ID.'
                        SD_CT:
                          type: integer
                          example: 3
                          description: 'Location (CT) ID. 0 = global (visible to all locations).'
                        SD_START_DELAY:
                          type: string
                          example: null
                          description: 'Start delay in months.'
                          nullable: true
                        SD_CONDITION_END:
                          type: string
                          example: pay_duly
                          description: 'Condition for ending the discount.'
                          nullable: true
                          enum:
                            - pay_duly
                        SD_END_PENALTY:
                          type: string
                          example: null
                          description: 'Penalty on early termination.'
                          nullable: true
                          enum:
                            - none
                            - service
                        SD_CASH:
                          type: string
                          example: null
                          description: 'Payment account ID.'
                          nullable: true
                        SD_INVOICE:
                          type: string
                          example: null
                          description: 'Show on invoices (1 = yes).'
                          nullable: true
                        SD_PROFORMA:
                          type: string
                          example: null
                          description: 'Show on proforma invoices (1 = yes).'
                          nullable: true
                        SD_START_RECREATE:
                          type: integer
                          example: 1
                          description: 'Auto-adjust start/end when service "Pay from" changes (1 = yes).'
                          nullable: true
                        SD_BULK_TRANSFER:
                          type: integer
                          example: 0
                          description: 'Allow bulk auto-activation on service changes (1 = yes).'
                          nullable: true
                        SD_END_NOTIFY:
                          type: string
                          example: null
                          description: 'Days before expiry to send notification.'
                          nullable: true
                        SD_FORCED:
                          type: string
                          example: null
                          description: 'Forced discount flag (1 = yes).'
                          nullable: true
                        SD_FLOATING:
                          type: string
                          example: null
                          description: 'Floating discount flag (1 = yes, end date follows contract period).'
                          nullable: true
                        available_for_classes:
                          type: array
                          example:
                            - 15
                          description: 'Service class IDs this campaign applies to (from M:N pivot).'
                          items:
                            type: integer
                        available_for_services:
                          type: array
                          example:
                            - 28
                          description: 'Service name IDs this campaign applies to (from M:N pivot).'
                          items:
                            type: integer
                    required:
                      - SD_ID
                      - SD_NAME
                      - SD_GROUPS
                      - SD_TYPE
                      - SD_SC_ID
                      - SD_SN_ID
                      - SD_SNB_ID
                      - SD_SND_IDS
                      - SD_SGD_ID
                      - SD_GA_ID
                      - SD_VALUE
                      - SD_VARIABILITY
                      - SD_CONDITION
                      - SD_CONDITION_PERIOD
                      - SD_TIME_LIMITED
                      - SD_TRADING_LIMIT
                      - SD_VALID_TO
                      - SD_GROUP
                      - SD_NOTE
                      - SD_CREATED
                      - SD_L_ID
                      - SD_CT
                      - SD_START_DELAY
                      - SD_CONDITION_END
                      - SD_END_PENALTY
                      - SD_CASH
                      - SD_INVOICE
                      - SD_PROFORMA
                      - SD_START_RECREATE
                      - SD_BULK_TRANSFER
                      - SD_END_NOTIFY
                      - SD_FORCED
                      - SD_FLOATING
                      - available_for_classes
                      - available_for_services
      tags:
        - 'Discount Definitions'
  '/api/v3/discount-definitions/{id}':
    get:
      summary: 'Get Discount Definition'
      operationId: getDiscountDefinition
      description: "  Returns a single discount campaign definition by ID.\n  Includes applied_to_services — active service IDs where this discount is currently assigned."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    SD_ID: 1721
                    SD_NAME: 'aut adipisci quidem'
                    SD_GROUPS: none
                    SD_TYPE: info
                    SD_SC_ID: null
                    SD_SN_ID: null
                    SD_SNB_ID: null
                    SD_SND_IDS: null
                    SD_SGD_ID: null
                    SD_GA_ID: null
                    SD_VALUE: '42.5404'
                    SD_VARIABILITY: none
                    SD_CONDITION: null
                    SD_CONDITION_PERIOD: null
                    SD_TIME_LIMITED: null
                    SD_TRADING_LIMIT: null
                    SD_VALID_TO: null
                    SD_GROUP: null
                    SD_NOTE: null
                    SD_CREATED: '2026-03-22 08:46:47'
                    SD_L_ID: 709
                    SD_CT: 3
                    SD_START_DELAY: null
                    SD_CONDITION_END: pay_duly
                    SD_END_PENALTY: null
                    SD_CASH: null
                    SD_INVOICE: null
                    SD_PROFORMA: null
                    SD_START_RECREATE: 1
                    SD_BULK_TRANSFER: 0
                    SD_END_NOTIFY: null
                    SD_FORCED: null
                    SD_FLOATING: null
                    available_for_classes:
                      - 15
                    available_for_services:
                      - 28
                    applied_to_services:
                      - 6877
                properties:
                  data:
                    type: object
                    properties:
                      SD_ID:
                        type: integer
                        example: 1721
                        description: 'Unique discount definition identifier (primary key).'
                      SD_NAME:
                        type: string
                        example: 'aut adipisci quidem'
                        description: 'Campaign name.'
                      SD_GROUPS:
                        type: string
                        example: none
                        description: "Campaign mode. 'none' = standard, 'groups' = group campaign."
                        enum:
                          - none
                          - groups
                      SD_TYPE:
                        type: string
                        example: info
                        description: 'Discount type.'
                        enum:
                          - percentage
                          - definite
                          - info
                          - credit
                          - points
                      SD_SC_ID:
                        type: string
                        example: null
                        description: 'Legacy service class FK (prefer available_for_classes relation).'
                        nullable: true
                      SD_SN_ID:
                        type: string
                        example: null
                        description: 'Legacy service name FK (prefer available_for_services relation).'
                        nullable: true
                      SD_SNB_ID:
                        type: string
                        example: null
                        description: 'Base service ID for condition-based discounts (depending type).'
                        nullable: true
                      SD_SND_IDS:
                        type: string
                        example: null
                        description: 'Comma-separated dependent service IDs.'
                        nullable: true
                      SD_SGD_ID:
                        type: string
                        example: null
                        description: 'Service group definition ID.'
                        nullable: true
                      SD_GA_ID:
                        type: string
                        example: null
                        description: 'Address group (area) ID.'
                        nullable: true
                      SD_VALUE:
                        type: string
                        example: '42.5404'
                        description: 'Discount value (percentage or fixed amount depending on SD_TYPE). Decimal(12,4).'
                      SD_VARIABILITY:
                        type: string
                        example: none
                        description: 'Price variability.'
                        enum:
                          - none
                          - maximum
                          - minimum
                      SD_CONDITION:
                        type: string
                        example: null
                        description: 'Condition for granting the discount.'
                        nullable: true
                        enum:
                          - trading_limit
                          - motivation1
                          - pay_duly
                          - depending
                          - period
                      SD_CONDITION_PERIOD:
                        type: string
                        example: null
                        description: 'Condition period identifier.'
                        nullable: true
                      SD_TIME_LIMITED:
                        type: string
                        example: null
                        description: 'Duration limit in months.'
                        nullable: true
                      SD_TRADING_LIMIT:
                        type: string
                        example: null
                        description: 'Minimum contract commitment in months.'
                        nullable: true
                      SD_VALID_TO:
                        type: string
                        example: null
                        description: 'Campaign expiry date (YYYY-MM-DD). Null = no expiry.'
                        nullable: true
                      SD_GROUP:
                        type: string
                        example: null
                        description: 'Exclusivity group — discounts in the same group cannot be combined.'
                        nullable: true
                      SD_NOTE:
                        type: string
                        example: null
                        description: 'Free-text note.'
                        nullable: true
                      SD_CREATED:
                        type: string
                        example: '2026-03-22 08:46:47'
                        description: 'Creation timestamp (datetime).'
                      SD_L_ID:
                        type: integer
                        example: 709
                        description: 'Creator operator (login) ID.'
                      SD_CT:
                        type: integer
                        example: 3
                        description: 'Location (CT) ID. 0 = global (visible to all locations).'
                      SD_START_DELAY:
                        type: string
                        example: null
                        description: 'Start delay in months.'
                        nullable: true
                      SD_CONDITION_END:
                        type: string
                        example: pay_duly
                        description: 'Condition for ending the discount.'
                        nullable: true
                        enum:
                          - pay_duly
                      SD_END_PENALTY:
                        type: string
                        example: null
                        description: 'Penalty on early termination.'
                        nullable: true
                        enum:
                          - none
                          - service
                      SD_CASH:
                        type: string
                        example: null
                        description: 'Payment account ID.'
                        nullable: true
                      SD_INVOICE:
                        type: string
                        example: null
                        description: 'Show on invoices (1 = yes).'
                        nullable: true
                      SD_PROFORMA:
                        type: string
                        example: null
                        description: 'Show on proforma invoices (1 = yes).'
                        nullable: true
                      SD_START_RECREATE:
                        type: integer
                        example: 1
                        description: 'Auto-adjust start/end when service "Pay from" changes (1 = yes).'
                        nullable: true
                      SD_BULK_TRANSFER:
                        type: integer
                        example: 0
                        description: 'Allow bulk auto-activation on service changes (1 = yes).'
                        nullable: true
                      SD_END_NOTIFY:
                        type: string
                        example: null
                        description: 'Days before expiry to send notification.'
                        nullable: true
                      SD_FORCED:
                        type: string
                        example: null
                        description: 'Forced discount flag (1 = yes).'
                        nullable: true
                      SD_FLOATING:
                        type: string
                        example: null
                        description: 'Floating discount flag (1 = yes, end date follows contract period).'
                        nullable: true
                      available_for_classes:
                        type: array
                        example:
                          - 15
                        description: 'Service class IDs this campaign applies to (from M:N pivot).'
                        items:
                          type: integer
                      available_for_services:
                        type: array
                        example:
                          - 28
                        description: 'Service name IDs this campaign applies to (from M:N pivot).'
                        items:
                          type: integer
                      applied_to_services:
                        type: array
                        example:
                          - 6877
                        description: 'Active service IDs where this discount is currently applied. Only included in detail (show) response.'
                        items:
                          type: integer
                    required:
                      - SD_ID
                      - SD_NAME
                      - SD_GROUPS
                      - SD_TYPE
                      - SD_SC_ID
                      - SD_SN_ID
                      - SD_SNB_ID
                      - SD_SND_IDS
                      - SD_SGD_ID
                      - SD_GA_ID
                      - SD_VALUE
                      - SD_VARIABILITY
                      - SD_CONDITION
                      - SD_CONDITION_PERIOD
                      - SD_TIME_LIMITED
                      - SD_TRADING_LIMIT
                      - SD_VALID_TO
                      - SD_GROUP
                      - SD_NOTE
                      - SD_CREATED
                      - SD_L_ID
                      - SD_CT
                      - SD_START_DELAY
                      - SD_CONDITION_END
                      - SD_END_PENALTY
                      - SD_CASH
                      - SD_INVOICE
                      - SD_PROFORMA
                      - SD_START_RECREATE
                      - SD_BULK_TRANSFER
                      - SD_END_NOTIFY
                      - SD_FORCED
                      - SD_FLOATING
                      - available_for_classes
                      - available_for_services
                      - applied_to_services
      tags:
        - 'Discount Definitions'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the discount definition.'
        example: 48
        required: true
        schema:
          type: integer
  /api/esbe/orders:
    post:
      summary: Orders
      operationId: orders
      description: "   This endpoint create an empty order.\n   The next step is to add products to the order."
      parameters:
        -
          in: query
          name: user_id
          description: 'ID of the user placing the order'
          example: 16
          required: true
          schema:
            type: integer
            description: 'ID of the user placing the order'
            example: 16
        -
          in: query
          name: transport_service_id
          description: 'ID of the transport service'
          example: 16
          required: false
          schema:
            type: integer
            description: 'ID of the transport service'
            example: 16
        -
          in: query
          name: billing_plan_id
          description: 'ID of the billing plan'
          example: 16
          required: false
          schema:
            type: integer
            description: 'ID of the billing plan'
            example: 16
        -
          in: query
          name: transport_premise_id
          description: 'ID of the transport premise'
          example: 16
          required: false
          schema:
            type: integer
            description: 'ID of the transport premise'
            example: 16
        -
          in: query
          name: order_date
          description: 'Date of the order'
          example: architecto
          required: false
          schema:
            type: date
            description: 'Date of the order'
            example: architecto
        -
          in: query
          name: note
          description: 'Optional note for the order'
          example: architecto
          required: false
          schema:
            type: string
            description: 'Optional note for the order'
            example: architecto
        -
          in: query
          name: delivery_date
          description: 'Date of the delivery'
          example: architecto
          required: false
          schema:
            type: date
            description: 'Date of the delivery'
            example: architecto
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  order_id: 'int Example: 12345'
                properties:
                  order_id:
                    type: string
                    example: 'int Example: 12345'
      tags:
        - Esbe
  '/api/esbe/orders/{order}/item':
    post:
      summary: 'Add Single Item'
      operationId: addSingleItem
      description: '   This endpoint adds a single item to an existing order.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  order_item_id: 'int Example: 67890'
                  personalized_product_id: 'int Example: 54321'
                properties:
                  order_item_id:
                    type: string
                    example: 'int Example: 67890'
                  personalized_product_id:
                    type: string
                    example: 'int Example: 54321'
      tags:
        - Esbe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: integer
                  description: "ID of the\n  user who owns the order."
                  example: 41994
                product_id:
                  type: integer
                  description: "The ID\n  of the product (SN_ID)."
                  example: 101
                quantity:
                  type: integer
                  description: "The\n  quantity of the product."
                  example: 2
                price:
                  type: numeric
                  description: "The total\n  price for the given quantity of this item."
                  example: 150.5
                price_wo_vat:
                  type: numeric
                  description: "The\n  total price without VAT."
                  example: 124.38
                parent_product_id:
                  type: integer
                  description: "The ID of the parent personalized product, if\n   this is a secondary item."
                  example: 9876
              required:
                - user_id
                - product_id
                - quantity
                - price
                - price_wo_vat
    put:
      summary: 'Update Single Item'
      operationId: updateSingleItem
      description: '   This endpoint update a single item in an existing order.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  personalized_product_id: 'int Example: 54321'
                properties:
                  personalized_product_id:
                    type: string
                    example: 'int Example: 54321'
      tags:
        - Esbe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: integer
                  description: "ID of the\n  user who owns the order."
                  example: 41994
                product_id:
                  type: integer
                  description: "The ID\n  of the product (SN_ID)."
                  example: 101
                quantity:
                  type: integer
                  description: "The\n  quantity of the product."
                  example: 2
                price:
                  type: numeric
                  description: "The total\n  price for the given quantity of this item."
                  example: 150.5
                price_wo_vat:
                  type: numeric
                  description: "The\n  total price without VAT."
                  example: 124.38
              required:
                - user_id
                - product_id
                - quantity
                - price
                - price_wo_vat
    delete:
      summary: 'Remove Single Item'
      operationId: removeSingleItem
      description: '   This endpoint removes a single item from an existing order.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: 'boolean Example: true'
                properties:
                  success:
                    type: string
                    example: 'boolean Example: true'
      tags:
        - Esbe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                product_id:
                  type: integer
                  description: 'The ID of the product/item to remove from the order.'
                  example: 12345
              required:
                - product_id
    parameters:
      -
        in: path
        name: order
        description: 'The order.'
        example: architecto
        required: true
        schema:
          type: string
  '/api/esbe/orders/{order}/realize':
    post:
      summary: 'Finalize Order'
      operationId: finalizeOrder
      description: "   This endpoint finalizes or \"realizes\" an order that has all its items.\n   This is the final step to make an order active."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: 'Order finalized successfully.'
                properties:
                  message:
                    type: string
                    example: 'Order finalized successfully.'
      tags:
        - Esbe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                delivery_date:
                  type: string
                  description: 'The planned delivery date for the order.'
                  example: '2025-09-10 00:00:00'
                recipient_person:
                  type: string
                  description: 'The name of the recipient.'
                  example: architecto
                recipient_phone:
                  type: string
                  description: 'The phone number of the recipient.'
                  example: architecto
                reference_number:
                  type: string
                  description: 'The reference number of the order.'
                  example: architecto
                recipient_city:
                  type: string
                  description: 'The city of the recipient.'
                  example: architecto
                recipient_zip:
                  type: string
                  description: 'The zip code of the recipient.'
                  example: architecto
                recipient_street:
                  type: string
                  description: 'The street of the recipient.'
                  example: architecto
                recipient_house_id:
                  type: string
                  description: 'The house ID of the recipient.'
                  example: architecto
                transport_premise_id:
                  type: integer
                  description: 'The ID of the transport premise.'
                  example: 16
                transport_service_id:
                  type: integer
                  description: 'The ID of the transport service.'
                  example: 16
                billing_plan_id:
                  type: integer
                  description: 'The ID of the billing plan.'
                  example: 16
                note:
                  type: string
                  description: 'An optional note for the realization.'
                  example: architecto
              required:
                - delivery_date
    parameters:
      -
        in: path
        name: order
        description: 'The order.'
        example: architecto
        required: true
        schema:
          type: string
  '/api/esbe/orders/{order}/generate-number':
    post:
      summary: 'Generate Order Number'
      operationId: generateOrderNumber
      description: "   This endpoint generates a unique order number for an existing order.\n   If the order already has a number, it returns the existing one."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: 'boolean Example: true'
                  order_number: 'int Example: 202409240001'
                  updated: 'boolean Example: true'
                properties:
                  success:
                    type: string
                    example: 'boolean Example: true'
                  order_number:
                    type: string
                    example: 'int Example: 202409240001'
                  updated:
                    type: string
                    example: 'boolean Example: true'
      tags:
        - Esbe
    parameters:
      -
        in: path
        name: order
        description: 'The order.'
        example: architecto
        required: true
        schema:
          type: string
  '/api/esbe/orders/{order}/user':
    patch:
      summary: 'Update Order User'
      operationId: updateOrderUser
      description: "   This endpoint updates the user assigned to an order and all its items.\n   It also updates associated personalized products and service data."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  success: 'boolean Example: true'
                  user_id: 'int Example: 12345'
                properties:
                  success:
                    type: string
                    example: 'boolean Example: true'
                  user_id:
                    type: string
                    example: 'int Example: 12345'
      tags:
        - Esbe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                user_id:
                  type: integer
                  description: 'The ID of the user to assign to the order.'
                  example: 12345
              required:
                - user_id
    parameters:
      -
        in: path
        name: order
        description: 'The order.'
        example: architecto
        required: true
        schema:
          type: string
  '/api/esbe/orders/{order}':
    delete:
      summary: 'Delete Order'
      operationId: deleteOrder
      description: '   This endpoint deletes an order. This should be used for cleanup if the ordering process fails.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Esbe
    parameters:
      -
        in: path
        name: order
        description: 'The order.'
        example: architecto
        required: true
        schema:
          type: string
  /api/esbe/send-email-using-template:
    post:
      summary: 'Send Email Using Template'
      operationId: sendEmailUsingTemplate
      description: "   This endpoint sends an email using a predefined template.\n   It processes the template with provided parameters and sends the email to the specified recipient."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  result: 'string Example: success'
                  eo_ids: 'string Example: 123,456'
                properties:
                  result:
                    type: string
                    example: 'string Example: success'
                  eo_ids:
                    type: string
                    example: 'string Example: 123,456'
      tags:
        - Esbe
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                from:
                  type: string
                  description: 'Email sender address'
                  example: sender@example.com
                to:
                  type: string
                  description: 'Email recipient address'
                  example: recipient@example.com
                ctype:
                  type: string
                  description: 'Content type'
                  example: architecto
                sched:
                  type: string
                  description: 'Schedule parameter'
                  example: architecto
                ct:
                  type: string
                  description: 'CT parameter'
                  example: architecto
                tt_name:
                  type: string
                  description: 'Template name'
                  example: order_confirmation
                params:
                  type: string
                  description: 'Template parameters'
                  example: architecto
                parsep:
                  type: string
                  description: 'Parameter separator'
                  example: architecto
                valsep:
                  type: string
                  description: 'Value separator'
                  example: architecto
              required:
                - to
                - tt_name
  /api/v3/internal-tax-documents:
    get:
      summary: 'List Internal Tax Documents'
      operationId: listInternalTaxDocuments
      description: "  Returns a paginated list of internal tax documents (billing prescriptions).\n  **At least one** of the following filters must be provided:\n  `customer`, `type`, `date_from`, `service`, `search`.\n  Without a narrowing filter the endpoint returns HTTP 422."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated document IDs.'
          example: '100,200,300'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated document IDs.'
            example: '100,200,300'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID.'
          example: 345
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID.'
            example: 345
        -
          in: query
          name: type
          description: 'Filter by document type. Accepts comma-separated values.'
          example: 'SERVICE,CREDIT_NOTE'
          required: false
          schema:
            type: string
            description: 'Filter by document type. Accepts comma-separated values.'
            example: 'SERVICE,CREDIT_NOTE'
        -
          in: query
          name: date_from
          description: 'Filter documents issued on or after this date (YYYY-MM-DD). Applies to TAX_DATE (DUZP).'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter documents issued on or after this date (YYYY-MM-DD). Applies to TAX_DATE (DUZP).'
            example: '2024-01-01'
        -
          in: query
          name: date_to
          description: 'Filter documents issued on or before this date (YYYY-MM-DD). Applies to TAX_DATE (DUZP).'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter documents issued on or before this date (YYYY-MM-DD). Applies to TAX_DATE (DUZP).'
            example: '2024-12-31'
        -
          in: query
          name: service
          description: 'Filter by service definition ID (ITD_SN_ID → services_name).'
          example: 19
          required: false
          schema:
            type: integer
            description: 'Filter by service definition ID (ITD_SN_ID → services_name).'
            example: 19
        -
          in: query
          name: service_class
          description: 'Filter by service class ID (requires JOIN to services_name → services_class).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by service class ID (requires JOIN to services_name → services_class).'
            example: 1
        -
          in: query
          name: billing_plan
          description: 'Filter by billing plan ID (via ITD_SAB_ID → services_active_billing.SAB_BP_ID).'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Filter by billing plan ID (via ITD_SAB_ID → services_active_billing.SAB_BP_ID).'
            example: 5
        -
          in: query
          name: search
          description: 'Search by document number (ID).'
          example: '100000'
          required: false
          schema:
            type: string
            description: 'Search by document number (ID).'
            example: '100000'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 0
                      ITD_ADVANCE_ID: 110
                      ITD_TYPE: NON_ATTACH
                      USER_ID: 4524
                      SRV_ID: 2617
                      'Y': 2025
                      MON: 4
                      ITD_DAY: null
                      ITD_Y_END: 2023
                      MON_END: null
                      ITD_DAY_END: null
                      PERIOD: month
                      PER: 0
                      TAX_DATE: null
                      ITD_MATURITY: null
                      PRICE: null
                      ITD_PRICE_VAT: null
                      ITD_PRICE_WO_VAT: null
                      ITD_PRICE_ROUND: null
                      ITD_FIX_PRICE: null
                      ITD_FIX_PRICE_VAT: null
                      ITD_FIX_PRICE_WO_VAT: null
                      ITD_VAR_PRICE: null
                      ITD_VAR_PRICE_VAT: null
                      ITD_VAR_PRICE_WO_VAT: null
                      ITD_TL_VALUE_PERCENT: null
                      ITD_SAB_ID: null
                      CT: 76
                      ITD_TAX_PRICE: null
                      ITD_TAX_PRICE_VAT: null
                      ITD_TAX_PRICE_WO_VAT: null
                      ITD_TAX_PRICE_ROUND: null
                      ITD_PRICE_PRIM: null
                      ITD_PRICE_PRIM_VAT: null
                      ITD_PRICE_PRIM_WO_VAT: null
                      ITD_SN_ID: 12
                      ITD_VAR_SYMBOL: null
                      ITD_INVOICING: null
                      ITD_VAS: null
                      ITD_REVERSE_CHARGE: null
                      detail: null
                      payment: null
                      note: null
                    -
                      ID: 0
                      ITD_ADVANCE_ID: 41
                      ITD_TYPE: NON_ATTACH
                      USER_ID: 1769
                      SRV_ID: 967
                      'Y': 2023
                      MON: 7
                      ITD_DAY: null
                      ITD_Y_END: 2022
                      MON_END: null
                      ITD_DAY_END: null
                      PERIOD: month
                      PER: 0
                      TAX_DATE: null
                      ITD_MATURITY: null
                      PRICE: null
                      ITD_PRICE_VAT: null
                      ITD_PRICE_WO_VAT: null
                      ITD_PRICE_ROUND: null
                      ITD_FIX_PRICE: null
                      ITD_FIX_PRICE_VAT: null
                      ITD_FIX_PRICE_WO_VAT: null
                      ITD_VAR_PRICE: null
                      ITD_VAR_PRICE_VAT: null
                      ITD_VAR_PRICE_WO_VAT: null
                      ITD_TL_VALUE_PERCENT: null
                      ITD_SAB_ID: null
                      CT: 38
                      ITD_TAX_PRICE: null
                      ITD_TAX_PRICE_VAT: null
                      ITD_TAX_PRICE_WO_VAT: null
                      ITD_TAX_PRICE_ROUND: null
                      ITD_PRICE_PRIM: null
                      ITD_PRICE_PRIM_VAT: null
                      ITD_PRICE_PRIM_WO_VAT: null
                      ITD_SN_ID: 383
                      ITD_VAR_SYMBOL: null
                      ITD_INVOICING: null
                      ITD_VAS: null
                      ITD_REVERSE_CHARGE: null
                      detail: null
                      payment: null
                      note: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 0
                        ITD_ADVANCE_ID: 110
                        ITD_TYPE: NON_ATTACH
                        USER_ID: 4524
                        SRV_ID: 2617
                        'Y': 2025
                        MON: 4
                        ITD_DAY: null
                        ITD_Y_END: 2023
                        MON_END: null
                        ITD_DAY_END: null
                        PERIOD: month
                        PER: 0
                        TAX_DATE: null
                        ITD_MATURITY: null
                        PRICE: null
                        ITD_PRICE_VAT: null
                        ITD_PRICE_WO_VAT: null
                        ITD_PRICE_ROUND: null
                        ITD_FIX_PRICE: null
                        ITD_FIX_PRICE_VAT: null
                        ITD_FIX_PRICE_WO_VAT: null
                        ITD_VAR_PRICE: null
                        ITD_VAR_PRICE_VAT: null
                        ITD_VAR_PRICE_WO_VAT: null
                        ITD_TL_VALUE_PERCENT: null
                        ITD_SAB_ID: null
                        CT: 76
                        ITD_TAX_PRICE: null
                        ITD_TAX_PRICE_VAT: null
                        ITD_TAX_PRICE_WO_VAT: null
                        ITD_TAX_PRICE_ROUND: null
                        ITD_PRICE_PRIM: null
                        ITD_PRICE_PRIM_VAT: null
                        ITD_PRICE_PRIM_WO_VAT: null
                        ITD_SN_ID: 12
                        ITD_VAR_SYMBOL: null
                        ITD_INVOICING: null
                        ITD_VAS: null
                        ITD_REVERSE_CHARGE: null
                        detail: null
                        payment: null
                        note: null
                      -
                        ID: 0
                        ITD_ADVANCE_ID: 41
                        ITD_TYPE: NON_ATTACH
                        USER_ID: 1769
                        SRV_ID: 967
                        'Y': 2023
                        MON: 7
                        ITD_DAY: null
                        ITD_Y_END: 2022
                        MON_END: null
                        ITD_DAY_END: null
                        PERIOD: month
                        PER: 0
                        TAX_DATE: null
                        ITD_MATURITY: null
                        PRICE: null
                        ITD_PRICE_VAT: null
                        ITD_PRICE_WO_VAT: null
                        ITD_PRICE_ROUND: null
                        ITD_FIX_PRICE: null
                        ITD_FIX_PRICE_VAT: null
                        ITD_FIX_PRICE_WO_VAT: null
                        ITD_VAR_PRICE: null
                        ITD_VAR_PRICE_VAT: null
                        ITD_VAR_PRICE_WO_VAT: null
                        ITD_TL_VALUE_PERCENT: null
                        ITD_SAB_ID: null
                        CT: 38
                        ITD_TAX_PRICE: null
                        ITD_TAX_PRICE_VAT: null
                        ITD_TAX_PRICE_WO_VAT: null
                        ITD_TAX_PRICE_ROUND: null
                        ITD_PRICE_PRIM: null
                        ITD_PRICE_PRIM_VAT: null
                        ITD_PRICE_PRIM_WO_VAT: null
                        ITD_SN_ID: 383
                        ITD_VAR_SYMBOL: null
                        ITD_INVOICING: null
                        ITD_VAS: null
                        ITD_REVERSE_CHARGE: null
                        detail: null
                        payment: null
                        note: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 0
                          description: 'Document number (primary key, part of composite PK with ITD_ADVANCE_ID).'
                        ITD_ADVANCE_ID:
                          type: integer
                          example: 110
                          description: 'Advance sequence number. 0 for base document (SERVICE), >0 for ADVANCE/CREDIT_NOTE sub-documents.'
                        ITD_TYPE:
                          type: string
                          example: NON_ATTACH
                          description: 'Document type.'
                          enum:
                            - SERVICE
                            - CREDIT_NOTE
                            - MANUAL
                            - ADVANCE
                            - NON_ATTACH
                        USER_ID:
                          type: integer
                          example: 4524
                          description: 'Customer ID. See GET /v3/customers/{id}.'
                        SRV_ID:
                          type: integer
                          example: 2617
                          description: 'Active service instance ID (services_active).'
                        'Y':
                          type: integer
                          example: 2025
                          description: 'Billing year.'
                        MON:
                          type: integer
                          example: 4
                          description: 'Billing month (1-12).'
                          nullable: true
                        ITD_DAY:
                          type: string
                          example: null
                          nullable: true
                        ITD_Y_END:
                          type: integer
                          example: 2023
                        MON_END:
                          type: string
                          example: null
                          nullable: true
                        ITD_DAY_END:
                          type: string
                          example: null
                          nullable: true
                        PERIOD:
                          type: string
                          example: month
                          description: 'Billing period type.'
                          enum:
                            - all
                            - chalfyear
                            - cquarter
                            - cyear
                            - month
                            - none
                            - vhalfyear
                            - vmonth
                            - vquarter
                            - vyear
                            - cyears2
                            - cyears3
                            - cmonths18
                            - vyears2
                            - vyears3
                            - vmonths18
                        PER:
                          type: integer
                          example: 0
                          description: 'Period sequence number.'
                        TAX_DATE:
                          type: string
                          example: null
                          description: 'Tax date / DUZP (YYYY-MM-DD).'
                          nullable: true
                        ITD_MATURITY:
                          type: string
                          example: null
                          description: 'Maturity date (YYYY-MM-DD).'
                          nullable: true
                        PRICE:
                          type: string
                          example: null
                          description: 'Total price including VAT (decimal, 4 places).'
                          nullable: true
                        ITD_PRICE_VAT:
                          type: string
                          example: null
                          description: 'VAT amount.'
                          nullable: true
                        ITD_PRICE_WO_VAT:
                          type: string
                          example: null
                          description: 'Price without VAT.'
                          nullable: true
                        ITD_PRICE_ROUND:
                          type: string
                          example: null
                          description: 'Rounding adjustment.'
                          nullable: true
                        ITD_FIX_PRICE:
                          type: string
                          example: null
                          description: 'Fixed price component including VAT.'
                          nullable: true
                        ITD_FIX_PRICE_VAT:
                          type: string
                          example: null
                          description: 'VAT of fixed component.'
                          nullable: true
                        ITD_FIX_PRICE_WO_VAT:
                          type: string
                          example: null
                          description: 'Fixed component without VAT.'
                          nullable: true
                        ITD_VAR_PRICE:
                          type: string
                          example: null
                          description: 'Variable price component including VAT (usage-based charges).'
                          nullable: true
                        ITD_VAR_PRICE_VAT:
                          type: string
                          example: null
                          description: 'VAT of variable component.'
                          nullable: true
                        ITD_VAR_PRICE_WO_VAT:
                          type: string
                          example: null
                          description: 'Variable component without VAT.'
                          nullable: true
                        ITD_TL_VALUE_PERCENT:
                          type: string
                          example: null
                          description: 'VAT rate in percent.'
                          nullable: true
                        ITD_SAB_ID:
                          type: string
                          example: null
                          description: 'Service billing configuration ID (services_active_billing).'
                          nullable: true
                        CT:
                          type: integer
                          example: 76
                          description: 'Location (installation) ID — multi-tenant discriminator.'
                        ITD_TAX_PRICE:
                          type: string
                          example: null
                          description: 'Actual tax levy amount including VAT.'
                          nullable: true
                        ITD_TAX_PRICE_VAT:
                          type: string
                          example: null
                          description: 'VAT of actual tax levy.'
                          nullable: true
                        ITD_TAX_PRICE_WO_VAT:
                          type: string
                          example: null
                          description: 'Actual tax levy without VAT.'
                          nullable: true
                        ITD_TAX_PRICE_ROUND:
                          type: string
                          example: null
                          description: 'Rounding adjustment of actual tax levy.'
                          nullable: true
                        ITD_PRICE_PRIM:
                          type: string
                          example: null
                          description: 'Original (primary) price including VAT.'
                          nullable: true
                        ITD_PRICE_PRIM_VAT:
                          type: string
                          example: null
                          description: 'Original price VAT.'
                          nullable: true
                        ITD_PRICE_PRIM_WO_VAT:
                          type: string
                          example: null
                          description: 'Original price without VAT.'
                          nullable: true
                        ITD_SN_ID:
                          type: integer
                          example: 12
                          description: 'Service definition ID (services_name).'
                          nullable: true
                        ITD_VAR_SYMBOL:
                          type: string
                          example: null
                          description: 'Variable symbol of the tax document (invoice) this document was invoiced into.'
                          nullable: true
                        ITD_INVOICING:
                          type: string
                          example: null
                          description: 'Invoicing amount (decimal, 4 places).'
                          nullable: true
                        ITD_VAS:
                          type: string
                          example: null
                          nullable: true
                        ITD_REVERSE_CHARGE:
                          type: string
                          example: null
                          description: 'Reverse charge flag. 0 = not applied, 1 = applied.'
                          nullable: true
                        detail:
                          type: string
                          example: null
                          description: 'Document detail — blocked amount and price breakdowns. NULL if no detail record exists.'
                          nullable: true
                        payment:
                          type: string
                          example: null
                          description: 'Payment information. NULL if no payment record exists.'
                          nullable: true
                        note:
                          type: string
                          example: null
                          description: 'Credit note (ODD) information. NULL if no note record exists.'
                          nullable: true
                    required:
                      - ID
                      - ITD_ADVANCE_ID
                      - ITD_TYPE
                      - USER_ID
                      - SRV_ID
                      - 'Y'
                      - MON
                      - PERIOD
                      - PER
                      - TAX_DATE
                      - ITD_MATURITY
                      - PRICE
                      - ITD_PRICE_VAT
                      - ITD_PRICE_WO_VAT
                      - ITD_PRICE_ROUND
                      - ITD_FIX_PRICE
                      - ITD_FIX_PRICE_VAT
                      - ITD_FIX_PRICE_WO_VAT
                      - ITD_VAR_PRICE
                      - ITD_VAR_PRICE_VAT
                      - ITD_VAR_PRICE_WO_VAT
                      - ITD_TL_VALUE_PERCENT
                      - ITD_SAB_ID
                      - CT
                      - ITD_TAX_PRICE
                      - ITD_TAX_PRICE_VAT
                      - ITD_TAX_PRICE_WO_VAT
                      - ITD_TAX_PRICE_ROUND
                      - ITD_PRICE_PRIM
                      - ITD_PRICE_PRIM_VAT
                      - ITD_PRICE_PRIM_WO_VAT
                      - ITD_SN_ID
                      - ITD_VAR_SYMBOL
                      - ITD_INVOICING
                      - ITD_REVERSE_CHARGE
                      - detail
                      - payment
                      - note
      tags:
        - 'Internal Tax Documents'
  '/api/v3/internal-tax-documents/{id}':
    get:
      summary: 'Get Internal Tax Document'
      operationId: getInternalTaxDocument
      description: "  Returns a single internal tax document by ID.\n  Use `advance_id` query parameter to specify which advance record to return (defaults to 0 — the base document)."
      parameters:
        -
          in: query
          name: advance_id
          description: 'Advance ID within the document. Defaults to 0 (base document).'
          example: 0
          required: false
          schema:
            type: integer
            description: 'Advance ID within the document. Defaults to 0 (base document).'
            example: 0
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 0
                    ITD_ADVANCE_ID: 10
                    ITD_TYPE: NON_ATTACH
                    USER_ID: 2617
                    SRV_ID: 8015
                    'Y': 2026
                    MON: 7
                    ITD_DAY: null
                    ITD_Y_END: 2021
                    MON_END: null
                    ITD_DAY_END: null
                    PERIOD: month
                    PER: 0
                    TAX_DATE: null
                    ITD_MATURITY: null
                    PRICE: null
                    ITD_PRICE_VAT: null
                    ITD_PRICE_WO_VAT: null
                    ITD_PRICE_ROUND: null
                    ITD_FIX_PRICE: null
                    ITD_FIX_PRICE_VAT: null
                    ITD_FIX_PRICE_WO_VAT: null
                    ITD_VAR_PRICE: null
                    ITD_VAR_PRICE_VAT: null
                    ITD_VAR_PRICE_WO_VAT: null
                    ITD_TL_VALUE_PERCENT: null
                    ITD_SAB_ID: null
                    CT: 39
                    ITD_TAX_PRICE: null
                    ITD_TAX_PRICE_VAT: null
                    ITD_TAX_PRICE_WO_VAT: null
                    ITD_TAX_PRICE_ROUND: null
                    ITD_PRICE_PRIM: null
                    ITD_PRICE_PRIM_VAT: null
                    ITD_PRICE_PRIM_WO_VAT: null
                    ITD_SN_ID: 765
                    ITD_VAR_SYMBOL: null
                    ITD_INVOICING: null
                    ITD_VAS: null
                    ITD_REVERSE_CHARGE: null
                    detail: null
                    payment: null
                    note: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 0
                        description: 'Document number (primary key, part of composite PK with ITD_ADVANCE_ID).'
                      ITD_ADVANCE_ID:
                        type: integer
                        example: 10
                        description: 'Advance sequence number. 0 for base document (SERVICE), >0 for ADVANCE/CREDIT_NOTE sub-documents.'
                      ITD_TYPE:
                        type: string
                        example: NON_ATTACH
                        description: 'Document type.'
                        enum:
                          - SERVICE
                          - CREDIT_NOTE
                          - MANUAL
                          - ADVANCE
                          - NON_ATTACH
                      USER_ID:
                        type: integer
                        example: 2617
                        description: 'Customer ID. See GET /v3/customers/{id}.'
                      SRV_ID:
                        type: integer
                        example: 8015
                        description: 'Active service instance ID (services_active).'
                      'Y':
                        type: integer
                        example: 2026
                        description: 'Billing year.'
                      MON:
                        type: integer
                        example: 7
                        description: 'Billing month (1-12).'
                        nullable: true
                      ITD_DAY:
                        type: string
                        example: null
                        nullable: true
                      ITD_Y_END:
                        type: integer
                        example: 2021
                      MON_END:
                        type: string
                        example: null
                        nullable: true
                      ITD_DAY_END:
                        type: string
                        example: null
                        nullable: true
                      PERIOD:
                        type: string
                        example: month
                        description: 'Billing period type.'
                        enum:
                          - all
                          - chalfyear
                          - cquarter
                          - cyear
                          - month
                          - none
                          - vhalfyear
                          - vmonth
                          - vquarter
                          - vyear
                          - cyears2
                          - cyears3
                          - cmonths18
                          - vyears2
                          - vyears3
                          - vmonths18
                      PER:
                        type: integer
                        example: 0
                        description: 'Period sequence number.'
                      TAX_DATE:
                        type: string
                        example: null
                        description: 'Tax date / DUZP (YYYY-MM-DD).'
                        nullable: true
                      ITD_MATURITY:
                        type: string
                        example: null
                        description: 'Maturity date (YYYY-MM-DD).'
                        nullable: true
                      PRICE:
                        type: string
                        example: null
                        description: 'Total price including VAT (decimal, 4 places).'
                        nullable: true
                      ITD_PRICE_VAT:
                        type: string
                        example: null
                        description: 'VAT amount.'
                        nullable: true
                      ITD_PRICE_WO_VAT:
                        type: string
                        example: null
                        description: 'Price without VAT.'
                        nullable: true
                      ITD_PRICE_ROUND:
                        type: string
                        example: null
                        description: 'Rounding adjustment.'
                        nullable: true
                      ITD_FIX_PRICE:
                        type: string
                        example: null
                        description: 'Fixed price component including VAT.'
                        nullable: true
                      ITD_FIX_PRICE_VAT:
                        type: string
                        example: null
                        description: 'VAT of fixed component.'
                        nullable: true
                      ITD_FIX_PRICE_WO_VAT:
                        type: string
                        example: null
                        description: 'Fixed component without VAT.'
                        nullable: true
                      ITD_VAR_PRICE:
                        type: string
                        example: null
                        description: 'Variable price component including VAT (usage-based charges).'
                        nullable: true
                      ITD_VAR_PRICE_VAT:
                        type: string
                        example: null
                        description: 'VAT of variable component.'
                        nullable: true
                      ITD_VAR_PRICE_WO_VAT:
                        type: string
                        example: null
                        description: 'Variable component without VAT.'
                        nullable: true
                      ITD_TL_VALUE_PERCENT:
                        type: string
                        example: null
                        description: 'VAT rate in percent.'
                        nullable: true
                      ITD_SAB_ID:
                        type: string
                        example: null
                        description: 'Service billing configuration ID (services_active_billing).'
                        nullable: true
                      CT:
                        type: integer
                        example: 39
                        description: 'Location (installation) ID — multi-tenant discriminator.'
                      ITD_TAX_PRICE:
                        type: string
                        example: null
                        description: 'Actual tax levy amount including VAT.'
                        nullable: true
                      ITD_TAX_PRICE_VAT:
                        type: string
                        example: null
                        description: 'VAT of actual tax levy.'
                        nullable: true
                      ITD_TAX_PRICE_WO_VAT:
                        type: string
                        example: null
                        description: 'Actual tax levy without VAT.'
                        nullable: true
                      ITD_TAX_PRICE_ROUND:
                        type: string
                        example: null
                        description: 'Rounding adjustment of actual tax levy.'
                        nullable: true
                      ITD_PRICE_PRIM:
                        type: string
                        example: null
                        description: 'Original (primary) price including VAT.'
                        nullable: true
                      ITD_PRICE_PRIM_VAT:
                        type: string
                        example: null
                        description: 'Original price VAT.'
                        nullable: true
                      ITD_PRICE_PRIM_WO_VAT:
                        type: string
                        example: null
                        description: 'Original price without VAT.'
                        nullable: true
                      ITD_SN_ID:
                        type: integer
                        example: 765
                        description: 'Service definition ID (services_name).'
                        nullable: true
                      ITD_VAR_SYMBOL:
                        type: string
                        example: null
                        description: 'Variable symbol of the tax document (invoice) this document was invoiced into.'
                        nullable: true
                      ITD_INVOICING:
                        type: string
                        example: null
                        description: 'Invoicing amount (decimal, 4 places).'
                        nullable: true
                      ITD_VAS:
                        type: string
                        example: null
                        nullable: true
                      ITD_REVERSE_CHARGE:
                        type: string
                        example: null
                        description: 'Reverse charge flag. 0 = not applied, 1 = applied.'
                        nullable: true
                      detail:
                        type: string
                        example: null
                        description: 'Document detail — blocked amount and price breakdowns. NULL if no detail record exists.'
                        nullable: true
                      payment:
                        type: string
                        example: null
                        description: 'Payment information. NULL if no payment record exists.'
                        nullable: true
                      note:
                        type: string
                        example: null
                        description: 'Credit note (ODD) information. NULL if no note record exists.'
                        nullable: true
                    required:
                      - ID
                      - ITD_ADVANCE_ID
                      - ITD_TYPE
                      - USER_ID
                      - SRV_ID
                      - 'Y'
                      - MON
                      - PERIOD
                      - PER
                      - TAX_DATE
                      - ITD_MATURITY
                      - PRICE
                      - ITD_PRICE_VAT
                      - ITD_PRICE_WO_VAT
                      - ITD_PRICE_ROUND
                      - ITD_FIX_PRICE
                      - ITD_FIX_PRICE_VAT
                      - ITD_FIX_PRICE_WO_VAT
                      - ITD_VAR_PRICE
                      - ITD_VAR_PRICE_VAT
                      - ITD_VAR_PRICE_WO_VAT
                      - ITD_TL_VALUE_PERCENT
                      - ITD_SAB_ID
                      - CT
                      - ITD_TAX_PRICE
                      - ITD_TAX_PRICE_VAT
                      - ITD_TAX_PRICE_WO_VAT
                      - ITD_TAX_PRICE_ROUND
                      - ITD_PRICE_PRIM
                      - ITD_PRICE_PRIM_VAT
                      - ITD_PRICE_PRIM_WO_VAT
                      - ITD_SN_ID
                      - ITD_VAR_SYMBOL
                      - ITD_INVOICING
                      - ITD_REVERSE_CHARGE
                      - detail
                      - payment
                      - note
      tags:
        - 'Internal Tax Documents'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the internal tax document.'
        example: 1000000010510504
        required: true
        schema:
          type: integer
  /api/v3/invoices:
    get:
      summary: 'List Invoices'
      operationId: listInvoices
      description: "  Returns a paginated list of invoices.\n  **At least one** of the following filters must be provided:\n  `customer`, `year`, `type`, `date_from`, `search`.\n  Without a narrowing filter the endpoint returns HTTP 422.\n  By default, only active invoices (IH_STAT_FLAG = 'A') are returned.\n  Use `status=S` for cancelled, or `status=all` for both."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated invoice IDs.'
          example: '100,200,300'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated invoice IDs.'
            example: '100,200,300'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID.'
          example: 345
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID.'
            example: 345
        -
          in: query
          name: type
          description: 'Filter by invoice type. Accepts comma-separated values.'
          example: 'INVOICE,ADVANCE'
          required: false
          schema:
            type: string
            description: 'Filter by invoice type. Accepts comma-separated values.'
            example: 'INVOICE,ADVANCE'
        -
          in: query
          name: year
          description: 'Filter by year of issue date (DATE_V).'
          example: 2024
          required: false
          schema:
            type: integer
            description: 'Filter by year of issue date (DATE_V).'
            example: 2024
        -
          in: query
          name: status
          description: 'Filter by status flag. A = active, S = cancelled, all = both. Default: only active (A).'
          example: A
          required: false
          schema:
            type: string
            description: 'Filter by status flag. A = active, S = cancelled, all = both. Default: only active (A).'
            example: A
        -
          in: query
          name: date_from
          description: 'Filter invoices issued on or after this date (YYYY-MM-DD).'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter invoices issued on or after this date (YYYY-MM-DD).'
            example: '2024-01-01'
        -
          in: query
          name: date_to
          description: 'Filter invoices issued on or before this date (YYYY-MM-DD).'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter invoices issued on or before this date (YYYY-MM-DD).'
            example: '2024-12-31'
        -
          in: query
          name: search
          description: 'Search by invoice record number (NUMBER_RECORD) or variable symbol (VAR_SYM).'
          example: '102'
          required: false
          schema:
            type: string
            description: 'Search by invoice record number (NUMBER_RECORD) or variable symbol (VAR_SYM).'
            example: '102'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 33162828
                      USER_ID: 2878
                      NUMBER_RECORD: '26824'
                      ACCORD: ''
                      INVOICE_ORDER: ''
                      DATE_S: '2006-09-20'
                      DATE_U: null
                      DATE_V: '2015-01-19'
                      TERM: ''
                      CON_SYM: ''
                      VAR_SYM: 2031881
                      NUMBER_DLIST: 1
                      CT: 40
                      NUM: 709
                      IH_DOC_ID: 8862
                      IH_AUTHOR: 12
                      IH_CREATED: null
                      NOTE: null
                      IH_STAT_FLAG: A
                      IH_TYPE: CREDIT_NOTE
                      IH_TAX: false
                      IH_TICKET: null
                      IH_PL_ID: null
                      IH_DATE_CONFIRM: null
                      IH_CANCELLED: null
                      IH_CANCEL_L_ID: null
                      IH_CANCEL_NOTE: null
                      IH_PROVIDER_USER_ID: null
                      IH_PA_ID: null
                      IH_NO_AUTO_DISPATCH: null
                      IH_HIDE_PRICE_DETAIL: null
                      items:
                        -
                          ID: 37256568
                          ID_INVOICE: 33162828
                          NOTE: 'Ipsum nostrum omnis autem et consequatur aut dolores enim.'
                          COUNT: null
                          AMOUNT: '7786.7381'
                          IB_ITD_PRICE_VAT: null
                          IB_ITD_PRICE_WO_VAT: null
                          IB_ITD_PRICE_ROUND: null
                          MONTH: '08'
                          YEAR: '2024'
                          USER_SERVICE_ID: 5468
                          IB_PER: 3
                          IB_NOTE2: null
                          IB_ATTACHMENT: null
                          IB_ITD_ID: null
                          IB_ITD_ADVANCE_ID: 0
                          IB_PRICE_TYPE: ALL
                          IB_DISCOUNT: 0
                          IB_SAD_ID: null
                          IB_ACCOUNT_ADVANCE: 0
                          IB_REVERSE_CHARGE: null
                          IB_SA_ID: null
                          IB_SA_BASE_ID: null
                          IB_TL_VALUE_PERCENT: null
                          IB_NO_PAY: null
                    -
                      ID: 33162829
                      USER_ID: 1462
                      NUMBER_RECORD: '48309'
                      ACCORD: ''
                      INVOICE_ORDER: ''
                      DATE_S: '1975-04-26'
                      DATE_U: null
                      DATE_V: '2024-01-23'
                      TERM: ''
                      CON_SYM: ''
                      VAR_SYM: 8327339
                      NUMBER_DLIST: 1
                      CT: 51
                      NUM: 177
                      IH_DOC_ID: 782
                      IH_AUTHOR: 614
                      IH_CREATED: null
                      NOTE: null
                      IH_STAT_FLAG: A
                      IH_TYPE: CREDIT_NOTE_ADVANCE
                      IH_TAX: false
                      IH_TICKET: null
                      IH_PL_ID: null
                      IH_DATE_CONFIRM: null
                      IH_CANCELLED: null
                      IH_CANCEL_L_ID: null
                      IH_CANCEL_NOTE: null
                      IH_PROVIDER_USER_ID: null
                      IH_PA_ID: null
                      IH_NO_AUTO_DISPATCH: null
                      IH_HIDE_PRICE_DETAIL: null
                      items:
                        -
                          ID: 37256569
                          ID_INVOICE: 33162829
                          NOTE: 'Aliquam veniam corporis dolorem mollitia deleniti nemo.'
                          COUNT: null
                          AMOUNT: '4091.1341'
                          IB_ITD_PRICE_VAT: null
                          IB_ITD_PRICE_WO_VAT: null
                          IB_ITD_PRICE_ROUND: null
                          MONTH: '05'
                          YEAR: '2020'
                          USER_SERVICE_ID: 7643
                          IB_PER: 6
                          IB_NOTE2: null
                          IB_ATTACHMENT: null
                          IB_ITD_ID: null
                          IB_ITD_ADVANCE_ID: 0
                          IB_PRICE_TYPE: FIX
                          IB_DISCOUNT: 0
                          IB_SAD_ID: null
                          IB_ACCOUNT_ADVANCE: 0
                          IB_REVERSE_CHARGE: null
                          IB_SA_ID: null
                          IB_SA_BASE_ID: null
                          IB_TL_VALUE_PERCENT: null
                          IB_NO_PAY: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 33162828
                        USER_ID: 2878
                        NUMBER_RECORD: '26824'
                        ACCORD: ''
                        INVOICE_ORDER: ''
                        DATE_S: '2006-09-20'
                        DATE_U: null
                        DATE_V: '2015-01-19'
                        TERM: ''
                        CON_SYM: ''
                        VAR_SYM: 2031881
                        NUMBER_DLIST: 1
                        CT: 40
                        NUM: 709
                        IH_DOC_ID: 8862
                        IH_AUTHOR: 12
                        IH_CREATED: null
                        NOTE: null
                        IH_STAT_FLAG: A
                        IH_TYPE: CREDIT_NOTE
                        IH_TAX: false
                        IH_TICKET: null
                        IH_PL_ID: null
                        IH_DATE_CONFIRM: null
                        IH_CANCELLED: null
                        IH_CANCEL_L_ID: null
                        IH_CANCEL_NOTE: null
                        IH_PROVIDER_USER_ID: null
                        IH_PA_ID: null
                        IH_NO_AUTO_DISPATCH: null
                        IH_HIDE_PRICE_DETAIL: null
                        items:
                          -
                            ID: 37256568
                            ID_INVOICE: 33162828
                            NOTE: 'Ipsum nostrum omnis autem et consequatur aut dolores enim.'
                            COUNT: null
                            AMOUNT: '7786.7381'
                            IB_ITD_PRICE_VAT: null
                            IB_ITD_PRICE_WO_VAT: null
                            IB_ITD_PRICE_ROUND: null
                            MONTH: '08'
                            YEAR: '2024'
                            USER_SERVICE_ID: 5468
                            IB_PER: 3
                            IB_NOTE2: null
                            IB_ATTACHMENT: null
                            IB_ITD_ID: null
                            IB_ITD_ADVANCE_ID: 0
                            IB_PRICE_TYPE: ALL
                            IB_DISCOUNT: 0
                            IB_SAD_ID: null
                            IB_ACCOUNT_ADVANCE: 0
                            IB_REVERSE_CHARGE: null
                            IB_SA_ID: null
                            IB_SA_BASE_ID: null
                            IB_TL_VALUE_PERCENT: null
                            IB_NO_PAY: null
                      -
                        ID: 33162829
                        USER_ID: 1462
                        NUMBER_RECORD: '48309'
                        ACCORD: ''
                        INVOICE_ORDER: ''
                        DATE_S: '1975-04-26'
                        DATE_U: null
                        DATE_V: '2024-01-23'
                        TERM: ''
                        CON_SYM: ''
                        VAR_SYM: 8327339
                        NUMBER_DLIST: 1
                        CT: 51
                        NUM: 177
                        IH_DOC_ID: 782
                        IH_AUTHOR: 614
                        IH_CREATED: null
                        NOTE: null
                        IH_STAT_FLAG: A
                        IH_TYPE: CREDIT_NOTE_ADVANCE
                        IH_TAX: false
                        IH_TICKET: null
                        IH_PL_ID: null
                        IH_DATE_CONFIRM: null
                        IH_CANCELLED: null
                        IH_CANCEL_L_ID: null
                        IH_CANCEL_NOTE: null
                        IH_PROVIDER_USER_ID: null
                        IH_PA_ID: null
                        IH_NO_AUTO_DISPATCH: null
                        IH_HIDE_PRICE_DETAIL: null
                        items:
                          -
                            ID: 37256569
                            ID_INVOICE: 33162829
                            NOTE: 'Aliquam veniam corporis dolorem mollitia deleniti nemo.'
                            COUNT: null
                            AMOUNT: '4091.1341'
                            IB_ITD_PRICE_VAT: null
                            IB_ITD_PRICE_WO_VAT: null
                            IB_ITD_PRICE_ROUND: null
                            MONTH: '05'
                            YEAR: '2020'
                            USER_SERVICE_ID: 7643
                            IB_PER: 6
                            IB_NOTE2: null
                            IB_ATTACHMENT: null
                            IB_ITD_ID: null
                            IB_ITD_ADVANCE_ID: 0
                            IB_PRICE_TYPE: FIX
                            IB_DISCOUNT: 0
                            IB_SAD_ID: null
                            IB_ACCOUNT_ADVANCE: 0
                            IB_REVERSE_CHARGE: null
                            IB_SA_ID: null
                            IB_SA_BASE_ID: null
                            IB_TL_VALUE_PERCENT: null
                            IB_NO_PAY: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 33162828
                          description: 'Unique invoice identifier (primary key).'
                        USER_ID:
                          type: integer
                          example: 2878
                          description: 'Customer ID. See GET /v3/customers/{id}.'
                        NUMBER_RECORD:
                          type: string
                          example: '26824'
                          description: 'Invoice record number.'
                        ACCORD:
                          type: string
                          example: ''
                          description: 'Accord number (related agreement reference).'
                        INVOICE_ORDER:
                          type: string
                          example: ''
                          description: 'Invoice order reference.'
                        DATE_S:
                          type: string
                          example: '2006-09-20'
                          description: 'Due date / maturity date (YYYY-MM-DD).'
                        DATE_U:
                          type: string
                          example: null
                          description: 'Taxable supply date / DUZP (YYYY-MM-DD).'
                          nullable: true
                        DATE_V:
                          type: string
                          example: '2015-01-19'
                          description: 'Issue date (YYYY-MM-DD).'
                        TERM:
                          type: string
                          example: ''
                          description: 'Payment term description.'
                        CON_SYM:
                          type: string
                          example: ''
                          description: 'Constant symbol.'
                        VAR_SYM:
                          type: integer
                          example: 2031881
                          description: 'Variable symbol — unique payment identifier for bank transfers.'
                        NUMBER_DLIST:
                          type: integer
                          example: 1
                          description: 'Delivery list number.'
                        CT:
                          type: integer
                          example: 40
                          description: 'Location (installation) ID — multi-tenant discriminator.'
                        NUM:
                          type: integer
                          example: 709
                          description: 'Sequential invoice number within the delivery list.'
                        IH_DOC_ID:
                          type: integer
                          example: 8862
                          description: 'Internal document number.'
                        IH_AUTHOR:
                          type: integer
                          example: 12
                          description: 'Operator ID who created the invoice.'
                        IH_CREATED:
                          type: string
                          example: null
                          description: 'Creation timestamp (YYYY-MM-DD HH:MM:SS).'
                          nullable: true
                        NOTE:
                          type: string
                          example: null
                          description: 'Invoice note/memo.'
                          nullable: true
                        IH_STAT_FLAG:
                          type: string
                          example: A
                          description: 'Status flag. A = active, S = cancelled.'
                          enum:
                            - A
                            - S
                        IH_TYPE:
                          type: string
                          example: CREDIT_NOTE
                          description: 'Invoice type.'
                          enum:
                            - INVOICE
                            - ADVANCE
                            - CREDIT_NOTE
                            - CREDIT_NOTE_ADVANCE
                        IH_TAX:
                          type: boolean
                          example: false
                          description: 'Tax document flag.'
                        IH_TICKET:
                          type: string
                          example: null
                          description: 'Generation ticket/sequence number.'
                          nullable: true
                        IH_PL_ID:
                          type: string
                          example: null
                          description: 'Linked payment list ID.'
                          nullable: true
                        IH_DATE_CONFIRM:
                          type: string
                          example: null
                          description: 'Confirmation date (YYYY-MM-DD).'
                          nullable: true
                        IH_CANCELLED:
                          type: string
                          example: null
                          description: 'Cancellation timestamp.'
                          nullable: true
                        IH_CANCEL_L_ID:
                          type: string
                          example: null
                          description: 'Operator ID who cancelled the invoice.'
                          nullable: true
                        IH_CANCEL_NOTE:
                          type: string
                          example: null
                          description: 'Cancellation reason/note.'
                          nullable: true
                        IH_PROVIDER_USER_ID:
                          type: string
                          example: null
                          description: 'Provider customer ID.'
                          nullable: true
                        IH_PA_ID:
                          type: string
                          example: null
                          description: 'Payment account ID.'
                          nullable: true
                        IH_NO_AUTO_DISPATCH:
                          type: string
                          example: null
                          description: 'Dispatch control. 0 = dispatch, 1 = do not dispatch.'
                          nullable: true
                        IH_HIDE_PRICE_DETAIL:
                          type: string
                          example: null
                          description: 'Hide price detail flag. 1 = hide prices in printouts.'
                          nullable: true
                        items:
                          type: array
                          example:
                            -
                              ID: 37256568
                              ID_INVOICE: 33162828
                              NOTE: 'Ipsum nostrum omnis autem et consequatur aut dolores enim.'
                              COUNT: null
                              AMOUNT: '7786.7381'
                              IB_ITD_PRICE_VAT: null
                              IB_ITD_PRICE_WO_VAT: null
                              IB_ITD_PRICE_ROUND: null
                              MONTH: '08'
                              YEAR: '2024'
                              USER_SERVICE_ID: 5468
                              IB_PER: 3
                              IB_NOTE2: null
                              IB_ATTACHMENT: null
                              IB_ITD_ID: null
                              IB_ITD_ADVANCE_ID: 0
                              IB_PRICE_TYPE: ALL
                              IB_DISCOUNT: 0
                              IB_SAD_ID: null
                              IB_ACCOUNT_ADVANCE: 0
                              IB_REVERSE_CHARGE: null
                              IB_SA_ID: null
                              IB_SA_BASE_ID: null
                              IB_TL_VALUE_PERCENT: null
                              IB_NO_PAY: null
                          description: 'Invoice line items (from invoice_body table).'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 37256568
                              ID_INVOICE:
                                type: integer
                                example: 33162828
                              NOTE:
                                type: string
                                example: 'Ipsum nostrum omnis autem et consequatur aut dolores enim.'
                              COUNT:
                                type: string
                                example: null
                                nullable: true
                              AMOUNT:
                                type: string
                                example: '7786.7381'
                              IB_ITD_PRICE_VAT:
                                type: string
                                example: null
                                nullable: true
                              IB_ITD_PRICE_WO_VAT:
                                type: string
                                example: null
                                nullable: true
                              IB_ITD_PRICE_ROUND:
                                type: string
                                example: null
                                nullable: true
                              MONTH:
                                type: string
                                example: '08'
                              YEAR:
                                type: string
                                example: '2024'
                              USER_SERVICE_ID:
                                type: integer
                                example: 5468
                              IB_PER:
                                type: integer
                                example: 3
                              IB_NOTE2:
                                type: string
                                example: null
                                nullable: true
                              IB_ATTACHMENT:
                                type: string
                                example: null
                                nullable: true
                              IB_ITD_ID:
                                type: string
                                example: null
                                nullable: true
                              IB_ITD_ADVANCE_ID:
                                type: integer
                                example: 0
                              IB_PRICE_TYPE:
                                type: string
                                example: ALL
                              IB_DISCOUNT:
                                type: integer
                                example: 0
                              IB_SAD_ID:
                                type: string
                                example: null
                                nullable: true
                              IB_ACCOUNT_ADVANCE:
                                type: integer
                                example: 0
                              IB_REVERSE_CHARGE:
                                type: string
                                example: null
                                nullable: true
                              IB_SA_ID:
                                type: string
                                example: null
                                nullable: true
                              IB_SA_BASE_ID:
                                type: string
                                example: null
                                nullable: true
                              IB_TL_VALUE_PERCENT:
                                type: string
                                example: null
                                nullable: true
                              IB_NO_PAY:
                                type: string
                                example: null
                                nullable: true
                    required:
                      - ID
                      - USER_ID
                      - NUMBER_RECORD
                      - ACCORD
                      - INVOICE_ORDER
                      - DATE_S
                      - DATE_U
                      - DATE_V
                      - TERM
                      - CON_SYM
                      - VAR_SYM
                      - NUMBER_DLIST
                      - CT
                      - NUM
                      - IH_DOC_ID
                      - IH_AUTHOR
                      - IH_CREATED
                      - NOTE
                      - IH_STAT_FLAG
                      - IH_TYPE
                      - IH_TAX
                      - IH_TICKET
                      - IH_PL_ID
                      - IH_DATE_CONFIRM
                      - IH_CANCELLED
                      - IH_CANCEL_L_ID
                      - IH_CANCEL_NOTE
                      - IH_PROVIDER_USER_ID
                      - IH_PA_ID
                      - IH_NO_AUTO_DISPATCH
                      - IH_HIDE_PRICE_DETAIL
                      - items
      tags:
        - Invoices
  '/api/v3/invoices/{id}':
    get:
      summary: 'Get Invoice'
      operationId: getInvoice
      description: '  Returns a single invoice by ID, including line items.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 33162830
                    USER_ID: 2878
                    NUMBER_RECORD: '89349'
                    ACCORD: ''
                    INVOICE_ORDER: ''
                    DATE_S: '2015-01-19'
                    DATE_U: null
                    DATE_V: '2010-09-13'
                    TERM: ''
                    CON_SYM: ''
                    VAR_SYM: 1310719
                    NUMBER_DLIST: 1
                    CT: 79
                    NUM: 274
                    IH_DOC_ID: 9279
                    IH_AUTHOR: 765
                    IH_CREATED: null
                    NOTE: null
                    IH_STAT_FLAG: A
                    IH_TYPE: INVOICE
                    IH_TAX: false
                    IH_TICKET: null
                    IH_PL_ID: null
                    IH_DATE_CONFIRM: null
                    IH_CANCELLED: null
                    IH_CANCEL_L_ID: null
                    IH_CANCEL_NOTE: null
                    IH_PROVIDER_USER_ID: null
                    IH_PA_ID: null
                    IH_NO_AUTO_DISPATCH: null
                    IH_HIDE_PRICE_DETAIL: null
                    items:
                      -
                        ID: 37256570
                        ID_INVOICE: 33162830
                        NOTE: 'Nostrum omnis autem et consequatur aut.'
                        COUNT: null
                        AMOUNT: '4770.9696'
                        IB_ITD_PRICE_VAT: null
                        IB_ITD_PRICE_WO_VAT: null
                        IB_ITD_PRICE_ROUND: null
                        MONTH: '05'
                        YEAR: '2023'
                        USER_SERVICE_ID: 2327
                        IB_PER: 9
                        IB_NOTE2: null
                        IB_ATTACHMENT: null
                        IB_ITD_ID: null
                        IB_ITD_ADVANCE_ID: 0
                        IB_PRICE_TYPE: FIX
                        IB_DISCOUNT: 0
                        IB_SAD_ID: null
                        IB_ACCOUNT_ADVANCE: 0
                        IB_REVERSE_CHARGE: null
                        IB_SA_ID: null
                        IB_SA_BASE_ID: null
                        IB_TL_VALUE_PERCENT: null
                        IB_NO_PAY: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 33162830
                        description: 'Unique invoice identifier (primary key).'
                      USER_ID:
                        type: integer
                        example: 2878
                        description: 'Customer ID. See GET /v3/customers/{id}.'
                      NUMBER_RECORD:
                        type: string
                        example: '89349'
                        description: 'Invoice record number.'
                      ACCORD:
                        type: string
                        example: ''
                        description: 'Accord number (related agreement reference).'
                      INVOICE_ORDER:
                        type: string
                        example: ''
                        description: 'Invoice order reference.'
                      DATE_S:
                        type: string
                        example: '2015-01-19'
                        description: 'Due date / maturity date (YYYY-MM-DD).'
                      DATE_U:
                        type: string
                        example: null
                        description: 'Taxable supply date / DUZP (YYYY-MM-DD).'
                        nullable: true
                      DATE_V:
                        type: string
                        example: '2010-09-13'
                        description: 'Issue date (YYYY-MM-DD).'
                      TERM:
                        type: string
                        example: ''
                        description: 'Payment term description.'
                      CON_SYM:
                        type: string
                        example: ''
                        description: 'Constant symbol.'
                      VAR_SYM:
                        type: integer
                        example: 1310719
                        description: 'Variable symbol — unique payment identifier for bank transfers.'
                      NUMBER_DLIST:
                        type: integer
                        example: 1
                        description: 'Delivery list number.'
                      CT:
                        type: integer
                        example: 79
                        description: 'Location (installation) ID — multi-tenant discriminator.'
                      NUM:
                        type: integer
                        example: 274
                        description: 'Sequential invoice number within the delivery list.'
                      IH_DOC_ID:
                        type: integer
                        example: 9279
                        description: 'Internal document number.'
                      IH_AUTHOR:
                        type: integer
                        example: 765
                        description: 'Operator ID who created the invoice.'
                      IH_CREATED:
                        type: string
                        example: null
                        description: 'Creation timestamp (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      NOTE:
                        type: string
                        example: null
                        description: 'Invoice note/memo.'
                        nullable: true
                      IH_STAT_FLAG:
                        type: string
                        example: A
                        description: 'Status flag. A = active, S = cancelled.'
                        enum:
                          - A
                          - S
                      IH_TYPE:
                        type: string
                        example: INVOICE
                        description: 'Invoice type.'
                        enum:
                          - INVOICE
                          - ADVANCE
                          - CREDIT_NOTE
                          - CREDIT_NOTE_ADVANCE
                      IH_TAX:
                        type: boolean
                        example: false
                        description: 'Tax document flag.'
                      IH_TICKET:
                        type: string
                        example: null
                        description: 'Generation ticket/sequence number.'
                        nullable: true
                      IH_PL_ID:
                        type: string
                        example: null
                        description: 'Linked payment list ID.'
                        nullable: true
                      IH_DATE_CONFIRM:
                        type: string
                        example: null
                        description: 'Confirmation date (YYYY-MM-DD).'
                        nullable: true
                      IH_CANCELLED:
                        type: string
                        example: null
                        description: 'Cancellation timestamp.'
                        nullable: true
                      IH_CANCEL_L_ID:
                        type: string
                        example: null
                        description: 'Operator ID who cancelled the invoice.'
                        nullable: true
                      IH_CANCEL_NOTE:
                        type: string
                        example: null
                        description: 'Cancellation reason/note.'
                        nullable: true
                      IH_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider customer ID.'
                        nullable: true
                      IH_PA_ID:
                        type: string
                        example: null
                        description: 'Payment account ID.'
                        nullable: true
                      IH_NO_AUTO_DISPATCH:
                        type: string
                        example: null
                        description: 'Dispatch control. 0 = dispatch, 1 = do not dispatch.'
                        nullable: true
                      IH_HIDE_PRICE_DETAIL:
                        type: string
                        example: null
                        description: 'Hide price detail flag. 1 = hide prices in printouts.'
                        nullable: true
                      items:
                        type: array
                        example:
                          -
                            ID: 37256570
                            ID_INVOICE: 33162830
                            NOTE: 'Nostrum omnis autem et consequatur aut.'
                            COUNT: null
                            AMOUNT: '4770.9696'
                            IB_ITD_PRICE_VAT: null
                            IB_ITD_PRICE_WO_VAT: null
                            IB_ITD_PRICE_ROUND: null
                            MONTH: '05'
                            YEAR: '2023'
                            USER_SERVICE_ID: 2327
                            IB_PER: 9
                            IB_NOTE2: null
                            IB_ATTACHMENT: null
                            IB_ITD_ID: null
                            IB_ITD_ADVANCE_ID: 0
                            IB_PRICE_TYPE: FIX
                            IB_DISCOUNT: 0
                            IB_SAD_ID: null
                            IB_ACCOUNT_ADVANCE: 0
                            IB_REVERSE_CHARGE: null
                            IB_SA_ID: null
                            IB_SA_BASE_ID: null
                            IB_TL_VALUE_PERCENT: null
                            IB_NO_PAY: null
                        description: 'Invoice line items (from invoice_body table).'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 37256570
                            ID_INVOICE:
                              type: integer
                              example: 33162830
                            NOTE:
                              type: string
                              example: 'Nostrum omnis autem et consequatur aut.'
                            COUNT:
                              type: string
                              example: null
                              nullable: true
                            AMOUNT:
                              type: string
                              example: '4770.9696'
                            IB_ITD_PRICE_VAT:
                              type: string
                              example: null
                              nullable: true
                            IB_ITD_PRICE_WO_VAT:
                              type: string
                              example: null
                              nullable: true
                            IB_ITD_PRICE_ROUND:
                              type: string
                              example: null
                              nullable: true
                            MONTH:
                              type: string
                              example: '05'
                            YEAR:
                              type: string
                              example: '2023'
                            USER_SERVICE_ID:
                              type: integer
                              example: 2327
                            IB_PER:
                              type: integer
                              example: 9
                            IB_NOTE2:
                              type: string
                              example: null
                              nullable: true
                            IB_ATTACHMENT:
                              type: string
                              example: null
                              nullable: true
                            IB_ITD_ID:
                              type: string
                              example: null
                              nullable: true
                            IB_ITD_ADVANCE_ID:
                              type: integer
                              example: 0
                            IB_PRICE_TYPE:
                              type: string
                              example: FIX
                            IB_DISCOUNT:
                              type: integer
                              example: 0
                            IB_SAD_ID:
                              type: string
                              example: null
                              nullable: true
                            IB_ACCOUNT_ADVANCE:
                              type: integer
                              example: 0
                            IB_REVERSE_CHARGE:
                              type: string
                              example: null
                              nullable: true
                            IB_SA_ID:
                              type: string
                              example: null
                              nullable: true
                            IB_SA_BASE_ID:
                              type: string
                              example: null
                              nullable: true
                            IB_TL_VALUE_PERCENT:
                              type: string
                              example: null
                              nullable: true
                            IB_NO_PAY:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - USER_ID
                      - NUMBER_RECORD
                      - ACCORD
                      - INVOICE_ORDER
                      - DATE_S
                      - DATE_U
                      - DATE_V
                      - TERM
                      - CON_SYM
                      - VAR_SYM
                      - NUMBER_DLIST
                      - CT
                      - NUM
                      - IH_DOC_ID
                      - IH_AUTHOR
                      - IH_CREATED
                      - NOTE
                      - IH_STAT_FLAG
                      - IH_TYPE
                      - IH_TAX
                      - IH_TICKET
                      - IH_PL_ID
                      - IH_DATE_CONFIRM
                      - IH_CANCELLED
                      - IH_CANCEL_L_ID
                      - IH_CANCEL_NOTE
                      - IH_PROVIDER_USER_ID
                      - IH_PA_ID
                      - IH_NO_AUTO_DISPATCH
                      - IH_HIDE_PRICE_DETAIL
                      - items
      tags:
        - Invoices
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the invoice.'
        example: 5352
        required: true
        schema:
          type: integer
  /api/v3/locations:
    get:
      summary: 'List Locations'
      operationId: listLocations
      description: 'Returns a paginated list of non-hidden locations.'
      parameters:
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location IDs (overrides X-CT header)'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location IDs (overrides X-CT header)'
            example: '1,2,3'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: '278'
                      NAME: 'aut adipisci quidem'
                      DESCRIPTION: 'Commodi incidunt iure odit et et modi.'
                      LOCATION: null
                      START_DATE: '2026-01-07'
                      SIPO_KODOZ: sc
                      SIPO_CISORG: null
                      INFO_EMAIL: ztromp@example.org
                      HIDDEN: 0
                      PATH: null
                      I_COMPANY_ID: 48
                      I_CP_ID: 1
                      I_MAP_ID: null
                      I_NOTE: 'Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia. Dignissimos neque blanditiis odio.'
                      I_MAP_CENTER_LAT: 28.134129
                      I_MAP_CENTER_LON: 116.728477
                      I_MAP_ZOOM: 20
                      I_MAP_ID_NAME: MAPNAME-mgos
                      I_CL_ID: 1
                    -
                      ID: '279'
                      NAME: 'officiis corporis nesciunt'
                      DESCRIPTION: null
                      LOCATION: Tressatown
                      START_DATE: '2026-03-21'
                      SIPO_KODOZ: zc
                      SIPO_CISORG: cvalex
                      INFO_EMAIL: alia45@example.net
                      HIDDEN: 0
                      PATH: null
                      I_COMPANY_ID: 52
                      I_CP_ID: 1
                      I_MAP_ID: null
                      I_NOTE: 'Ut dicta vitae assumenda consequatur ut et sunt. Sit repellendus ut eaque alias ratione. Sed rem ea ut aut deserunt. In quod id aspernatur consectetur id a. Assumenda eaque neque sit sunt nihil accusantium odit. Perspiciatis rem dolorem aut quis ut.'
                      I_MAP_CENTER_LAT: 31.792143
                      I_MAP_CENTER_LON: 54.509342
                      I_MAP_ZOOM: 8
                      I_MAP_ID_NAME: MAPNAME-xpvf
                      I_CL_ID: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: '278'
                        NAME: 'aut adipisci quidem'
                        DESCRIPTION: 'Commodi incidunt iure odit et et modi.'
                        LOCATION: null
                        START_DATE: '2026-01-07'
                        SIPO_KODOZ: sc
                        SIPO_CISORG: null
                        INFO_EMAIL: ztromp@example.org
                        HIDDEN: 0
                        PATH: null
                        I_COMPANY_ID: 48
                        I_CP_ID: 1
                        I_MAP_ID: null
                        I_NOTE: 'Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia. Dignissimos neque blanditiis odio.'
                        I_MAP_CENTER_LAT: 28.134129
                        I_MAP_CENTER_LON: 116.728477
                        I_MAP_ZOOM: 20
                        I_MAP_ID_NAME: MAPNAME-mgos
                        I_CL_ID: 1
                      -
                        ID: '279'
                        NAME: 'officiis corporis nesciunt'
                        DESCRIPTION: null
                        LOCATION: Tressatown
                        START_DATE: '2026-03-21'
                        SIPO_KODOZ: zc
                        SIPO_CISORG: cvalex
                        INFO_EMAIL: alia45@example.net
                        HIDDEN: 0
                        PATH: null
                        I_COMPANY_ID: 52
                        I_CP_ID: 1
                        I_MAP_ID: null
                        I_NOTE: 'Ut dicta vitae assumenda consequatur ut et sunt. Sit repellendus ut eaque alias ratione. Sed rem ea ut aut deserunt. In quod id aspernatur consectetur id a. Assumenda eaque neque sit sunt nihil accusantium odit. Perspiciatis rem dolorem aut quis ut.'
                        I_MAP_CENTER_LAT: 31.792143
                        I_MAP_CENTER_LON: 54.509342
                        I_MAP_ZOOM: 8
                        I_MAP_ID_NAME: MAPNAME-xpvf
                        I_CL_ID: 1
                    items:
                      type: object
                      properties:
                        ID:
                          type: string
                          example: '278'
                          description: 'Installation (location) ID.'
                        NAME:
                          type: string
                          example: 'aut adipisci quidem'
                          description: 'Installation name.'
                          nullable: true
                        DESCRIPTION:
                          type: string
                          example: 'Commodi incidunt iure odit et et modi.'
                        LOCATION:
                          type: string
                          example: null
                          nullable: true
                        START_DATE:
                          type: string
                          example: '2026-01-07'
                        SIPO_KODOZ:
                          type: string
                          example: sc
                        SIPO_CISORG:
                          type: string
                          example: null
                          nullable: true
                        INFO_EMAIL:
                          type: string
                          example: ztromp@example.org
                        HIDDEN:
                          type: integer
                          example: 0
                        PATH:
                          type: string
                          example: null
                          nullable: true
                        I_COMPANY_ID:
                          type: integer
                          example: 48
                        I_CP_ID:
                          type: integer
                          example: 1
                        I_MAP_ID:
                          type: string
                          example: null
                          nullable: true
                        I_NOTE:
                          type: string
                          example: 'Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia. Dignissimos neque blanditiis odio.'
                        I_MAP_CENTER_LAT:
                          type: number
                          example: 28.134129
                        I_MAP_CENTER_LON:
                          type: number
                          example: 116.728477
                        I_MAP_ZOOM:
                          type: integer
                          example: 20
                        I_MAP_ID_NAME:
                          type: string
                          example: MAPNAME-mgos
                        I_CL_ID:
                          type: integer
                          example: 1
                    required:
                      - ID
                      - NAME
      tags:
        - Locations
  /api/v3/operator-roles:
    get:
      summary: 'List Operator Roles'
      operationId: listOperatorRoles
      description: "Returns a paginated list of operator roles.\nPartner-bound users see roles of their CIBS partner + global roles (LR_CP_ID IS NULL)."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page.'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated role IDs.'
          example: '9,12'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated role IDs.'
            example: '9,12'
        -
          in: query
          name: cibs_partners
          description: 'Filter by comma-separated CIBS partner IDs. Use "null" to get global (partnerless) roles only.'
          example: '3,69'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated CIBS partner IDs. Use "null" to get global (partnerless) roles only.'
            example: '3,69'
        -
          in: query
          name: search
          description: 'Search in role name.'
          example: admin
          required: false
          schema:
            type: string
            description: 'Search in role name.'
            example: admin
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      LR_ID: 671
                      LR_CP_ID: null
                      LR_NAME: 'aut adipisci quidem'
                      LR_LEVEL: 7
                      LR_NOTE: null
                      LR_CREATED: '2026-04-05 16:12:19'
                      LR_L_ID: 1
                      rights:
                        -
                          ID: 650392
                          UR_TYPE: ROLE
                          USER_ID: 1
                          UR_LR_ID: 671
                          NAME: incidunt-iure-odit
                          OPTIONS: ''
                          CIBS_VERSION: null
                          UR_CREATED: '2026-02-18 14:59:44'
                          UR_CREATOR_L_ID: 1
                    -
                      LR_ID: 672
                      LR_CP_ID: null
                      LR_NAME: 'et modi ipsum'
                      LR_LEVEL: 1
                      LR_NOTE: null
                      LR_CREATED: '2026-01-21 11:33:24'
                      LR_L_ID: 1
                      rights:
                        -
                          ID: 650393
                          UR_TYPE: ROLE
                          USER_ID: 1
                          UR_LR_ID: 672
                          NAME: et-consequatur
                          OPTIONS: ''
                          CIBS_VERSION: null
                          UR_CREATED: '2026-03-30 17:42:21'
                          UR_CREATOR_L_ID: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        LR_ID: 671
                        LR_CP_ID: null
                        LR_NAME: 'aut adipisci quidem'
                        LR_LEVEL: 7
                        LR_NOTE: null
                        LR_CREATED: '2026-04-05 16:12:19'
                        LR_L_ID: 1
                        rights:
                          -
                            ID: 650392
                            UR_TYPE: ROLE
                            USER_ID: 1
                            UR_LR_ID: 671
                            NAME: incidunt-iure-odit
                            OPTIONS: ''
                            CIBS_VERSION: null
                            UR_CREATED: '2026-02-18 14:59:44'
                            UR_CREATOR_L_ID: 1
                      -
                        LR_ID: 672
                        LR_CP_ID: null
                        LR_NAME: 'et modi ipsum'
                        LR_LEVEL: 1
                        LR_NOTE: null
                        LR_CREATED: '2026-01-21 11:33:24'
                        LR_L_ID: 1
                        rights:
                          -
                            ID: 650393
                            UR_TYPE: ROLE
                            USER_ID: 1
                            UR_LR_ID: 672
                            NAME: et-consequatur
                            OPTIONS: ''
                            CIBS_VERSION: null
                            UR_CREATED: '2026-03-30 17:42:21'
                            UR_CREATOR_L_ID: 1
                    items:
                      type: object
                      properties:
                        LR_ID:
                          type: integer
                          example: 671
                          description: 'Unique role identifier (primary key).'
                        LR_CP_ID:
                          type: string
                          example: null
                          description: 'CIBS partner ID. NULL for global roles available to all partners.'
                          nullable: true
                        LR_NAME:
                          type: string
                          example: 'aut adipisci quidem'
                          description: 'Role name.'
                        LR_LEVEL:
                          type: integer
                          example: 7
                          description: 'Role level (0–255). Users can only manage roles with lower level.'
                        LR_NOTE:
                          type: string
                          example: null
                          description: 'Free-text note.'
                          nullable: true
                        LR_CREATED:
                          type: string
                          example: '2026-04-05 16:12:19'
                          description: 'Role creation datetime.'
                        LR_L_ID:
                          type: integer
                          example: 1
                          description: 'ID of the operator who created this role.'
                        rights:
                          type: array
                          example:
                            -
                              ID: 650392
                              UR_TYPE: ROLE
                              USER_ID: 1
                              UR_LR_ID: 671
                              NAME: incidunt-iure-odit
                              OPTIONS: ''
                              CIBS_VERSION: null
                              UR_CREATED: '2026-02-18 14:59:44'
                              UR_CREATOR_L_ID: 1
                          description: 'Rights assigned to this role. Always loaded.'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 650392
                              UR_TYPE:
                                type: string
                                example: ROLE
                              USER_ID:
                                type: integer
                                example: 1
                              UR_LR_ID:
                                type: integer
                                example: 671
                              NAME:
                                type: string
                                example: incidunt-iure-odit
                              OPTIONS:
                                type: string
                                example: ''
                              CIBS_VERSION:
                                type: string
                                example: null
                                nullable: true
                              UR_CREATED:
                                type: string
                                example: '2026-02-18 14:59:44'
                              UR_CREATOR_L_ID:
                                type: integer
                                example: 1
                    required:
                      - LR_ID
                      - LR_CP_ID
                      - LR_NAME
                      - LR_LEVEL
                      - LR_NOTE
                      - LR_CREATED
                      - LR_L_ID
                      - rights
      tags:
        - 'Operator Roles'
  '/api/v3/operator-roles/{id}':
    get:
      summary: 'Get Operator Role'
      operationId: getOperatorRole
      description: 'Returns a single operator role by ID, including its rights and assigned operators.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    LR_ID: 673
                    LR_CP_ID: null
                    LR_NAME: 'aut adipisci quidem'
                    LR_LEVEL: 7
                    LR_NOTE: null
                    LR_CREATED: '2026-04-05 16:12:19'
                    LR_L_ID: 1
                    rights:
                      -
                        ID: 650394
                        UR_TYPE: ROLE
                        USER_ID: 1
                        UR_LR_ID: 673
                        NAME: et-modi-ipsum
                        OPTIONS: ''
                        CIBS_VERSION: null
                        UR_CREATED: '2026-01-07 20:23:45'
                        UR_CREATOR_L_ID: 1
                    operators:
                      -
                        ID: 5549
                        FIRST_NAME: Isidro
                        SURNAME: McLaughlin
                        LOGIN: ztromp
                        L_LEVEL: 3
                        MAIL: wnitzsche@example.org
                        PHONE: null
                        NOTE: null
                        SALESMAN: 0
                        L_SMS_ENABLE: 0
                        LOG_LEVEL: NOTICE
                        L_CP_ID: null
                        L_CREATED: '2026-03-27 13:07:51'
                        L_L_ID: 1
                        L_ACTIVE: 1
                        L_PASS_EXPIRE: null
                        L_PASS_CHANGE: null
                        L_TYPE: MACHINE
                        L_SIGNATURE: null
                        L_SELFCARE: 0
                        L_CACHE_INITIALS: ''
                        L_INITIALS: null
                        L_STATISTICS_ENABLE: 0
                        pivot:
                          LRC_LR_ID: 673
                          LRC_L_ID: 5549
                properties:
                  data:
                    type: object
                    properties:
                      LR_ID:
                        type: integer
                        example: 673
                        description: 'Unique role identifier (primary key).'
                      LR_CP_ID:
                        type: string
                        example: null
                        description: 'CIBS partner ID. NULL for global roles available to all partners.'
                        nullable: true
                      LR_NAME:
                        type: string
                        example: 'aut adipisci quidem'
                        description: 'Role name.'
                      LR_LEVEL:
                        type: integer
                        example: 7
                        description: 'Role level (0–255). Users can only manage roles with lower level.'
                      LR_NOTE:
                        type: string
                        example: null
                        description: 'Free-text note.'
                        nullable: true
                      LR_CREATED:
                        type: string
                        example: '2026-04-05 16:12:19'
                        description: 'Role creation datetime.'
                      LR_L_ID:
                        type: integer
                        example: 1
                        description: 'ID of the operator who created this role.'
                      rights:
                        type: array
                        example:
                          -
                            ID: 650394
                            UR_TYPE: ROLE
                            USER_ID: 1
                            UR_LR_ID: 673
                            NAME: et-modi-ipsum
                            OPTIONS: ''
                            CIBS_VERSION: null
                            UR_CREATED: '2026-01-07 20:23:45'
                            UR_CREATOR_L_ID: 1
                        description: 'Rights assigned to this role. Always loaded.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 650394
                            UR_TYPE:
                              type: string
                              example: ROLE
                            USER_ID:
                              type: integer
                              example: 1
                            UR_LR_ID:
                              type: integer
                              example: 673
                            NAME:
                              type: string
                              example: et-modi-ipsum
                            OPTIONS:
                              type: string
                              example: ''
                            CIBS_VERSION:
                              type: string
                              example: null
                              nullable: true
                            UR_CREATED:
                              type: string
                              example: '2026-01-07 20:23:45'
                            UR_CREATOR_L_ID:
                              type: integer
                              example: 1
                      operators:
                        type: array
                        example:
                          -
                            ID: 5549
                            FIRST_NAME: Isidro
                            SURNAME: McLaughlin
                            LOGIN: ztromp
                            L_LEVEL: 3
                            MAIL: wnitzsche@example.org
                            PHONE: null
                            NOTE: null
                            SALESMAN: 0
                            L_SMS_ENABLE: 0
                            LOG_LEVEL: NOTICE
                            L_CP_ID: null
                            L_CREATED: '2026-03-27 13:07:51'
                            L_L_ID: 1
                            L_ACTIVE: 1
                            L_PASS_EXPIRE: null
                            L_PASS_CHANGE: null
                            L_TYPE: MACHINE
                            L_SIGNATURE: null
                            L_SELFCARE: 0
                            L_CACHE_INITIALS: ''
                            L_INITIALS: null
                            L_STATISTICS_ENABLE: 0
                            pivot:
                              LRC_LR_ID: 673
                              LRC_L_ID: 5549
                        description: 'Operators who have this role assigned. Loaded on show (detail) only.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 5549
                            FIRST_NAME:
                              type: string
                              example: Isidro
                            SURNAME:
                              type: string
                              example: McLaughlin
                            LOGIN:
                              type: string
                              example: ztromp
                            L_LEVEL:
                              type: integer
                              example: 3
                            MAIL:
                              type: string
                              example: wnitzsche@example.org
                            PHONE:
                              type: string
                              example: null
                              nullable: true
                            NOTE:
                              type: string
                              example: null
                              nullable: true
                            SALESMAN:
                              type: integer
                              example: 0
                            L_SMS_ENABLE:
                              type: integer
                              example: 0
                            LOG_LEVEL:
                              type: string
                              example: NOTICE
                            L_CP_ID:
                              type: string
                              example: null
                              nullable: true
                            L_CREATED:
                              type: string
                              example: '2026-03-27 13:07:51'
                            L_L_ID:
                              type: integer
                              example: 1
                            L_ACTIVE:
                              type: integer
                              example: 1
                            L_PASS_EXPIRE:
                              type: string
                              example: null
                              nullable: true
                            L_PASS_CHANGE:
                              type: string
                              example: null
                              nullable: true
                            L_TYPE:
                              type: string
                              example: MACHINE
                            L_SIGNATURE:
                              type: string
                              example: null
                              nullable: true
                            L_SELFCARE:
                              type: integer
                              example: 0
                            L_CACHE_INITIALS:
                              type: string
                              example: ''
                            L_INITIALS:
                              type: string
                              example: null
                              nullable: true
                            L_STATISTICS_ENABLE:
                              type: integer
                              example: 0
                            pivot:
                              type: object
                              properties:
                                LRC_LR_ID:
                                  type: integer
                                  example: 673
                                LRC_L_ID:
                                  type: integer
                                  example: 5549
                    required:
                      - LR_ID
                      - LR_CP_ID
                      - LR_NAME
                      - LR_LEVEL
                      - LR_NOTE
                      - LR_CREATED
                      - LR_L_ID
                      - rights
                      - operators
      tags:
        - 'Operator Roles'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the operator role.'
        example: 9
        required: true
        schema:
          type: integer
  /api/v3/operators:
    get:
      summary: 'List Operators'
      operationId: listOperators
      description: "Returns a paginated list of system operators (admin users).\nBy default only active operators are returned (L_ACTIVE=1).\nUse the `active` filter to include/filter inactive operators.\nPartner-bound users only see operators of their CIBS partner.\nUse `include_internal=true` to also see internal operators (with limited fields)."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page.'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated operator IDs.'
          example: '294,705'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated operator IDs.'
            example: '294,705'
        -
          in: query
          name: active
          description: 'Filter by active status. When omitted, only active operators are returned.'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by active status. When omitted, only active operators are returned.'
            example: 'true'
        -
          in: query
          name: role
          description: 'Filter operators by assigned role ID.'
          example: 12
          required: false
          schema:
            type: integer
            description: 'Filter operators by assigned role ID.'
            example: 12
        -
          in: query
          name: type
          description: 'Filter by operator type (PERSON, MACHINE, COOPERATION).'
          example: PERSON
          required: false
          schema:
            type: string
            description: 'Filter by operator type (PERSON, MACHINE, COOPERATION).'
            example: PERSON
        -
          in: query
          name: search
          description: 'Search in name, surname, login, and email.'
          example: jan
          required: false
          schema:
            type: string
            description: 'Search in name, surname, login, and email.'
            example: jan
        -
          in: query
          name: include_internal
          description: 'Include internal operators (L_CP_ID IS NULL) with limited fields. Only relevant for partner-bound users.'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Include internal operators (L_CP_ID IS NULL) with limited fields. Only relevant for partner-bound users.'
            example: 'true'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 5546
                      FIRST_NAME: Morgan
                      SURNAME: Hirthe
                      LOGIN: pfritsch
                      L_LEVEL: 4
                      MAIL: pauline09@example.com
                      PHONE: null
                      NOTE: null
                      SALESMAN: 0
                      L_SMS_ENABLE: 0
                      LOG_LEVEL: NOTICE
                      L_CP_ID: null
                      L_CREATED: '2026-02-24 07:26:03'
                      L_L_ID: 1
                      L_ACTIVE: 1
                      L_PASS_EXPIRE: null
                      L_PASS_CHANGE: null
                      L_TYPE: MACHINE
                      L_SIGNATURE: null
                      L_SELFCARE: 0
                      L_CACHE_INITIALS: ''
                      L_INITIALS: null
                      L_STATISTICS_ENABLE: 0
                      roles:
                        -
                          LR_ID: 668
                          LR_CP_ID: null
                          LR_NAME: 'deleniti distinctio eum'
                          LR_LEVEL: 2
                          LR_NOTE: null
                          LR_CREATED: '2026-01-17 22:43:15'
                          LR_L_ID: 1
                          pivot:
                            LRC_L_ID: 5546
                            LRC_LR_ID: 668
                      effective_rights:
                        -
                          ID: 316843116
                          USER_ID: 5546
                          NAME: aliquam-veniam-corporis
                          OPTIONS: ''
                      own_rights: []
                    -
                      ID: 5547
                      FIRST_NAME: Amari
                      SURNAME: Torp
                      LOGIN: kirsten.ward
                      L_LEVEL: 9
                      MAIL: anderson.herbert@example.com
                      PHONE: null
                      NOTE: null
                      SALESMAN: 0
                      L_SMS_ENABLE: 0
                      LOG_LEVEL: NOTICE
                      L_CP_ID: null
                      L_CREATED: '2026-03-17 04:25:13'
                      L_L_ID: 1
                      L_ACTIVE: 1
                      L_PASS_EXPIRE: null
                      L_PASS_CHANGE: null
                      L_TYPE: MACHINE
                      L_SIGNATURE: null
                      L_SELFCARE: 0
                      L_CACHE_INITIALS: ''
                      L_INITIALS: null
                      L_STATISTICS_ENABLE: 0
                      roles:
                        -
                          LR_ID: 669
                          LR_CP_ID: null
                          LR_NAME: 'modi rerum ex'
                          LR_LEVEL: 4
                          LR_NOTE: null
                          LR_CREATED: '2026-03-03 00:22:53'
                          LR_L_ID: 1
                          pivot:
                            LRC_L_ID: 5547
                            LRC_LR_ID: 669
                      effective_rights:
                        -
                          ID: 316843117
                          USER_ID: 5547
                          NAME: ab-reiciendis-quia
                          OPTIONS: ''
                      own_rights: []
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 5546
                        FIRST_NAME: Morgan
                        SURNAME: Hirthe
                        LOGIN: pfritsch
                        L_LEVEL: 4
                        MAIL: pauline09@example.com
                        PHONE: null
                        NOTE: null
                        SALESMAN: 0
                        L_SMS_ENABLE: 0
                        LOG_LEVEL: NOTICE
                        L_CP_ID: null
                        L_CREATED: '2026-02-24 07:26:03'
                        L_L_ID: 1
                        L_ACTIVE: 1
                        L_PASS_EXPIRE: null
                        L_PASS_CHANGE: null
                        L_TYPE: MACHINE
                        L_SIGNATURE: null
                        L_SELFCARE: 0
                        L_CACHE_INITIALS: ''
                        L_INITIALS: null
                        L_STATISTICS_ENABLE: 0
                        roles:
                          -
                            LR_ID: 668
                            LR_CP_ID: null
                            LR_NAME: 'deleniti distinctio eum'
                            LR_LEVEL: 2
                            LR_NOTE: null
                            LR_CREATED: '2026-01-17 22:43:15'
                            LR_L_ID: 1
                            pivot:
                              LRC_L_ID: 5546
                              LRC_LR_ID: 668
                        effective_rights:
                          -
                            ID: 316843116
                            USER_ID: 5546
                            NAME: aliquam-veniam-corporis
                            OPTIONS: ''
                        own_rights: []
                      -
                        ID: 5547
                        FIRST_NAME: Amari
                        SURNAME: Torp
                        LOGIN: kirsten.ward
                        L_LEVEL: 9
                        MAIL: anderson.herbert@example.com
                        PHONE: null
                        NOTE: null
                        SALESMAN: 0
                        L_SMS_ENABLE: 0
                        LOG_LEVEL: NOTICE
                        L_CP_ID: null
                        L_CREATED: '2026-03-17 04:25:13'
                        L_L_ID: 1
                        L_ACTIVE: 1
                        L_PASS_EXPIRE: null
                        L_PASS_CHANGE: null
                        L_TYPE: MACHINE
                        L_SIGNATURE: null
                        L_SELFCARE: 0
                        L_CACHE_INITIALS: ''
                        L_INITIALS: null
                        L_STATISTICS_ENABLE: 0
                        roles:
                          -
                            LR_ID: 669
                            LR_CP_ID: null
                            LR_NAME: 'modi rerum ex'
                            LR_LEVEL: 4
                            LR_NOTE: null
                            LR_CREATED: '2026-03-03 00:22:53'
                            LR_L_ID: 1
                            pivot:
                              LRC_L_ID: 5547
                              LRC_LR_ID: 669
                        effective_rights:
                          -
                            ID: 316843117
                            USER_ID: 5547
                            NAME: ab-reiciendis-quia
                            OPTIONS: ''
                        own_rights: []
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 5546
                          description: 'Unique operator identifier (primary key).'
                        FIRST_NAME:
                          type: string
                          example: Morgan
                          description: 'First name of the operator.'
                        SURNAME:
                          type: string
                          example: Hirthe
                          description: 'Surname of the operator.'
                          nullable: true
                        LOGIN:
                          type: string
                          example: pfritsch
                          description: 'Login username (unique).'
                          nullable: true
                        L_LEVEL:
                          type: integer
                          example: 4
                          description: 'Permission level (0–255). Higher level can manage lower-level operators.'
                        MAIL:
                          type: string
                          example: pauline09@example.com
                          description: 'Email address(es), comma-separated.'
                        PHONE:
                          type: string
                          example: null
                          description: 'Phone number (raw bigint).'
                          nullable: true
                        NOTE:
                          type: string
                          example: null
                          description: 'Free-text note.'
                          nullable: true
                        SALESMAN:
                          type: integer
                          example: 0
                          description: 'Flag: operator is a sales representative (0/1).'
                        L_SMS_ENABLE:
                          type: integer
                          example: 0
                          description: 'Flag: can send SMS requests (0/1).'
                        LOG_LEVEL:
                          type: string
                          example: NOTICE
                          description: 'Logging level.'
                          enum:
                            - EMERG
                            - ALERT
                            - CRIT
                            - ERR
                            - WARNING
                            - NOTICE
                            - INFO
                            - DEBUG
                        L_CP_ID:
                          type: string
                          example: null
                          description: 'CIBS partner ID. NULL for internal (global) operators.'
                          nullable: true
                        L_CREATED:
                          type: string
                          example: '2026-02-24 07:26:03'
                          description: 'Account creation datetime.'
                        L_L_ID:
                          type: integer
                          example: 1
                          description: 'ID of the operator who created this account.'
                        L_ACTIVE:
                          type: integer
                          example: 1
                          description: 'Flag: active (1) or inactive (0).'
                        L_PASS_EXPIRE:
                          type: string
                          example: null
                          description: 'Password expiration (days). Positive: N days from last change. Negative: immediate then -N-1 days. 0/NULL: never.'
                          nullable: true
                        L_PASS_CHANGE:
                          type: string
                          example: null
                          description: 'Datetime of last password change.'
                          nullable: true
                        L_TYPE:
                          type: string
                          example: MACHINE
                          description: 'Operator type. "PERSON" = human operator, "MACHINE" = automated agent, "COOPERATION" = external cooperation partner.'
                          enum:
                            - PERSON
                            - MACHINE
                            - COOPERATION
                        L_SIGNATURE:
                          type: string
                          example: null
                          description: 'Scanned signature for document templates.'
                          nullable: true
                        L_SELFCARE:
                          type: integer
                          example: 0
                          description: 'Flag: selfcare operator (0/1).'
                        L_CACHE_INITIALS:
                          type: string
                          example: ''
                          description: 'Computed operator initials cache.'
                        L_INITIALS:
                          type: string
                          example: null
                          description: 'Operator initials (manually set).'
                          nullable: true
                        L_STATISTICS_ENABLE:
                          type: integer
                          example: 0
                          description: 'Flag: login statistics recording enabled (0/1).'
                        roles:
                          type: array
                          example:
                            -
                              LR_ID: 668
                              LR_CP_ID: null
                              LR_NAME: 'deleniti distinctio eum'
                              LR_LEVEL: 2
                              LR_NOTE: null
                              LR_CREATED: '2026-01-17 22:43:15'
                              LR_L_ID: 1
                              pivot:
                                LRC_L_ID: 5546
                                LRC_LR_ID: 668
                          description: 'Roles assigned to this operator. On show, each role includes its rights.'
                          items:
                            type: object
                            properties:
                              LR_ID:
                                type: integer
                                example: 668
                              LR_CP_ID:
                                type: string
                                example: null
                                nullable: true
                              LR_NAME:
                                type: string
                                example: 'deleniti distinctio eum'
                              LR_LEVEL:
                                type: integer
                                example: 2
                              LR_NOTE:
                                type: string
                                example: null
                                nullable: true
                              LR_CREATED:
                                type: string
                                example: '2026-01-17 22:43:15'
                              LR_L_ID:
                                type: integer
                                example: 1
                              pivot:
                                type: object
                                properties:
                                  LRC_L_ID:
                                    type: integer
                                    example: 5546
                                  LRC_LR_ID:
                                    type: integer
                                    example: 668
                        effective_rights:
                          type: array
                          example:
                            -
                              ID: 316843116
                              USER_ID: 5546
                              NAME: aliquam-veniam-corporis
                              OPTIONS: ''
                          description: 'All effective rights (own + role-inherited), computed by the system. Loaded on index and show.'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 316843116
                              USER_ID:
                                type: integer
                                example: 5546
                              NAME:
                                type: string
                                example: aliquam-veniam-corporis
                              OPTIONS:
                                type: string
                                example: ''
                        own_rights:
                          type: array
                          example: []
                          description: 'Rights directly assigned to this operator (not inherited from roles). Loaded on index and show.'
                    required:
                      - ID
                      - FIRST_NAME
                      - SURNAME
                      - LOGIN
                      - L_LEVEL
                      - MAIL
                      - PHONE
                      - NOTE
                      - SALESMAN
                      - L_SMS_ENABLE
                      - LOG_LEVEL
                      - L_CP_ID
                      - L_CREATED
                      - L_L_ID
                      - L_ACTIVE
                      - L_PASS_EXPIRE
                      - L_PASS_CHANGE
                      - L_TYPE
                      - L_SIGNATURE
                      - L_SELFCARE
                      - L_CACHE_INITIALS
                      - L_INITIALS
                      - L_STATISTICS_ENABLE
                      - roles
                      - effective_rights
                      - own_rights
      tags:
        - Operators
  '/api/v3/operators/{id}':
    get:
      summary: 'Get Operator'
      operationId: getOperator
      description: "Returns a single operator by ID, including roles (with their rights),\neffective rights, and own rights."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 5548
                    FIRST_NAME: Morgan
                    SURNAME: Hirthe
                    LOGIN: carey67
                    L_LEVEL: 10
                    MAIL: daphne59@example.com
                    PHONE: null
                    NOTE: null
                    SALESMAN: 0
                    L_SMS_ENABLE: 0
                    LOG_LEVEL: NOTICE
                    L_CP_ID: null
                    L_CREATED: '2026-04-01 01:34:10'
                    L_L_ID: 1
                    L_ACTIVE: 1
                    L_PASS_EXPIRE: null
                    L_PASS_CHANGE: null
                    L_TYPE: MACHINE
                    L_SIGNATURE: null
                    L_SELFCARE: 0
                    L_CACHE_INITIALS: ''
                    L_INITIALS: null
                    L_STATISTICS_ENABLE: 0
                    roles:
                      -
                        LR_ID: 670
                        LR_CP_ID: null
                        LR_NAME: 'aliquam veniam corporis'
                        LR_LEVEL: 3
                        LR_NOTE: null
                        LR_CREATED: '2026-02-16 23:36:19'
                        LR_L_ID: 1
                        pivot:
                          LRC_L_ID: 5548
                          LRC_LR_ID: 670
                        rights:
                          -
                            ID: 650390
                            UR_TYPE: ROLE
                            USER_ID: 1
                            UR_LR_ID: 670
                            NAME: nemo-odit
                            OPTIONS: ''
                            CIBS_VERSION: null
                            UR_CREATED: '2026-01-23 06:43:52'
                            UR_CREATOR_L_ID: 1
                    effective_rights:
                      -
                        ID: 316843118
                        USER_ID: 5548
                        NAME: dignissimos-neque
                        OPTIONS: ''
                    own_rights: []
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 5548
                        description: 'Unique operator identifier (primary key).'
                      FIRST_NAME:
                        type: string
                        example: Morgan
                        description: 'First name of the operator.'
                      SURNAME:
                        type: string
                        example: Hirthe
                        description: 'Surname of the operator.'
                        nullable: true
                      LOGIN:
                        type: string
                        example: carey67
                        description: 'Login username (unique).'
                        nullable: true
                      L_LEVEL:
                        type: integer
                        example: 10
                        description: 'Permission level (0–255). Higher level can manage lower-level operators.'
                      MAIL:
                        type: string
                        example: daphne59@example.com
                        description: 'Email address(es), comma-separated.'
                      PHONE:
                        type: string
                        example: null
                        description: 'Phone number (raw bigint).'
                        nullable: true
                      NOTE:
                        type: string
                        example: null
                        description: 'Free-text note.'
                        nullable: true
                      SALESMAN:
                        type: integer
                        example: 0
                        description: 'Flag: operator is a sales representative (0/1).'
                      L_SMS_ENABLE:
                        type: integer
                        example: 0
                        description: 'Flag: can send SMS requests (0/1).'
                      LOG_LEVEL:
                        type: string
                        example: NOTICE
                        description: 'Logging level.'
                        enum:
                          - EMERG
                          - ALERT
                          - CRIT
                          - ERR
                          - WARNING
                          - NOTICE
                          - INFO
                          - DEBUG
                      L_CP_ID:
                        type: string
                        example: null
                        description: 'CIBS partner ID. NULL for internal (global) operators.'
                        nullable: true
                      L_CREATED:
                        type: string
                        example: '2026-04-01 01:34:10'
                        description: 'Account creation datetime.'
                      L_L_ID:
                        type: integer
                        example: 1
                        description: 'ID of the operator who created this account.'
                      L_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Flag: active (1) or inactive (0).'
                      L_PASS_EXPIRE:
                        type: string
                        example: null
                        description: 'Password expiration (days). Positive: N days from last change. Negative: immediate then -N-1 days. 0/NULL: never.'
                        nullable: true
                      L_PASS_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of last password change.'
                        nullable: true
                      L_TYPE:
                        type: string
                        example: MACHINE
                        description: 'Operator type. "PERSON" = human operator, "MACHINE" = automated agent, "COOPERATION" = external cooperation partner.'
                        enum:
                          - PERSON
                          - MACHINE
                          - COOPERATION
                      L_SIGNATURE:
                        type: string
                        example: null
                        description: 'Scanned signature for document templates.'
                        nullable: true
                      L_SELFCARE:
                        type: integer
                        example: 0
                        description: 'Flag: selfcare operator (0/1).'
                      L_CACHE_INITIALS:
                        type: string
                        example: ''
                        description: 'Computed operator initials cache.'
                      L_INITIALS:
                        type: string
                        example: null
                        description: 'Operator initials (manually set).'
                        nullable: true
                      L_STATISTICS_ENABLE:
                        type: integer
                        example: 0
                        description: 'Flag: login statistics recording enabled (0/1).'
                      roles:
                        type: array
                        example:
                          -
                            LR_ID: 670
                            LR_CP_ID: null
                            LR_NAME: 'aliquam veniam corporis'
                            LR_LEVEL: 3
                            LR_NOTE: null
                            LR_CREATED: '2026-02-16 23:36:19'
                            LR_L_ID: 1
                            pivot:
                              LRC_L_ID: 5548
                              LRC_LR_ID: 670
                            rights:
                              -
                                ID: 650390
                                UR_TYPE: ROLE
                                USER_ID: 1
                                UR_LR_ID: 670
                                NAME: nemo-odit
                                OPTIONS: ''
                                CIBS_VERSION: null
                                UR_CREATED: '2026-01-23 06:43:52'
                                UR_CREATOR_L_ID: 1
                        description: 'Roles assigned to this operator. On show, each role includes its rights.'
                        items:
                          type: object
                          properties:
                            LR_ID:
                              type: integer
                              example: 670
                            LR_CP_ID:
                              type: string
                              example: null
                              nullable: true
                            LR_NAME:
                              type: string
                              example: 'aliquam veniam corporis'
                            LR_LEVEL:
                              type: integer
                              example: 3
                            LR_NOTE:
                              type: string
                              example: null
                              nullable: true
                            LR_CREATED:
                              type: string
                              example: '2026-02-16 23:36:19'
                            LR_L_ID:
                              type: integer
                              example: 1
                            pivot:
                              type: object
                              properties:
                                LRC_L_ID:
                                  type: integer
                                  example: 5548
                                LRC_LR_ID:
                                  type: integer
                                  example: 670
                            rights:
                              type: array
                              example:
                                -
                                  ID: 650390
                                  UR_TYPE: ROLE
                                  USER_ID: 1
                                  UR_LR_ID: 670
                                  NAME: nemo-odit
                                  OPTIONS: ''
                                  CIBS_VERSION: null
                                  UR_CREATED: '2026-01-23 06:43:52'
                                  UR_CREATOR_L_ID: 1
                              items:
                                type: object
                                properties:
                                  ID:
                                    type: integer
                                    example: 650390
                                  UR_TYPE:
                                    type: string
                                    example: ROLE
                                  USER_ID:
                                    type: integer
                                    example: 1
                                  UR_LR_ID:
                                    type: integer
                                    example: 670
                                  NAME:
                                    type: string
                                    example: nemo-odit
                                  OPTIONS:
                                    type: string
                                    example: ''
                                  CIBS_VERSION:
                                    type: string
                                    example: null
                                    nullable: true
                                  UR_CREATED:
                                    type: string
                                    example: '2026-01-23 06:43:52'
                                  UR_CREATOR_L_ID:
                                    type: integer
                                    example: 1
                      effective_rights:
                        type: array
                        example:
                          -
                            ID: 316843118
                            USER_ID: 5548
                            NAME: dignissimos-neque
                            OPTIONS: ''
                        description: 'All effective rights (own + role-inherited), computed by the system. Loaded on index and show.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 316843118
                            USER_ID:
                              type: integer
                              example: 5548
                            NAME:
                              type: string
                              example: dignissimos-neque
                            OPTIONS:
                              type: string
                              example: ''
                      own_rights:
                        type: array
                        example: []
                        description: 'Rights directly assigned to this operator (not inherited from roles). Loaded on index and show.'
                    required:
                      - ID
                      - FIRST_NAME
                      - SURNAME
                      - LOGIN
                      - L_LEVEL
                      - MAIL
                      - PHONE
                      - NOTE
                      - SALESMAN
                      - L_SMS_ENABLE
                      - LOG_LEVEL
                      - L_CP_ID
                      - L_CREATED
                      - L_L_ID
                      - L_ACTIVE
                      - L_PASS_EXPIRE
                      - L_PASS_CHANGE
                      - L_TYPE
                      - L_SIGNATURE
                      - L_SELFCARE
                      - L_CACHE_INITIALS
                      - L_INITIALS
                      - L_STATISTICS_ENABLE
                      - roles
                      - effective_rights
                      - own_rights
      tags:
        - Operators
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the operator.'
        example: 0
        required: true
        schema:
          type: integer
  /api/v3/payment-accounts:
    get:
      summary: 'List Payment Accounts'
      operationId: listPaymentAccounts
      description: "  Returns a paginated list of payment accounts (cash registers and bank accounts).\n  By default only active accounts are returned; use `active=false` for inactive.\n  CT scoping is indirect — only accounts linked to at least one of the\n  user's authorized locations (via pay_account_loc) are visible."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page (max 100).'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of items per page (max 100).'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated payment account IDs.'
          example: '2,11,12'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated payment account IDs.'
            example: '2,11,12'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Returns accounts linked to any of the given locations. Overrides X-CT header default.'
          example: '11,12'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Returns accounts linked to any of the given locations. Overrides X-CT header default.'
            example: '11,12'
        -
          in: query
          name: type
          description: 'Filter by account type.'
          example: cash
          required: false
          schema:
            type: string
            description: 'Filter by account type.'
            example: cash
        -
          in: query
          name: active
          description: 'Filter by active status. When omitted, only active accounts (PA_ACTUAL = 1) are returned.'
          example: 'false'
          required: false
          schema:
            type: string
            description: 'Filter by active status. When omitted, only active accounts (PA_ACTUAL = 1) are returned.'
            example: 'false'
        -
          in: query
          name: search
          description: 'Search by account name (PA_NAME).'
          example: Pokladna
          required: false
          schema:
            type: string
            description: 'Search by account name (PA_NAME).'
            example: Pokladna
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      PA_ID: 1526
                      PA_TYPE: cash
                      PA_CC_ID: 1
                      PA_NAME: 'adipisci quidem nostrum'
                      PA_ACCOUNT_PREFIX: null
                      PA_ACCOUNT_NUMBER: null
                      PA_ACCOUNT_BANK: null
                      PA_IBAN: null
                      PA_IMPORT_TYPE: gpc
                      PA_COLLECTION_TYPE: kpc
                      PA_CP_ID: 1
                      PA_ACTUAL: 1
                      PA_IMPORT_CHECK: STATEMENT_NO
                      PA_IMPORT_DATE: null
                      PA_COMMISSION: none
                      PA_CORRELATION: null
                      PA_CORRELATION_CARD: null
                      PA_CORRELATION_SIPO: null
                      PA_NO_CHARGED: null
                      PA_WRITE_OFF: null
                      PA_EET: null
                      PA_EET_DEFAULT: null
                      PA_EET_SHOP_SIGN: null
                      PA_EET_CASH_SIGN: null
                      PA_EET_NOTIFICATION: null
                      PA_AUTOCONFIRM: 0
                      PA_AUTOCONFIRM_DAY: null
                      PA_AUTOCONFIRM_TYPE: null
                      PA_AUTOCONFIRM_MAKE_PAYMENT: null
                      PA_AUTOCONFIRM_NOTIFICATION: null
                      PA_AUTOCONFIRM_SEND_ALWAYS: null
                      PA_AUTOGENERATE: 0
                      PA_AUTOGENERATE_DAY: null
                      PA_AUTOGENERATE_TYPE: null
                      PA_AUTOGENERATE_NOTIFICATION: null
                      PA_AUTOGENERATE_SEND_ALWAYS: null
                      PA_ROUNDING: null
                      PA_ROUNDING_VALUE: null
                      PA_ROUNDING_REVENUES_ACCOUNT: null
                      PA_ROUNDING_COST_ACCOUNT: null
                      PA_CREATE_L_ID: 1
                      PA_CREATED: '2026-04-05 15:45:24'
                      locations:
                        -
                          PAL_ID: 1553
                          PAL_PA_ID: 1526
                          PAL_CT: 10
                          PAL_PROVIDER_USER_ID: null
                          PAL_DEFAULT: 0
                    -
                      PA_ID: 1527
                      PA_TYPE: cash
                      PA_CC_ID: 1
                      PA_NAME: 'iure odit et'
                      PA_ACCOUNT_PREFIX: null
                      PA_ACCOUNT_NUMBER: null
                      PA_ACCOUNT_BANK: null
                      PA_IBAN: null
                      PA_IMPORT_TYPE: gpc
                      PA_COLLECTION_TYPE: kpc
                      PA_CP_ID: 1
                      PA_ACTUAL: 1
                      PA_IMPORT_CHECK: STATEMENT_NO
                      PA_IMPORT_DATE: null
                      PA_COMMISSION: none
                      PA_CORRELATION: null
                      PA_CORRELATION_CARD: null
                      PA_CORRELATION_SIPO: null
                      PA_NO_CHARGED: null
                      PA_WRITE_OFF: null
                      PA_EET: null
                      PA_EET_DEFAULT: null
                      PA_EET_SHOP_SIGN: null
                      PA_EET_CASH_SIGN: null
                      PA_EET_NOTIFICATION: null
                      PA_AUTOCONFIRM: 0
                      PA_AUTOCONFIRM_DAY: null
                      PA_AUTOCONFIRM_TYPE: null
                      PA_AUTOCONFIRM_MAKE_PAYMENT: null
                      PA_AUTOCONFIRM_NOTIFICATION: null
                      PA_AUTOCONFIRM_SEND_ALWAYS: null
                      PA_AUTOGENERATE: 0
                      PA_AUTOGENERATE_DAY: null
                      PA_AUTOGENERATE_TYPE: null
                      PA_AUTOGENERATE_NOTIFICATION: null
                      PA_AUTOGENERATE_SEND_ALWAYS: null
                      PA_ROUNDING: null
                      PA_ROUNDING_VALUE: null
                      PA_ROUNDING_REVENUES_ACCOUNT: null
                      PA_ROUNDING_COST_ACCOUNT: null
                      PA_CREATE_L_ID: 1
                      PA_CREATED: '2026-03-08 18:51:32'
                      locations:
                        -
                          PAL_ID: 1554
                          PAL_PA_ID: 1527
                          PAL_CT: 8
                          PAL_PROVIDER_USER_ID: null
                          PAL_DEFAULT: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        PA_ID: 1526
                        PA_TYPE: cash
                        PA_CC_ID: 1
                        PA_NAME: 'adipisci quidem nostrum'
                        PA_ACCOUNT_PREFIX: null
                        PA_ACCOUNT_NUMBER: null
                        PA_ACCOUNT_BANK: null
                        PA_IBAN: null
                        PA_IMPORT_TYPE: gpc
                        PA_COLLECTION_TYPE: kpc
                        PA_CP_ID: 1
                        PA_ACTUAL: 1
                        PA_IMPORT_CHECK: STATEMENT_NO
                        PA_IMPORT_DATE: null
                        PA_COMMISSION: none
                        PA_CORRELATION: null
                        PA_CORRELATION_CARD: null
                        PA_CORRELATION_SIPO: null
                        PA_NO_CHARGED: null
                        PA_WRITE_OFF: null
                        PA_EET: null
                        PA_EET_DEFAULT: null
                        PA_EET_SHOP_SIGN: null
                        PA_EET_CASH_SIGN: null
                        PA_EET_NOTIFICATION: null
                        PA_AUTOCONFIRM: 0
                        PA_AUTOCONFIRM_DAY: null
                        PA_AUTOCONFIRM_TYPE: null
                        PA_AUTOCONFIRM_MAKE_PAYMENT: null
                        PA_AUTOCONFIRM_NOTIFICATION: null
                        PA_AUTOCONFIRM_SEND_ALWAYS: null
                        PA_AUTOGENERATE: 0
                        PA_AUTOGENERATE_DAY: null
                        PA_AUTOGENERATE_TYPE: null
                        PA_AUTOGENERATE_NOTIFICATION: null
                        PA_AUTOGENERATE_SEND_ALWAYS: null
                        PA_ROUNDING: null
                        PA_ROUNDING_VALUE: null
                        PA_ROUNDING_REVENUES_ACCOUNT: null
                        PA_ROUNDING_COST_ACCOUNT: null
                        PA_CREATE_L_ID: 1
                        PA_CREATED: '2026-04-05 15:45:24'
                        locations:
                          -
                            PAL_ID: 1553
                            PAL_PA_ID: 1526
                            PAL_CT: 10
                            PAL_PROVIDER_USER_ID: null
                            PAL_DEFAULT: 0
                      -
                        PA_ID: 1527
                        PA_TYPE: cash
                        PA_CC_ID: 1
                        PA_NAME: 'iure odit et'
                        PA_ACCOUNT_PREFIX: null
                        PA_ACCOUNT_NUMBER: null
                        PA_ACCOUNT_BANK: null
                        PA_IBAN: null
                        PA_IMPORT_TYPE: gpc
                        PA_COLLECTION_TYPE: kpc
                        PA_CP_ID: 1
                        PA_ACTUAL: 1
                        PA_IMPORT_CHECK: STATEMENT_NO
                        PA_IMPORT_DATE: null
                        PA_COMMISSION: none
                        PA_CORRELATION: null
                        PA_CORRELATION_CARD: null
                        PA_CORRELATION_SIPO: null
                        PA_NO_CHARGED: null
                        PA_WRITE_OFF: null
                        PA_EET: null
                        PA_EET_DEFAULT: null
                        PA_EET_SHOP_SIGN: null
                        PA_EET_CASH_SIGN: null
                        PA_EET_NOTIFICATION: null
                        PA_AUTOCONFIRM: 0
                        PA_AUTOCONFIRM_DAY: null
                        PA_AUTOCONFIRM_TYPE: null
                        PA_AUTOCONFIRM_MAKE_PAYMENT: null
                        PA_AUTOCONFIRM_NOTIFICATION: null
                        PA_AUTOCONFIRM_SEND_ALWAYS: null
                        PA_AUTOGENERATE: 0
                        PA_AUTOGENERATE_DAY: null
                        PA_AUTOGENERATE_TYPE: null
                        PA_AUTOGENERATE_NOTIFICATION: null
                        PA_AUTOGENERATE_SEND_ALWAYS: null
                        PA_ROUNDING: null
                        PA_ROUNDING_VALUE: null
                        PA_ROUNDING_REVENUES_ACCOUNT: null
                        PA_ROUNDING_COST_ACCOUNT: null
                        PA_CREATE_L_ID: 1
                        PA_CREATED: '2026-03-08 18:51:32'
                        locations:
                          -
                            PAL_ID: 1554
                            PAL_PA_ID: 1527
                            PAL_CT: 8
                            PAL_PROVIDER_USER_ID: null
                            PAL_DEFAULT: 0
                    items:
                      type: object
                      properties:
                        PA_ID:
                          type: integer
                          example: 1526
                          description: 'Unique payment account identifier (primary key).'
                        PA_TYPE:
                          type: string
                          example: cash
                          description: "Account type: 'cash' = cash register, 'bank' = bank account."
                          enum:
                            - cash
                            - bank
                        PA_CC_ID:
                          type: integer
                          example: 1
                          description: 'Currency code FK (→ currency_codes.CC_ID).'
                        PA_NAME:
                          type: string
                          example: 'adipisci quidem nostrum'
                          description: 'Display name of the account (max 40 chars).'
                        PA_ACCOUNT_PREFIX:
                          type: string
                          example: null
                          description: 'Bank account prefix (Czech format, up to 6 digits).'
                          nullable: true
                        PA_ACCOUNT_NUMBER:
                          type: string
                          example: null
                          description: 'Bank account number (up to 17 digits).'
                          nullable: true
                        PA_ACCOUNT_BANK:
                          type: string
                          example: null
                          description: 'Bank code (4-digit Czech bank code).'
                          nullable: true
                        PA_IBAN:
                          type: string
                          example: null
                          description: 'International Bank Account Number (IBAN).'
                          nullable: true
                        PA_IMPORT_TYPE:
                          type: string
                          example: gpc
                          description: 'Bank statement import format.'
                          enum:
                            - gpc
                            - csv
                            - txt
                            - ace
                            - uni
                            - acr
                            - MT940
                            - gpp
                            - citi
                            - rbsv
                            - csas
                            - SAP
                        PA_COLLECTION_TYPE:
                          type: string
                          example: kpc
                          description: 'Collection file format.'
                          enum:
                            - kpc
                            - gemini
                        PA_CP_ID:
                          type: integer
                          example: 1
                          description: 'CIBS partner FK — the partner this account belongs to.'
                        PA_ACTUAL:
                          type: integer
                          example: 1
                          description: 'Active flag. 1 = current/active, 0 = inactive.'
                        PA_IMPORT_CHECK:
                          type: string
                          example: STATEMENT_NO
                          description: 'Duplicate detection method during import.'
                          enum:
                            - NONE
                            - STATEMENT_NO
                            - RECORD_NO
                            - DATA
                        PA_IMPORT_DATE:
                          type: string
                          example: null
                          description: "Date source for import: 'head' = statement header, 'item' = transaction item."
                          nullable: true
                          enum:
                            - head
                            - item
                        PA_COMMISSION:
                          type: string
                          example: none
                          description: "Card payment commission import mode: 'none' or 'txt'."
                          enum:
                            - none
                            - txt
                        PA_CORRELATION:
                          type: string
                          example: null
                          description: 'Ledger account number for accounting correlation.'
                          nullable: true
                        PA_CORRELATION_CARD:
                          type: string
                          example: null
                          description: 'Ledger account for card payment correlation.'
                          nullable: true
                        PA_CORRELATION_SIPO:
                          type: string
                          example: null
                          description: 'Ledger account for SIPO payment correlation.'
                          nullable: true
                        PA_NO_CHARGED:
                          type: string
                          example: null
                          description: 'Non-accounting register flag (cash registers only).'
                          nullable: true
                        PA_WRITE_OFF:
                          type: string
                          example: null
                          description: 'Write-off register flag (cash registers only).'
                          nullable: true
                        PA_EET:
                          type: string
                          example: null
                          description: 'EET enabled flag.'
                          nullable: true
                        PA_EET_DEFAULT:
                          type: string
                          example: null
                          description: 'Default EET register flag.'
                          nullable: true
                        PA_EET_SHOP_SIGN:
                          type: string
                          example: null
                          description: 'EET shop identification number.'
                          nullable: true
                        PA_EET_CASH_SIGN:
                          type: string
                          example: null
                          description: 'EET cash register identifier.'
                          nullable: true
                        PA_EET_NOTIFICATION:
                          type: string
                          example: null
                          description: 'EET notification template (longtext).'
                          nullable: true
                        PA_AUTOCONFIRM:
                          type: integer
                          example: 0
                          description: 'Auto-confirmation of payments enabled flag.'
                        PA_AUTOCONFIRM_DAY:
                          type: string
                          example: null
                          description: 'Day of month for auto-confirmation.'
                          nullable: true
                        PA_AUTOCONFIRM_TYPE:
                          type: string
                          example: null
                          description: "Auto-confirmation scope: 'ALL', 'CIBS', or 'OTHER'."
                          nullable: true
                          enum:
                            - ALL
                            - CIBS
                            - OTHER
                        PA_AUTOCONFIRM_MAKE_PAYMENT:
                          type: string
                          example: null
                          description: 'Also create payment during auto-confirmation.'
                          nullable: true
                        PA_AUTOCONFIRM_NOTIFICATION:
                          type: string
                          example: null
                          description: 'Auto-confirmation notification template.'
                          nullable: true
                        PA_AUTOCONFIRM_SEND_ALWAYS:
                          type: string
                          example: null
                          description: 'Always send auto-confirmation notification.'
                          nullable: true
                        PA_AUTOGENERATE:
                          type: integer
                          example: 0
                          description: 'Auto-generation of payment orders enabled flag.'
                        PA_AUTOGENERATE_DAY:
                          type: string
                          example: null
                          description: 'Day of month for auto-generation.'
                          nullable: true
                        PA_AUTOGENERATE_TYPE:
                          type: string
                          example: null
                          description: "Auto-generation scope: 'ALL', 'CIBS', or 'OTHER'."
                          nullable: true
                          enum:
                            - ALL
                            - CIBS
                            - OTHER
                        PA_AUTOGENERATE_NOTIFICATION:
                          type: string
                          example: null
                          description: 'Auto-generation notification template.'
                          nullable: true
                        PA_AUTOGENERATE_SEND_ALWAYS:
                          type: string
                          example: null
                          description: 'Always send auto-generation notification.'
                          nullable: true
                        PA_ROUNDING:
                          type: string
                          example: null
                          description: 'Payment rounding enabled flag (cash registers only).'
                          nullable: true
                        PA_ROUNDING_VALUE:
                          type: string
                          example: null
                          description: 'Maximum rounding value (decimal).'
                          nullable: true
                        PA_ROUNDING_REVENUES_ACCOUNT:
                          type: string
                          example: null
                          description: 'Ledger account for rounding revenues.'
                          nullable: true
                        PA_ROUNDING_COST_ACCOUNT:
                          type: string
                          example: null
                          description: 'Ledger account for rounding costs.'
                          nullable: true
                        PA_CREATE_L_ID:
                          type: integer
                          example: 1
                          description: 'Operator ID who created this record.'
                        PA_CREATED:
                          type: string
                          example: '2026-04-05 15:45:24'
                          description: 'Creation timestamp (YYYY-MM-DD HH:MM:SS).'
                        locations:
                          type: array
                          example:
                            -
                              PAL_ID: 1553
                              PAL_PA_ID: 1526
                              PAL_CT: 10
                              PAL_PROVIDER_USER_ID: null
                              PAL_DEFAULT: 0
                          description: 'Business locations (CTs) where this payment account operates.'
                          items:
                            type: object
                            properties:
                              PAL_ID:
                                type: integer
                                example: 1553
                              PAL_PA_ID:
                                type: integer
                                example: 1526
                              PAL_CT:
                                type: integer
                                example: 10
                              PAL_PROVIDER_USER_ID:
                                type: string
                                example: null
                                nullable: true
                              PAL_DEFAULT:
                                type: integer
                                example: 0
                    required:
                      - PA_ID
                      - PA_TYPE
                      - PA_CC_ID
                      - PA_NAME
                      - PA_ACCOUNT_PREFIX
                      - PA_ACCOUNT_NUMBER
                      - PA_ACCOUNT_BANK
                      - PA_IBAN
                      - PA_IMPORT_TYPE
                      - PA_COLLECTION_TYPE
                      - PA_CP_ID
                      - PA_ACTUAL
                      - PA_IMPORT_CHECK
                      - PA_IMPORT_DATE
                      - PA_COMMISSION
                      - PA_CORRELATION
                      - PA_CORRELATION_CARD
                      - PA_CORRELATION_SIPO
                      - PA_NO_CHARGED
                      - PA_WRITE_OFF
                      - PA_EET
                      - PA_EET_DEFAULT
                      - PA_EET_SHOP_SIGN
                      - PA_EET_CASH_SIGN
                      - PA_EET_NOTIFICATION
                      - PA_AUTOCONFIRM
                      - PA_AUTOCONFIRM_DAY
                      - PA_AUTOCONFIRM_TYPE
                      - PA_AUTOCONFIRM_MAKE_PAYMENT
                      - PA_AUTOCONFIRM_NOTIFICATION
                      - PA_AUTOCONFIRM_SEND_ALWAYS
                      - PA_AUTOGENERATE
                      - PA_AUTOGENERATE_DAY
                      - PA_AUTOGENERATE_TYPE
                      - PA_AUTOGENERATE_NOTIFICATION
                      - PA_AUTOGENERATE_SEND_ALWAYS
                      - PA_ROUNDING
                      - PA_ROUNDING_VALUE
                      - PA_ROUNDING_REVENUES_ACCOUNT
                      - PA_ROUNDING_COST_ACCOUNT
                      - PA_CREATE_L_ID
                      - PA_CREATED
                      - locations
      tags:
        - 'Payment Accounts'
  '/api/v3/payment-accounts/{id}':
    get:
      summary: 'Get Payment Account'
      operationId: getPaymentAccount
      description: '  Returns a single payment account by ID, including its business location assignments.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    PA_ID: 1528
                    PA_TYPE: cash
                    PA_CC_ID: 1
                    PA_NAME: 'adipisci quidem nostrum'
                    PA_ACCOUNT_PREFIX: null
                    PA_ACCOUNT_NUMBER: null
                    PA_ACCOUNT_BANK: null
                    PA_IBAN: null
                    PA_IMPORT_TYPE: gpc
                    PA_COLLECTION_TYPE: kpc
                    PA_CP_ID: 1
                    PA_ACTUAL: 1
                    PA_IMPORT_CHECK: STATEMENT_NO
                    PA_IMPORT_DATE: null
                    PA_COMMISSION: none
                    PA_CORRELATION: null
                    PA_CORRELATION_CARD: null
                    PA_CORRELATION_SIPO: null
                    PA_NO_CHARGED: null
                    PA_WRITE_OFF: null
                    PA_EET: null
                    PA_EET_DEFAULT: null
                    PA_EET_SHOP_SIGN: null
                    PA_EET_CASH_SIGN: null
                    PA_EET_NOTIFICATION: null
                    PA_AUTOCONFIRM: 0
                    PA_AUTOCONFIRM_DAY: null
                    PA_AUTOCONFIRM_TYPE: null
                    PA_AUTOCONFIRM_MAKE_PAYMENT: null
                    PA_AUTOCONFIRM_NOTIFICATION: null
                    PA_AUTOCONFIRM_SEND_ALWAYS: null
                    PA_AUTOGENERATE: 0
                    PA_AUTOGENERATE_DAY: null
                    PA_AUTOGENERATE_TYPE: null
                    PA_AUTOGENERATE_NOTIFICATION: null
                    PA_AUTOGENERATE_SEND_ALWAYS: null
                    PA_ROUNDING: null
                    PA_ROUNDING_VALUE: null
                    PA_ROUNDING_REVENUES_ACCOUNT: null
                    PA_ROUNDING_COST_ACCOUNT: null
                    PA_CREATE_L_ID: 1
                    PA_CREATED: '2026-04-05 15:45:24'
                    locations:
                      -
                        PAL_ID: 1555
                        PAL_PA_ID: 1528
                        PAL_CT: 10
                        PAL_PROVIDER_USER_ID: null
                        PAL_DEFAULT: 0
                properties:
                  data:
                    type: object
                    properties:
                      PA_ID:
                        type: integer
                        example: 1528
                        description: 'Unique payment account identifier (primary key).'
                      PA_TYPE:
                        type: string
                        example: cash
                        description: "Account type: 'cash' = cash register, 'bank' = bank account."
                        enum:
                          - cash
                          - bank
                      PA_CC_ID:
                        type: integer
                        example: 1
                        description: 'Currency code FK (→ currency_codes.CC_ID).'
                      PA_NAME:
                        type: string
                        example: 'adipisci quidem nostrum'
                        description: 'Display name of the account (max 40 chars).'
                      PA_ACCOUNT_PREFIX:
                        type: string
                        example: null
                        description: 'Bank account prefix (Czech format, up to 6 digits).'
                        nullable: true
                      PA_ACCOUNT_NUMBER:
                        type: string
                        example: null
                        description: 'Bank account number (up to 17 digits).'
                        nullable: true
                      PA_ACCOUNT_BANK:
                        type: string
                        example: null
                        description: 'Bank code (4-digit Czech bank code).'
                        nullable: true
                      PA_IBAN:
                        type: string
                        example: null
                        description: 'International Bank Account Number (IBAN).'
                        nullable: true
                      PA_IMPORT_TYPE:
                        type: string
                        example: gpc
                        description: 'Bank statement import format.'
                        enum:
                          - gpc
                          - csv
                          - txt
                          - ace
                          - uni
                          - acr
                          - MT940
                          - gpp
                          - citi
                          - rbsv
                          - csas
                          - SAP
                      PA_COLLECTION_TYPE:
                        type: string
                        example: kpc
                        description: 'Collection file format.'
                        enum:
                          - kpc
                          - gemini
                      PA_CP_ID:
                        type: integer
                        example: 1
                        description: 'CIBS partner FK — the partner this account belongs to.'
                      PA_ACTUAL:
                        type: integer
                        example: 1
                        description: 'Active flag. 1 = current/active, 0 = inactive.'
                      PA_IMPORT_CHECK:
                        type: string
                        example: STATEMENT_NO
                        description: 'Duplicate detection method during import.'
                        enum:
                          - NONE
                          - STATEMENT_NO
                          - RECORD_NO
                          - DATA
                      PA_IMPORT_DATE:
                        type: string
                        example: null
                        description: "Date source for import: 'head' = statement header, 'item' = transaction item."
                        nullable: true
                        enum:
                          - head
                          - item
                      PA_COMMISSION:
                        type: string
                        example: none
                        description: "Card payment commission import mode: 'none' or 'txt'."
                        enum:
                          - none
                          - txt
                      PA_CORRELATION:
                        type: string
                        example: null
                        description: 'Ledger account number for accounting correlation.'
                        nullable: true
                      PA_CORRELATION_CARD:
                        type: string
                        example: null
                        description: 'Ledger account for card payment correlation.'
                        nullable: true
                      PA_CORRELATION_SIPO:
                        type: string
                        example: null
                        description: 'Ledger account for SIPO payment correlation.'
                        nullable: true
                      PA_NO_CHARGED:
                        type: string
                        example: null
                        description: 'Non-accounting register flag (cash registers only).'
                        nullable: true
                      PA_WRITE_OFF:
                        type: string
                        example: null
                        description: 'Write-off register flag (cash registers only).'
                        nullable: true
                      PA_EET:
                        type: string
                        example: null
                        description: 'EET enabled flag.'
                        nullable: true
                      PA_EET_DEFAULT:
                        type: string
                        example: null
                        description: 'Default EET register flag.'
                        nullable: true
                      PA_EET_SHOP_SIGN:
                        type: string
                        example: null
                        description: 'EET shop identification number.'
                        nullable: true
                      PA_EET_CASH_SIGN:
                        type: string
                        example: null
                        description: 'EET cash register identifier.'
                        nullable: true
                      PA_EET_NOTIFICATION:
                        type: string
                        example: null
                        description: 'EET notification template (longtext).'
                        nullable: true
                      PA_AUTOCONFIRM:
                        type: integer
                        example: 0
                        description: 'Auto-confirmation of payments enabled flag.'
                      PA_AUTOCONFIRM_DAY:
                        type: string
                        example: null
                        description: 'Day of month for auto-confirmation.'
                        nullable: true
                      PA_AUTOCONFIRM_TYPE:
                        type: string
                        example: null
                        description: "Auto-confirmation scope: 'ALL', 'CIBS', or 'OTHER'."
                        nullable: true
                        enum:
                          - ALL
                          - CIBS
                          - OTHER
                      PA_AUTOCONFIRM_MAKE_PAYMENT:
                        type: string
                        example: null
                        description: 'Also create payment during auto-confirmation.'
                        nullable: true
                      PA_AUTOCONFIRM_NOTIFICATION:
                        type: string
                        example: null
                        description: 'Auto-confirmation notification template.'
                        nullable: true
                      PA_AUTOCONFIRM_SEND_ALWAYS:
                        type: string
                        example: null
                        description: 'Always send auto-confirmation notification.'
                        nullable: true
                      PA_AUTOGENERATE:
                        type: integer
                        example: 0
                        description: 'Auto-generation of payment orders enabled flag.'
                      PA_AUTOGENERATE_DAY:
                        type: string
                        example: null
                        description: 'Day of month for auto-generation.'
                        nullable: true
                      PA_AUTOGENERATE_TYPE:
                        type: string
                        example: null
                        description: "Auto-generation scope: 'ALL', 'CIBS', or 'OTHER'."
                        nullable: true
                        enum:
                          - ALL
                          - CIBS
                          - OTHER
                      PA_AUTOGENERATE_NOTIFICATION:
                        type: string
                        example: null
                        description: 'Auto-generation notification template.'
                        nullable: true
                      PA_AUTOGENERATE_SEND_ALWAYS:
                        type: string
                        example: null
                        description: 'Always send auto-generation notification.'
                        nullable: true
                      PA_ROUNDING:
                        type: string
                        example: null
                        description: 'Payment rounding enabled flag (cash registers only).'
                        nullable: true
                      PA_ROUNDING_VALUE:
                        type: string
                        example: null
                        description: 'Maximum rounding value (decimal).'
                        nullable: true
                      PA_ROUNDING_REVENUES_ACCOUNT:
                        type: string
                        example: null
                        description: 'Ledger account for rounding revenues.'
                        nullable: true
                      PA_ROUNDING_COST_ACCOUNT:
                        type: string
                        example: null
                        description: 'Ledger account for rounding costs.'
                        nullable: true
                      PA_CREATE_L_ID:
                        type: integer
                        example: 1
                        description: 'Operator ID who created this record.'
                      PA_CREATED:
                        type: string
                        example: '2026-04-05 15:45:24'
                        description: 'Creation timestamp (YYYY-MM-DD HH:MM:SS).'
                      locations:
                        type: array
                        example:
                          -
                            PAL_ID: 1555
                            PAL_PA_ID: 1528
                            PAL_CT: 10
                            PAL_PROVIDER_USER_ID: null
                            PAL_DEFAULT: 0
                        description: 'Business locations (CTs) where this payment account operates.'
                        items:
                          type: object
                          properties:
                            PAL_ID:
                              type: integer
                              example: 1555
                            PAL_PA_ID:
                              type: integer
                              example: 1528
                            PAL_CT:
                              type: integer
                              example: 10
                            PAL_PROVIDER_USER_ID:
                              type: string
                              example: null
                              nullable: true
                            PAL_DEFAULT:
                              type: integer
                              example: 0
                    required:
                      - PA_ID
                      - PA_TYPE
                      - PA_CC_ID
                      - PA_NAME
                      - PA_ACCOUNT_PREFIX
                      - PA_ACCOUNT_NUMBER
                      - PA_ACCOUNT_BANK
                      - PA_IBAN
                      - PA_IMPORT_TYPE
                      - PA_COLLECTION_TYPE
                      - PA_CP_ID
                      - PA_ACTUAL
                      - PA_IMPORT_CHECK
                      - PA_IMPORT_DATE
                      - PA_COMMISSION
                      - PA_CORRELATION
                      - PA_CORRELATION_CARD
                      - PA_CORRELATION_SIPO
                      - PA_NO_CHARGED
                      - PA_WRITE_OFF
                      - PA_EET
                      - PA_EET_DEFAULT
                      - PA_EET_SHOP_SIGN
                      - PA_EET_CASH_SIGN
                      - PA_EET_NOTIFICATION
                      - PA_AUTOCONFIRM
                      - PA_AUTOCONFIRM_DAY
                      - PA_AUTOCONFIRM_TYPE
                      - PA_AUTOCONFIRM_MAKE_PAYMENT
                      - PA_AUTOCONFIRM_NOTIFICATION
                      - PA_AUTOCONFIRM_SEND_ALWAYS
                      - PA_AUTOGENERATE
                      - PA_AUTOGENERATE_DAY
                      - PA_AUTOGENERATE_TYPE
                      - PA_AUTOGENERATE_NOTIFICATION
                      - PA_AUTOGENERATE_SEND_ALWAYS
                      - PA_ROUNDING
                      - PA_ROUNDING_VALUE
                      - PA_ROUNDING_REVENUES_ACCOUNT
                      - PA_ROUNDING_COST_ACCOUNT
                      - PA_CREATE_L_ID
                      - PA_CREATED
                      - locations
      tags:
        - 'Payment Accounts'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the payment account.'
        example: 2
        required: true
        schema:
          type: integer
  /api/v3/payments:
    get:
      summary: 'List Payments'
      operationId: listPayments
      description: "  Returns a paginated list of payments.\n  **At least one** of the following filters must be provided:\n  `customer`, `account`, `date_from`, `var_symbol`.\n  Without a narrowing filter the endpoint returns HTTP 422."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated payment IDs.'
          example: '100,200,300'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated payment IDs.'
            example: '100,200,300'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID.'
          example: 1009
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID.'
            example: 1009
        -
          in: query
          name: account
          description: 'Filter by payment account ID.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by payment account ID.'
            example: 1
        -
          in: query
          name: type
          description: 'Filter by payment method (TYPE column).'
          example: P
          required: false
          schema:
            type: string
            description: 'Filter by payment method (TYPE column).'
            example: P
        -
          in: query
          name: join_type
          description: 'Filter by matching status. U = Mango, O = Other, S = SIPO, N = Unmatched, C = Card.'
          example: U
          required: false
          schema:
            type: string
            description: 'Filter by matching status. U = Mango, O = Other, S = SIPO, N = Unmatched, C = Card.'
            example: U
        -
          in: query
          name: date_from
          description: 'Filter payments on or after this date (YYYY-MM-DD).'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter payments on or after this date (YYYY-MM-DD).'
            example: '2024-01-01'
        -
          in: query
          name: date_to
          description: 'Filter payments on or before this date (YYYY-MM-DD).'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter payments on or before this date (YYYY-MM-DD).'
            example: '2024-12-31'
        -
          in: query
          name: var_symbol
          description: 'Filter by variable symbol.'
          example: 1234567890
          required: false
          schema:
            type: integer
            description: 'Filter by variable symbol.'
            example: 1234567890
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 24911376
                      PL_PA_ID: null
                      PAYMENT_DATE: '1981-11-20'
                      PL_DATE_ACCOUNT_BANK: null
                      AMOUNT: '9473.3378'
                      TYPE: H
                      VAR_SYMBOL: 7214902
                      PL_SPEC_SYMBOL: null
                      PL_KONS_SYMBOL: null
                      USER_ID: 5485
                      CT: 95
                      NOTE: null
                      SYS_TIME: '2026-04-20 11:25:58'
                      PL_DOC_ID: null
                      PL_JOIN_TYPE: S
                      PL_BANK_DOC_ID: null
                      PL_BANK_ACC_PREFIX: null
                      PL_BANK_ACC_NUMBER: null
                      PL_BANK_ACC_BANK: null
                      PL_IBAN: null
                      PL_SIPO_ID: null
                      PL_FLAG: O
                      PL_MATCHING_STRATEGY: 0
                      PL_INTERNAL_ID: null
                      PL_DATE_DEATTACH: null
                      PL_AUTHOR_DEATTACH: null
                      PL_UDF_TYPE: null
                      PL_DEATTACH: null
                      PL_DEATTACH_ATTACH: null
                      PL_CREATE_L_ID: null
                      PL_CREATED: null
                      PL_CHANGE_L_ID: null
                      PL_CHANGED: null
                      PL_PF_ID: null
                      PL_PROVIDER_USER_ID: null
                      PL_CREDIT_NOTE_ADVANCE: null
                      PL_CACHE_ATTACHED: null
                      PL_CACHE_ADVANCE: null
                    -
                      ID: 24911377
                      PL_PA_ID: null
                      PAYMENT_DATE: '1990-01-29'
                      PL_DATE_ACCOUNT_BANK: null
                      AMOUNT: '-7760.2620'
                      TYPE: P
                      VAR_SYMBOL: 8265058
                      PL_SPEC_SYMBOL: null
                      PL_KONS_SYMBOL: null
                      USER_ID: 6877
                      CT: 76
                      NOTE: 'Consequatur aut dolores enim non facere tempora.'
                      SYS_TIME: '2026-04-20 11:25:58'
                      PL_DOC_ID: null
                      PL_JOIN_TYPE: S
                      PL_BANK_DOC_ID: null
                      PL_BANK_ACC_PREFIX: null
                      PL_BANK_ACC_NUMBER: null
                      PL_BANK_ACC_BANK: null
                      PL_IBAN: null
                      PL_SIPO_ID: null
                      PL_FLAG: O
                      PL_MATCHING_STRATEGY: 0
                      PL_INTERNAL_ID: null
                      PL_DATE_DEATTACH: null
                      PL_AUTHOR_DEATTACH: null
                      PL_UDF_TYPE: null
                      PL_DEATTACH: null
                      PL_DEATTACH_ATTACH: null
                      PL_CREATE_L_ID: null
                      PL_CREATED: null
                      PL_CHANGE_L_ID: null
                      PL_CHANGED: null
                      PL_PF_ID: null
                      PL_PROVIDER_USER_ID: null
                      PL_CREDIT_NOTE_ADVANCE: null
                      PL_CACHE_ATTACHED: null
                      PL_CACHE_ADVANCE: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 24911376
                        PL_PA_ID: null
                        PAYMENT_DATE: '1981-11-20'
                        PL_DATE_ACCOUNT_BANK: null
                        AMOUNT: '9473.3378'
                        TYPE: H
                        VAR_SYMBOL: 7214902
                        PL_SPEC_SYMBOL: null
                        PL_KONS_SYMBOL: null
                        USER_ID: 5485
                        CT: 95
                        NOTE: null
                        SYS_TIME: '2026-04-20 11:25:58'
                        PL_DOC_ID: null
                        PL_JOIN_TYPE: S
                        PL_BANK_DOC_ID: null
                        PL_BANK_ACC_PREFIX: null
                        PL_BANK_ACC_NUMBER: null
                        PL_BANK_ACC_BANK: null
                        PL_IBAN: null
                        PL_SIPO_ID: null
                        PL_FLAG: O
                        PL_MATCHING_STRATEGY: 0
                        PL_INTERNAL_ID: null
                        PL_DATE_DEATTACH: null
                        PL_AUTHOR_DEATTACH: null
                        PL_UDF_TYPE: null
                        PL_DEATTACH: null
                        PL_DEATTACH_ATTACH: null
                        PL_CREATE_L_ID: null
                        PL_CREATED: null
                        PL_CHANGE_L_ID: null
                        PL_CHANGED: null
                        PL_PF_ID: null
                        PL_PROVIDER_USER_ID: null
                        PL_CREDIT_NOTE_ADVANCE: null
                        PL_CACHE_ATTACHED: null
                        PL_CACHE_ADVANCE: null
                      -
                        ID: 24911377
                        PL_PA_ID: null
                        PAYMENT_DATE: '1990-01-29'
                        PL_DATE_ACCOUNT_BANK: null
                        AMOUNT: '-7760.2620'
                        TYPE: P
                        VAR_SYMBOL: 8265058
                        PL_SPEC_SYMBOL: null
                        PL_KONS_SYMBOL: null
                        USER_ID: 6877
                        CT: 76
                        NOTE: 'Consequatur aut dolores enim non facere tempora.'
                        SYS_TIME: '2026-04-20 11:25:58'
                        PL_DOC_ID: null
                        PL_JOIN_TYPE: S
                        PL_BANK_DOC_ID: null
                        PL_BANK_ACC_PREFIX: null
                        PL_BANK_ACC_NUMBER: null
                        PL_BANK_ACC_BANK: null
                        PL_IBAN: null
                        PL_SIPO_ID: null
                        PL_FLAG: O
                        PL_MATCHING_STRATEGY: 0
                        PL_INTERNAL_ID: null
                        PL_DATE_DEATTACH: null
                        PL_AUTHOR_DEATTACH: null
                        PL_UDF_TYPE: null
                        PL_DEATTACH: null
                        PL_DEATTACH_ATTACH: null
                        PL_CREATE_L_ID: null
                        PL_CREATED: null
                        PL_CHANGE_L_ID: null
                        PL_CHANGED: null
                        PL_PF_ID: null
                        PL_PROVIDER_USER_ID: null
                        PL_CREDIT_NOTE_ADVANCE: null
                        PL_CACHE_ATTACHED: null
                        PL_CACHE_ADVANCE: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 24911376
                          description: 'Unique payment identifier (primary key).'
                        PL_PA_ID:
                          type: string
                          example: null
                          description: 'Payment account (cash register / bank account) ID. See GET /v3/payment-accounts/{id}.'
                          nullable: true
                        PAYMENT_DATE:
                          type: string
                          example: '1981-11-20'
                          description: 'Payment date (YYYY-MM-DD).'
                        PL_DATE_ACCOUNT_BANK:
                          type: string
                          example: null
                          description: 'Bank settlement date (YYYY-MM-DD).'
                          nullable: true
                        AMOUNT:
                          type: string
                          example: '9473.3378'
                          description: 'Payment amount (decimal, 4 decimal places).'
                        TYPE:
                          type: string
                          example: H
                          description: 'Payment method code (e.g. P = bank transfer, H = cash).'
                        VAR_SYMBOL:
                          type: integer
                          example: 7214902
                          description: 'Variable symbol — used for payment identification and matching.'
                          nullable: true
                        PL_SPEC_SYMBOL:
                          type: string
                          example: null
                          description: 'Specific symbol.'
                          nullable: true
                        PL_KONS_SYMBOL:
                          type: string
                          example: null
                          description: 'Constant symbol.'
                          nullable: true
                        USER_ID:
                          type: integer
                          example: 5485
                          description: 'Customer ID this payment belongs to. See GET /v3/customers/{id}.'
                          nullable: true
                        CT:
                          type: integer
                          example: 95
                          description: 'Location (installation) ID — multi-tenant discriminator.'
                          nullable: true
                        NOTE:
                          type: string
                          example: null
                          description: 'Payment note / description.'
                          nullable: true
                        SYS_TIME:
                          type: string
                          example: '2026-04-20 11:25:58'
                          description: 'Last modification timestamp (auto-updated).'
                        PL_DOC_ID:
                          type: string
                          example: null
                          description: 'Receipt / document ID.'
                          nullable: true
                        PL_JOIN_TYPE:
                          type: string
                          example: S
                          description: 'Matching status. U = Mango (matched automatically), O = Other, S = SIPO, N = Unmatched, C = Card.'
                          enum:
                            - U
                            - O
                            - S
                            - 'N'
                            - C
                        PL_BANK_DOC_ID:
                          type: string
                          example: null
                          description: 'Bank statement document ID.'
                          nullable: true
                        PL_BANK_ACC_PREFIX:
                          type: string
                          example: null
                          description: 'Counter-party bank account prefix.'
                          nullable: true
                        PL_BANK_ACC_NUMBER:
                          type: string
                          example: null
                          description: 'Counter-party bank account number.'
                          nullable: true
                        PL_BANK_ACC_BANK:
                          type: string
                          example: null
                          description: 'Counter-party bank code.'
                          nullable: true
                        PL_IBAN:
                          type: string
                          example: null
                          description: 'Counter-party IBAN.'
                          nullable: true
                        PL_SIPO_ID:
                          type: string
                          example: null
                          description: 'SIPO identification code.'
                          nullable: true
                        PL_FLAG:
                          type: string
                          example: O
                          description: 'Payment flag. O = ordinary, B = balance sheet.'
                          enum:
                            - O
                            - B
                        PL_MATCHING_STRATEGY:
                          type: integer
                          example: 0
                          description: 'Matching strategy identifier.'
                        PL_INTERNAL_ID:
                          type: string
                          example: null
                          description: 'Internal reference ID (for linked/split payments).'
                          nullable: true
                        PL_DATE_DEATTACH:
                          type: string
                          example: null
                          description: 'Detachment datetime.'
                          nullable: true
                        PL_AUTHOR_DEATTACH:
                          type: string
                          example: null
                          description: 'Operator ID who performed the detachment.'
                          nullable: true
                        PL_UDF_TYPE:
                          type: string
                          example: null
                          description: 'User-defined field type.'
                          nullable: true
                        PL_DEATTACH:
                          type: string
                          example: null
                          description: 'Detachment flag.'
                          nullable: true
                        PL_DEATTACH_ATTACH:
                          type: string
                          example: null
                          description: 'Detach-and-reattach flag.'
                          nullable: true
                        PL_CREATE_L_ID:
                          type: string
                          example: null
                          description: 'Operator login ID who created the record.'
                          nullable: true
                        PL_CREATED:
                          type: string
                          example: null
                          description: 'Creation datetime.'
                          nullable: true
                        PL_CHANGE_L_ID:
                          type: string
                          example: null
                          description: 'Operator login ID who last modified the record.'
                          nullable: true
                        PL_CHANGED:
                          type: string
                          example: null
                          description: 'Last change datetime.'
                          nullable: true
                        PL_PF_ID:
                          type: string
                          example: null
                          description: 'Payment file ID (import batch reference).'
                          nullable: true
                        PL_PROVIDER_USER_ID:
                          type: string
                          example: null
                          description: 'Provider customer ID (for provider-level payments).'
                          nullable: true
                        PL_CREDIT_NOTE_ADVANCE:
                          type: string
                          example: null
                          description: 'Credit note advance flag.'
                          nullable: true
                        PL_CACHE_ATTACHED:
                          type: string
                          example: null
                          description: 'Cached total of matched (attached) amount.'
                          nullable: true
                        PL_CACHE_ADVANCE:
                          type: string
                          example: null
                          description: 'Cached advance (overpayment) amount.'
                          nullable: true
                    required:
                      - ID
                      - PL_PA_ID
                      - PAYMENT_DATE
                      - PL_DATE_ACCOUNT_BANK
                      - AMOUNT
                      - TYPE
                      - VAR_SYMBOL
                      - PL_SPEC_SYMBOL
                      - PL_KONS_SYMBOL
                      - USER_ID
                      - CT
                      - NOTE
                      - SYS_TIME
                      - PL_DOC_ID
                      - PL_JOIN_TYPE
                      - PL_BANK_DOC_ID
                      - PL_BANK_ACC_PREFIX
                      - PL_BANK_ACC_NUMBER
                      - PL_BANK_ACC_BANK
                      - PL_IBAN
                      - PL_SIPO_ID
                      - PL_FLAG
                      - PL_MATCHING_STRATEGY
                      - PL_INTERNAL_ID
                      - PL_DATE_DEATTACH
                      - PL_AUTHOR_DEATTACH
                      - PL_UDF_TYPE
                      - PL_DEATTACH
                      - PL_DEATTACH_ATTACH
                      - PL_CREATE_L_ID
                      - PL_CREATED
                      - PL_CHANGE_L_ID
                      - PL_CHANGED
                      - PL_PF_ID
                      - PL_PROVIDER_USER_ID
                      - PL_CREDIT_NOTE_ADVANCE
                      - PL_CACHE_ATTACHED
                      - PL_CACHE_ADVANCE
      tags:
        - Payments
  '/api/v3/payments/{id}':
    get:
      summary: 'Get Payment'
      operationId: getPayment
      description: '  Returns a single payment by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 24911378
                    PL_PA_ID: null
                    PAYMENT_DATE: '1981-11-20'
                    PL_DATE_ACCOUNT_BANK: null
                    AMOUNT: '9473.3378'
                    TYPE: H
                    VAR_SYMBOL: 8988862
                    PL_SPEC_SYMBOL: null
                    PL_KONS_SYMBOL: null
                    USER_ID: 5485
                    CT: 95
                    NOTE: null
                    SYS_TIME: '2026-04-20 11:25:58'
                    PL_DOC_ID: null
                    PL_JOIN_TYPE: S
                    PL_BANK_DOC_ID: null
                    PL_BANK_ACC_PREFIX: null
                    PL_BANK_ACC_NUMBER: null
                    PL_BANK_ACC_BANK: null
                    PL_IBAN: null
                    PL_SIPO_ID: null
                    PL_FLAG: O
                    PL_MATCHING_STRATEGY: 0
                    PL_INTERNAL_ID: null
                    PL_DATE_DEATTACH: null
                    PL_AUTHOR_DEATTACH: null
                    PL_UDF_TYPE: null
                    PL_DEATTACH: null
                    PL_DEATTACH_ATTACH: null
                    PL_CREATE_L_ID: null
                    PL_CREATED: null
                    PL_CHANGE_L_ID: null
                    PL_CHANGED: null
                    PL_PF_ID: null
                    PL_PROVIDER_USER_ID: null
                    PL_CREDIT_NOTE_ADVANCE: null
                    PL_CACHE_ATTACHED: null
                    PL_CACHE_ADVANCE: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 24911378
                        description: 'Unique payment identifier (primary key).'
                      PL_PA_ID:
                        type: string
                        example: null
                        description: 'Payment account (cash register / bank account) ID. See GET /v3/payment-accounts/{id}.'
                        nullable: true
                      PAYMENT_DATE:
                        type: string
                        example: '1981-11-20'
                        description: 'Payment date (YYYY-MM-DD).'
                      PL_DATE_ACCOUNT_BANK:
                        type: string
                        example: null
                        description: 'Bank settlement date (YYYY-MM-DD).'
                        nullable: true
                      AMOUNT:
                        type: string
                        example: '9473.3378'
                        description: 'Payment amount (decimal, 4 decimal places).'
                      TYPE:
                        type: string
                        example: H
                        description: 'Payment method code (e.g. P = bank transfer, H = cash).'
                      VAR_SYMBOL:
                        type: integer
                        example: 8988862
                        description: 'Variable symbol — used for payment identification and matching.'
                        nullable: true
                      PL_SPEC_SYMBOL:
                        type: string
                        example: null
                        description: 'Specific symbol.'
                        nullable: true
                      PL_KONS_SYMBOL:
                        type: string
                        example: null
                        description: 'Constant symbol.'
                        nullable: true
                      USER_ID:
                        type: integer
                        example: 5485
                        description: 'Customer ID this payment belongs to. See GET /v3/customers/{id}.'
                        nullable: true
                      CT:
                        type: integer
                        example: 95
                        description: 'Location (installation) ID — multi-tenant discriminator.'
                        nullable: true
                      NOTE:
                        type: string
                        example: null
                        description: 'Payment note / description.'
                        nullable: true
                      SYS_TIME:
                        type: string
                        example: '2026-04-20 11:25:58'
                        description: 'Last modification timestamp (auto-updated).'
                      PL_DOC_ID:
                        type: string
                        example: null
                        description: 'Receipt / document ID.'
                        nullable: true
                      PL_JOIN_TYPE:
                        type: string
                        example: S
                        description: 'Matching status. U = Mango (matched automatically), O = Other, S = SIPO, N = Unmatched, C = Card.'
                        enum:
                          - U
                          - O
                          - S
                          - 'N'
                          - C
                      PL_BANK_DOC_ID:
                        type: string
                        example: null
                        description: 'Bank statement document ID.'
                        nullable: true
                      PL_BANK_ACC_PREFIX:
                        type: string
                        example: null
                        description: 'Counter-party bank account prefix.'
                        nullable: true
                      PL_BANK_ACC_NUMBER:
                        type: string
                        example: null
                        description: 'Counter-party bank account number.'
                        nullable: true
                      PL_BANK_ACC_BANK:
                        type: string
                        example: null
                        description: 'Counter-party bank code.'
                        nullable: true
                      PL_IBAN:
                        type: string
                        example: null
                        description: 'Counter-party IBAN.'
                        nullable: true
                      PL_SIPO_ID:
                        type: string
                        example: null
                        description: 'SIPO identification code.'
                        nullable: true
                      PL_FLAG:
                        type: string
                        example: O
                        description: 'Payment flag. O = ordinary, B = balance sheet.'
                        enum:
                          - O
                          - B
                      PL_MATCHING_STRATEGY:
                        type: integer
                        example: 0
                        description: 'Matching strategy identifier.'
                      PL_INTERNAL_ID:
                        type: string
                        example: null
                        description: 'Internal reference ID (for linked/split payments).'
                        nullable: true
                      PL_DATE_DEATTACH:
                        type: string
                        example: null
                        description: 'Detachment datetime.'
                        nullable: true
                      PL_AUTHOR_DEATTACH:
                        type: string
                        example: null
                        description: 'Operator ID who performed the detachment.'
                        nullable: true
                      PL_UDF_TYPE:
                        type: string
                        example: null
                        description: 'User-defined field type.'
                        nullable: true
                      PL_DEATTACH:
                        type: string
                        example: null
                        description: 'Detachment flag.'
                        nullable: true
                      PL_DEATTACH_ATTACH:
                        type: string
                        example: null
                        description: 'Detach-and-reattach flag.'
                        nullable: true
                      PL_CREATE_L_ID:
                        type: string
                        example: null
                        description: 'Operator login ID who created the record.'
                        nullable: true
                      PL_CREATED:
                        type: string
                        example: null
                        description: 'Creation datetime.'
                        nullable: true
                      PL_CHANGE_L_ID:
                        type: string
                        example: null
                        description: 'Operator login ID who last modified the record.'
                        nullable: true
                      PL_CHANGED:
                        type: string
                        example: null
                        description: 'Last change datetime.'
                        nullable: true
                      PL_PF_ID:
                        type: string
                        example: null
                        description: 'Payment file ID (import batch reference).'
                        nullable: true
                      PL_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider customer ID (for provider-level payments).'
                        nullable: true
                      PL_CREDIT_NOTE_ADVANCE:
                        type: string
                        example: null
                        description: 'Credit note advance flag.'
                        nullable: true
                      PL_CACHE_ATTACHED:
                        type: string
                        example: null
                        description: 'Cached total of matched (attached) amount.'
                        nullable: true
                      PL_CACHE_ADVANCE:
                        type: string
                        example: null
                        description: 'Cached advance (overpayment) amount.'
                        nullable: true
                    required:
                      - ID
                      - PL_PA_ID
                      - PAYMENT_DATE
                      - PL_DATE_ACCOUNT_BANK
                      - AMOUNT
                      - TYPE
                      - VAR_SYMBOL
                      - PL_SPEC_SYMBOL
                      - PL_KONS_SYMBOL
                      - USER_ID
                      - CT
                      - NOTE
                      - SYS_TIME
                      - PL_DOC_ID
                      - PL_JOIN_TYPE
                      - PL_BANK_DOC_ID
                      - PL_BANK_ACC_PREFIX
                      - PL_BANK_ACC_NUMBER
                      - PL_BANK_ACC_BANK
                      - PL_IBAN
                      - PL_SIPO_ID
                      - PL_FLAG
                      - PL_MATCHING_STRATEGY
                      - PL_INTERNAL_ID
                      - PL_DATE_DEATTACH
                      - PL_AUTHOR_DEATTACH
                      - PL_UDF_TYPE
                      - PL_DEATTACH
                      - PL_DEATTACH_ATTACH
                      - PL_CREATE_L_ID
                      - PL_CREATED
                      - PL_CHANGE_L_ID
                      - PL_CHANGED
                      - PL_PF_ID
                      - PL_PROVIDER_USER_ID
                      - PL_CREDIT_NOTE_ADVANCE
                      - PL_CACHE_ATTACHED
                      - PL_CACHE_ADVANCE
      tags:
        - Payments
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the payment.'
        example: 259
        required: true
        schema:
          type: integer
  '/api/v3/processes/{process}/jobs':
    get:
      summary: 'List Process Jobs'
      operationId: listProcessJobs
      description: "Returns a paginated list of jobs for a given process.\n\nJobs are always scoped to the parent process. Process visibility follows same rules as Mango Opcare. (Set the right `MAINTENANCE_LIST.VIEW` to value `%.%` for unrestricted access. See [Mango documentation](https://wiki.mango.cloud/) for details.)"
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated job IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated job IDs'
            example: '1,2,3'
        -
          in: query
          name: state
          description: 'Filter by job state: PLANNED, DONE, CANCELED'
          example: PLANNED
          required: false
          schema:
            type: string
            description: 'Filter by job state: PLANNED, DONE, CANCELED'
            example: PLANNED
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      MJ_ID: 3432496
                      MJ_ML_ID: 1462358
                      MJ_ML_ORDER: null
                      MJ_PLANNING_POLICY: NONE
                      MJ_MJT_ID: '050'
                      MJ_MJK_ID: null
                      MJ_START: '2026-04-05 16:17:42'
                      MJ_STOP: null
                      MJ_DURATION: 169
                      MJ_RECURRENCE: null
                      MJ_CACHE_RECURRENCE_HR: null
                      MJ_SERMAN_ID: null
                      MJ_SG_ID: null
                      MJ_STATE: PLANNED
                      MJ_DESCRIPTION: null
                      MJ_NOTE: null
                      MJ_PRIVATE: 0
                      MJ_DONE_TIME: null
                      MJ_L_ID: '005542'
                      MJ_CREATED: '2026-02-18 15:00:09'
                      MJ_EDITED: '2026-04-20 11:25:52'
                      MJ_REAL_FINISH_TIME: null
                      MJ_POINTS: null
                      MJ_TIME_BLOCK_ID: null
                      MJ_DATE: null
                      MJ_FROM_DATE: null
                      MJ_FROM_MTB_ID: null
                      MJ_TO_DATE: null
                      MJ_TO_MTB_ID: null
                      MJ_LINKED_MJ_ID: null
                      MJ_REAL_START_TIME: null
                      MJ_AUTO_DONE: 0
                      MJ_AUTO_DONE_MOMENT: null
                      MJ_AUTO_DONE_ACTION: null
                      MJ_CUSTOMER_COOP: 0
                      MJ_INSERT_PAYMENT: null
                      MJ_LAST_ACTION: null
                      MJ_GA_ID: null
                      MJ_UCP_ID: null
                      MJ_US_ID: null
                      MJ_UA_ID: null
                      MJ_STREET: null
                      MJ_HOUSE_ID: null
                      MJ_ZIP: null
                      MJ_CITY: null
                      MJ_WORK_TIME: null
                      MJ_CACHE_START: null
                      MJ_CACHE_STOP: null
                      MJ_CACHE_MAX_STOP: null
                      MJ_EXPEDICE: null
                      MJ_EXPEDANT_ID: null
                      MJ_MJ_PREV_STARTED: null
                      MJ_MJ_PREV_FINISHED: null
                      MJ_PLANNING: 0
                      attendees:
                        -
                          MJA_ID: 1668423
                          MJA_JOIN_TYPE: JOB
                          MJA_OBJ_ID: 3432496
                          MJA_L_ID: null
                          MJA_EMAIL: modesta58@example.net
                          MJA_RESPONSE_STATUS: accepted
                          MJA_RESPONSE_NOTE: 'Reiciendis quia perspiciatis deserunt ducimus corrupti et.'
                    -
                      MJ_ID: 3432497
                      MJ_ML_ID: 1462359
                      MJ_ML_ORDER: null
                      MJ_PLANNING_POLICY: TIMEBLOCK_RANGE
                      MJ_MJT_ID: '100'
                      MJ_MJK_ID: null
                      MJ_START: null
                      MJ_STOP: null
                      MJ_DURATION: 273
                      MJ_RECURRENCE: null
                      MJ_CACHE_RECURRENCE_HR: null
                      MJ_SERMAN_ID: null
                      MJ_SG_ID: null
                      MJ_STATE: CANCELED
                      MJ_DESCRIPTION: 'Nesciunt ut ratione iure impedit molestiae ut rem.'
                      MJ_NOTE: null
                      MJ_PRIVATE: 0
                      MJ_DONE_TIME: null
                      MJ_L_ID: '005543'
                      MJ_CREATED: '2026-04-11 11:37:03'
                      MJ_EDITED: '2026-04-20 11:25:52'
                      MJ_REAL_FINISH_TIME: null
                      MJ_POINTS: null
                      MJ_TIME_BLOCK_ID: null
                      MJ_DATE: null
                      MJ_FROM_DATE: null
                      MJ_FROM_MTB_ID: null
                      MJ_TO_DATE: null
                      MJ_TO_MTB_ID: null
                      MJ_LINKED_MJ_ID: null
                      MJ_REAL_START_TIME: null
                      MJ_AUTO_DONE: 0
                      MJ_AUTO_DONE_MOMENT: null
                      MJ_AUTO_DONE_ACTION: null
                      MJ_CUSTOMER_COOP: 0
                      MJ_INSERT_PAYMENT: null
                      MJ_LAST_ACTION: null
                      MJ_GA_ID: null
                      MJ_UCP_ID: null
                      MJ_US_ID: null
                      MJ_UA_ID: null
                      MJ_STREET: null
                      MJ_HOUSE_ID: null
                      MJ_ZIP: null
                      MJ_CITY: null
                      MJ_WORK_TIME: null
                      MJ_CACHE_START: null
                      MJ_CACHE_STOP: null
                      MJ_CACHE_MAX_STOP: null
                      MJ_EXPEDICE: null
                      MJ_EXPEDANT_ID: null
                      MJ_MJ_PREV_STARTED: null
                      MJ_MJ_PREV_FINISHED: null
                      MJ_PLANNING: 0
                      attendees:
                        -
                          MJA_ID: 1668424
                          MJA_JOIN_TYPE: JOB
                          MJA_OBJ_ID: 3432497
                          MJA_L_ID: null
                          MJA_EMAIL: brutherford@example.com
                          MJA_RESPONSE_STATUS: needsAction
                          MJA_RESPONSE_NOTE: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        MJ_ID: 3432496
                        MJ_ML_ID: 1462358
                        MJ_ML_ORDER: null
                        MJ_PLANNING_POLICY: NONE
                        MJ_MJT_ID: '050'
                        MJ_MJK_ID: null
                        MJ_START: '2026-04-05 16:17:42'
                        MJ_STOP: null
                        MJ_DURATION: 169
                        MJ_RECURRENCE: null
                        MJ_CACHE_RECURRENCE_HR: null
                        MJ_SERMAN_ID: null
                        MJ_SG_ID: null
                        MJ_STATE: PLANNED
                        MJ_DESCRIPTION: null
                        MJ_NOTE: null
                        MJ_PRIVATE: 0
                        MJ_DONE_TIME: null
                        MJ_L_ID: '005542'
                        MJ_CREATED: '2026-02-18 15:00:09'
                        MJ_EDITED: '2026-04-20 11:25:52'
                        MJ_REAL_FINISH_TIME: null
                        MJ_POINTS: null
                        MJ_TIME_BLOCK_ID: null
                        MJ_DATE: null
                        MJ_FROM_DATE: null
                        MJ_FROM_MTB_ID: null
                        MJ_TO_DATE: null
                        MJ_TO_MTB_ID: null
                        MJ_LINKED_MJ_ID: null
                        MJ_REAL_START_TIME: null
                        MJ_AUTO_DONE: 0
                        MJ_AUTO_DONE_MOMENT: null
                        MJ_AUTO_DONE_ACTION: null
                        MJ_CUSTOMER_COOP: 0
                        MJ_INSERT_PAYMENT: null
                        MJ_LAST_ACTION: null
                        MJ_GA_ID: null
                        MJ_UCP_ID: null
                        MJ_US_ID: null
                        MJ_UA_ID: null
                        MJ_STREET: null
                        MJ_HOUSE_ID: null
                        MJ_ZIP: null
                        MJ_CITY: null
                        MJ_WORK_TIME: null
                        MJ_CACHE_START: null
                        MJ_CACHE_STOP: null
                        MJ_CACHE_MAX_STOP: null
                        MJ_EXPEDICE: null
                        MJ_EXPEDANT_ID: null
                        MJ_MJ_PREV_STARTED: null
                        MJ_MJ_PREV_FINISHED: null
                        MJ_PLANNING: 0
                        attendees:
                          -
                            MJA_ID: 1668423
                            MJA_JOIN_TYPE: JOB
                            MJA_OBJ_ID: 3432496
                            MJA_L_ID: null
                            MJA_EMAIL: modesta58@example.net
                            MJA_RESPONSE_STATUS: accepted
                            MJA_RESPONSE_NOTE: 'Reiciendis quia perspiciatis deserunt ducimus corrupti et.'
                      -
                        MJ_ID: 3432497
                        MJ_ML_ID: 1462359
                        MJ_ML_ORDER: null
                        MJ_PLANNING_POLICY: TIMEBLOCK_RANGE
                        MJ_MJT_ID: '100'
                        MJ_MJK_ID: null
                        MJ_START: null
                        MJ_STOP: null
                        MJ_DURATION: 273
                        MJ_RECURRENCE: null
                        MJ_CACHE_RECURRENCE_HR: null
                        MJ_SERMAN_ID: null
                        MJ_SG_ID: null
                        MJ_STATE: CANCELED
                        MJ_DESCRIPTION: 'Nesciunt ut ratione iure impedit molestiae ut rem.'
                        MJ_NOTE: null
                        MJ_PRIVATE: 0
                        MJ_DONE_TIME: null
                        MJ_L_ID: '005543'
                        MJ_CREATED: '2026-04-11 11:37:03'
                        MJ_EDITED: '2026-04-20 11:25:52'
                        MJ_REAL_FINISH_TIME: null
                        MJ_POINTS: null
                        MJ_TIME_BLOCK_ID: null
                        MJ_DATE: null
                        MJ_FROM_DATE: null
                        MJ_FROM_MTB_ID: null
                        MJ_TO_DATE: null
                        MJ_TO_MTB_ID: null
                        MJ_LINKED_MJ_ID: null
                        MJ_REAL_START_TIME: null
                        MJ_AUTO_DONE: 0
                        MJ_AUTO_DONE_MOMENT: null
                        MJ_AUTO_DONE_ACTION: null
                        MJ_CUSTOMER_COOP: 0
                        MJ_INSERT_PAYMENT: null
                        MJ_LAST_ACTION: null
                        MJ_GA_ID: null
                        MJ_UCP_ID: null
                        MJ_US_ID: null
                        MJ_UA_ID: null
                        MJ_STREET: null
                        MJ_HOUSE_ID: null
                        MJ_ZIP: null
                        MJ_CITY: null
                        MJ_WORK_TIME: null
                        MJ_CACHE_START: null
                        MJ_CACHE_STOP: null
                        MJ_CACHE_MAX_STOP: null
                        MJ_EXPEDICE: null
                        MJ_EXPEDANT_ID: null
                        MJ_MJ_PREV_STARTED: null
                        MJ_MJ_PREV_FINISHED: null
                        MJ_PLANNING: 0
                        attendees:
                          -
                            MJA_ID: 1668424
                            MJA_JOIN_TYPE: JOB
                            MJA_OBJ_ID: 3432497
                            MJA_L_ID: null
                            MJA_EMAIL: brutherford@example.com
                            MJA_RESPONSE_STATUS: needsAction
                            MJA_RESPONSE_NOTE: null
                    items:
                      type: object
                      properties:
                        MJ_ID:
                          type: integer
                          example: 3432496
                          description: 'Unique job ID.'
                        MJ_ML_ID:
                          type: integer
                          example: 1462358
                          description: 'Parent process (maintenance list) ID. References maintenance_list.'
                          nullable: true
                        MJ_ML_ORDER:
                          type: string
                          example: null
                          description: 'Order of the job within the process.'
                          nullable: true
                        MJ_PLANNING_POLICY:
                          type: string
                          example: NONE
                          description: 'Scheduling policy for the job. Determines which date/time fields are relevant.'
                          enum:
                            - LONGTIME
                            - TIMEBLOCK
                            - TIMEBLOCK_RANGE
                            - SEQUENCE
                            - NONE
                        MJ_MJT_ID:
                          type: string
                          example: '050'
                          description: 'Job type ID. References maintenance_job_types.'
                        MJ_MJK_ID:
                          type: string
                          example: null
                          description: 'Job kind (category) ID. References maintenance_job_kinds.'
                          nullable: true
                        MJ_START:
                          type: string
                          example: '2026-04-05 16:17:42'
                          description: 'Planned start date and time.'
                          nullable: true
                        MJ_STOP:
                          type: string
                          example: null
                          description: 'Planned end date and time.'
                          nullable: true
                        MJ_DURATION:
                          type: integer
                          example: 169
                          description: 'Expected duration of the job in minutes.'
                          nullable: true
                        MJ_RECURRENCE:
                          type: string
                          example: null
                          description: 'Recurrence rule definition string.'
                          nullable: true
                        MJ_CACHE_RECURRENCE_HR:
                          type: string
                          example: null
                          description: 'Cached human-readable representation of the recurrence rule.'
                          nullable: true
                        MJ_SERMAN_ID:
                          type: string
                          example: null
                          description: 'Assigned resource (serviceman) login ID. References logins.'
                          nullable: true
                        MJ_SG_ID:
                          type: string
                          example: null
                          description: 'Service group ID. References serman_groups.'
                          nullable: true
                        MJ_STATE:
                          type: string
                          example: PLANNED
                          description: 'Current state of the job.'
                          enum:
                            - PLANNED
                            - DONE
                            - CANCELED
                        MJ_DESCRIPTION:
                          type: string
                          example: null
                          description: 'Task description / name of the job.'
                          nullable: true
                        MJ_NOTE:
                          type: string
                          example: null
                          description: 'Note or progress log for the job.'
                          nullable: true
                        MJ_PRIVATE:
                          type: integer
                          example: 0
                          description: 'Whether the job is visible only to its assigned resource in the calendar. 1 = private, 0 = public.'
                        MJ_DONE_TIME:
                          type: string
                          example: null
                          description: 'Timestamp when the job was marked as done.'
                          nullable: true
                        MJ_L_ID:
                          type: string
                          example: '005542'
                          description: 'Login ID of the user who created or owns this job. References logins.'
                        MJ_CREATED:
                          type: string
                          example: '2026-02-18 15:00:09'
                          description: 'Timestamp when the job was created.'
                        MJ_EDITED:
                          type: string
                          example: '2026-04-20 11:25:52'
                          description: 'Timestamp when the job was last edited.'
                          nullable: true
                        MJ_REAL_FINISH_TIME:
                          type: string
                          example: null
                          description: 'Actual finish date recorded by the assignee.'
                          nullable: true
                        MJ_POINTS:
                          type: string
                          example: null
                          description: 'Number of capacity points consumed by this job.'
                          nullable: true
                        MJ_TIME_BLOCK_ID:
                          type: string
                          example: null
                          description: 'Assigned time-block ID. References maintenance_time_block.'
                          nullable: true
                        MJ_DATE:
                          type: string
                          example: null
                          description: 'Scheduled date for the job.'
                          nullable: true
                        MJ_FROM_DATE:
                          type: string
                          example: null
                          description: 'Start date for time-block or range scheduling.'
                          nullable: true
                        MJ_FROM_MTB_ID:
                          type: string
                          example: null
                          description: 'Start time-block ID. References maintenance_time_block.'
                          nullable: true
                        MJ_TO_DATE:
                          type: string
                          example: null
                          description: 'End date for time-block range scheduling.'
                          nullable: true
                        MJ_TO_MTB_ID:
                          type: string
                          example: null
                          description: 'End time-block ID. References maintenance_time_block.'
                          nullable: true
                        MJ_LINKED_MJ_ID:
                          type: string
                          example: null
                          description: 'ID of a linked job (self-reference to maintenance_jobs).'
                          nullable: true
                        MJ_REAL_START_TIME:
                          type: string
                          example: null
                          description: 'Actual start time recorded by the assignee.'
                          nullable: true
                        MJ_AUTO_DONE:
                          type: integer
                          example: 0
                          description: 'Whether the job should be automatically marked as done. 1 = yes, 0 = no.'
                        MJ_AUTO_DONE_MOMENT:
                          type: string
                          example: null
                          description: 'When to trigger auto-done.'
                          nullable: true
                          enum:
                            - ON_CREATE
                            - ON_START
                        MJ_AUTO_DONE_ACTION:
                          type: string
                          example: null
                          description: 'Action identifier to execute when auto-done is triggered.'
                          nullable: true
                        MJ_CUSTOMER_COOP:
                          type: integer
                          example: 0
                          description: 'Whether customer presence is required while processing the job. 1 = yes, 0 = no.'
                        MJ_INSERT_PAYMENT:
                          type: string
                          example: null
                          description: 'Payment flag or payment record ID associated with this job.'
                          nullable: true
                        MJ_LAST_ACTION:
                          type: string
                          example: null
                          description: 'Identifier of the last action performed on this job.'
                          nullable: true
                        MJ_GA_ID:
                          type: string
                          example: null
                          description: 'Group address ID. References groups_address.'
                          nullable: true
                        MJ_UCP_ID:
                          type: string
                          example: null
                          description: 'UIR city part ID. References uir_city_parts.'
                          nullable: true
                        MJ_US_ID:
                          type: string
                          example: null
                          description: 'UIR street ID. References uir_streets.'
                          nullable: true
                        MJ_UA_ID:
                          type: string
                          example: null
                          description: 'UIR address ID. References uir_addresses.'
                          nullable: true
                        MJ_STREET:
                          type: string
                          example: null
                          description: 'Street name of the job location.'
                          nullable: true
                        MJ_HOUSE_ID:
                          type: string
                          example: null
                          description: 'House number at the job location.'
                          nullable: true
                        MJ_ZIP:
                          type: string
                          example: null
                          description: 'ZIP / postal code of the job location.'
                          nullable: true
                        MJ_CITY:
                          type: string
                          example: null
                          description: 'City of the job location.'
                          nullable: true
                        MJ_WORK_TIME:
                          type: string
                          example: null
                          description: 'Actual work time spent on the job in minutes.'
                          nullable: true
                        MJ_CACHE_START:
                          type: string
                          example: null
                          description: 'Cached computed start datetime (resolved from scheduling rules).'
                          nullable: true
                        MJ_CACHE_STOP:
                          type: string
                          example: null
                          description: 'Cached computed end datetime (resolved from scheduling rules).'
                          nullable: true
                        MJ_CACHE_MAX_STOP:
                          type: string
                          example: null
                          description: 'Cached maximum possible end datetime.'
                          nullable: true
                        MJ_EXPEDICE:
                          type: string
                          example: null
                          description: 'Whether expedition (dispatch) is enabled for this job. 1 = yes, 0 = no.'
                          nullable: true
                        MJ_EXPEDANT_ID:
                          type: string
                          example: null
                          description: 'ID of the dispatcher (expedient) who dispatched this job.'
                          nullable: true
                        MJ_MJ_PREV_STARTED:
                          type: string
                          example: null
                          description: 'ID of a predecessor job that must be started before this job becomes available.'
                          nullable: true
                        MJ_MJ_PREV_FINISHED:
                          type: string
                          example: null
                          description: 'ID of a predecessor job that must be finished (DONE) before this job becomes available.'
                          nullable: true
                        MJ_PLANNING:
                          type: integer
                          example: 0
                          description: 'Whether this job is used only for planning/scheduling other jobs. 1 = planning-only, 0 = regular job.'
                        attendees:
                          type: array
                          example:
                            -
                              MJA_ID: 1668423
                              MJA_JOIN_TYPE: JOB
                              MJA_OBJ_ID: 3432496
                              MJA_L_ID: null
                              MJA_EMAIL: modesta58@example.net
                              MJA_RESPONSE_STATUS: accepted
                              MJA_RESPONSE_NOTE: 'Reiciendis quia perspiciatis deserunt ducimus corrupti et.'
                          description: 'List of attendees assigned to this job.'
                          items:
                            type: object
                            properties:
                              MJA_ID:
                                type: integer
                                example: 1668423
                              MJA_JOIN_TYPE:
                                type: string
                                example: JOB
                              MJA_OBJ_ID:
                                type: integer
                                example: 3432496
                              MJA_L_ID:
                                type: string
                                example: null
                                nullable: true
                              MJA_EMAIL:
                                type: string
                                example: modesta58@example.net
                              MJA_RESPONSE_STATUS:
                                type: string
                                example: accepted
                              MJA_RESPONSE_NOTE:
                                type: string
                                example: 'Reiciendis quia perspiciatis deserunt ducimus corrupti et.'
                    required:
                      - MJ_ID
                      - MJ_ML_ID
                      - MJ_ML_ORDER
                      - MJ_PLANNING_POLICY
                      - MJ_MJT_ID
                      - MJ_MJK_ID
                      - MJ_START
                      - MJ_STOP
                      - MJ_DURATION
                      - MJ_RECURRENCE
                      - MJ_CACHE_RECURRENCE_HR
                      - MJ_SERMAN_ID
                      - MJ_SG_ID
                      - MJ_STATE
                      - MJ_DESCRIPTION
                      - MJ_NOTE
                      - MJ_PRIVATE
                      - MJ_DONE_TIME
                      - MJ_L_ID
                      - MJ_CREATED
                      - MJ_EDITED
                      - MJ_REAL_FINISH_TIME
                      - MJ_POINTS
                      - MJ_TIME_BLOCK_ID
                      - MJ_DATE
                      - MJ_FROM_DATE
                      - MJ_FROM_MTB_ID
                      - MJ_TO_DATE
                      - MJ_TO_MTB_ID
                      - MJ_LINKED_MJ_ID
                      - MJ_REAL_START_TIME
                      - MJ_AUTO_DONE
                      - MJ_AUTO_DONE_MOMENT
                      - MJ_AUTO_DONE_ACTION
                      - MJ_CUSTOMER_COOP
                      - MJ_INSERT_PAYMENT
                      - MJ_LAST_ACTION
                      - MJ_GA_ID
                      - MJ_UCP_ID
                      - MJ_US_ID
                      - MJ_UA_ID
                      - MJ_STREET
                      - MJ_HOUSE_ID
                      - MJ_ZIP
                      - MJ_CITY
                      - MJ_WORK_TIME
                      - MJ_CACHE_START
                      - MJ_CACHE_STOP
                      - MJ_CACHE_MAX_STOP
                      - MJ_EXPEDICE
                      - MJ_EXPEDANT_ID
                      - MJ_MJ_PREV_STARTED
                      - MJ_MJ_PREV_FINISHED
                      - MJ_PLANNING
                      - attendees
      tags:
        - 'Process Jobs'
    post:
      summary: 'Create Process Job'
      operationId: createProcessJob
      description: "Creates a new job for a process via maintenance_jobs_job_create stored procedure.\nRequired fields depend on planning_policy."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    MJ_ID: 3432498
                    MJ_ML_ID: 1462360
                    MJ_ML_ORDER: null
                    MJ_PLANNING_POLICY: TIMEBLOCK
                    MJ_MJT_ID: '066'
                    MJ_MJK_ID: null
                    MJ_START: '2026-01-18 00:00:30'
                    MJ_STOP: null
                    MJ_DURATION: 152
                    MJ_RECURRENCE: null
                    MJ_CACHE_RECURRENCE_HR: null
                    MJ_SERMAN_ID: null
                    MJ_SG_ID: null
                    MJ_STATE: DONE
                    MJ_DESCRIPTION: 'Harum mollitia modi deserunt aut ab provident perspiciatis quo.'
                    MJ_NOTE: null
                    MJ_PRIVATE: 0
                    MJ_DONE_TIME: null
                    MJ_L_ID: '005544'
                    MJ_CREATED: '2026-03-07 12:45:12'
                    MJ_EDITED: '2026-04-20 11:25:52'
                    MJ_REAL_FINISH_TIME: null
                    MJ_POINTS: null
                    MJ_TIME_BLOCK_ID: null
                    MJ_DATE: null
                    MJ_FROM_DATE: null
                    MJ_FROM_MTB_ID: null
                    MJ_TO_DATE: null
                    MJ_TO_MTB_ID: null
                    MJ_LINKED_MJ_ID: null
                    MJ_REAL_START_TIME: null
                    MJ_AUTO_DONE: 0
                    MJ_AUTO_DONE_MOMENT: null
                    MJ_AUTO_DONE_ACTION: null
                    MJ_CUSTOMER_COOP: 0
                    MJ_INSERT_PAYMENT: null
                    MJ_LAST_ACTION: null
                    MJ_GA_ID: null
                    MJ_UCP_ID: null
                    MJ_US_ID: null
                    MJ_UA_ID: null
                    MJ_STREET: null
                    MJ_HOUSE_ID: null
                    MJ_ZIP: null
                    MJ_CITY: null
                    MJ_WORK_TIME: null
                    MJ_CACHE_START: null
                    MJ_CACHE_STOP: null
                    MJ_CACHE_MAX_STOP: null
                    MJ_EXPEDICE: null
                    MJ_EXPEDANT_ID: null
                    MJ_MJ_PREV_STARTED: null
                    MJ_MJ_PREV_FINISHED: null
                    MJ_PLANNING: 0
                    attendees:
                      -
                        MJA_ID: 1668425
                        MJA_JOIN_TYPE: JOB
                        MJA_OBJ_ID: 3432498
                        MJA_L_ID: null
                        MJA_EMAIL: ludie22@example.net
                        MJA_RESPONSE_STATUS: declined
                        MJA_RESPONSE_NOTE: null
                properties:
                  data:
                    type: object
                    properties:
                      MJ_ID:
                        type: integer
                        example: 3432498
                        description: 'Unique job ID.'
                      MJ_ML_ID:
                        type: integer
                        example: 1462360
                        description: 'Parent process (maintenance list) ID. References maintenance_list.'
                        nullable: true
                      MJ_ML_ORDER:
                        type: string
                        example: null
                        description: 'Order of the job within the process.'
                        nullable: true
                      MJ_PLANNING_POLICY:
                        type: string
                        example: TIMEBLOCK
                        description: 'Scheduling policy for the job. Determines which date/time fields are relevant.'
                        enum:
                          - LONGTIME
                          - TIMEBLOCK
                          - TIMEBLOCK_RANGE
                          - SEQUENCE
                          - NONE
                      MJ_MJT_ID:
                        type: string
                        example: '066'
                        description: 'Job type ID. References maintenance_job_types.'
                      MJ_MJK_ID:
                        type: string
                        example: null
                        description: 'Job kind (category) ID. References maintenance_job_kinds.'
                        nullable: true
                      MJ_START:
                        type: string
                        example: '2026-01-18 00:00:30'
                        description: 'Planned start date and time.'
                        nullable: true
                      MJ_STOP:
                        type: string
                        example: null
                        description: 'Planned end date and time.'
                        nullable: true
                      MJ_DURATION:
                        type: integer
                        example: 152
                        description: 'Expected duration of the job in minutes.'
                        nullable: true
                      MJ_RECURRENCE:
                        type: string
                        example: null
                        description: 'Recurrence rule definition string.'
                        nullable: true
                      MJ_CACHE_RECURRENCE_HR:
                        type: string
                        example: null
                        description: 'Cached human-readable representation of the recurrence rule.'
                        nullable: true
                      MJ_SERMAN_ID:
                        type: string
                        example: null
                        description: 'Assigned resource (serviceman) login ID. References logins.'
                        nullable: true
                      MJ_SG_ID:
                        type: string
                        example: null
                        description: 'Service group ID. References serman_groups.'
                        nullable: true
                      MJ_STATE:
                        type: string
                        example: DONE
                        description: 'Current state of the job.'
                        enum:
                          - PLANNED
                          - DONE
                          - CANCELED
                      MJ_DESCRIPTION:
                        type: string
                        example: 'Harum mollitia modi deserunt aut ab provident perspiciatis quo.'
                        description: 'Task description / name of the job.'
                        nullable: true
                      MJ_NOTE:
                        type: string
                        example: null
                        description: 'Note or progress log for the job.'
                        nullable: true
                      MJ_PRIVATE:
                        type: integer
                        example: 0
                        description: 'Whether the job is visible only to its assigned resource in the calendar. 1 = private, 0 = public.'
                      MJ_DONE_TIME:
                        type: string
                        example: null
                        description: 'Timestamp when the job was marked as done.'
                        nullable: true
                      MJ_L_ID:
                        type: string
                        example: '005544'
                        description: 'Login ID of the user who created or owns this job. References logins.'
                      MJ_CREATED:
                        type: string
                        example: '2026-03-07 12:45:12'
                        description: 'Timestamp when the job was created.'
                      MJ_EDITED:
                        type: string
                        example: '2026-04-20 11:25:52'
                        description: 'Timestamp when the job was last edited.'
                        nullable: true
                      MJ_REAL_FINISH_TIME:
                        type: string
                        example: null
                        description: 'Actual finish date recorded by the assignee.'
                        nullable: true
                      MJ_POINTS:
                        type: string
                        example: null
                        description: 'Number of capacity points consumed by this job.'
                        nullable: true
                      MJ_TIME_BLOCK_ID:
                        type: string
                        example: null
                        description: 'Assigned time-block ID. References maintenance_time_block.'
                        nullable: true
                      MJ_DATE:
                        type: string
                        example: null
                        description: 'Scheduled date for the job.'
                        nullable: true
                      MJ_FROM_DATE:
                        type: string
                        example: null
                        description: 'Start date for time-block or range scheduling.'
                        nullable: true
                      MJ_FROM_MTB_ID:
                        type: string
                        example: null
                        description: 'Start time-block ID. References maintenance_time_block.'
                        nullable: true
                      MJ_TO_DATE:
                        type: string
                        example: null
                        description: 'End date for time-block range scheduling.'
                        nullable: true
                      MJ_TO_MTB_ID:
                        type: string
                        example: null
                        description: 'End time-block ID. References maintenance_time_block.'
                        nullable: true
                      MJ_LINKED_MJ_ID:
                        type: string
                        example: null
                        description: 'ID of a linked job (self-reference to maintenance_jobs).'
                        nullable: true
                      MJ_REAL_START_TIME:
                        type: string
                        example: null
                        description: 'Actual start time recorded by the assignee.'
                        nullable: true
                      MJ_AUTO_DONE:
                        type: integer
                        example: 0
                        description: 'Whether the job should be automatically marked as done. 1 = yes, 0 = no.'
                      MJ_AUTO_DONE_MOMENT:
                        type: string
                        example: null
                        description: 'When to trigger auto-done.'
                        nullable: true
                        enum:
                          - ON_CREATE
                          - ON_START
                      MJ_AUTO_DONE_ACTION:
                        type: string
                        example: null
                        description: 'Action identifier to execute when auto-done is triggered.'
                        nullable: true
                      MJ_CUSTOMER_COOP:
                        type: integer
                        example: 0
                        description: 'Whether customer presence is required while processing the job. 1 = yes, 0 = no.'
                      MJ_INSERT_PAYMENT:
                        type: string
                        example: null
                        description: 'Payment flag or payment record ID associated with this job.'
                        nullable: true
                      MJ_LAST_ACTION:
                        type: string
                        example: null
                        description: 'Identifier of the last action performed on this job.'
                        nullable: true
                      MJ_GA_ID:
                        type: string
                        example: null
                        description: 'Group address ID. References groups_address.'
                        nullable: true
                      MJ_UCP_ID:
                        type: string
                        example: null
                        description: 'UIR city part ID. References uir_city_parts.'
                        nullable: true
                      MJ_US_ID:
                        type: string
                        example: null
                        description: 'UIR street ID. References uir_streets.'
                        nullable: true
                      MJ_UA_ID:
                        type: string
                        example: null
                        description: 'UIR address ID. References uir_addresses.'
                        nullable: true
                      MJ_STREET:
                        type: string
                        example: null
                        description: 'Street name of the job location.'
                        nullable: true
                      MJ_HOUSE_ID:
                        type: string
                        example: null
                        description: 'House number at the job location.'
                        nullable: true
                      MJ_ZIP:
                        type: string
                        example: null
                        description: 'ZIP / postal code of the job location.'
                        nullable: true
                      MJ_CITY:
                        type: string
                        example: null
                        description: 'City of the job location.'
                        nullable: true
                      MJ_WORK_TIME:
                        type: string
                        example: null
                        description: 'Actual work time spent on the job in minutes.'
                        nullable: true
                      MJ_CACHE_START:
                        type: string
                        example: null
                        description: 'Cached computed start datetime (resolved from scheduling rules).'
                        nullable: true
                      MJ_CACHE_STOP:
                        type: string
                        example: null
                        description: 'Cached computed end datetime (resolved from scheduling rules).'
                        nullable: true
                      MJ_CACHE_MAX_STOP:
                        type: string
                        example: null
                        description: 'Cached maximum possible end datetime.'
                        nullable: true
                      MJ_EXPEDICE:
                        type: string
                        example: null
                        description: 'Whether expedition (dispatch) is enabled for this job. 1 = yes, 0 = no.'
                        nullable: true
                      MJ_EXPEDANT_ID:
                        type: string
                        example: null
                        description: 'ID of the dispatcher (expedient) who dispatched this job.'
                        nullable: true
                      MJ_MJ_PREV_STARTED:
                        type: string
                        example: null
                        description: 'ID of a predecessor job that must be started before this job becomes available.'
                        nullable: true
                      MJ_MJ_PREV_FINISHED:
                        type: string
                        example: null
                        description: 'ID of a predecessor job that must be finished (DONE) before this job becomes available.'
                        nullable: true
                      MJ_PLANNING:
                        type: integer
                        example: 0
                        description: 'Whether this job is used only for planning/scheduling other jobs. 1 = planning-only, 0 = regular job.'
                      attendees:
                        type: array
                        example:
                          -
                            MJA_ID: 1668425
                            MJA_JOIN_TYPE: JOB
                            MJA_OBJ_ID: 3432498
                            MJA_L_ID: null
                            MJA_EMAIL: ludie22@example.net
                            MJA_RESPONSE_STATUS: declined
                            MJA_RESPONSE_NOTE: null
                        description: 'List of attendees assigned to this job.'
                        items:
                          type: object
                          properties:
                            MJA_ID:
                              type: integer
                              example: 1668425
                            MJA_JOIN_TYPE:
                              type: string
                              example: JOB
                            MJA_OBJ_ID:
                              type: integer
                              example: 3432498
                            MJA_L_ID:
                              type: string
                              example: null
                              nullable: true
                            MJA_EMAIL:
                              type: string
                              example: ludie22@example.net
                            MJA_RESPONSE_STATUS:
                              type: string
                              example: declined
                            MJA_RESPONSE_NOTE:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - MJ_ID
                      - MJ_ML_ID
                      - MJ_ML_ORDER
                      - MJ_PLANNING_POLICY
                      - MJ_MJT_ID
                      - MJ_MJK_ID
                      - MJ_START
                      - MJ_STOP
                      - MJ_DURATION
                      - MJ_RECURRENCE
                      - MJ_CACHE_RECURRENCE_HR
                      - MJ_SERMAN_ID
                      - MJ_SG_ID
                      - MJ_STATE
                      - MJ_DESCRIPTION
                      - MJ_NOTE
                      - MJ_PRIVATE
                      - MJ_DONE_TIME
                      - MJ_L_ID
                      - MJ_CREATED
                      - MJ_EDITED
                      - MJ_REAL_FINISH_TIME
                      - MJ_POINTS
                      - MJ_TIME_BLOCK_ID
                      - MJ_DATE
                      - MJ_FROM_DATE
                      - MJ_FROM_MTB_ID
                      - MJ_TO_DATE
                      - MJ_TO_MTB_ID
                      - MJ_LINKED_MJ_ID
                      - MJ_REAL_START_TIME
                      - MJ_AUTO_DONE
                      - MJ_AUTO_DONE_MOMENT
                      - MJ_AUTO_DONE_ACTION
                      - MJ_CUSTOMER_COOP
                      - MJ_INSERT_PAYMENT
                      - MJ_LAST_ACTION
                      - MJ_GA_ID
                      - MJ_UCP_ID
                      - MJ_US_ID
                      - MJ_UA_ID
                      - MJ_STREET
                      - MJ_HOUSE_ID
                      - MJ_ZIP
                      - MJ_CITY
                      - MJ_WORK_TIME
                      - MJ_CACHE_START
                      - MJ_CACHE_STOP
                      - MJ_CACHE_MAX_STOP
                      - MJ_EXPEDICE
                      - MJ_EXPEDANT_ID
                      - MJ_MJ_PREV_STARTED
                      - MJ_MJ_PREV_FINISHED
                      - MJ_PLANNING
                      - attendees
      tags:
        - 'Process Jobs'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                serman_id:
                  type: integer
                  description: 'Assigned operator (serviceman) ID'
                  example: 1
                sg_id:
                  type: integer
                  description: 'Service group ID'
                  example: 16
                mjt_id:
                  type: integer
                  description: 'Job type ID'
                  example: 16
                planning_policy:
                  type: string
                  description: 'Planning policy: LONGTIME, TIMEBLOCK, TIMEBLOCK_RANGE, SEQUENCE'
                  example: LONGTIME
                start_time:
                  type: string
                  description: 'Start time (required for LONGTIME)'
                  example: '2026-03-20 08:00:00'
                stop_time:
                  type: string
                  description: 'Stop time (required for LONGTIME)'
                  example: '2026-03-20 10:00:00'
                from_date:
                  type: string
                  description: 'From date (required for TIMEBLOCK, TIMEBLOCK_RANGE)'
                  example: '2026-03-20'
                to_date:
                  type: string
                  description: 'To date (required for TIMEBLOCK_RANGE)'
                  example: '2026-03-25'
                duration:
                  type: integer
                  description: 'Duration in minutes (required for SEQUENCE)'
                  example: 60
                points:
                  type: integer
                  description: 'Points (required for TIMEBLOCK)'
                  example: 5
                description:
                  type: string
                  description: 'Job description'
                  example: 'Eius et animi quos velit et.'
                note:
                  type: string
                  description: 'Job note'
                  example: architecto
                attendees:
                  type: array
                  description: 'Attendee emails'
                  example:
                    - architecto
                  items:
                    type: string
                notifications:
                  type: array
                  description: 'Notification recipients'
                  example:
                    - architecto
                  items:
                    type: string
                private:
                  type: integer
                  description: 'Private flag (0 or 1)'
                  example: 0
              required:
                - serman_id
                - planning_policy
    parameters:
      -
        in: path
        name: process
        description: 'The process.'
        example: 3
        required: true
        schema:
          type: integer
  '/api/v3/processes/{process}/jobs/{job}':
    put:
      summary: 'Update Process Job'
      operationId: updateProcessJob
      description: "Updates an existing job via maintenance_jobs_job_edit stored procedure.\n\nState changes (DONE, CANCELLED) are performed via the state parameter."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    MJ_ID: 3432499
                    MJ_ML_ID: 1462361
                    MJ_ML_ORDER: null
                    MJ_PLANNING_POLICY: SEQUENCE
                    MJ_MJT_ID: '057'
                    MJ_MJK_ID: null
                    MJ_START: '2026-02-01 07:06:37'
                    MJ_STOP: null
                    MJ_DURATION: 193
                    MJ_RECURRENCE: null
                    MJ_CACHE_RECURRENCE_HR: null
                    MJ_SERMAN_ID: null
                    MJ_SG_ID: null
                    MJ_STATE: PLANNED
                    MJ_DESCRIPTION: null
                    MJ_NOTE: null
                    MJ_PRIVATE: 0
                    MJ_DONE_TIME: null
                    MJ_L_ID: '005545'
                    MJ_CREATED: '2026-02-07 10:59:07'
                    MJ_EDITED: '2026-04-20 11:25:52'
                    MJ_REAL_FINISH_TIME: null
                    MJ_POINTS: null
                    MJ_TIME_BLOCK_ID: null
                    MJ_DATE: null
                    MJ_FROM_DATE: null
                    MJ_FROM_MTB_ID: null
                    MJ_TO_DATE: null
                    MJ_TO_MTB_ID: null
                    MJ_LINKED_MJ_ID: null
                    MJ_REAL_START_TIME: null
                    MJ_AUTO_DONE: 0
                    MJ_AUTO_DONE_MOMENT: null
                    MJ_AUTO_DONE_ACTION: null
                    MJ_CUSTOMER_COOP: 0
                    MJ_INSERT_PAYMENT: null
                    MJ_LAST_ACTION: null
                    MJ_GA_ID: null
                    MJ_UCP_ID: null
                    MJ_US_ID: null
                    MJ_UA_ID: null
                    MJ_STREET: null
                    MJ_HOUSE_ID: null
                    MJ_ZIP: null
                    MJ_CITY: null
                    MJ_WORK_TIME: null
                    MJ_CACHE_START: null
                    MJ_CACHE_STOP: null
                    MJ_CACHE_MAX_STOP: null
                    MJ_EXPEDICE: null
                    MJ_EXPEDANT_ID: null
                    MJ_MJ_PREV_STARTED: null
                    MJ_MJ_PREV_FINISHED: null
                    MJ_PLANNING: 0
                    attendees:
                      -
                        MJA_ID: 1668426
                        MJA_JOIN_TYPE: JOB
                        MJA_OBJ_ID: 3432499
                        MJA_L_ID: null
                        MJA_EMAIL: aniya55@example.org
                        MJA_RESPONSE_STATUS: declined
                        MJA_RESPONSE_NOTE: 'In optio doloremque fugiat ut et excepturi dolorem fugit.'
                properties:
                  data:
                    type: object
                    properties:
                      MJ_ID:
                        type: integer
                        example: 3432499
                        description: 'Unique job ID.'
                      MJ_ML_ID:
                        type: integer
                        example: 1462361
                        description: 'Parent process (maintenance list) ID. References maintenance_list.'
                        nullable: true
                      MJ_ML_ORDER:
                        type: string
                        example: null
                        description: 'Order of the job within the process.'
                        nullable: true
                      MJ_PLANNING_POLICY:
                        type: string
                        example: SEQUENCE
                        description: 'Scheduling policy for the job. Determines which date/time fields are relevant.'
                        enum:
                          - LONGTIME
                          - TIMEBLOCK
                          - TIMEBLOCK_RANGE
                          - SEQUENCE
                          - NONE
                      MJ_MJT_ID:
                        type: string
                        example: '057'
                        description: 'Job type ID. References maintenance_job_types.'
                      MJ_MJK_ID:
                        type: string
                        example: null
                        description: 'Job kind (category) ID. References maintenance_job_kinds.'
                        nullable: true
                      MJ_START:
                        type: string
                        example: '2026-02-01 07:06:37'
                        description: 'Planned start date and time.'
                        nullable: true
                      MJ_STOP:
                        type: string
                        example: null
                        description: 'Planned end date and time.'
                        nullable: true
                      MJ_DURATION:
                        type: integer
                        example: 193
                        description: 'Expected duration of the job in minutes.'
                        nullable: true
                      MJ_RECURRENCE:
                        type: string
                        example: null
                        description: 'Recurrence rule definition string.'
                        nullable: true
                      MJ_CACHE_RECURRENCE_HR:
                        type: string
                        example: null
                        description: 'Cached human-readable representation of the recurrence rule.'
                        nullable: true
                      MJ_SERMAN_ID:
                        type: string
                        example: null
                        description: 'Assigned resource (serviceman) login ID. References logins.'
                        nullable: true
                      MJ_SG_ID:
                        type: string
                        example: null
                        description: 'Service group ID. References serman_groups.'
                        nullable: true
                      MJ_STATE:
                        type: string
                        example: PLANNED
                        description: 'Current state of the job.'
                        enum:
                          - PLANNED
                          - DONE
                          - CANCELED
                      MJ_DESCRIPTION:
                        type: string
                        example: null
                        description: 'Task description / name of the job.'
                        nullable: true
                      MJ_NOTE:
                        type: string
                        example: null
                        description: 'Note or progress log for the job.'
                        nullable: true
                      MJ_PRIVATE:
                        type: integer
                        example: 0
                        description: 'Whether the job is visible only to its assigned resource in the calendar. 1 = private, 0 = public.'
                      MJ_DONE_TIME:
                        type: string
                        example: null
                        description: 'Timestamp when the job was marked as done.'
                        nullable: true
                      MJ_L_ID:
                        type: string
                        example: '005545'
                        description: 'Login ID of the user who created or owns this job. References logins.'
                      MJ_CREATED:
                        type: string
                        example: '2026-02-07 10:59:07'
                        description: 'Timestamp when the job was created.'
                      MJ_EDITED:
                        type: string
                        example: '2026-04-20 11:25:52'
                        description: 'Timestamp when the job was last edited.'
                        nullable: true
                      MJ_REAL_FINISH_TIME:
                        type: string
                        example: null
                        description: 'Actual finish date recorded by the assignee.'
                        nullable: true
                      MJ_POINTS:
                        type: string
                        example: null
                        description: 'Number of capacity points consumed by this job.'
                        nullable: true
                      MJ_TIME_BLOCK_ID:
                        type: string
                        example: null
                        description: 'Assigned time-block ID. References maintenance_time_block.'
                        nullable: true
                      MJ_DATE:
                        type: string
                        example: null
                        description: 'Scheduled date for the job.'
                        nullable: true
                      MJ_FROM_DATE:
                        type: string
                        example: null
                        description: 'Start date for time-block or range scheduling.'
                        nullable: true
                      MJ_FROM_MTB_ID:
                        type: string
                        example: null
                        description: 'Start time-block ID. References maintenance_time_block.'
                        nullable: true
                      MJ_TO_DATE:
                        type: string
                        example: null
                        description: 'End date for time-block range scheduling.'
                        nullable: true
                      MJ_TO_MTB_ID:
                        type: string
                        example: null
                        description: 'End time-block ID. References maintenance_time_block.'
                        nullable: true
                      MJ_LINKED_MJ_ID:
                        type: string
                        example: null
                        description: 'ID of a linked job (self-reference to maintenance_jobs).'
                        nullable: true
                      MJ_REAL_START_TIME:
                        type: string
                        example: null
                        description: 'Actual start time recorded by the assignee.'
                        nullable: true
                      MJ_AUTO_DONE:
                        type: integer
                        example: 0
                        description: 'Whether the job should be automatically marked as done. 1 = yes, 0 = no.'
                      MJ_AUTO_DONE_MOMENT:
                        type: string
                        example: null
                        description: 'When to trigger auto-done.'
                        nullable: true
                        enum:
                          - ON_CREATE
                          - ON_START
                      MJ_AUTO_DONE_ACTION:
                        type: string
                        example: null
                        description: 'Action identifier to execute when auto-done is triggered.'
                        nullable: true
                      MJ_CUSTOMER_COOP:
                        type: integer
                        example: 0
                        description: 'Whether customer presence is required while processing the job. 1 = yes, 0 = no.'
                      MJ_INSERT_PAYMENT:
                        type: string
                        example: null
                        description: 'Payment flag or payment record ID associated with this job.'
                        nullable: true
                      MJ_LAST_ACTION:
                        type: string
                        example: null
                        description: 'Identifier of the last action performed on this job.'
                        nullable: true
                      MJ_GA_ID:
                        type: string
                        example: null
                        description: 'Group address ID. References groups_address.'
                        nullable: true
                      MJ_UCP_ID:
                        type: string
                        example: null
                        description: 'UIR city part ID. References uir_city_parts.'
                        nullable: true
                      MJ_US_ID:
                        type: string
                        example: null
                        description: 'UIR street ID. References uir_streets.'
                        nullable: true
                      MJ_UA_ID:
                        type: string
                        example: null
                        description: 'UIR address ID. References uir_addresses.'
                        nullable: true
                      MJ_STREET:
                        type: string
                        example: null
                        description: 'Street name of the job location.'
                        nullable: true
                      MJ_HOUSE_ID:
                        type: string
                        example: null
                        description: 'House number at the job location.'
                        nullable: true
                      MJ_ZIP:
                        type: string
                        example: null
                        description: 'ZIP / postal code of the job location.'
                        nullable: true
                      MJ_CITY:
                        type: string
                        example: null
                        description: 'City of the job location.'
                        nullable: true
                      MJ_WORK_TIME:
                        type: string
                        example: null
                        description: 'Actual work time spent on the job in minutes.'
                        nullable: true
                      MJ_CACHE_START:
                        type: string
                        example: null
                        description: 'Cached computed start datetime (resolved from scheduling rules).'
                        nullable: true
                      MJ_CACHE_STOP:
                        type: string
                        example: null
                        description: 'Cached computed end datetime (resolved from scheduling rules).'
                        nullable: true
                      MJ_CACHE_MAX_STOP:
                        type: string
                        example: null
                        description: 'Cached maximum possible end datetime.'
                        nullable: true
                      MJ_EXPEDICE:
                        type: string
                        example: null
                        description: 'Whether expedition (dispatch) is enabled for this job. 1 = yes, 0 = no.'
                        nullable: true
                      MJ_EXPEDANT_ID:
                        type: string
                        example: null
                        description: 'ID of the dispatcher (expedient) who dispatched this job.'
                        nullable: true
                      MJ_MJ_PREV_STARTED:
                        type: string
                        example: null
                        description: 'ID of a predecessor job that must be started before this job becomes available.'
                        nullable: true
                      MJ_MJ_PREV_FINISHED:
                        type: string
                        example: null
                        description: 'ID of a predecessor job that must be finished (DONE) before this job becomes available.'
                        nullable: true
                      MJ_PLANNING:
                        type: integer
                        example: 0
                        description: 'Whether this job is used only for planning/scheduling other jobs. 1 = planning-only, 0 = regular job.'
                      attendees:
                        type: array
                        example:
                          -
                            MJA_ID: 1668426
                            MJA_JOIN_TYPE: JOB
                            MJA_OBJ_ID: 3432499
                            MJA_L_ID: null
                            MJA_EMAIL: aniya55@example.org
                            MJA_RESPONSE_STATUS: declined
                            MJA_RESPONSE_NOTE: 'In optio doloremque fugiat ut et excepturi dolorem fugit.'
                        description: 'List of attendees assigned to this job.'
                        items:
                          type: object
                          properties:
                            MJA_ID:
                              type: integer
                              example: 1668426
                            MJA_JOIN_TYPE:
                              type: string
                              example: JOB
                            MJA_OBJ_ID:
                              type: integer
                              example: 3432499
                            MJA_L_ID:
                              type: string
                              example: null
                              nullable: true
                            MJA_EMAIL:
                              type: string
                              example: aniya55@example.org
                            MJA_RESPONSE_STATUS:
                              type: string
                              example: declined
                            MJA_RESPONSE_NOTE:
                              type: string
                              example: 'In optio doloremque fugiat ut et excepturi dolorem fugit.'
                    required:
                      - MJ_ID
                      - MJ_ML_ID
                      - MJ_ML_ORDER
                      - MJ_PLANNING_POLICY
                      - MJ_MJT_ID
                      - MJ_MJK_ID
                      - MJ_START
                      - MJ_STOP
                      - MJ_DURATION
                      - MJ_RECURRENCE
                      - MJ_CACHE_RECURRENCE_HR
                      - MJ_SERMAN_ID
                      - MJ_SG_ID
                      - MJ_STATE
                      - MJ_DESCRIPTION
                      - MJ_NOTE
                      - MJ_PRIVATE
                      - MJ_DONE_TIME
                      - MJ_L_ID
                      - MJ_CREATED
                      - MJ_EDITED
                      - MJ_REAL_FINISH_TIME
                      - MJ_POINTS
                      - MJ_TIME_BLOCK_ID
                      - MJ_DATE
                      - MJ_FROM_DATE
                      - MJ_FROM_MTB_ID
                      - MJ_TO_DATE
                      - MJ_TO_MTB_ID
                      - MJ_LINKED_MJ_ID
                      - MJ_REAL_START_TIME
                      - MJ_AUTO_DONE
                      - MJ_AUTO_DONE_MOMENT
                      - MJ_AUTO_DONE_ACTION
                      - MJ_CUSTOMER_COOP
                      - MJ_INSERT_PAYMENT
                      - MJ_LAST_ACTION
                      - MJ_GA_ID
                      - MJ_UCP_ID
                      - MJ_US_ID
                      - MJ_UA_ID
                      - MJ_STREET
                      - MJ_HOUSE_ID
                      - MJ_ZIP
                      - MJ_CITY
                      - MJ_WORK_TIME
                      - MJ_CACHE_START
                      - MJ_CACHE_STOP
                      - MJ_CACHE_MAX_STOP
                      - MJ_EXPEDICE
                      - MJ_EXPEDANT_ID
                      - MJ_MJ_PREV_STARTED
                      - MJ_MJ_PREV_FINISHED
                      - MJ_PLANNING
                      - attendees
      tags:
        - 'Process Jobs'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                state:
                  type: string
                  description: 'New job state: PLANNED, DONE, CANCELLED'
                  example: DONE
                action:
                  type: string
                  description: 'Action to perform (edit, done, done_finish, cancel, transfer, reschedule)'
                  example: architecto
                planning_policy:
                  type: string
                  description: 'Planning policy: LONGTIME, TIMEBLOCK, TIMEBLOCK_RANGE, SEQUENCE'
                  example: architecto
                start_time:
                  type: string
                  description: 'Start datetime'
                  example: '2026-03-20 08:00:00'
                stop_time:
                  type: string
                  description: 'Stop datetime'
                  example: '2026-03-20 10:00:00'
                from_date:
                  type: string
                  description: 'From date'
                  example: '2026-03-20'
                to_date:
                  type: string
                  description: 'To date'
                  example: '2026-03-25'
                description:
                  type: string
                  description: 'Job description'
                  example: 'Eius et animi quos velit et.'
                note:
                  type: string
                  description: 'Job note'
                  example: architecto
                task_note:
                  type: string
                  description: 'Note appended to the process'
                  example: architecto
                real_finish_time:
                  type: string
                  description: 'Actual finish time'
                  example: architecto
                work_time:
                  type: integer
                  description: 'Work time in minutes'
                  example: 16
    parameters:
      -
        in: path
        name: process
        description: 'The process.'
        example: 3
        required: true
        schema:
          type: integer
      -
        in: path
        name: job
        description: 'The job.'
        example: architecto
        required: true
        schema:
          type: string
  /api/v3/processes:
    get:
      summary: 'List Processes'
      operationId: listProcesses
      description: "Returns a paginated list of maintenance processes.\n\nProcess visibility follows same rules as Mango Opcare. (Set the right `MAINTENANCE_LIST.VIEW` to value `%.%` for unrestricted access. See [Mango documentation](https://wiki.mango.cloud/) for details.)\n\nAdd `?time_tracking=true` to include time tracking computed attributes."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: type
          description: 'Filter by task type ID(s), comma-separated'
          example: '5'
          required: false
          schema:
            type: string
            description: 'Filter by task type ID(s), comma-separated'
            example: '5'
        -
          in: query
          name: customer_id
          description: 'Filter by customer user ID'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by customer user ID'
            example: 100
        -
          in: query
          name: in_progress
          description: 'Filter by in-progress master state (true = STATE_ID=2)'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by in-progress master state (true = STATE_ID=2)'
            example: 'true'
        -
          in: query
          name: substate
          description: 'Filter by substate ID(s), comma-separated'
          example: '10,20'
          required: false
          schema:
            type: string
            description: 'Filter by substate ID(s), comma-separated'
            example: '10,20'
        -
          in: query
          name: created_from
          description: 'Filter processes created from this date (inclusive)'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter processes created from this date (inclusive)'
            example: '2024-01-01'
        -
          in: query
          name: created_to
          description: 'Filter processes created to this date (inclusive)'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter processes created to this date (inclusive)'
            example: '2024-12-31'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 1462353
                      ML_SG_ID: null
                      USER_ID: null
                      STATE_ID: '03'
                      ML_MSS_ID: null
                      ML_FINISH_MSS_ID: null
                      SERMAN_ID: null
                      CREATE_ID: '977'
                      ML_MTT_ID: '0000000081'
                      ML_NODEAVAIL_SGD_ID: null
                      ML_MTT_STARTING_CODE: null
                      ML_MTT_CODE: null
                      NAME: null
                      ML_CACHE_FULLNAME: null
                      CREATION_TIME: '2026-03-22 09:23:11'
                      FINISH_TIME: null
                      SOLVING_TIME: null
                      PRE_FINISH_DATE: null
                      CT: '79'
                      ML_HPC_ID: null
                      ML_PRIORITY: HIGH
                      ML_N_ID: null
                      ML_SA_ID: null
                      ML_O_ID: null
                      ML_DOCUMENT_TYPE: null
                      ML_EXTERN_SOLVED: 0
                      ML_FINISH_MJ_ID: null
                      ML_REQUIRE_DOC_SCAN: 0
                      ML_INSERT_PAYMENT: null
                      ML_FINISH_NOTE: null
                      ML_GA_ID: null
                      ML_UCP_ID: null
                      ML_PREV_ML_ID: null
                      ML_OI_ID: null
                      ML_US_ID: null
                      ML_UA_ID: null
                      ML_STREET: null
                      ML_HOUSE_ID: null
                      ML_ZIP: null
                      ML_CITY: null
                      ML_USER_CONTACT: null
                      ML_ML_ID: null
                      ML_DR_ID: null
                      ML_DESC: null
                      ML_DELAY_ACCEPTED: null
                      ML_PLANNING_STRATEGY: null
                      ML_CACHE_ADDRESS: '544 Aglae Ridge Apt. 067, Lefflerhaven'
                      ML_CONFIG_DATE: '2026-01-09 21:55:53'
                      ML_BULK: 0
                      ML_WAKE_TIME: null
                      ML_SLA_ID: null
                      ML_SLA_ACT: ''
                      ML_SLA_TIME: null
                      ML_P_ID: null
                      ML_UC_ID: null
                      ML_CACHE_MTT_UNIQUE_ID: 25
                      ML_CACHE_MSS_UNIQUE_ID: 50
                      ML_CACHE_FULLNAME_SC: null
                      params:
                        -
                          MP_ID: 14780352
                          MP_ML_ID: 1462353
                          MP_NAME: JOB_START_TIME
                          MP_VALUE: 'Voluptatem laboriosam praesentium quis adipisci.'
                          MP_INDEX: null
                          MP_VALUE_UTF8: null
                          MP_UPDATED: '2026-02-24 07:32:03'
                          MP_L_ID: null
                      attachments:
                        -
                          FA_ID: 539946
                          FA_DOC_ID: 1462353
                          FA_DOC_TYPE: maintenance
                          FA_NAME: 'deleniti distinctio eum'
                          FA_DESC: 'Id aut libero aliquam veniam.'
                          FA_FILE_TYPE: 2
                          FA_FILE_SIZE: null
                          FA_FILE_NAME: noqitp.pdf
                          FA_DELETED: null
                          FA_CREATED: '2026-02-16 07:28:17'
                          FA_CREATE_L_ID: null
                          FA_MODIFIED: null
                          FA_MODIFY_L_ID: null
                    -
                      ID: 1462354
                      ML_SG_ID: null
                      USER_ID: null
                      STATE_ID: '05'
                      ML_MSS_ID: null
                      ML_FINISH_MSS_ID: null
                      SERMAN_ID: null
                      CREATE_ID: '785'
                      ML_MTT_ID: '0000000080'
                      ML_NODEAVAIL_SGD_ID: null
                      ML_MTT_STARTING_CODE: null
                      ML_MTT_CODE: null
                      NAME: null
                      ML_CACHE_FULLNAME: null
                      CREATION_TIME: '2026-01-24 01:09:13'
                      FINISH_TIME: null
                      SOLVING_TIME: null
                      PRE_FINISH_DATE: null
                      CT: '16'
                      ML_HPC_ID: null
                      ML_PRIORITY: MEDIUM
                      ML_N_ID: null
                      ML_SA_ID: null
                      ML_O_ID: null
                      ML_DOCUMENT_TYPE: null
                      ML_EXTERN_SOLVED: 0
                      ML_FINISH_MJ_ID: null
                      ML_REQUIRE_DOC_SCAN: 0
                      ML_INSERT_PAYMENT: null
                      ML_FINISH_NOTE: null
                      ML_GA_ID: null
                      ML_UCP_ID: null
                      ML_PREV_ML_ID: null
                      ML_OI_ID: null
                      ML_US_ID: null
                      ML_UA_ID: null
                      ML_STREET: null
                      ML_HOUSE_ID: null
                      ML_ZIP: null
                      ML_CITY: null
                      ML_USER_CONTACT: null
                      ML_ML_ID: null
                      ML_DR_ID: null
                      ML_DESC: null
                      ML_DELAY_ACCEPTED: null
                      ML_PLANNING_STRATEGY: null
                      ML_CACHE_ADDRESS: '752 Brennon Tunnel, Port Roxanneview'
                      ML_CONFIG_DATE: '2026-01-14 18:49:22'
                      ML_BULK: 0
                      ML_WAKE_TIME: null
                      ML_SLA_ID: null
                      ML_SLA_ACT: ''
                      ML_SLA_TIME: null
                      ML_P_ID: null
                      ML_UC_ID: null
                      ML_CACHE_MTT_UNIQUE_ID: 98
                      ML_CACHE_MSS_UNIQUE_ID: 60
                      ML_CACHE_FULLNAME_SC: null
                      params:
                        -
                          MP_ID: 14780353
                          MP_ML_ID: 1462354
                          MP_NAME: TERM
                          MP_VALUE: 'Assumenda et tenetur ab reiciendis quia.'
                          MP_INDEX: null
                          MP_VALUE_UTF8: null
                          MP_UPDATED: '2026-01-20 06:27:49'
                          MP_L_ID: null
                      attachments:
                        -
                          FA_ID: 539947
                          FA_DOC_ID: 1462354
                          FA_DOC_TYPE: maintenance
                          FA_NAME: 'ducimus corrupti et'
                          FA_DESC: 'Quia maiores assumenda odit.'
                          FA_FILE_TYPE: null
                          FA_FILE_SIZE: 2227
                          FA_FILE_NAME: tvnbob.pdf
                          FA_DELETED: null
                          FA_CREATED: '2026-03-06 16:14:42'
                          FA_CREATE_L_ID: null
                          FA_MODIFIED: null
                          FA_MODIFY_L_ID: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 1462353
                        ML_SG_ID: null
                        USER_ID: null
                        STATE_ID: '03'
                        ML_MSS_ID: null
                        ML_FINISH_MSS_ID: null
                        SERMAN_ID: null
                        CREATE_ID: '977'
                        ML_MTT_ID: '0000000081'
                        ML_NODEAVAIL_SGD_ID: null
                        ML_MTT_STARTING_CODE: null
                        ML_MTT_CODE: null
                        NAME: null
                        ML_CACHE_FULLNAME: null
                        CREATION_TIME: '2026-03-22 09:23:11'
                        FINISH_TIME: null
                        SOLVING_TIME: null
                        PRE_FINISH_DATE: null
                        CT: '79'
                        ML_HPC_ID: null
                        ML_PRIORITY: HIGH
                        ML_N_ID: null
                        ML_SA_ID: null
                        ML_O_ID: null
                        ML_DOCUMENT_TYPE: null
                        ML_EXTERN_SOLVED: 0
                        ML_FINISH_MJ_ID: null
                        ML_REQUIRE_DOC_SCAN: 0
                        ML_INSERT_PAYMENT: null
                        ML_FINISH_NOTE: null
                        ML_GA_ID: null
                        ML_UCP_ID: null
                        ML_PREV_ML_ID: null
                        ML_OI_ID: null
                        ML_US_ID: null
                        ML_UA_ID: null
                        ML_STREET: null
                        ML_HOUSE_ID: null
                        ML_ZIP: null
                        ML_CITY: null
                        ML_USER_CONTACT: null
                        ML_ML_ID: null
                        ML_DR_ID: null
                        ML_DESC: null
                        ML_DELAY_ACCEPTED: null
                        ML_PLANNING_STRATEGY: null
                        ML_CACHE_ADDRESS: '544 Aglae Ridge Apt. 067, Lefflerhaven'
                        ML_CONFIG_DATE: '2026-01-09 21:55:53'
                        ML_BULK: 0
                        ML_WAKE_TIME: null
                        ML_SLA_ID: null
                        ML_SLA_ACT: ''
                        ML_SLA_TIME: null
                        ML_P_ID: null
                        ML_UC_ID: null
                        ML_CACHE_MTT_UNIQUE_ID: 25
                        ML_CACHE_MSS_UNIQUE_ID: 50
                        ML_CACHE_FULLNAME_SC: null
                        params:
                          -
                            MP_ID: 14780352
                            MP_ML_ID: 1462353
                            MP_NAME: JOB_START_TIME
                            MP_VALUE: 'Voluptatem laboriosam praesentium quis adipisci.'
                            MP_INDEX: null
                            MP_VALUE_UTF8: null
                            MP_UPDATED: '2026-02-24 07:32:03'
                            MP_L_ID: null
                        attachments:
                          -
                            FA_ID: 539946
                            FA_DOC_ID: 1462353
                            FA_DOC_TYPE: maintenance
                            FA_NAME: 'deleniti distinctio eum'
                            FA_DESC: 'Id aut libero aliquam veniam.'
                            FA_FILE_TYPE: 2
                            FA_FILE_SIZE: null
                            FA_FILE_NAME: noqitp.pdf
                            FA_DELETED: null
                            FA_CREATED: '2026-02-16 07:28:17'
                            FA_CREATE_L_ID: null
                            FA_MODIFIED: null
                            FA_MODIFY_L_ID: null
                      -
                        ID: 1462354
                        ML_SG_ID: null
                        USER_ID: null
                        STATE_ID: '05'
                        ML_MSS_ID: null
                        ML_FINISH_MSS_ID: null
                        SERMAN_ID: null
                        CREATE_ID: '785'
                        ML_MTT_ID: '0000000080'
                        ML_NODEAVAIL_SGD_ID: null
                        ML_MTT_STARTING_CODE: null
                        ML_MTT_CODE: null
                        NAME: null
                        ML_CACHE_FULLNAME: null
                        CREATION_TIME: '2026-01-24 01:09:13'
                        FINISH_TIME: null
                        SOLVING_TIME: null
                        PRE_FINISH_DATE: null
                        CT: '16'
                        ML_HPC_ID: null
                        ML_PRIORITY: MEDIUM
                        ML_N_ID: null
                        ML_SA_ID: null
                        ML_O_ID: null
                        ML_DOCUMENT_TYPE: null
                        ML_EXTERN_SOLVED: 0
                        ML_FINISH_MJ_ID: null
                        ML_REQUIRE_DOC_SCAN: 0
                        ML_INSERT_PAYMENT: null
                        ML_FINISH_NOTE: null
                        ML_GA_ID: null
                        ML_UCP_ID: null
                        ML_PREV_ML_ID: null
                        ML_OI_ID: null
                        ML_US_ID: null
                        ML_UA_ID: null
                        ML_STREET: null
                        ML_HOUSE_ID: null
                        ML_ZIP: null
                        ML_CITY: null
                        ML_USER_CONTACT: null
                        ML_ML_ID: null
                        ML_DR_ID: null
                        ML_DESC: null
                        ML_DELAY_ACCEPTED: null
                        ML_PLANNING_STRATEGY: null
                        ML_CACHE_ADDRESS: '752 Brennon Tunnel, Port Roxanneview'
                        ML_CONFIG_DATE: '2026-01-14 18:49:22'
                        ML_BULK: 0
                        ML_WAKE_TIME: null
                        ML_SLA_ID: null
                        ML_SLA_ACT: ''
                        ML_SLA_TIME: null
                        ML_P_ID: null
                        ML_UC_ID: null
                        ML_CACHE_MTT_UNIQUE_ID: 98
                        ML_CACHE_MSS_UNIQUE_ID: 60
                        ML_CACHE_FULLNAME_SC: null
                        params:
                          -
                            MP_ID: 14780353
                            MP_ML_ID: 1462354
                            MP_NAME: TERM
                            MP_VALUE: 'Assumenda et tenetur ab reiciendis quia.'
                            MP_INDEX: null
                            MP_VALUE_UTF8: null
                            MP_UPDATED: '2026-01-20 06:27:49'
                            MP_L_ID: null
                        attachments:
                          -
                            FA_ID: 539947
                            FA_DOC_ID: 1462354
                            FA_DOC_TYPE: maintenance
                            FA_NAME: 'ducimus corrupti et'
                            FA_DESC: 'Quia maiores assumenda odit.'
                            FA_FILE_TYPE: null
                            FA_FILE_SIZE: 2227
                            FA_FILE_NAME: tvnbob.pdf
                            FA_DELETED: null
                            FA_CREATED: '2026-03-06 16:14:42'
                            FA_CREATE_L_ID: null
                            FA_MODIFIED: null
                            FA_MODIFY_L_ID: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 1462353
                          description: 'Unique process identifier (primary key).'
                        ML_SG_ID:
                          type: string
                          example: null
                          description: 'Resource group ID (references serman_groups).'
                          nullable: true
                        USER_ID:
                          type: string
                          example: null
                          description: 'Customer ID (references users).'
                          nullable: true
                        STATE_ID:
                          type: string
                          example: '03'
                          description: 'Master state ID (references maintenance_states). 1 = reported, 2 = in progress, 3 = resolved, 4 = confirmed.'
                        ML_MSS_ID:
                          type: string
                          example: null
                          description: 'Current substate ID (references maintenance_substates).'
                          nullable: true
                        ML_FINISH_MSS_ID:
                          type: string
                          example: null
                          description: 'Substate before finish. Used in workflow to determine the substate prior to task completion.'
                          nullable: true
                        SERMAN_ID:
                          type: string
                          example: null
                          description: 'Assigned resource/solver ID (references logins).'
                          nullable: true
                        CREATE_ID:
                          type: string
                          example: '977'
                          description: 'Creator operator ID (references logins).'
                        ML_MTT_ID:
                          type: string
                          example: '0000000081'
                          description: 'Process type ID (references maintenance_task_types).'
                        ML_NODEAVAIL_SGD_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Process group (technology) ID.'
                          nullable: true
                        ML_MTT_STARTING_CODE:
                          type: string
                          example: null
                          description: 'Deprecated. Initial code of the process type.'
                          nullable: true
                        ML_MTT_CODE:
                          type: string
                          example: null
                          description: 'Deprecated. Finish code of the process type.'
                          nullable: true
                        NAME:
                          type: string
                          example: null
                          description: 'Process name.'
                          nullable: true
                        ML_CACHE_FULLNAME:
                          type: string
                          example: null
                          description: 'Cached display name resolved from process type configuration.'
                          nullable: true
                        CREATION_TIME:
                          type: string
                          example: '2026-03-22 09:23:11'
                          description: 'Process creation datetime.'
                        FINISH_TIME:
                          type: string
                          example: null
                          description: 'Process completion datetime.'
                          nullable: true
                        SOLVING_TIME:
                          type: string
                          example: null
                          description: 'Deprecated. Start-of-solving datetime.'
                          nullable: true
                        PRE_FINISH_DATE:
                          type: string
                          example: null
                          description: 'Deprecated. Estimated end datetime.'
                          nullable: true
                        CT:
                          type: string
                          example: '79'
                          description: 'Company/tenant identifier (multi-tenant discriminator).'
                        ML_HPC_ID:
                          type: string
                          example: null
                          description: 'Helpdesk phone call ID that initiated this process.'
                          nullable: true
                        ML_PRIORITY:
                          type: string
                          example: HIGH
                          description: 'Process priority.'
                          enum:
                            - LOW
                            - MEDIUM
                            - HIGH
                            - CRITICAL
                        ML_N_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Node/device ID.'
                          nullable: true
                        ML_SA_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Service assignment ID.'
                          nullable: true
                        ML_O_ID:
                          type: string
                          example: null
                          description: 'Order ID.'
                          nullable: true
                        ML_DOCUMENT_TYPE:
                          type: string
                          example: null
                          description: 'Deprecated. Document type that initiated this process (references code_list).'
                          nullable: true
                        ML_EXTERN_SOLVED:
                          type: integer
                          example: 0
                          description: 'Deprecated. Externally solved flag.'
                        ML_FINISH_MJ_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Finishing job ID.'
                          nullable: true
                        ML_REQUIRE_DOC_SCAN:
                          type: integer
                          example: 0
                          description: 'Deprecated. Flag requiring document scan on process completion.'
                        ML_INSERT_PAYMENT:
                          type: string
                          example: null
                          description: 'Deprecated. Allow payment insertion on done job. null = not allowed, 0 = allow without pre-fill, value = pre-fill amount.'
                          nullable: true
                        ML_FINISH_NOTE:
                          type: string
                          example: null
                          description: 'Deprecated. Closing note.'
                          nullable: true
                        ML_GA_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Geographic area ID.'
                          nullable: true
                        ML_UCP_ID:
                          type: string
                          example: null
                          description: 'Deprecated. UIR city part ID.'
                          nullable: true
                        ML_PREV_ML_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Previous/past process ID.'
                          nullable: true
                        ML_OI_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Order item ID.'
                          nullable: true
                        ML_US_ID:
                          type: string
                          example: null
                          description: 'Deprecated. UIR street ID.'
                          nullable: true
                        ML_UA_ID:
                          type: string
                          example: null
                          description: 'Deprecated. UIR address ID.'
                          nullable: true
                        ML_STREET:
                          type: string
                          example: null
                          description: 'Deprecated. Street address text.'
                          nullable: true
                        ML_HOUSE_ID:
                          type: string
                          example: null
                          description: 'Deprecated. House number.'
                          nullable: true
                        ML_ZIP:
                          type: string
                          example: null
                          description: 'Deprecated. Postal code (PSČ).'
                          nullable: true
                        ML_CITY:
                          type: string
                          example: null
                          description: 'Deprecated. City name.'
                          nullable: true
                        ML_USER_CONTACT:
                          type: string
                          example: null
                          description: 'Customer contact detail (phone number, email, etc.).'
                          nullable: true
                        ML_ML_ID:
                          type: string
                          example: null
                          description: 'Parent/bulk process ID (references maintenance_list). Used for process hierarchy.'
                          nullable: true
                        ML_DR_ID:
                          type: string
                          example: null
                          description: 'Deprecated. Debt recovery process ID.'
                          nullable: true
                        ML_DESC:
                          type: string
                          example: null
                          description: 'Detailed process description.'
                          nullable: true
                        ML_DELAY_ACCEPTED:
                          type: string
                          example: null
                          description: 'Deprecated. Customer requested and accepted delayed resolution.'
                          nullable: true
                        ML_PLANNING_STRATEGY:
                          type: string
                          example: null
                          description: "Planning strategy code for auto-planned jobs. null = unknown (uses default), 'none' = selects all with MSC_STRATEGY_CODE IS NULL."
                          nullable: true
                        ML_CACHE_ADDRESS:
                          type: string
                          example: '544 Aglae Ridge Apt. 067, Lefflerhaven'
                          description: 'Cached address of the activity location.'
                        ML_CONFIG_DATE:
                          type: string
                          example: '2026-01-09 21:55:53'
                          description: 'Configuration snapshot datetime. Determines which process type configuration version applies.'
                        ML_BULK:
                          type: integer
                          example: 0
                          description: 'Bulk process flag. 1 = enables assigning other processes underneath this one.'
                        ML_WAKE_TIME:
                          type: string
                          example: null
                          description: 'Suspended-to datetime. When set, the process is suspended until this time.'
                          nullable: true
                        ML_SLA_ID:
                          type: string
                          example: null
                          description: 'SLA definition ID (references code_list).'
                          nullable: true
                        ML_SLA_ACT:
                          type: string
                          example: ''
                          description: "Active SLA flags. Set values: 'EXPIRE', 'WARNING'. Empty string when no SLA issues."
                        ML_SLA_TIME:
                          type: string
                          example: null
                          description: 'Datetime of the first expiring unhandled SLA point. Updated by the maintenance_task_sla_update procedure.'
                          nullable: true
                        ML_P_ID:
                          type: string
                          example: null
                          description: 'Premise ID (references premises).'
                          nullable: true
                        ML_UC_ID:
                          type: string
                          example: null
                          description: 'Customer contact ID (references users_contacts).'
                          nullable: true
                        ML_CACHE_MTT_UNIQUE_ID:
                          type: integer
                          example: 25
                          description: 'Cached resolved process type unique ID (from maintenance_task_types).'
                        ML_CACHE_MSS_UNIQUE_ID:
                          type: integer
                          example: 50
                          description: 'Cached resolved substate unique ID (from maintenance_substates).'
                        ML_CACHE_FULLNAME_SC:
                          type: string
                          example: null
                          description: 'Cached display name optimized for search (stripped/normalized).'
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              MP_ID: 14780352
                              MP_ML_ID: 1462353
                              MP_NAME: JOB_START_TIME
                              MP_VALUE: 'Voluptatem laboriosam praesentium quis adipisci.'
                              MP_INDEX: null
                              MP_VALUE_UTF8: null
                              MP_UPDATED: '2026-02-24 07:32:03'
                              MP_L_ID: null
                          description: 'Process parameters — collection of key-value pairs associated with this process.'
                          items:
                            type: object
                            properties:
                              MP_ID:
                                type: integer
                                example: 14780352
                              MP_ML_ID:
                                type: integer
                                example: 1462353
                              MP_NAME:
                                type: string
                                example: JOB_START_TIME
                              MP_VALUE:
                                type: string
                                example: 'Voluptatem laboriosam praesentium quis adipisci.'
                              MP_INDEX:
                                type: string
                                example: null
                                nullable: true
                              MP_VALUE_UTF8:
                                type: string
                                example: null
                                nullable: true
                              MP_UPDATED:
                                type: string
                                example: '2026-02-24 07:32:03'
                              MP_L_ID:
                                type: string
                                example: null
                                nullable: true
                        attachments:
                          type: array
                          example:
                            -
                              FA_ID: 539946
                              FA_DOC_ID: 1462353
                              FA_DOC_TYPE: maintenance
                              FA_NAME: 'deleniti distinctio eum'
                              FA_DESC: 'Id aut libero aliquam veniam.'
                              FA_FILE_TYPE: 2
                              FA_FILE_SIZE: null
                              FA_FILE_NAME: noqitp.pdf
                              FA_DELETED: null
                              FA_CREATED: '2026-02-16 07:28:17'
                              FA_CREATE_L_ID: null
                              FA_MODIFIED: null
                              FA_MODIFY_L_ID: null
                          description: 'File attachments associated with this process.'
                          items:
                            type: object
                            properties:
                              FA_ID:
                                type: integer
                                example: 539946
                              FA_DOC_ID:
                                type: integer
                                example: 1462353
                              FA_DOC_TYPE:
                                type: string
                                example: maintenance
                              FA_NAME:
                                type: string
                                example: 'deleniti distinctio eum'
                              FA_DESC:
                                type: string
                                example: 'Id aut libero aliquam veniam.'
                              FA_FILE_TYPE:
                                type: integer
                                example: 2
                              FA_FILE_SIZE:
                                type: string
                                example: null
                                nullable: true
                              FA_FILE_NAME:
                                type: string
                                example: noqitp.pdf
                              FA_DELETED:
                                type: string
                                example: null
                                nullable: true
                              FA_CREATED:
                                type: string
                                example: '2026-02-16 07:28:17'
                              FA_CREATE_L_ID:
                                type: string
                                example: null
                                nullable: true
                              FA_MODIFIED:
                                type: string
                                example: null
                                nullable: true
                              FA_MODIFY_L_ID:
                                type: string
                                example: null
                                nullable: true
                    required:
                      - ID
                      - ML_SG_ID
                      - USER_ID
                      - STATE_ID
                      - ML_MSS_ID
                      - ML_FINISH_MSS_ID
                      - SERMAN_ID
                      - CREATE_ID
                      - ML_MTT_ID
                      - ML_NODEAVAIL_SGD_ID
                      - ML_MTT_STARTING_CODE
                      - ML_MTT_CODE
                      - NAME
                      - ML_CACHE_FULLNAME
                      - CREATION_TIME
                      - FINISH_TIME
                      - SOLVING_TIME
                      - PRE_FINISH_DATE
                      - CT
                      - ML_HPC_ID
                      - ML_PRIORITY
                      - ML_N_ID
                      - ML_SA_ID
                      - ML_O_ID
                      - ML_DOCUMENT_TYPE
                      - ML_EXTERN_SOLVED
                      - ML_FINISH_MJ_ID
                      - ML_REQUIRE_DOC_SCAN
                      - ML_INSERT_PAYMENT
                      - ML_FINISH_NOTE
                      - ML_GA_ID
                      - ML_UCP_ID
                      - ML_PREV_ML_ID
                      - ML_OI_ID
                      - ML_US_ID
                      - ML_UA_ID
                      - ML_STREET
                      - ML_HOUSE_ID
                      - ML_ZIP
                      - ML_CITY
                      - ML_USER_CONTACT
                      - ML_ML_ID
                      - ML_DR_ID
                      - ML_DESC
                      - ML_DELAY_ACCEPTED
                      - ML_PLANNING_STRATEGY
                      - ML_CACHE_ADDRESS
                      - ML_CONFIG_DATE
                      - ML_BULK
                      - ML_WAKE_TIME
                      - ML_SLA_ID
                      - ML_SLA_ACT
                      - ML_SLA_TIME
                      - ML_P_ID
                      - ML_UC_ID
                      - ML_CACHE_MTT_UNIQUE_ID
                      - ML_CACHE_MSS_UNIQUE_ID
                      - ML_CACHE_FULLNAME_SC
                      - params
                      - attachments
      tags:
        - Processes
    post:
      summary: 'Create Process'
      operationId: createProcess
      description: 'Creates a new maintenance process via maintenance_task_create stored procedure.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        201:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1462355
                    ML_SG_ID: null
                    USER_ID: null
                    STATE_ID: '01'
                    ML_MSS_ID: null
                    ML_FINISH_MSS_ID: null
                    SERMAN_ID: null
                    CREATE_ID: '225'
                    ML_MTT_ID: '0000000076'
                    ML_NODEAVAIL_SGD_ID: null
                    ML_MTT_STARTING_CODE: null
                    ML_MTT_CODE: null
                    NAME: null
                    ML_CACHE_FULLNAME: null
                    CREATION_TIME: '2026-01-18 00:00:30'
                    FINISH_TIME: null
                    SOLVING_TIME: null
                    PRE_FINISH_DATE: null
                    CT: '43'
                    ML_HPC_ID: null
                    ML_PRIORITY: MEDIUM
                    ML_N_ID: null
                    ML_SA_ID: null
                    ML_O_ID: null
                    ML_DOCUMENT_TYPE: null
                    ML_EXTERN_SOLVED: 0
                    ML_FINISH_MJ_ID: null
                    ML_REQUIRE_DOC_SCAN: 0
                    ML_INSERT_PAYMENT: null
                    ML_FINISH_NOTE: null
                    ML_GA_ID: null
                    ML_UCP_ID: null
                    ML_PREV_ML_ID: null
                    ML_OI_ID: null
                    ML_US_ID: null
                    ML_UA_ID: null
                    ML_STREET: null
                    ML_HOUSE_ID: null
                    ML_ZIP: null
                    ML_CITY: null
                    ML_USER_CONTACT: null
                    ML_ML_ID: null
                    ML_DR_ID: null
                    ML_DESC: null
                    ML_DELAY_ACCEPTED: null
                    ML_PLANNING_STRATEGY: null
                    ML_CACHE_ADDRESS: '26343 Cecil Expressway Apt. 748, Gilbertstad'
                    ML_CONFIG_DATE: '2026-03-14 09:32:29'
                    ML_BULK: 0
                    ML_WAKE_TIME: null
                    ML_SLA_ID: null
                    ML_SLA_ACT: ''
                    ML_SLA_TIME: null
                    ML_P_ID: null
                    ML_UC_ID: null
                    ML_CACHE_MTT_UNIQUE_ID: 72
                    ML_CACHE_MSS_UNIQUE_ID: 7
                    ML_CACHE_FULLNAME_SC: null
                    params:
                      -
                        MP_ID: 14780354
                        MP_ML_ID: 1462355
                        MP_NAME: SALESMAN
                        MP_VALUE: 'Qui commodi incidunt iure odit.'
                        MP_INDEX: null
                        MP_VALUE_UTF8: null
                        MP_UPDATED: '2026-02-18 15:00:09'
                        MP_L_ID: null
                    attachments:
                      -
                        FA_ID: 539948
                        FA_DOC_ID: 1462355
                        FA_DOC_TYPE: maintenance
                        FA_NAME: 'modi ipsum nostrum'
                        FA_DESC: 'Autem et consequatur aut dolores enim non facere tempora.'
                        FA_FILE_TYPE: 2
                        FA_FILE_SIZE: 2317
                        FA_FILE_NAME: vlxjkl.pdf
                        FA_DELETED: null
                        FA_CREATED: '2026-04-17 19:31:43'
                        FA_CREATE_L_ID: null
                        FA_MODIFIED: null
                        FA_MODIFY_L_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1462355
                        description: 'Unique process identifier (primary key).'
                      ML_SG_ID:
                        type: string
                        example: null
                        description: 'Resource group ID (references serman_groups).'
                        nullable: true
                      USER_ID:
                        type: string
                        example: null
                        description: 'Customer ID (references users).'
                        nullable: true
                      STATE_ID:
                        type: string
                        example: '01'
                        description: 'Master state ID (references maintenance_states). 1 = reported, 2 = in progress, 3 = resolved, 4 = confirmed.'
                      ML_MSS_ID:
                        type: string
                        example: null
                        description: 'Current substate ID (references maintenance_substates).'
                        nullable: true
                      ML_FINISH_MSS_ID:
                        type: string
                        example: null
                        description: 'Substate before finish. Used in workflow to determine the substate prior to task completion.'
                        nullable: true
                      SERMAN_ID:
                        type: string
                        example: null
                        description: 'Assigned resource/solver ID (references logins).'
                        nullable: true
                      CREATE_ID:
                        type: string
                        example: '225'
                        description: 'Creator operator ID (references logins).'
                      ML_MTT_ID:
                        type: string
                        example: '0000000076'
                        description: 'Process type ID (references maintenance_task_types).'
                      ML_NODEAVAIL_SGD_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Process group (technology) ID.'
                        nullable: true
                      ML_MTT_STARTING_CODE:
                        type: string
                        example: null
                        description: 'Deprecated. Initial code of the process type.'
                        nullable: true
                      ML_MTT_CODE:
                        type: string
                        example: null
                        description: 'Deprecated. Finish code of the process type.'
                        nullable: true
                      NAME:
                        type: string
                        example: null
                        description: 'Process name.'
                        nullable: true
                      ML_CACHE_FULLNAME:
                        type: string
                        example: null
                        description: 'Cached display name resolved from process type configuration.'
                        nullable: true
                      CREATION_TIME:
                        type: string
                        example: '2026-01-18 00:00:30'
                        description: 'Process creation datetime.'
                      FINISH_TIME:
                        type: string
                        example: null
                        description: 'Process completion datetime.'
                        nullable: true
                      SOLVING_TIME:
                        type: string
                        example: null
                        description: 'Deprecated. Start-of-solving datetime.'
                        nullable: true
                      PRE_FINISH_DATE:
                        type: string
                        example: null
                        description: 'Deprecated. Estimated end datetime.'
                        nullable: true
                      CT:
                        type: string
                        example: '43'
                        description: 'Company/tenant identifier (multi-tenant discriminator).'
                      ML_HPC_ID:
                        type: string
                        example: null
                        description: 'Helpdesk phone call ID that initiated this process.'
                        nullable: true
                      ML_PRIORITY:
                        type: string
                        example: MEDIUM
                        description: 'Process priority.'
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - CRITICAL
                      ML_N_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Node/device ID.'
                        nullable: true
                      ML_SA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Service assignment ID.'
                        nullable: true
                      ML_O_ID:
                        type: string
                        example: null
                        description: 'Order ID.'
                        nullable: true
                      ML_DOCUMENT_TYPE:
                        type: string
                        example: null
                        description: 'Deprecated. Document type that initiated this process (references code_list).'
                        nullable: true
                      ML_EXTERN_SOLVED:
                        type: integer
                        example: 0
                        description: 'Deprecated. Externally solved flag.'
                      ML_FINISH_MJ_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Finishing job ID.'
                        nullable: true
                      ML_REQUIRE_DOC_SCAN:
                        type: integer
                        example: 0
                        description: 'Deprecated. Flag requiring document scan on process completion.'
                      ML_INSERT_PAYMENT:
                        type: string
                        example: null
                        description: 'Deprecated. Allow payment insertion on done job. null = not allowed, 0 = allow without pre-fill, value = pre-fill amount.'
                        nullable: true
                      ML_FINISH_NOTE:
                        type: string
                        example: null
                        description: 'Deprecated. Closing note.'
                        nullable: true
                      ML_GA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Geographic area ID.'
                        nullable: true
                      ML_UCP_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR city part ID.'
                        nullable: true
                      ML_PREV_ML_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Previous/past process ID.'
                        nullable: true
                      ML_OI_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Order item ID.'
                        nullable: true
                      ML_US_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR street ID.'
                        nullable: true
                      ML_UA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR address ID.'
                        nullable: true
                      ML_STREET:
                        type: string
                        example: null
                        description: 'Deprecated. Street address text.'
                        nullable: true
                      ML_HOUSE_ID:
                        type: string
                        example: null
                        description: 'Deprecated. House number.'
                        nullable: true
                      ML_ZIP:
                        type: string
                        example: null
                        description: 'Deprecated. Postal code (PSČ).'
                        nullable: true
                      ML_CITY:
                        type: string
                        example: null
                        description: 'Deprecated. City name.'
                        nullable: true
                      ML_USER_CONTACT:
                        type: string
                        example: null
                        description: 'Customer contact detail (phone number, email, etc.).'
                        nullable: true
                      ML_ML_ID:
                        type: string
                        example: null
                        description: 'Parent/bulk process ID (references maintenance_list). Used for process hierarchy.'
                        nullable: true
                      ML_DR_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Debt recovery process ID.'
                        nullable: true
                      ML_DESC:
                        type: string
                        example: null
                        description: 'Detailed process description.'
                        nullable: true
                      ML_DELAY_ACCEPTED:
                        type: string
                        example: null
                        description: 'Deprecated. Customer requested and accepted delayed resolution.'
                        nullable: true
                      ML_PLANNING_STRATEGY:
                        type: string
                        example: null
                        description: "Planning strategy code for auto-planned jobs. null = unknown (uses default), 'none' = selects all with MSC_STRATEGY_CODE IS NULL."
                        nullable: true
                      ML_CACHE_ADDRESS:
                        type: string
                        example: '26343 Cecil Expressway Apt. 748, Gilbertstad'
                        description: 'Cached address of the activity location.'
                      ML_CONFIG_DATE:
                        type: string
                        example: '2026-03-14 09:32:29'
                        description: 'Configuration snapshot datetime. Determines which process type configuration version applies.'
                      ML_BULK:
                        type: integer
                        example: 0
                        description: 'Bulk process flag. 1 = enables assigning other processes underneath this one.'
                      ML_WAKE_TIME:
                        type: string
                        example: null
                        description: 'Suspended-to datetime. When set, the process is suspended until this time.'
                        nullable: true
                      ML_SLA_ID:
                        type: string
                        example: null
                        description: 'SLA definition ID (references code_list).'
                        nullable: true
                      ML_SLA_ACT:
                        type: string
                        example: ''
                        description: "Active SLA flags. Set values: 'EXPIRE', 'WARNING'. Empty string when no SLA issues."
                      ML_SLA_TIME:
                        type: string
                        example: null
                        description: 'Datetime of the first expiring unhandled SLA point. Updated by the maintenance_task_sla_update procedure.'
                        nullable: true
                      ML_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (references premises).'
                        nullable: true
                      ML_UC_ID:
                        type: string
                        example: null
                        description: 'Customer contact ID (references users_contacts).'
                        nullable: true
                      ML_CACHE_MTT_UNIQUE_ID:
                        type: integer
                        example: 72
                        description: 'Cached resolved process type unique ID (from maintenance_task_types).'
                      ML_CACHE_MSS_UNIQUE_ID:
                        type: integer
                        example: 7
                        description: 'Cached resolved substate unique ID (from maintenance_substates).'
                      ML_CACHE_FULLNAME_SC:
                        type: string
                        example: null
                        description: 'Cached display name optimized for search (stripped/normalized).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            MP_ID: 14780354
                            MP_ML_ID: 1462355
                            MP_NAME: SALESMAN
                            MP_VALUE: 'Qui commodi incidunt iure odit.'
                            MP_INDEX: null
                            MP_VALUE_UTF8: null
                            MP_UPDATED: '2026-02-18 15:00:09'
                            MP_L_ID: null
                        description: 'Process parameters — collection of key-value pairs associated with this process.'
                        items:
                          type: object
                          properties:
                            MP_ID:
                              type: integer
                              example: 14780354
                            MP_ML_ID:
                              type: integer
                              example: 1462355
                            MP_NAME:
                              type: string
                              example: SALESMAN
                            MP_VALUE:
                              type: string
                              example: 'Qui commodi incidunt iure odit.'
                            MP_INDEX:
                              type: string
                              example: null
                              nullable: true
                            MP_VALUE_UTF8:
                              type: string
                              example: null
                              nullable: true
                            MP_UPDATED:
                              type: string
                              example: '2026-02-18 15:00:09'
                            MP_L_ID:
                              type: string
                              example: null
                              nullable: true
                      attachments:
                        type: array
                        example:
                          -
                            FA_ID: 539948
                            FA_DOC_ID: 1462355
                            FA_DOC_TYPE: maintenance
                            FA_NAME: 'modi ipsum nostrum'
                            FA_DESC: 'Autem et consequatur aut dolores enim non facere tempora.'
                            FA_FILE_TYPE: 2
                            FA_FILE_SIZE: 2317
                            FA_FILE_NAME: vlxjkl.pdf
                            FA_DELETED: null
                            FA_CREATED: '2026-04-17 19:31:43'
                            FA_CREATE_L_ID: null
                            FA_MODIFIED: null
                            FA_MODIFY_L_ID: null
                        description: 'File attachments associated with this process.'
                        items:
                          type: object
                          properties:
                            FA_ID:
                              type: integer
                              example: 539948
                            FA_DOC_ID:
                              type: integer
                              example: 1462355
                            FA_DOC_TYPE:
                              type: string
                              example: maintenance
                            FA_NAME:
                              type: string
                              example: 'modi ipsum nostrum'
                            FA_DESC:
                              type: string
                              example: 'Autem et consequatur aut dolores enim non facere tempora.'
                            FA_FILE_TYPE:
                              type: integer
                              example: 2
                            FA_FILE_SIZE:
                              type: integer
                              example: 2317
                            FA_FILE_NAME:
                              type: string
                              example: vlxjkl.pdf
                            FA_DELETED:
                              type: string
                              example: null
                              nullable: true
                            FA_CREATED:
                              type: string
                              example: '2026-04-17 19:31:43'
                            FA_CREATE_L_ID:
                              type: string
                              example: null
                              nullable: true
                            FA_MODIFIED:
                              type: string
                              example: null
                              nullable: true
                            FA_MODIFY_L_ID:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - ML_SG_ID
                      - USER_ID
                      - STATE_ID
                      - ML_MSS_ID
                      - ML_FINISH_MSS_ID
                      - SERMAN_ID
                      - CREATE_ID
                      - ML_MTT_ID
                      - ML_NODEAVAIL_SGD_ID
                      - ML_MTT_STARTING_CODE
                      - ML_MTT_CODE
                      - NAME
                      - ML_CACHE_FULLNAME
                      - CREATION_TIME
                      - FINISH_TIME
                      - SOLVING_TIME
                      - PRE_FINISH_DATE
                      - CT
                      - ML_HPC_ID
                      - ML_PRIORITY
                      - ML_N_ID
                      - ML_SA_ID
                      - ML_O_ID
                      - ML_DOCUMENT_TYPE
                      - ML_EXTERN_SOLVED
                      - ML_FINISH_MJ_ID
                      - ML_REQUIRE_DOC_SCAN
                      - ML_INSERT_PAYMENT
                      - ML_FINISH_NOTE
                      - ML_GA_ID
                      - ML_UCP_ID
                      - ML_PREV_ML_ID
                      - ML_OI_ID
                      - ML_US_ID
                      - ML_UA_ID
                      - ML_STREET
                      - ML_HOUSE_ID
                      - ML_ZIP
                      - ML_CITY
                      - ML_USER_CONTACT
                      - ML_ML_ID
                      - ML_DR_ID
                      - ML_DESC
                      - ML_DELAY_ACCEPTED
                      - ML_PLANNING_STRATEGY
                      - ML_CACHE_ADDRESS
                      - ML_CONFIG_DATE
                      - ML_BULK
                      - ML_WAKE_TIME
                      - ML_SLA_ID
                      - ML_SLA_ACT
                      - ML_SLA_TIME
                      - ML_P_ID
                      - ML_UC_ID
                      - ML_CACHE_MTT_UNIQUE_ID
                      - ML_CACHE_MSS_UNIQUE_ID
                      - ML_CACHE_FULLNAME_SC
                      - params
                      - attachments
      tags:
        - Processes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type_id:
                  type: integer
                  description: 'Task type ID (maintenance_task_types.MTT_ID)'
                  example: 5
                name:
                  type: string
                  description: 'Process name'
                  example: 'Network installation'
                priority:
                  type: string
                  description: 'Priority (LOW, MEDIUM, HIGH, CRITICAL)'
                  example: MEDIUM
                description:
                  type: string
                  description: 'Process description'
                  example: 'Eius et animi quos velit et.'
                customer_id:
                  type: integer
                  description: 'Customer user ID'
                  example: 100
                creation_time:
                  type: string
                  description: 'Creation time (defaults to NOW())'
                  example: '2024-01-15 10:00:00'
                ml_desc:
                  type: string
                  description: 'Detailed description'
                  example: architecto
                premise_id:
                  type: integer
                  description: 'Premise ID'
                  example: 16
                uc_id:
                  type: integer
                  description: 'User contact ID'
                  example: 16
                user_contact:
                  type: string
                  description: 'User contact info'
                  example: architecto
                bulk:
                  type: integer
                  description: 'Bulk task flag (0 or 1)'
                  example: 16
                sla_id:
                  type: integer
                  description: 'SLA ID'
                  example: 16
                group_task:
                  type: integer
                  description: 'Group task flag'
                  example: 16
                params:
                  type: array
                  description: 'Process parameters array [{name, value}]'
                  example:
                    - []
                  items:
                    type: object
              required:
                - type_id
                - name
  '/api/v3/processes/{id}':
    get:
      summary: 'Get Process'
      operationId: getProcess
      description: "Returns a single maintenance process by ID.\n\nProcess visibility follows same rules as Mango Opcare. (Set the right `MAINTENANCE_LIST.VIEW` to value `%.%` for unrestricted access. See [Mango documentation](https://wiki.mango.cloud/) for details.)\n"
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1462356
                    ML_SG_ID: null
                    USER_ID: null
                    STATE_ID: '03'
                    ML_MSS_ID: null
                    ML_FINISH_MSS_ID: null
                    SERMAN_ID: null
                    CREATE_ID: '977'
                    ML_MTT_ID: '0000000081'
                    ML_NODEAVAIL_SGD_ID: null
                    ML_MTT_STARTING_CODE: null
                    ML_MTT_CODE: null
                    NAME: null
                    ML_CACHE_FULLNAME: null
                    CREATION_TIME: '2026-03-22 09:17:07'
                    FINISH_TIME: null
                    SOLVING_TIME: null
                    PRE_FINISH_DATE: null
                    CT: '79'
                    ML_HPC_ID: null
                    ML_PRIORITY: HIGH
                    ML_N_ID: null
                    ML_SA_ID: null
                    ML_O_ID: null
                    ML_DOCUMENT_TYPE: null
                    ML_EXTERN_SOLVED: 0
                    ML_FINISH_MJ_ID: null
                    ML_REQUIRE_DOC_SCAN: 0
                    ML_INSERT_PAYMENT: null
                    ML_FINISH_NOTE: null
                    ML_GA_ID: null
                    ML_UCP_ID: null
                    ML_PREV_ML_ID: null
                    ML_OI_ID: null
                    ML_US_ID: null
                    ML_UA_ID: null
                    ML_STREET: null
                    ML_HOUSE_ID: null
                    ML_ZIP: null
                    ML_CITY: null
                    ML_USER_CONTACT: null
                    ML_ML_ID: null
                    ML_DR_ID: null
                    ML_DESC: null
                    ML_DELAY_ACCEPTED: null
                    ML_PLANNING_STRATEGY: null
                    ML_CACHE_ADDRESS: '544 Aglae Ridge Apt. 067, Lefflerhaven'
                    ML_CONFIG_DATE: '2026-01-09 21:49:09'
                    ML_BULK: 0
                    ML_WAKE_TIME: null
                    ML_SLA_ID: null
                    ML_SLA_ACT: ''
                    ML_SLA_TIME: null
                    ML_P_ID: null
                    ML_UC_ID: null
                    ML_CACHE_MTT_UNIQUE_ID: 25
                    ML_CACHE_MSS_UNIQUE_ID: 50
                    ML_CACHE_FULLNAME_SC: null
                    params:
                      -
                        MP_ID: 14780355
                        MP_ML_ID: 1462356
                        MP_NAME: JOB_START_TIME
                        MP_VALUE: 'Voluptatem laboriosam praesentium quis adipisci.'
                        MP_INDEX: null
                        MP_VALUE_UTF8: null
                        MP_UPDATED: '2026-02-24 07:29:03'
                        MP_L_ID: null
                    attachments:
                      -
                        FA_ID: 539949
                        FA_DOC_ID: 1462356
                        FA_DOC_TYPE: maintenance
                        FA_NAME: 'deleniti distinctio eum'
                        FA_DESC: 'Id aut libero aliquam veniam.'
                        FA_FILE_TYPE: 2
                        FA_FILE_SIZE: null
                        FA_FILE_NAME: noqitp.pdf
                        FA_DELETED: null
                        FA_CREATED: '2026-02-16 07:26:38'
                        FA_CREATE_L_ID: null
                        FA_MODIFIED: null
                        FA_MODIFY_L_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1462356
                        description: 'Unique process identifier (primary key).'
                      ML_SG_ID:
                        type: string
                        example: null
                        description: 'Resource group ID (references serman_groups).'
                        nullable: true
                      USER_ID:
                        type: string
                        example: null
                        description: 'Customer ID (references users).'
                        nullable: true
                      STATE_ID:
                        type: string
                        example: '03'
                        description: 'Master state ID (references maintenance_states). 1 = reported, 2 = in progress, 3 = resolved, 4 = confirmed.'
                      ML_MSS_ID:
                        type: string
                        example: null
                        description: 'Current substate ID (references maintenance_substates).'
                        nullable: true
                      ML_FINISH_MSS_ID:
                        type: string
                        example: null
                        description: 'Substate before finish. Used in workflow to determine the substate prior to task completion.'
                        nullable: true
                      SERMAN_ID:
                        type: string
                        example: null
                        description: 'Assigned resource/solver ID (references logins).'
                        nullable: true
                      CREATE_ID:
                        type: string
                        example: '977'
                        description: 'Creator operator ID (references logins).'
                      ML_MTT_ID:
                        type: string
                        example: '0000000081'
                        description: 'Process type ID (references maintenance_task_types).'
                      ML_NODEAVAIL_SGD_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Process group (technology) ID.'
                        nullable: true
                      ML_MTT_STARTING_CODE:
                        type: string
                        example: null
                        description: 'Deprecated. Initial code of the process type.'
                        nullable: true
                      ML_MTT_CODE:
                        type: string
                        example: null
                        description: 'Deprecated. Finish code of the process type.'
                        nullable: true
                      NAME:
                        type: string
                        example: null
                        description: 'Process name.'
                        nullable: true
                      ML_CACHE_FULLNAME:
                        type: string
                        example: null
                        description: 'Cached display name resolved from process type configuration.'
                        nullable: true
                      CREATION_TIME:
                        type: string
                        example: '2026-03-22 09:17:07'
                        description: 'Process creation datetime.'
                      FINISH_TIME:
                        type: string
                        example: null
                        description: 'Process completion datetime.'
                        nullable: true
                      SOLVING_TIME:
                        type: string
                        example: null
                        description: 'Deprecated. Start-of-solving datetime.'
                        nullable: true
                      PRE_FINISH_DATE:
                        type: string
                        example: null
                        description: 'Deprecated. Estimated end datetime.'
                        nullable: true
                      CT:
                        type: string
                        example: '79'
                        description: 'Company/tenant identifier (multi-tenant discriminator).'
                      ML_HPC_ID:
                        type: string
                        example: null
                        description: 'Helpdesk phone call ID that initiated this process.'
                        nullable: true
                      ML_PRIORITY:
                        type: string
                        example: HIGH
                        description: 'Process priority.'
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - CRITICAL
                      ML_N_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Node/device ID.'
                        nullable: true
                      ML_SA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Service assignment ID.'
                        nullable: true
                      ML_O_ID:
                        type: string
                        example: null
                        description: 'Order ID.'
                        nullable: true
                      ML_DOCUMENT_TYPE:
                        type: string
                        example: null
                        description: 'Deprecated. Document type that initiated this process (references code_list).'
                        nullable: true
                      ML_EXTERN_SOLVED:
                        type: integer
                        example: 0
                        description: 'Deprecated. Externally solved flag.'
                      ML_FINISH_MJ_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Finishing job ID.'
                        nullable: true
                      ML_REQUIRE_DOC_SCAN:
                        type: integer
                        example: 0
                        description: 'Deprecated. Flag requiring document scan on process completion.'
                      ML_INSERT_PAYMENT:
                        type: string
                        example: null
                        description: 'Deprecated. Allow payment insertion on done job. null = not allowed, 0 = allow without pre-fill, value = pre-fill amount.'
                        nullable: true
                      ML_FINISH_NOTE:
                        type: string
                        example: null
                        description: 'Deprecated. Closing note.'
                        nullable: true
                      ML_GA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Geographic area ID.'
                        nullable: true
                      ML_UCP_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR city part ID.'
                        nullable: true
                      ML_PREV_ML_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Previous/past process ID.'
                        nullable: true
                      ML_OI_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Order item ID.'
                        nullable: true
                      ML_US_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR street ID.'
                        nullable: true
                      ML_UA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR address ID.'
                        nullable: true
                      ML_STREET:
                        type: string
                        example: null
                        description: 'Deprecated. Street address text.'
                        nullable: true
                      ML_HOUSE_ID:
                        type: string
                        example: null
                        description: 'Deprecated. House number.'
                        nullable: true
                      ML_ZIP:
                        type: string
                        example: null
                        description: 'Deprecated. Postal code (PSČ).'
                        nullable: true
                      ML_CITY:
                        type: string
                        example: null
                        description: 'Deprecated. City name.'
                        nullable: true
                      ML_USER_CONTACT:
                        type: string
                        example: null
                        description: 'Customer contact detail (phone number, email, etc.).'
                        nullable: true
                      ML_ML_ID:
                        type: string
                        example: null
                        description: 'Parent/bulk process ID (references maintenance_list). Used for process hierarchy.'
                        nullable: true
                      ML_DR_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Debt recovery process ID.'
                        nullable: true
                      ML_DESC:
                        type: string
                        example: null
                        description: 'Detailed process description.'
                        nullable: true
                      ML_DELAY_ACCEPTED:
                        type: string
                        example: null
                        description: 'Deprecated. Customer requested and accepted delayed resolution.'
                        nullable: true
                      ML_PLANNING_STRATEGY:
                        type: string
                        example: null
                        description: "Planning strategy code for auto-planned jobs. null = unknown (uses default), 'none' = selects all with MSC_STRATEGY_CODE IS NULL."
                        nullable: true
                      ML_CACHE_ADDRESS:
                        type: string
                        example: '544 Aglae Ridge Apt. 067, Lefflerhaven'
                        description: 'Cached address of the activity location.'
                      ML_CONFIG_DATE:
                        type: string
                        example: '2026-01-09 21:49:09'
                        description: 'Configuration snapshot datetime. Determines which process type configuration version applies.'
                      ML_BULK:
                        type: integer
                        example: 0
                        description: 'Bulk process flag. 1 = enables assigning other processes underneath this one.'
                      ML_WAKE_TIME:
                        type: string
                        example: null
                        description: 'Suspended-to datetime. When set, the process is suspended until this time.'
                        nullable: true
                      ML_SLA_ID:
                        type: string
                        example: null
                        description: 'SLA definition ID (references code_list).'
                        nullable: true
                      ML_SLA_ACT:
                        type: string
                        example: ''
                        description: "Active SLA flags. Set values: 'EXPIRE', 'WARNING'. Empty string when no SLA issues."
                      ML_SLA_TIME:
                        type: string
                        example: null
                        description: 'Datetime of the first expiring unhandled SLA point. Updated by the maintenance_task_sla_update procedure.'
                        nullable: true
                      ML_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (references premises).'
                        nullable: true
                      ML_UC_ID:
                        type: string
                        example: null
                        description: 'Customer contact ID (references users_contacts).'
                        nullable: true
                      ML_CACHE_MTT_UNIQUE_ID:
                        type: integer
                        example: 25
                        description: 'Cached resolved process type unique ID (from maintenance_task_types).'
                      ML_CACHE_MSS_UNIQUE_ID:
                        type: integer
                        example: 50
                        description: 'Cached resolved substate unique ID (from maintenance_substates).'
                      ML_CACHE_FULLNAME_SC:
                        type: string
                        example: null
                        description: 'Cached display name optimized for search (stripped/normalized).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            MP_ID: 14780355
                            MP_ML_ID: 1462356
                            MP_NAME: JOB_START_TIME
                            MP_VALUE: 'Voluptatem laboriosam praesentium quis adipisci.'
                            MP_INDEX: null
                            MP_VALUE_UTF8: null
                            MP_UPDATED: '2026-02-24 07:29:03'
                            MP_L_ID: null
                        description: 'Process parameters — collection of key-value pairs associated with this process.'
                        items:
                          type: object
                          properties:
                            MP_ID:
                              type: integer
                              example: 14780355
                            MP_ML_ID:
                              type: integer
                              example: 1462356
                            MP_NAME:
                              type: string
                              example: JOB_START_TIME
                            MP_VALUE:
                              type: string
                              example: 'Voluptatem laboriosam praesentium quis adipisci.'
                            MP_INDEX:
                              type: string
                              example: null
                              nullable: true
                            MP_VALUE_UTF8:
                              type: string
                              example: null
                              nullable: true
                            MP_UPDATED:
                              type: string
                              example: '2026-02-24 07:29:03'
                            MP_L_ID:
                              type: string
                              example: null
                              nullable: true
                      attachments:
                        type: array
                        example:
                          -
                            FA_ID: 539949
                            FA_DOC_ID: 1462356
                            FA_DOC_TYPE: maintenance
                            FA_NAME: 'deleniti distinctio eum'
                            FA_DESC: 'Id aut libero aliquam veniam.'
                            FA_FILE_TYPE: 2
                            FA_FILE_SIZE: null
                            FA_FILE_NAME: noqitp.pdf
                            FA_DELETED: null
                            FA_CREATED: '2026-02-16 07:26:38'
                            FA_CREATE_L_ID: null
                            FA_MODIFIED: null
                            FA_MODIFY_L_ID: null
                        description: 'File attachments associated with this process.'
                        items:
                          type: object
                          properties:
                            FA_ID:
                              type: integer
                              example: 539949
                            FA_DOC_ID:
                              type: integer
                              example: 1462356
                            FA_DOC_TYPE:
                              type: string
                              example: maintenance
                            FA_NAME:
                              type: string
                              example: 'deleniti distinctio eum'
                            FA_DESC:
                              type: string
                              example: 'Id aut libero aliquam veniam.'
                            FA_FILE_TYPE:
                              type: integer
                              example: 2
                            FA_FILE_SIZE:
                              type: string
                              example: null
                              nullable: true
                            FA_FILE_NAME:
                              type: string
                              example: noqitp.pdf
                            FA_DELETED:
                              type: string
                              example: null
                              nullable: true
                            FA_CREATED:
                              type: string
                              example: '2026-02-16 07:26:38'
                            FA_CREATE_L_ID:
                              type: string
                              example: null
                              nullable: true
                            FA_MODIFIED:
                              type: string
                              example: null
                              nullable: true
                            FA_MODIFY_L_ID:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - ML_SG_ID
                      - USER_ID
                      - STATE_ID
                      - ML_MSS_ID
                      - ML_FINISH_MSS_ID
                      - SERMAN_ID
                      - CREATE_ID
                      - ML_MTT_ID
                      - ML_NODEAVAIL_SGD_ID
                      - ML_MTT_STARTING_CODE
                      - ML_MTT_CODE
                      - NAME
                      - ML_CACHE_FULLNAME
                      - CREATION_TIME
                      - FINISH_TIME
                      - SOLVING_TIME
                      - PRE_FINISH_DATE
                      - CT
                      - ML_HPC_ID
                      - ML_PRIORITY
                      - ML_N_ID
                      - ML_SA_ID
                      - ML_O_ID
                      - ML_DOCUMENT_TYPE
                      - ML_EXTERN_SOLVED
                      - ML_FINISH_MJ_ID
                      - ML_REQUIRE_DOC_SCAN
                      - ML_INSERT_PAYMENT
                      - ML_FINISH_NOTE
                      - ML_GA_ID
                      - ML_UCP_ID
                      - ML_PREV_ML_ID
                      - ML_OI_ID
                      - ML_US_ID
                      - ML_UA_ID
                      - ML_STREET
                      - ML_HOUSE_ID
                      - ML_ZIP
                      - ML_CITY
                      - ML_USER_CONTACT
                      - ML_ML_ID
                      - ML_DR_ID
                      - ML_DESC
                      - ML_DELAY_ACCEPTED
                      - ML_PLANNING_STRATEGY
                      - ML_CACHE_ADDRESS
                      - ML_CONFIG_DATE
                      - ML_BULK
                      - ML_WAKE_TIME
                      - ML_SLA_ID
                      - ML_SLA_ACT
                      - ML_SLA_TIME
                      - ML_P_ID
                      - ML_UC_ID
                      - ML_CACHE_MTT_UNIQUE_ID
                      - ML_CACHE_MSS_UNIQUE_ID
                      - ML_CACHE_FULLNAME_SC
                      - params
                      - attachments
      tags:
        - Processes
    put:
      summary: 'Update Process'
      operationId: updateProcess
      description: 'Updates an existing maintenance process via maintenance_task_edit stored procedure.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1462357
                    ML_SG_ID: null
                    USER_ID: null
                    STATE_ID: '01'
                    ML_MSS_ID: null
                    ML_FINISH_MSS_ID: null
                    SERMAN_ID: null
                    CREATE_ID: '225'
                    ML_MTT_ID: '0000000076'
                    ML_NODEAVAIL_SGD_ID: null
                    ML_MTT_STARTING_CODE: null
                    ML_MTT_CODE: null
                    NAME: null
                    ML_CACHE_FULLNAME: null
                    CREATION_TIME: '2026-01-18 00:00:30'
                    FINISH_TIME: null
                    SOLVING_TIME: null
                    PRE_FINISH_DATE: null
                    CT: '43'
                    ML_HPC_ID: null
                    ML_PRIORITY: MEDIUM
                    ML_N_ID: null
                    ML_SA_ID: null
                    ML_O_ID: null
                    ML_DOCUMENT_TYPE: null
                    ML_EXTERN_SOLVED: 0
                    ML_FINISH_MJ_ID: null
                    ML_REQUIRE_DOC_SCAN: 0
                    ML_INSERT_PAYMENT: null
                    ML_FINISH_NOTE: null
                    ML_GA_ID: null
                    ML_UCP_ID: null
                    ML_PREV_ML_ID: null
                    ML_OI_ID: null
                    ML_US_ID: null
                    ML_UA_ID: null
                    ML_STREET: null
                    ML_HOUSE_ID: null
                    ML_ZIP: null
                    ML_CITY: null
                    ML_USER_CONTACT: null
                    ML_ML_ID: null
                    ML_DR_ID: null
                    ML_DESC: null
                    ML_DELAY_ACCEPTED: null
                    ML_PLANNING_STRATEGY: null
                    ML_CACHE_ADDRESS: '26343 Cecil Expressway Apt. 748, Gilbertstad'
                    ML_CONFIG_DATE: '2026-03-14 09:32:29'
                    ML_BULK: 0
                    ML_WAKE_TIME: null
                    ML_SLA_ID: null
                    ML_SLA_ACT: ''
                    ML_SLA_TIME: null
                    ML_P_ID: null
                    ML_UC_ID: null
                    ML_CACHE_MTT_UNIQUE_ID: 72
                    ML_CACHE_MSS_UNIQUE_ID: 7
                    ML_CACHE_FULLNAME_SC: null
                    params:
                      -
                        MP_ID: 14780356
                        MP_ML_ID: 1462357
                        MP_NAME: SALESMAN
                        MP_VALUE: 'Qui commodi incidunt iure odit.'
                        MP_INDEX: null
                        MP_VALUE_UTF8: null
                        MP_UPDATED: '2026-02-18 15:00:09'
                        MP_L_ID: null
                    attachments:
                      -
                        FA_ID: 539950
                        FA_DOC_ID: 1462357
                        FA_DOC_TYPE: maintenance
                        FA_NAME: 'modi ipsum nostrum'
                        FA_DESC: 'Autem et consequatur aut dolores enim non facere tempora.'
                        FA_FILE_TYPE: 2
                        FA_FILE_SIZE: 2317
                        FA_FILE_NAME: vlxjkl.pdf
                        FA_DELETED: null
                        FA_CREATED: '2026-04-17 19:31:43'
                        FA_CREATE_L_ID: null
                        FA_MODIFIED: null
                        FA_MODIFY_L_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1462357
                        description: 'Unique process identifier (primary key).'
                      ML_SG_ID:
                        type: string
                        example: null
                        description: 'Resource group ID (references serman_groups).'
                        nullable: true
                      USER_ID:
                        type: string
                        example: null
                        description: 'Customer ID (references users).'
                        nullable: true
                      STATE_ID:
                        type: string
                        example: '01'
                        description: 'Master state ID (references maintenance_states). 1 = reported, 2 = in progress, 3 = resolved, 4 = confirmed.'
                      ML_MSS_ID:
                        type: string
                        example: null
                        description: 'Current substate ID (references maintenance_substates).'
                        nullable: true
                      ML_FINISH_MSS_ID:
                        type: string
                        example: null
                        description: 'Substate before finish. Used in workflow to determine the substate prior to task completion.'
                        nullable: true
                      SERMAN_ID:
                        type: string
                        example: null
                        description: 'Assigned resource/solver ID (references logins).'
                        nullable: true
                      CREATE_ID:
                        type: string
                        example: '225'
                        description: 'Creator operator ID (references logins).'
                      ML_MTT_ID:
                        type: string
                        example: '0000000076'
                        description: 'Process type ID (references maintenance_task_types).'
                      ML_NODEAVAIL_SGD_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Process group (technology) ID.'
                        nullable: true
                      ML_MTT_STARTING_CODE:
                        type: string
                        example: null
                        description: 'Deprecated. Initial code of the process type.'
                        nullable: true
                      ML_MTT_CODE:
                        type: string
                        example: null
                        description: 'Deprecated. Finish code of the process type.'
                        nullable: true
                      NAME:
                        type: string
                        example: null
                        description: 'Process name.'
                        nullable: true
                      ML_CACHE_FULLNAME:
                        type: string
                        example: null
                        description: 'Cached display name resolved from process type configuration.'
                        nullable: true
                      CREATION_TIME:
                        type: string
                        example: '2026-01-18 00:00:30'
                        description: 'Process creation datetime.'
                      FINISH_TIME:
                        type: string
                        example: null
                        description: 'Process completion datetime.'
                        nullable: true
                      SOLVING_TIME:
                        type: string
                        example: null
                        description: 'Deprecated. Start-of-solving datetime.'
                        nullable: true
                      PRE_FINISH_DATE:
                        type: string
                        example: null
                        description: 'Deprecated. Estimated end datetime.'
                        nullable: true
                      CT:
                        type: string
                        example: '43'
                        description: 'Company/tenant identifier (multi-tenant discriminator).'
                      ML_HPC_ID:
                        type: string
                        example: null
                        description: 'Helpdesk phone call ID that initiated this process.'
                        nullable: true
                      ML_PRIORITY:
                        type: string
                        example: MEDIUM
                        description: 'Process priority.'
                        enum:
                          - LOW
                          - MEDIUM
                          - HIGH
                          - CRITICAL
                      ML_N_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Node/device ID.'
                        nullable: true
                      ML_SA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Service assignment ID.'
                        nullable: true
                      ML_O_ID:
                        type: string
                        example: null
                        description: 'Order ID.'
                        nullable: true
                      ML_DOCUMENT_TYPE:
                        type: string
                        example: null
                        description: 'Deprecated. Document type that initiated this process (references code_list).'
                        nullable: true
                      ML_EXTERN_SOLVED:
                        type: integer
                        example: 0
                        description: 'Deprecated. Externally solved flag.'
                      ML_FINISH_MJ_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Finishing job ID.'
                        nullable: true
                      ML_REQUIRE_DOC_SCAN:
                        type: integer
                        example: 0
                        description: 'Deprecated. Flag requiring document scan on process completion.'
                      ML_INSERT_PAYMENT:
                        type: string
                        example: null
                        description: 'Deprecated. Allow payment insertion on done job. null = not allowed, 0 = allow without pre-fill, value = pre-fill amount.'
                        nullable: true
                      ML_FINISH_NOTE:
                        type: string
                        example: null
                        description: 'Deprecated. Closing note.'
                        nullable: true
                      ML_GA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Geographic area ID.'
                        nullable: true
                      ML_UCP_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR city part ID.'
                        nullable: true
                      ML_PREV_ML_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Previous/past process ID.'
                        nullable: true
                      ML_OI_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Order item ID.'
                        nullable: true
                      ML_US_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR street ID.'
                        nullable: true
                      ML_UA_ID:
                        type: string
                        example: null
                        description: 'Deprecated. UIR address ID.'
                        nullable: true
                      ML_STREET:
                        type: string
                        example: null
                        description: 'Deprecated. Street address text.'
                        nullable: true
                      ML_HOUSE_ID:
                        type: string
                        example: null
                        description: 'Deprecated. House number.'
                        nullable: true
                      ML_ZIP:
                        type: string
                        example: null
                        description: 'Deprecated. Postal code (PSČ).'
                        nullable: true
                      ML_CITY:
                        type: string
                        example: null
                        description: 'Deprecated. City name.'
                        nullable: true
                      ML_USER_CONTACT:
                        type: string
                        example: null
                        description: 'Customer contact detail (phone number, email, etc.).'
                        nullable: true
                      ML_ML_ID:
                        type: string
                        example: null
                        description: 'Parent/bulk process ID (references maintenance_list). Used for process hierarchy.'
                        nullable: true
                      ML_DR_ID:
                        type: string
                        example: null
                        description: 'Deprecated. Debt recovery process ID.'
                        nullable: true
                      ML_DESC:
                        type: string
                        example: null
                        description: 'Detailed process description.'
                        nullable: true
                      ML_DELAY_ACCEPTED:
                        type: string
                        example: null
                        description: 'Deprecated. Customer requested and accepted delayed resolution.'
                        nullable: true
                      ML_PLANNING_STRATEGY:
                        type: string
                        example: null
                        description: "Planning strategy code for auto-planned jobs. null = unknown (uses default), 'none' = selects all with MSC_STRATEGY_CODE IS NULL."
                        nullable: true
                      ML_CACHE_ADDRESS:
                        type: string
                        example: '26343 Cecil Expressway Apt. 748, Gilbertstad'
                        description: 'Cached address of the activity location.'
                      ML_CONFIG_DATE:
                        type: string
                        example: '2026-03-14 09:32:29'
                        description: 'Configuration snapshot datetime. Determines which process type configuration version applies.'
                      ML_BULK:
                        type: integer
                        example: 0
                        description: 'Bulk process flag. 1 = enables assigning other processes underneath this one.'
                      ML_WAKE_TIME:
                        type: string
                        example: null
                        description: 'Suspended-to datetime. When set, the process is suspended until this time.'
                        nullable: true
                      ML_SLA_ID:
                        type: string
                        example: null
                        description: 'SLA definition ID (references code_list).'
                        nullable: true
                      ML_SLA_ACT:
                        type: string
                        example: ''
                        description: "Active SLA flags. Set values: 'EXPIRE', 'WARNING'. Empty string when no SLA issues."
                      ML_SLA_TIME:
                        type: string
                        example: null
                        description: 'Datetime of the first expiring unhandled SLA point. Updated by the maintenance_task_sla_update procedure.'
                        nullable: true
                      ML_P_ID:
                        type: string
                        example: null
                        description: 'Premise ID (references premises).'
                        nullable: true
                      ML_UC_ID:
                        type: string
                        example: null
                        description: 'Customer contact ID (references users_contacts).'
                        nullable: true
                      ML_CACHE_MTT_UNIQUE_ID:
                        type: integer
                        example: 72
                        description: 'Cached resolved process type unique ID (from maintenance_task_types).'
                      ML_CACHE_MSS_UNIQUE_ID:
                        type: integer
                        example: 7
                        description: 'Cached resolved substate unique ID (from maintenance_substates).'
                      ML_CACHE_FULLNAME_SC:
                        type: string
                        example: null
                        description: 'Cached display name optimized for search (stripped/normalized).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            MP_ID: 14780356
                            MP_ML_ID: 1462357
                            MP_NAME: SALESMAN
                            MP_VALUE: 'Qui commodi incidunt iure odit.'
                            MP_INDEX: null
                            MP_VALUE_UTF8: null
                            MP_UPDATED: '2026-02-18 15:00:09'
                            MP_L_ID: null
                        description: 'Process parameters — collection of key-value pairs associated with this process.'
                        items:
                          type: object
                          properties:
                            MP_ID:
                              type: integer
                              example: 14780356
                            MP_ML_ID:
                              type: integer
                              example: 1462357
                            MP_NAME:
                              type: string
                              example: SALESMAN
                            MP_VALUE:
                              type: string
                              example: 'Qui commodi incidunt iure odit.'
                            MP_INDEX:
                              type: string
                              example: null
                              nullable: true
                            MP_VALUE_UTF8:
                              type: string
                              example: null
                              nullable: true
                            MP_UPDATED:
                              type: string
                              example: '2026-02-18 15:00:09'
                            MP_L_ID:
                              type: string
                              example: null
                              nullable: true
                      attachments:
                        type: array
                        example:
                          -
                            FA_ID: 539950
                            FA_DOC_ID: 1462357
                            FA_DOC_TYPE: maintenance
                            FA_NAME: 'modi ipsum nostrum'
                            FA_DESC: 'Autem et consequatur aut dolores enim non facere tempora.'
                            FA_FILE_TYPE: 2
                            FA_FILE_SIZE: 2317
                            FA_FILE_NAME: vlxjkl.pdf
                            FA_DELETED: null
                            FA_CREATED: '2026-04-17 19:31:43'
                            FA_CREATE_L_ID: null
                            FA_MODIFIED: null
                            FA_MODIFY_L_ID: null
                        description: 'File attachments associated with this process.'
                        items:
                          type: object
                          properties:
                            FA_ID:
                              type: integer
                              example: 539950
                            FA_DOC_ID:
                              type: integer
                              example: 1462357
                            FA_DOC_TYPE:
                              type: string
                              example: maintenance
                            FA_NAME:
                              type: string
                              example: 'modi ipsum nostrum'
                            FA_DESC:
                              type: string
                              example: 'Autem et consequatur aut dolores enim non facere tempora.'
                            FA_FILE_TYPE:
                              type: integer
                              example: 2
                            FA_FILE_SIZE:
                              type: integer
                              example: 2317
                            FA_FILE_NAME:
                              type: string
                              example: vlxjkl.pdf
                            FA_DELETED:
                              type: string
                              example: null
                              nullable: true
                            FA_CREATED:
                              type: string
                              example: '2026-04-17 19:31:43'
                            FA_CREATE_L_ID:
                              type: string
                              example: null
                              nullable: true
                            FA_MODIFIED:
                              type: string
                              example: null
                              nullable: true
                            FA_MODIFY_L_ID:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - ML_SG_ID
                      - USER_ID
                      - STATE_ID
                      - ML_MSS_ID
                      - ML_FINISH_MSS_ID
                      - SERMAN_ID
                      - CREATE_ID
                      - ML_MTT_ID
                      - ML_NODEAVAIL_SGD_ID
                      - ML_MTT_STARTING_CODE
                      - ML_MTT_CODE
                      - NAME
                      - ML_CACHE_FULLNAME
                      - CREATION_TIME
                      - FINISH_TIME
                      - SOLVING_TIME
                      - PRE_FINISH_DATE
                      - CT
                      - ML_HPC_ID
                      - ML_PRIORITY
                      - ML_N_ID
                      - ML_SA_ID
                      - ML_O_ID
                      - ML_DOCUMENT_TYPE
                      - ML_EXTERN_SOLVED
                      - ML_FINISH_MJ_ID
                      - ML_REQUIRE_DOC_SCAN
                      - ML_INSERT_PAYMENT
                      - ML_FINISH_NOTE
                      - ML_GA_ID
                      - ML_UCP_ID
                      - ML_PREV_ML_ID
                      - ML_OI_ID
                      - ML_US_ID
                      - ML_UA_ID
                      - ML_STREET
                      - ML_HOUSE_ID
                      - ML_ZIP
                      - ML_CITY
                      - ML_USER_CONTACT
                      - ML_ML_ID
                      - ML_DR_ID
                      - ML_DESC
                      - ML_DELAY_ACCEPTED
                      - ML_PLANNING_STRATEGY
                      - ML_CACHE_ADDRESS
                      - ML_CONFIG_DATE
                      - ML_BULK
                      - ML_WAKE_TIME
                      - ML_SLA_ID
                      - ML_SLA_ACT
                      - ML_SLA_TIME
                      - ML_P_ID
                      - ML_UC_ID
                      - ML_CACHE_MTT_UNIQUE_ID
                      - ML_CACHE_MSS_UNIQUE_ID
                      - ML_CACHE_FULLNAME_SC
                      - params
                      - attachments
      tags:
        - Processes
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                type_id:
                  type: integer
                  description: 'Task type ID'
                  example: 5
                name:
                  type: string
                  description: 'Process name'
                  example: 'Network installation'
                priority:
                  type: string
                  description: 'Priority (LOW, MEDIUM, HIGH, CRITICAL)'
                  example: MEDIUM
                description:
                  type: string
                  description: 'Process description'
                  example: 'Eius et animi quos velit et.'
                customer_id:
                  type: integer
                  description: 'Customer user ID'
                  example: 100
                ml_desc:
                  type: string
                  description: 'Detailed description'
                  example: architecto
                premise_id:
                  type: integer
                  description: 'Premise ID'
                  example: 16
                uc_id:
                  type: integer
                  description: 'User contact ID'
                  example: 16
                user_contact:
                  type: string
                  description: 'User contact info'
                  example: architecto
                state_change:
                  type: integer
                  description: 'State change (0=none, 1=finish, 2=confirm, 3=confirmall)'
                  example: 16
                bulk:
                  type: integer
                  description: 'Bulk task flag (0 or 1)'
                  example: 16
                sla_id:
                  type: integer
                  description: 'SLA ID'
                  example: 16
                group_task:
                  type: integer
                  description: 'Group task flag'
                  example: 16
                params:
                  type: array
                  description: 'Process parameters array [{name, value}]'
                  example:
                    - []
                  items:
                    type: object
    delete:
      summary: 'Delete Process (State Change)'
      operationId: deleteProcessStateChange
      description: "Performs a substate transition on a process via maintenance_task_change_substate.\nRequires transition_id in the request body."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - Processes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transition_id:
                  type: integer
                  description: 'Substate transition ID (maintenance_substates_transitions.MSST_ID)'
                  example: 84
              required:
                - transition_id
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the process.'
        example: 3
        required: true
        schema:
          type: integer
  '/api/v3/processes/{process}/attachments/{attachment}/download':
    get:
      summary: 'Download Process Attachment'
      operationId: downloadProcessAttachment
      description: 'Downloads a file attachment belonging to a process.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        401:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  message: Unauthenticated.
                properties:
                  message:
                    type: string
                    example: Unauthenticated.
      tags:
        - Processes
    parameters:
      -
        in: path
        name: process
        description: 'The process.'
        example: 3
        required: true
        schema:
          type: integer
      -
        in: path
        name: attachment
        description: 'The attachment.'
        example: architecto
        required: true
        schema:
          type: string
  /api/v3/debt-recovery-processes:
    get:
      summary: 'List Debt Recovery Processes'
      operationId: listDebtRecoveryProcesses
      description: "  Returns a paginated list of debt recovery processes.\n  **At least one** of the following filters must be provided:\n  `customer`, `state`.\n  Without a narrowing filter the endpoint returns HTTP 422."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated debt recovery process IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated debt recovery process IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID.'
          example: 345
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID.'
            example: 345
        -
          in: query
          name: state
          description: 'Filter by process state. Accepts comma-separated values.'
          example: 'IN_PROGRESS,BLOCKED'
          required: false
          schema:
            type: string
            description: 'Filter by process state. Accepts comma-separated values.'
            example: 'IN_PROGRESS,BLOCKED'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      DR_ID: 492516
                      DR_U_ID: 2878
                      DR_START: '2024-08-09 00:20:56'
                      DR_STATE: BLOCKED
                      DR_ORDER: 3
                      DR_PROVISIONING: 0
                      DR_END: null
                      DR_SUSPENDED_TO: null
                      DR_UNBLOCK_FEE: 0
                      DR_CHANGED: null
                      DR_L_ID: null
                    -
                      DR_ID: 492517
                      DR_U_ID: 5485
                      DR_START: '2024-09-22 15:47:22'
                      DR_STATE: SUSPENDED
                      DR_ORDER: 5
                      DR_PROVISIONING: 1
                      DR_END: null
                      DR_SUSPENDED_TO: null
                      DR_UNBLOCK_FEE: 0
                      DR_CHANGED: null
                      DR_L_ID: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        DR_ID: 492516
                        DR_U_ID: 2878
                        DR_START: '2024-08-09 00:20:56'
                        DR_STATE: BLOCKED
                        DR_ORDER: 3
                        DR_PROVISIONING: 0
                        DR_END: null
                        DR_SUSPENDED_TO: null
                        DR_UNBLOCK_FEE: 0
                        DR_CHANGED: null
                        DR_L_ID: null
                      -
                        DR_ID: 492517
                        DR_U_ID: 5485
                        DR_START: '2024-09-22 15:47:22'
                        DR_STATE: SUSPENDED
                        DR_ORDER: 5
                        DR_PROVISIONING: 1
                        DR_END: null
                        DR_SUSPENDED_TO: null
                        DR_UNBLOCK_FEE: 0
                        DR_CHANGED: null
                        DR_L_ID: null
                    items:
                      type: object
                      properties:
                        DR_ID:
                          type: integer
                          example: 492516
                          description: 'Unique debt recovery process identifier (primary key).'
                        DR_U_ID:
                          type: integer
                          example: 2878
                          description: 'Customer (user) ID. See GET /v3/customers/{id}.'
                        DR_START:
                          type: string
                          example: '2024-08-09 00:20:56'
                          description: 'Process start date and time (YYYY-MM-DD HH:MM:SS).'
                        DR_STATE:
                          type: string
                          example: BLOCKED
                          description: 'Current process state. One of: REMINDER_GEN, REMINDER_EXP, REMINDER_ACK, SUSPENDED, IN_PROGRESS, BLOCKED, CANCELED, EXTERNAL, AVIZO.'
                        DR_ORDER:
                          type: integer
                          example: 3
                          description: 'Reminder sequence number within this process.'
                        DR_PROVISIONING:
                          type: integer
                          example: 0
                          description: 'Provisioning flag. 1 = provisioning affected.'
                        DR_END:
                          type: string
                          example: null
                          description: 'Process end date and time.'
                          nullable: true
                        DR_SUSPENDED_TO:
                          type: string
                          example: null
                          description: 'Date until which the process is suspended (YYYY-MM-DD).'
                          nullable: true
                        DR_UNBLOCK_FEE:
                          type: integer
                          example: 0
                          description: 'Unblock fee flag. 1 = fee applies.'
                        DR_CHANGED:
                          type: string
                          example: null
                          description: 'Last modification date and time.'
                          nullable: true
                        DR_L_ID:
                          type: string
                          example: null
                          description: 'Login session ID of the last modifier.'
                          nullable: true
                    required:
                      - DR_ID
                      - DR_U_ID
                      - DR_START
                      - DR_STATE
                      - DR_ORDER
                      - DR_PROVISIONING
                      - DR_END
                      - DR_SUSPENDED_TO
                      - DR_UNBLOCK_FEE
                      - DR_CHANGED
                      - DR_L_ID
      tags:
        - Reminders
  '/api/v3/debt-recovery-processes/{id}':
    get:
      summary: 'Get Debt Recovery Process'
      operationId: getDebtRecoveryProcess
      description: '  Returns a single debt recovery process by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    DR_ID: 492518
                    DR_U_ID: 2878
                    DR_START: '2024-08-09 00:20:56'
                    DR_STATE: BLOCKED
                    DR_ORDER: 3
                    DR_PROVISIONING: 0
                    DR_END: null
                    DR_SUSPENDED_TO: null
                    DR_UNBLOCK_FEE: 0
                    DR_CHANGED: null
                    DR_L_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      DR_ID:
                        type: integer
                        example: 492518
                        description: 'Unique debt recovery process identifier (primary key).'
                      DR_U_ID:
                        type: integer
                        example: 2878
                        description: 'Customer (user) ID. See GET /v3/customers/{id}.'
                      DR_START:
                        type: string
                        example: '2024-08-09 00:20:56'
                        description: 'Process start date and time (YYYY-MM-DD HH:MM:SS).'
                      DR_STATE:
                        type: string
                        example: BLOCKED
                        description: 'Current process state. One of: REMINDER_GEN, REMINDER_EXP, REMINDER_ACK, SUSPENDED, IN_PROGRESS, BLOCKED, CANCELED, EXTERNAL, AVIZO.'
                      DR_ORDER:
                        type: integer
                        example: 3
                        description: 'Reminder sequence number within this process.'
                      DR_PROVISIONING:
                        type: integer
                        example: 0
                        description: 'Provisioning flag. 1 = provisioning affected.'
                      DR_END:
                        type: string
                        example: null
                        description: 'Process end date and time.'
                        nullable: true
                      DR_SUSPENDED_TO:
                        type: string
                        example: null
                        description: 'Date until which the process is suspended (YYYY-MM-DD).'
                        nullable: true
                      DR_UNBLOCK_FEE:
                        type: integer
                        example: 0
                        description: 'Unblock fee flag. 1 = fee applies.'
                      DR_CHANGED:
                        type: string
                        example: null
                        description: 'Last modification date and time.'
                        nullable: true
                      DR_L_ID:
                        type: string
                        example: null
                        description: 'Login session ID of the last modifier.'
                        nullable: true
                    required:
                      - DR_ID
                      - DR_U_ID
                      - DR_START
                      - DR_STATE
                      - DR_ORDER
                      - DR_PROVISIONING
                      - DR_END
                      - DR_SUSPENDED_TO
                      - DR_UNBLOCK_FEE
                      - DR_CHANGED
                      - DR_L_ID
      tags:
        - Reminders
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the debt recovery process.'
        example: 1
        required: true
        schema:
          type: integer
  /api/v3/reminder-batches:
    get:
      summary: 'List Reminder Batches'
      operationId: listReminderBatches
      description: "  Returns a paginated list of reminder batches.\n  **At least one** of the following filters must be provided:\n  `date_from`, `date_to`.\n  Without a narrowing filter the endpoint returns HTTP 422.\n  Reminders within batches are NOT loaded in the list — use the detail endpoint."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated batch IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated batch IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: date_from
          description: 'Filter batches created on or after this date (YYYY-MM-DD). Applies to RHB_DATE.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter batches created on or after this date (YYYY-MM-DD). Applies to RHB_DATE.'
            example: '2024-01-01'
        -
          in: query
          name: date_to
          description: 'Filter batches created on or before this date (YYYY-MM-DD). Applies to RHB_DATE.'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter batches created on or before this date (YYYY-MM-DD). Applies to RHB_DATE.'
            example: '2024-12-31'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      RHB_ID: 5520
                      RHB_BATCH: 592
                      RHB_ML_ID: null
                      RHB_MJ_ID: null
                      RHB_TYPE: REMINDER
                      RHB_DATE: null
                      RHB_FINAL_DATE: null
                      RHB_LAST_REM_DATE: null
                      RHB_DUE_DAYS: null
                      RHB_DUE_DATE: null
                      RHB_DUE_DATE1: null
                      RHB_DUE_DATE2: null
                      RHB_TAX_DATE1: null
                      RHB_TAX_DATE2: null
                      RHB_ADDRESS: null
                      RHB_U_FILTER: null
                      RHB_NOTAX: null
                      RHB_GROUP: null
                      RHB_DEBTFROM: null
                      RHB_DEBTTO: null
                      RHB_NOTE: null
                      RHB_CREATOR: null
                      RHB_CREATED: null
                    -
                      RHB_ID: 5521
                      RHB_BATCH: 339
                      RHB_ML_ID: null
                      RHB_MJ_ID: null
                      RHB_TYPE: REMINDER
                      RHB_DATE: null
                      RHB_FINAL_DATE: null
                      RHB_LAST_REM_DATE: null
                      RHB_DUE_DAYS: null
                      RHB_DUE_DATE: null
                      RHB_DUE_DATE1: null
                      RHB_DUE_DATE2: null
                      RHB_TAX_DATE1: null
                      RHB_TAX_DATE2: null
                      RHB_ADDRESS: null
                      RHB_U_FILTER: null
                      RHB_NOTAX: null
                      RHB_GROUP: null
                      RHB_DEBTFROM: null
                      RHB_DEBTTO: null
                      RHB_NOTE: null
                      RHB_CREATOR: null
                      RHB_CREATED: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        RHB_ID: 5520
                        RHB_BATCH: 592
                        RHB_ML_ID: null
                        RHB_MJ_ID: null
                        RHB_TYPE: REMINDER
                        RHB_DATE: null
                        RHB_FINAL_DATE: null
                        RHB_LAST_REM_DATE: null
                        RHB_DUE_DAYS: null
                        RHB_DUE_DATE: null
                        RHB_DUE_DATE1: null
                        RHB_DUE_DATE2: null
                        RHB_TAX_DATE1: null
                        RHB_TAX_DATE2: null
                        RHB_ADDRESS: null
                        RHB_U_FILTER: null
                        RHB_NOTAX: null
                        RHB_GROUP: null
                        RHB_DEBTFROM: null
                        RHB_DEBTTO: null
                        RHB_NOTE: null
                        RHB_CREATOR: null
                        RHB_CREATED: null
                      -
                        RHB_ID: 5521
                        RHB_BATCH: 339
                        RHB_ML_ID: null
                        RHB_MJ_ID: null
                        RHB_TYPE: REMINDER
                        RHB_DATE: null
                        RHB_FINAL_DATE: null
                        RHB_LAST_REM_DATE: null
                        RHB_DUE_DAYS: null
                        RHB_DUE_DATE: null
                        RHB_DUE_DATE1: null
                        RHB_DUE_DATE2: null
                        RHB_TAX_DATE1: null
                        RHB_TAX_DATE2: null
                        RHB_ADDRESS: null
                        RHB_U_FILTER: null
                        RHB_NOTAX: null
                        RHB_GROUP: null
                        RHB_DEBTFROM: null
                        RHB_DEBTTO: null
                        RHB_NOTE: null
                        RHB_CREATOR: null
                        RHB_CREATED: null
                    items:
                      type: object
                      properties:
                        RHB_ID:
                          type: integer
                          example: 5520
                          description: 'Unique batch identifier (primary key).'
                        RHB_BATCH:
                          type: integer
                          example: 592
                          description: 'Batch sequence number.'
                        RHB_ML_ID:
                          type: string
                          example: null
                          description: 'Maintenance list (process) ID. See GET /v3/processes/{id}.'
                          nullable: true
                        RHB_MJ_ID:
                          type: string
                          example: null
                          description: 'Maintenance job ID within the process.'
                          nullable: true
                        RHB_TYPE:
                          type: string
                          example: REMINDER
                          description: 'Batch type identifier (up to 30 characters).'
                        RHB_DATE:
                          type: string
                          example: null
                          description: 'Batch creation/run date (YYYY-MM-DD).'
                          nullable: true
                        RHB_FINAL_DATE:
                          type: string
                          example: null
                          description: 'Payment due date for the batch (YYYY-MM-DD).'
                          nullable: true
                        RHB_LAST_REM_DATE:
                          type: string
                          example: null
                          description: 'Date of the last reminder in this batch (YYYY-MM-DD).'
                          nullable: true
                        RHB_DUE_DAYS:
                          type: string
                          example: null
                          description: 'Number of days until due.'
                          nullable: true
                        RHB_DUE_DATE:
                          type: string
                          example: null
                          description: 'Primary due date (YYYY-MM-DD).'
                          nullable: true
                        RHB_DUE_DATE1:
                          type: string
                          example: null
                          description: 'Secondary due date (YYYY-MM-DD).'
                          nullable: true
                        RHB_DUE_DATE2:
                          type: string
                          example: null
                          description: 'Tertiary due date (YYYY-MM-DD).'
                          nullable: true
                        RHB_TAX_DATE1:
                          type: string
                          example: null
                          description: 'Tax period start date (YYYY-MM-DD).'
                          nullable: true
                        RHB_TAX_DATE2:
                          type: string
                          example: null
                          description: 'Tax period end date (YYYY-MM-DD).'
                          nullable: true
                        RHB_ADDRESS:
                          type: string
                          example: null
                          description: 'Delivery address override (up to 100 characters).'
                          nullable: true
                        RHB_U_FILTER:
                          type: string
                          example: null
                          description: 'Customer filter ID applied during batch generation.'
                          nullable: true
                        RHB_NOTAX:
                          type: string
                          example: null
                          description: 'Exclude tax documents flag.'
                          nullable: true
                        RHB_GROUP:
                          type: string
                          example: null
                          description: 'Customer group filter (up to 10 characters).'
                          nullable: true
                        RHB_DEBTFROM:
                          type: string
                          example: null
                          description: 'Minimum debt threshold for inclusion.'
                          nullable: true
                        RHB_DEBTTO:
                          type: string
                          example: null
                          description: 'Maximum debt threshold for inclusion.'
                          nullable: true
                        RHB_NOTE:
                          type: string
                          example: null
                          description: 'Batch note / description.'
                          nullable: true
                        RHB_CREATOR:
                          type: string
                          example: null
                          description: 'Login ID of the batch creator.'
                          nullable: true
                        RHB_CREATED:
                          type: string
                          example: null
                          description: 'Batch creation timestamp (YYYY-MM-DD HH:MM:SS).'
                          nullable: true
                    required:
                      - RHB_ID
                      - RHB_BATCH
                      - RHB_ML_ID
                      - RHB_MJ_ID
                      - RHB_TYPE
                      - RHB_DATE
                      - RHB_FINAL_DATE
                      - RHB_LAST_REM_DATE
                      - RHB_DUE_DAYS
                      - RHB_DUE_DATE
                      - RHB_DUE_DATE1
                      - RHB_DUE_DATE2
                      - RHB_TAX_DATE1
                      - RHB_TAX_DATE2
                      - RHB_ADDRESS
                      - RHB_U_FILTER
                      - RHB_NOTAX
                      - RHB_GROUP
                      - RHB_DEBTFROM
                      - RHB_DEBTTO
                      - RHB_NOTE
                      - RHB_CREATOR
                      - RHB_CREATED
      tags:
        - Reminders
  '/api/v3/reminder-batches/{id}':
    get:
      summary: 'Get Reminder Batch'
      operationId: getReminderBatch
      description: "  Returns a single reminder batch by ID.\n  Includes the `reminders` relation (loaded only in this detail view)."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    RHB_ID: 5522
                    RHB_BATCH: 592
                    RHB_ML_ID: null
                    RHB_MJ_ID: null
                    RHB_TYPE: REMINDER
                    RHB_DATE: null
                    RHB_FINAL_DATE: null
                    RHB_LAST_REM_DATE: null
                    RHB_DUE_DAYS: null
                    RHB_DUE_DATE: null
                    RHB_DUE_DATE1: null
                    RHB_DUE_DATE2: null
                    RHB_TAX_DATE1: null
                    RHB_TAX_DATE2: null
                    RHB_ADDRESS: null
                    RHB_U_FILTER: null
                    RHB_NOTAX: null
                    RHB_GROUP: null
                    RHB_DEBTFROM: null
                    RHB_DEBTTO: null
                    RHB_NOTE: null
                    RHB_CREATOR: null
                    RHB_CREATED: null
                    reminders:
                      -
                        ID: 1840896
                        RH_DOC_ID: 80304
                        USER_ID: 2617
                        DATE_REMIND: '2010-09-13'
                        NOTE: 0
                        CT: 40
                        SEND_NOTE: null
                        RH_ORDER: 1
                        RH_AUTHOR: 274
                        RH_CREATED: null
                        RH_FINAL_DATE: null
                        RH_NOTE: null
                        RH_RHB_ID: 5522
                        RH_DATE_ACK: null
                        RH_DR_ID: null
                        RH_PROVIDER_USER_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      RHB_ID:
                        type: integer
                        example: 5522
                        description: 'Unique batch identifier (primary key).'
                      RHB_BATCH:
                        type: integer
                        example: 592
                        description: 'Batch sequence number.'
                      RHB_ML_ID:
                        type: string
                        example: null
                        description: 'Maintenance list (process) ID. See GET /v3/processes/{id}.'
                        nullable: true
                      RHB_MJ_ID:
                        type: string
                        example: null
                        description: 'Maintenance job ID within the process.'
                        nullable: true
                      RHB_TYPE:
                        type: string
                        example: REMINDER
                        description: 'Batch type identifier (up to 30 characters).'
                      RHB_DATE:
                        type: string
                        example: null
                        description: 'Batch creation/run date (YYYY-MM-DD).'
                        nullable: true
                      RHB_FINAL_DATE:
                        type: string
                        example: null
                        description: 'Payment due date for the batch (YYYY-MM-DD).'
                        nullable: true
                      RHB_LAST_REM_DATE:
                        type: string
                        example: null
                        description: 'Date of the last reminder in this batch (YYYY-MM-DD).'
                        nullable: true
                      RHB_DUE_DAYS:
                        type: string
                        example: null
                        description: 'Number of days until due.'
                        nullable: true
                      RHB_DUE_DATE:
                        type: string
                        example: null
                        description: 'Primary due date (YYYY-MM-DD).'
                        nullable: true
                      RHB_DUE_DATE1:
                        type: string
                        example: null
                        description: 'Secondary due date (YYYY-MM-DD).'
                        nullable: true
                      RHB_DUE_DATE2:
                        type: string
                        example: null
                        description: 'Tertiary due date (YYYY-MM-DD).'
                        nullable: true
                      RHB_TAX_DATE1:
                        type: string
                        example: null
                        description: 'Tax period start date (YYYY-MM-DD).'
                        nullable: true
                      RHB_TAX_DATE2:
                        type: string
                        example: null
                        description: 'Tax period end date (YYYY-MM-DD).'
                        nullable: true
                      RHB_ADDRESS:
                        type: string
                        example: null
                        description: 'Delivery address override (up to 100 characters).'
                        nullable: true
                      RHB_U_FILTER:
                        type: string
                        example: null
                        description: 'Customer filter ID applied during batch generation.'
                        nullable: true
                      RHB_NOTAX:
                        type: string
                        example: null
                        description: 'Exclude tax documents flag.'
                        nullable: true
                      RHB_GROUP:
                        type: string
                        example: null
                        description: 'Customer group filter (up to 10 characters).'
                        nullable: true
                      RHB_DEBTFROM:
                        type: string
                        example: null
                        description: 'Minimum debt threshold for inclusion.'
                        nullable: true
                      RHB_DEBTTO:
                        type: string
                        example: null
                        description: 'Maximum debt threshold for inclusion.'
                        nullable: true
                      RHB_NOTE:
                        type: string
                        example: null
                        description: 'Batch note / description.'
                        nullable: true
                      RHB_CREATOR:
                        type: string
                        example: null
                        description: 'Login ID of the batch creator.'
                        nullable: true
                      RHB_CREATED:
                        type: string
                        example: null
                        description: 'Batch creation timestamp (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      reminders:
                        type: array
                        example:
                          -
                            ID: 1840896
                            RH_DOC_ID: 80304
                            USER_ID: 2617
                            DATE_REMIND: '2010-09-13'
                            NOTE: 0
                            CT: 40
                            SEND_NOTE: null
                            RH_ORDER: 1
                            RH_AUTHOR: 274
                            RH_CREATED: null
                            RH_FINAL_DATE: null
                            RH_NOTE: null
                            RH_RHB_ID: 5522
                            RH_DATE_ACK: null
                            RH_DR_ID: null
                            RH_PROVIDER_USER_ID: null
                        description: 'Reminders in this batch (loaded in detail view only).'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 1840896
                            RH_DOC_ID:
                              type: integer
                              example: 80304
                            USER_ID:
                              type: integer
                              example: 2617
                            DATE_REMIND:
                              type: string
                              example: '2010-09-13'
                            NOTE:
                              type: integer
                              example: 0
                            CT:
                              type: integer
                              example: 40
                            SEND_NOTE:
                              type: string
                              example: null
                              nullable: true
                            RH_ORDER:
                              type: integer
                              example: 1
                            RH_AUTHOR:
                              type: integer
                              example: 274
                            RH_CREATED:
                              type: string
                              example: null
                              nullable: true
                            RH_FINAL_DATE:
                              type: string
                              example: null
                              nullable: true
                            RH_NOTE:
                              type: string
                              example: null
                              nullable: true
                            RH_RHB_ID:
                              type: integer
                              example: 5522
                            RH_DATE_ACK:
                              type: string
                              example: null
                              nullable: true
                            RH_DR_ID:
                              type: string
                              example: null
                              nullable: true
                            RH_PROVIDER_USER_ID:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - RHB_ID
                      - RHB_BATCH
                      - RHB_ML_ID
                      - RHB_MJ_ID
                      - RHB_TYPE
                      - RHB_DATE
                      - RHB_FINAL_DATE
                      - RHB_LAST_REM_DATE
                      - RHB_DUE_DAYS
                      - RHB_DUE_DATE
                      - RHB_DUE_DATE1
                      - RHB_DUE_DATE2
                      - RHB_TAX_DATE1
                      - RHB_TAX_DATE2
                      - RHB_ADDRESS
                      - RHB_U_FILTER
                      - RHB_NOTAX
                      - RHB_GROUP
                      - RHB_DEBTFROM
                      - RHB_DEBTTO
                      - RHB_NOTE
                      - RHB_CREATOR
                      - RHB_CREATED
                      - reminders
      tags:
        - Reminders
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the reminder batch.'
        example: 1
        required: true
        schema:
          type: integer
  /api/v3/reminders:
    get:
      summary: 'List Reminders'
      operationId: listReminders
      description: "  Returns a paginated list of reminders with computed financial data and line items.\n  **At least one** of the following filters must be provided:\n  `customer`, `batch`, `date_from`, `year`.\n  Without a narrowing filter the endpoint returns HTTP 422."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated reminder IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated reminder IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID.'
          example: 345
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID.'
            example: 345
        -
          in: query
          name: batch
          description: 'Filter by reminder batch ID.'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by reminder batch ID.'
            example: 100
        -
          in: query
          name: debt_recovery
          description: 'Filter by debt recovery process ID.'
          example: 50
          required: false
          schema:
            type: integer
            description: 'Filter by debt recovery process ID.'
            example: 50
        -
          in: query
          name: provider
          description: 'Filter by provider (user) ID.'
          example: 200
          required: false
          schema:
            type: integer
            description: 'Filter by provider (user) ID.'
            example: 200
        -
          in: query
          name: date_from
          description: 'Filter reminders issued on or after this date (YYYY-MM-DD). Applies to DATE_REMIND.'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter reminders issued on or after this date (YYYY-MM-DD). Applies to DATE_REMIND.'
            example: '2024-01-01'
        -
          in: query
          name: date_to
          description: 'Filter reminders issued on or before this date (YYYY-MM-DD). Applies to DATE_REMIND.'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter reminders issued on or before this date (YYYY-MM-DD). Applies to DATE_REMIND.'
            example: '2024-12-31'
        -
          in: query
          name: order
          description: 'Filter by reminder sequence number (1st, 2nd, etc.).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by reminder sequence number (1st, 2nd, etc.).'
            example: 1
        -
          in: query
          name: year
          description: 'Filter by year extracted from DATE_REMIND.'
          example: 2024
          required: false
          schema:
            type: integer
            description: 'Filter by year extracted from DATE_REMIND.'
            example: 2024
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 1840897
                      RH_DOC_ID: 79198
                      USER_ID: 2839
                      DATE_REMIND: '2006-09-20'
                      NOTE: 0
                      CT: 43
                      SEND_NOTE: null
                      RH_ORDER: 2
                      RH_AUTHOR: 481
                      RH_CREATED: null
                      RH_FINAL_DATE: null
                      RH_NOTE: null
                      RH_RHB_ID: null
                      RH_DATE_ACK: null
                      RH_DR_ID: null
                      RH_PROVIDER_USER_ID: null
                      items:
                        -
                          ID: 4112094
                          ID_REMIND: 1840897
                          AMOUNT: '2045.3884'
                          MONTH: '12'
                          YEAR: '2021'
                          USER_SERVICE_ID: 1839
                          RB_PAID: '4426.6266'
                          RB_MATURITY: null
                          RB_DELAY: null
                          RB_ITD_ID: 35644
                          RB_ITD_ADVANCE_ID: 0
                          RB_SA_BASE_ID: null
                    -
                      ID: 1840898
                      RH_DOC_ID: 8317
                      USER_ID: 7018
                      DATE_REMIND: '2009-07-27'
                      NOTE: 0
                      CT: 38
                      SEND_NOTE: null
                      RH_ORDER: 2
                      RH_AUTHOR: 94
                      RH_CREATED: null
                      RH_FINAL_DATE: null
                      RH_NOTE: null
                      RH_RHB_ID: null
                      RH_DATE_ACK: null
                      RH_DR_ID: null
                      RH_PROVIDER_USER_ID: null
                      items:
                        -
                          ID: 4112095
                          ID_REMIND: 1840898
                          AMOUNT: '2384.8442'
                          MONTH: '02'
                          YEAR: '2020'
                          USER_SERVICE_ID: 5040
                          RB_PAID: '3688.2401'
                          RB_MATURITY: null
                          RB_DELAY: null
                          RB_ITD_ID: 20535
                          RB_ITD_ADVANCE_ID: 0
                          RB_SA_BASE_ID: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 1840897
                        RH_DOC_ID: 79198
                        USER_ID: 2839
                        DATE_REMIND: '2006-09-20'
                        NOTE: 0
                        CT: 43
                        SEND_NOTE: null
                        RH_ORDER: 2
                        RH_AUTHOR: 481
                        RH_CREATED: null
                        RH_FINAL_DATE: null
                        RH_NOTE: null
                        RH_RHB_ID: null
                        RH_DATE_ACK: null
                        RH_DR_ID: null
                        RH_PROVIDER_USER_ID: null
                        items:
                          -
                            ID: 4112094
                            ID_REMIND: 1840897
                            AMOUNT: '2045.3884'
                            MONTH: '12'
                            YEAR: '2021'
                            USER_SERVICE_ID: 1839
                            RB_PAID: '4426.6266'
                            RB_MATURITY: null
                            RB_DELAY: null
                            RB_ITD_ID: 35644
                            RB_ITD_ADVANCE_ID: 0
                            RB_SA_BASE_ID: null
                      -
                        ID: 1840898
                        RH_DOC_ID: 8317
                        USER_ID: 7018
                        DATE_REMIND: '2009-07-27'
                        NOTE: 0
                        CT: 38
                        SEND_NOTE: null
                        RH_ORDER: 2
                        RH_AUTHOR: 94
                        RH_CREATED: null
                        RH_FINAL_DATE: null
                        RH_NOTE: null
                        RH_RHB_ID: null
                        RH_DATE_ACK: null
                        RH_DR_ID: null
                        RH_PROVIDER_USER_ID: null
                        items:
                          -
                            ID: 4112095
                            ID_REMIND: 1840898
                            AMOUNT: '2384.8442'
                            MONTH: '02'
                            YEAR: '2020'
                            USER_SERVICE_ID: 5040
                            RB_PAID: '3688.2401'
                            RB_MATURITY: null
                            RB_DELAY: null
                            RB_ITD_ID: 20535
                            RB_ITD_ADVANCE_ID: 0
                            RB_SA_BASE_ID: null
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 1840897
                          description: 'Unique reminder identifier (primary key).'
                        RH_DOC_ID:
                          type: integer
                          example: 79198
                          description: 'Reminder document number.'
                        USER_ID:
                          type: integer
                          example: 2839
                          description: 'Customer (user) ID. See GET /v3/customers/{id}.'
                        DATE_REMIND:
                          type: string
                          example: '2006-09-20'
                          description: 'Reminder issue date (YYYY-MM-DD).'
                        NOTE:
                          type: integer
                          example: 0
                          description: 'Legacy note code.'
                          nullable: true
                        CT:
                          type: integer
                          example: 43
                          description: 'Location / installation CT ID.'
                        SEND_NOTE:
                          type: string
                          example: null
                          description: 'Note displayed on the reminder document.'
                          nullable: true
                        RH_ORDER:
                          type: integer
                          example: 2
                          description: 'Reminder sequence number (1st, 2nd, etc.).'
                        RH_AUTHOR:
                          type: integer
                          example: 481
                          description: 'Login ID of the reminder creator.'
                        RH_CREATED:
                          type: string
                          example: null
                          description: 'Creation timestamp (YYYY-MM-DD HH:MM:SS).'
                          nullable: true
                        RH_FINAL_DATE:
                          type: string
                          example: null
                          description: 'Payment due date (YYYY-MM-DD).'
                          nullable: true
                        RH_NOTE:
                          type: string
                          example: null
                          description: 'Extended internal note.'
                          nullable: true
                        RH_RHB_ID:
                          type: string
                          example: null
                          description: 'Reminder batch ID. See GET /v3/reminder-batches/{id}.'
                          nullable: true
                        RH_DATE_ACK:
                          type: string
                          example: null
                          description: 'Acknowledgment timestamp.'
                          nullable: true
                        RH_DR_ID:
                          type: string
                          example: null
                          description: 'Debt recovery process ID. See GET /v3/debt-recovery-processes/{id}.'
                          nullable: true
                        RH_PROVIDER_USER_ID:
                          type: string
                          example: null
                          description: 'Provider (user) ID.'
                          nullable: true
                        items:
                          type: array
                          example:
                            -
                              ID: 4112094
                              ID_REMIND: 1840897
                              AMOUNT: '2045.3884'
                              MONTH: '12'
                              YEAR: '2021'
                              USER_SERVICE_ID: 1839
                              RB_PAID: '4426.6266'
                              RB_MATURITY: null
                              RB_DELAY: null
                              RB_ITD_ID: 35644
                              RB_ITD_ADVANCE_ID: 0
                              RB_SA_BASE_ID: null
                          description: 'Reminder line items (always included).'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 4112094
                              ID_REMIND:
                                type: integer
                                example: 1840897
                              AMOUNT:
                                type: string
                                example: '2045.3884'
                              MONTH:
                                type: string
                                example: '12'
                              YEAR:
                                type: string
                                example: '2021'
                              USER_SERVICE_ID:
                                type: integer
                                example: 1839
                              RB_PAID:
                                type: string
                                example: '4426.6266'
                              RB_MATURITY:
                                type: string
                                example: null
                                nullable: true
                              RB_DELAY:
                                type: string
                                example: null
                                nullable: true
                              RB_ITD_ID:
                                type: integer
                                example: 35644
                              RB_ITD_ADVANCE_ID:
                                type: integer
                                example: 0
                              RB_SA_BASE_ID:
                                type: string
                                example: null
                                nullable: true
                    required:
                      - ID
                      - RH_DOC_ID
                      - USER_ID
                      - DATE_REMIND
                      - NOTE
                      - CT
                      - SEND_NOTE
                      - RH_ORDER
                      - RH_AUTHOR
                      - RH_CREATED
                      - RH_FINAL_DATE
                      - RH_NOTE
                      - RH_RHB_ID
                      - RH_DATE_ACK
                      - RH_DR_ID
                      - RH_PROVIDER_USER_ID
                      - items
      tags:
        - Reminders
  '/api/v3/reminders/{id}':
    get:
      summary: 'Get Reminder'
      operationId: getReminder
      description: '  Returns a single reminder by ID with computed financial data and line items.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 1840899
                    RH_DOC_ID: 79198
                    USER_ID: 2839
                    DATE_REMIND: '2006-09-20'
                    NOTE: 0
                    CT: 43
                    SEND_NOTE: null
                    RH_ORDER: 2
                    RH_AUTHOR: 481
                    RH_CREATED: null
                    RH_FINAL_DATE: null
                    RH_NOTE: null
                    RH_RHB_ID: null
                    RH_DATE_ACK: null
                    RH_DR_ID: null
                    RH_PROVIDER_USER_ID: null
                    items:
                      -
                        ID: 4112096
                        ID_REMIND: 1840899
                        AMOUNT: '2045.3884'
                        MONTH: '12'
                        YEAR: '2021'
                        USER_SERVICE_ID: 1839
                        RB_PAID: '4426.6266'
                        RB_MATURITY: null
                        RB_DELAY: null
                        RB_ITD_ID: 35644
                        RB_ITD_ADVANCE_ID: 0
                        RB_SA_BASE_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 1840899
                        description: 'Unique reminder identifier (primary key).'
                      RH_DOC_ID:
                        type: integer
                        example: 79198
                        description: 'Reminder document number.'
                      USER_ID:
                        type: integer
                        example: 2839
                        description: 'Customer (user) ID. See GET /v3/customers/{id}.'
                      DATE_REMIND:
                        type: string
                        example: '2006-09-20'
                        description: 'Reminder issue date (YYYY-MM-DD).'
                      NOTE:
                        type: integer
                        example: 0
                        description: 'Legacy note code.'
                        nullable: true
                      CT:
                        type: integer
                        example: 43
                        description: 'Location / installation CT ID.'
                      SEND_NOTE:
                        type: string
                        example: null
                        description: 'Note displayed on the reminder document.'
                        nullable: true
                      RH_ORDER:
                        type: integer
                        example: 2
                        description: 'Reminder sequence number (1st, 2nd, etc.).'
                      RH_AUTHOR:
                        type: integer
                        example: 481
                        description: 'Login ID of the reminder creator.'
                      RH_CREATED:
                        type: string
                        example: null
                        description: 'Creation timestamp (YYYY-MM-DD HH:MM:SS).'
                        nullable: true
                      RH_FINAL_DATE:
                        type: string
                        example: null
                        description: 'Payment due date (YYYY-MM-DD).'
                        nullable: true
                      RH_NOTE:
                        type: string
                        example: null
                        description: 'Extended internal note.'
                        nullable: true
                      RH_RHB_ID:
                        type: string
                        example: null
                        description: 'Reminder batch ID. See GET /v3/reminder-batches/{id}.'
                        nullable: true
                      RH_DATE_ACK:
                        type: string
                        example: null
                        description: 'Acknowledgment timestamp.'
                        nullable: true
                      RH_DR_ID:
                        type: string
                        example: null
                        description: 'Debt recovery process ID. See GET /v3/debt-recovery-processes/{id}.'
                        nullable: true
                      RH_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider (user) ID.'
                        nullable: true
                      items:
                        type: array
                        example:
                          -
                            ID: 4112096
                            ID_REMIND: 1840899
                            AMOUNT: '2045.3884'
                            MONTH: '12'
                            YEAR: '2021'
                            USER_SERVICE_ID: 1839
                            RB_PAID: '4426.6266'
                            RB_MATURITY: null
                            RB_DELAY: null
                            RB_ITD_ID: 35644
                            RB_ITD_ADVANCE_ID: 0
                            RB_SA_BASE_ID: null
                        description: 'Reminder line items (always included).'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 4112096
                            ID_REMIND:
                              type: integer
                              example: 1840899
                            AMOUNT:
                              type: string
                              example: '2045.3884'
                            MONTH:
                              type: string
                              example: '12'
                            YEAR:
                              type: string
                              example: '2021'
                            USER_SERVICE_ID:
                              type: integer
                              example: 1839
                            RB_PAID:
                              type: string
                              example: '4426.6266'
                            RB_MATURITY:
                              type: string
                              example: null
                              nullable: true
                            RB_DELAY:
                              type: string
                              example: null
                              nullable: true
                            RB_ITD_ID:
                              type: integer
                              example: 35644
                            RB_ITD_ADVANCE_ID:
                              type: integer
                              example: 0
                            RB_SA_BASE_ID:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - ID
                      - RH_DOC_ID
                      - USER_ID
                      - DATE_REMIND
                      - NOTE
                      - CT
                      - SEND_NOTE
                      - RH_ORDER
                      - RH_AUTHOR
                      - RH_CREATED
                      - RH_FINAL_DATE
                      - RH_NOTE
                      - RH_RHB_ID
                      - RH_DATE_ACK
                      - RH_DR_ID
                      - RH_PROVIDER_USER_ID
                      - items
      tags:
        - Reminders
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the reminder.'
        example: 1732
        required: true
        schema:
          type: integer
  /api/v3/rights-definitions:
    get:
      summary: 'List Right Definitions'
      operationId: listRightDefinitions
      description: "Returns a paginated list of all right definitions (global codelist).\nNo CT or partner scoping — this is a system-wide catalogue of available rights."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of results per page.'
          example: 15
          required: false
          schema:
            type: integer
            description: 'Number of results per page.'
            example: 15
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated right definition IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated right definition IDs.'
            example: '1,2,3'
        -
          in: query
          name: search
          description: 'Search in right name (RD_NAME).'
          example: MODULE
          required: false
          schema:
            type: string
            description: 'Search in right name (RD_NAME).'
            example: MODULE
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      RD_ID: 3692
                      RD_NAME: adipisci-quidem-nostrum
                      RD_LEVEL: 10
                      RD_ROLES_ACCESS: 1
                      RD_DISTINCT: 1
                      RD_TYPE: MODULE
                      RD_DOMAIN: null
                      RD_SETTING: 0
                      RD_CATEGORY: OTHER
                    -
                      RD_ID: 3693
                      RD_NAME: omnis-autem
                      RD_LEVEL: 10
                      RD_ROLES_ACCESS: 1
                      RD_DISTINCT: 1
                      RD_TYPE: SELECT
                      RD_DOMAIN: null
                      RD_SETTING: 0
                      RD_CATEGORY: OTHER
                properties:
                  data:
                    type: array
                    example:
                      -
                        RD_ID: 3692
                        RD_NAME: adipisci-quidem-nostrum
                        RD_LEVEL: 10
                        RD_ROLES_ACCESS: 1
                        RD_DISTINCT: 1
                        RD_TYPE: MODULE
                        RD_DOMAIN: null
                        RD_SETTING: 0
                        RD_CATEGORY: OTHER
                      -
                        RD_ID: 3693
                        RD_NAME: omnis-autem
                        RD_LEVEL: 10
                        RD_ROLES_ACCESS: 1
                        RD_DISTINCT: 1
                        RD_TYPE: SELECT
                        RD_DOMAIN: null
                        RD_SETTING: 0
                        RD_CATEGORY: OTHER
                    items:
                      type: object
                      properties:
                        RD_ID:
                          type: integer
                          example: 3692
                          description: 'Unique right definition identifier (primary key).'
                        RD_NAME:
                          type: string
                          example: adipisci-quidem-nostrum
                          description: 'Unique right name/key.'
                        RD_LEVEL:
                          type: integer
                          example: 10
                          description: 'Visibility level. Only operators with equal or higher level can see/assign this right.'
                        RD_ROLES_ACCESS:
                          type: integer
                          example: 1
                          description: 'Flag: right is assignable via roles (0/1).'
                        RD_DISTINCT:
                          type: integer
                          example: 1
                          description: 'Flag: distinct behavior for value deduplication (0/1).'
                        RD_TYPE:
                          type: string
                          example: MODULE
                          description: 'Data type of the right value.'
                          enum:
                            - BOOL
                            - LOCID
                            - NODEID
                            - NUM
                            - PAID
                            - SELECT
                            - STRING
                            - MENUID
                            - MODULE
                            - MODULEVIEW
                            - GROUP
                            - CLASS_DEF
                            - RADIOGROUP
                            - TEXT
                        RD_DOMAIN:
                          type: string
                          example: null
                          description: 'Comma-separated list of allowed values (domain).'
                          nullable: true
                        RD_SETTING:
                          type: integer
                          example: 0
                          description: 'Flag: system setting right (0/1).'
                        RD_CATEGORY:
                          type: string
                          example: OTHER
                          description: 'Right category.'
                          enum:
                            - OTHER
                            - OBJECT
                            - ACTION
                    required:
                      - RD_ID
                      - RD_NAME
                      - RD_LEVEL
                      - RD_ROLES_ACCESS
                      - RD_DISTINCT
                      - RD_TYPE
                      - RD_DOMAIN
                      - RD_SETTING
                      - RD_CATEGORY
      tags:
        - 'Right Definitions'
  /api/v3/sipo-contracts:
    get:
      summary: 'List SIPO Contracts'
      operationId: listSIPOContracts
      description: "  Returns a paginated list of SIPO / INKASO collection contracts.\n  Each contract includes its assigned business locations."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated contract IDs.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated contract IDs.'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '12,14'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '12,14'
        -
          in: query
          name: collection_type
          description: 'Filter by collection type.'
          example: SIPO
          required: false
          schema:
            type: string
            description: 'Filter by collection type.'
            example: SIPO
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      SCL_ID: 70
                      SCL_ORGNUM: 857680
                      SCL_EXPORT_TYPE: FULL
                      SCL_PA_ID: 921
                      SCL_LIMIT_DAY: 26
                      SCL_NOTE: 'Qui commodi incidunt iure odit.'
                      SCL_CP_ID: 38
                      SCL_COLLECTION_TYPE: SIPO
                      SCL_MATURITY: 45
                      SCL_CREATED: '2026-01-17 21:01:07'
                      SCL_CREATE_L_ID: 247
                      locations:
                        -
                          SCLL_ID: 156
                          SCLL_SCL_ID: 70
                          SCLL_CT: 211
                          SCLL_PROVIDER_USER_ID: null
                    -
                      SCL_ID: 71
                      SCL_ORGNUM: 469606
                      SCL_EXPORT_TYPE: FULL
                      SCL_PA_ID: 600
                      SCL_LIMIT_DAY: 16
                      SCL_NOTE: 'Dolores enim non facere tempora.'
                      SCL_CP_ID: 2
                      SCL_COLLECTION_TYPE: FETCH
                      SCL_MATURITY: 51
                      SCL_CREATED: '2026-01-04 23:46:27'
                      SCL_CREATE_L_ID: 292
                      locations:
                        -
                          SCLL_ID: 157
                          SCLL_SCL_ID: 71
                          SCLL_CT: 174
                          SCLL_PROVIDER_USER_ID: 89143
                properties:
                  data:
                    type: array
                    example:
                      -
                        SCL_ID: 70
                        SCL_ORGNUM: 857680
                        SCL_EXPORT_TYPE: FULL
                        SCL_PA_ID: 921
                        SCL_LIMIT_DAY: 26
                        SCL_NOTE: 'Qui commodi incidunt iure odit.'
                        SCL_CP_ID: 38
                        SCL_COLLECTION_TYPE: SIPO
                        SCL_MATURITY: 45
                        SCL_CREATED: '2026-01-17 21:01:07'
                        SCL_CREATE_L_ID: 247
                        locations:
                          -
                            SCLL_ID: 156
                            SCLL_SCL_ID: 70
                            SCLL_CT: 211
                            SCLL_PROVIDER_USER_ID: null
                      -
                        SCL_ID: 71
                        SCL_ORGNUM: 469606
                        SCL_EXPORT_TYPE: FULL
                        SCL_PA_ID: 600
                        SCL_LIMIT_DAY: 16
                        SCL_NOTE: 'Dolores enim non facere tempora.'
                        SCL_CP_ID: 2
                        SCL_COLLECTION_TYPE: FETCH
                        SCL_MATURITY: 51
                        SCL_CREATED: '2026-01-04 23:46:27'
                        SCL_CREATE_L_ID: 292
                        locations:
                          -
                            SCLL_ID: 157
                            SCLL_SCL_ID: 71
                            SCLL_CT: 174
                            SCLL_PROVIDER_USER_ID: 89143
                    items:
                      type: object
                      properties:
                        SCL_ID:
                          type: integer
                          example: 70
                          description: 'Unique contract ID.'
                        SCL_ORGNUM:
                          type: integer
                          example: 857680
                          description: 'Organization number (6-digit, Czech Post). Relevant only for SIPO type.'
                        SCL_EXPORT_TYPE:
                          type: string
                          example: FULL
                          description: 'Export type.'
                          enum:
                            - FULL
                            - CHANGES
                        SCL_PA_ID:
                          type: integer
                          example: 921
                          description: 'Payment account ID. Relevant only for SIPO type.'
                          nullable: true
                        SCL_LIMIT_DAY:
                          type: integer
                          example: 26
                          description: 'Monthly deadline day for SIPO prescriptions (1–28).'
                          nullable: true
                        SCL_NOTE:
                          type: string
                          example: 'Qui commodi incidunt iure odit.'
                          description: 'Note / description.'
                          nullable: true
                        SCL_CP_ID:
                          type: integer
                          example: 38
                          description: 'CIBS partner (operator) ID.'
                        SCL_COLLECTION_TYPE:
                          type: string
                          example: SIPO
                          description: 'Collection type.'
                          enum:
                            - SIPO
                            - FETCH
                        SCL_MATURITY:
                          type: integer
                          example: 45
                          description: 'Maturity days for money-in-transit calculation.'
                        SCL_CREATED:
                          type: string
                          example: '2026-01-17 21:01:07'
                          description: 'Creation timestamp.'
                          nullable: true
                        SCL_CREATE_L_ID:
                          type: integer
                          example: 247
                          description: 'Login ID of the creator.'
                          nullable: true
                        locations:
                          type: array
                          example:
                            -
                              SCLL_ID: 156
                              SCLL_SCL_ID: 70
                              SCLL_CT: 211
                              SCLL_PROVIDER_USER_ID: null
                          description: 'Assigned business locations.'
                          items:
                            type: object
                            properties:
                              SCLL_ID:
                                type: integer
                                example: 156
                              SCLL_SCL_ID:
                                type: integer
                                example: 70
                              SCLL_CT:
                                type: integer
                                example: 211
                              SCLL_PROVIDER_USER_ID:
                                type: string
                                example: null
                                nullable: true
                    required:
                      - SCL_ID
                      - SCL_ORGNUM
                      - SCL_EXPORT_TYPE
                      - SCL_PA_ID
                      - SCL_LIMIT_DAY
                      - SCL_NOTE
                      - SCL_CP_ID
                      - SCL_COLLECTION_TYPE
                      - SCL_MATURITY
                      - SCL_CREATED
                      - SCL_CREATE_L_ID
                      - locations
      tags:
        - SIPO
  '/api/v3/sipo-contracts/{id}':
    get:
      summary: 'Get SIPO Contract'
      operationId: getSIPOContract
      description: "  Returns a single SIPO / INKASO collection contract by ID,\n  including its assigned business locations."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    SCL_ID: 72
                    SCL_ORGNUM: 857680
                    SCL_EXPORT_TYPE: FULL
                    SCL_PA_ID: 814
                    SCL_LIMIT_DAY: 26
                    SCL_NOTE: 'Qui commodi incidunt iure odit.'
                    SCL_CP_ID: 118
                    SCL_COLLECTION_TYPE: SIPO
                    SCL_MATURITY: 45
                    SCL_CREATED: '2026-01-17 21:01:07'
                    SCL_CREATE_L_ID: 247
                    locations:
                      -
                        SCLL_ID: 158
                        SCLL_SCL_ID: 72
                        SCLL_CT: 75
                        SCLL_PROVIDER_USER_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      SCL_ID:
                        type: integer
                        example: 72
                        description: 'Unique contract ID.'
                      SCL_ORGNUM:
                        type: integer
                        example: 857680
                        description: 'Organization number (6-digit, Czech Post). Relevant only for SIPO type.'
                      SCL_EXPORT_TYPE:
                        type: string
                        example: FULL
                        description: 'Export type.'
                        enum:
                          - FULL
                          - CHANGES
                      SCL_PA_ID:
                        type: integer
                        example: 814
                        description: 'Payment account ID. Relevant only for SIPO type.'
                        nullable: true
                      SCL_LIMIT_DAY:
                        type: integer
                        example: 26
                        description: 'Monthly deadline day for SIPO prescriptions (1–28).'
                        nullable: true
                      SCL_NOTE:
                        type: string
                        example: 'Qui commodi incidunt iure odit.'
                        description: 'Note / description.'
                        nullable: true
                      SCL_CP_ID:
                        type: integer
                        example: 118
                        description: 'CIBS partner (operator) ID.'
                      SCL_COLLECTION_TYPE:
                        type: string
                        example: SIPO
                        description: 'Collection type.'
                        enum:
                          - SIPO
                          - FETCH
                      SCL_MATURITY:
                        type: integer
                        example: 45
                        description: 'Maturity days for money-in-transit calculation.'
                      SCL_CREATED:
                        type: string
                        example: '2026-01-17 21:01:07'
                        description: 'Creation timestamp.'
                        nullable: true
                      SCL_CREATE_L_ID:
                        type: integer
                        example: 247
                        description: 'Login ID of the creator.'
                        nullable: true
                      locations:
                        type: array
                        example:
                          -
                            SCLL_ID: 158
                            SCLL_SCL_ID: 72
                            SCLL_CT: 75
                            SCLL_PROVIDER_USER_ID: null
                        description: 'Assigned business locations.'
                        items:
                          type: object
                          properties:
                            SCLL_ID:
                              type: integer
                              example: 158
                            SCLL_SCL_ID:
                              type: integer
                              example: 72
                            SCLL_CT:
                              type: integer
                              example: 75
                            SCLL_PROVIDER_USER_ID:
                              type: string
                              example: null
                              nullable: true
                    required:
                      - SCL_ID
                      - SCL_ORGNUM
                      - SCL_EXPORT_TYPE
                      - SCL_PA_ID
                      - SCL_LIMIT_DAY
                      - SCL_NOTE
                      - SCL_CP_ID
                      - SCL_COLLECTION_TYPE
                      - SCL_MATURITY
                      - SCL_CREATED
                      - SCL_CREATE_L_ID
                      - locations
      tags:
        - SIPO
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the sipo contract.'
        example: 13
        required: true
        schema:
          type: integer
  /api/v3/sipo-lists:
    get:
      summary: 'List SIPO Lists'
      operationId: listSIPOLists
      description: '  Returns a paginated list of generated SIPO / INKASO prescription lists.'
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated SIPO list IDs.'
          example: '100,200'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated SIPO list IDs.'
            example: '100,200'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '12,14'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '12,14'
        -
          in: query
          name: contract
          description: 'Filter by contract ID (SL_SCL_ID).'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Filter by contract ID (SL_SCL_ID).'
            example: 1
        -
          in: query
          name: year
          description: 'Filter by year.'
          example: 2024
          required: false
          schema:
            type: integer
            description: 'Filter by year.'
            example: 2024
        -
          in: query
          name: month
          description: 'Filter by month (1–12).'
          example: 6
          required: false
          schema:
            type: integer
            description: 'Filter by month (1–12).'
            example: 6
        -
          in: query
          name: date_from
          description: 'Filter lists on or after this date (YYYY-MM-DD).'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter lists on or after this date (YYYY-MM-DD).'
            example: '2024-01-01'
        -
          in: query
          name: date_to
          description: 'Filter lists on or before this date (YYYY-MM-DD).'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter lists on or before this date (YYYY-MM-DD).'
            example: '2024-12-31'
        -
          in: query
          name: collection_type
          description: 'Filter by collection type.'
          example: SIPO
          required: false
          schema:
            type: string
            description: 'Filter by collection type.'
            example: SIPO
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      SL_ID: 20937
                      SL_DATE: '1981-11-20'
                      SL_MONTH: 1
                      SL_YEAR: 2024
                      SL_CT: 556
                      SL_CREATION: '2026-04-05 15:40:01'
                      SL_AUTHOR: 5485
                      SL_TYPE: FULL
                      SL_SCL_ID: null
                      SL_COLLECTION_TYPE: SIPO
                      SL_DUE_DATE: null
                      SL_PA_ID: 1839
                      SL_DATE_M: '1971-11-16'
                      SL_PROVIDER_USER_ID: null
                    -
                      SL_ID: 20938
                      SL_DATE: '2018-11-19'
                      SL_MONTH: 7
                      SL_YEAR: 2021
                      SL_CT: 383
                      SL_CREATION: '2026-03-30 17:25:51'
                      SL_AUTHOR: 4639
                      SL_TYPE: FULL
                      SL_SCL_ID: null
                      SL_COLLECTION_TYPE: FETCH
                      SL_DUE_DATE: '2020-03-13'
                      SL_PA_ID: null
                      SL_DATE_M: '2023-08-06'
                      SL_PROVIDER_USER_ID: 79168
                properties:
                  data:
                    type: array
                    example:
                      -
                        SL_ID: 20937
                        SL_DATE: '1981-11-20'
                        SL_MONTH: 1
                        SL_YEAR: 2024
                        SL_CT: 556
                        SL_CREATION: '2026-04-05 15:40:01'
                        SL_AUTHOR: 5485
                        SL_TYPE: FULL
                        SL_SCL_ID: null
                        SL_COLLECTION_TYPE: SIPO
                        SL_DUE_DATE: null
                        SL_PA_ID: 1839
                        SL_DATE_M: '1971-11-16'
                        SL_PROVIDER_USER_ID: null
                      -
                        SL_ID: 20938
                        SL_DATE: '2018-11-19'
                        SL_MONTH: 7
                        SL_YEAR: 2021
                        SL_CT: 383
                        SL_CREATION: '2026-03-30 17:25:51'
                        SL_AUTHOR: 4639
                        SL_TYPE: FULL
                        SL_SCL_ID: null
                        SL_COLLECTION_TYPE: FETCH
                        SL_DUE_DATE: '2020-03-13'
                        SL_PA_ID: null
                        SL_DATE_M: '2023-08-06'
                        SL_PROVIDER_USER_ID: 79168
                    items:
                      type: object
                      properties:
                        SL_ID:
                          type: integer
                          example: 20937
                          description: 'Unique SIPO list ID.'
                        SL_DATE:
                          type: string
                          example: '1981-11-20'
                          description: 'List date (YYYY-MM-DD).'
                        SL_MONTH:
                          type: integer
                          example: 1
                          description: 'Month of the prescription period.'
                        SL_YEAR:
                          type: integer
                          example: 2024
                          description: 'Year of the prescription period.'
                        SL_CT:
                          type: integer
                          example: 556
                          description: 'Location (installation) ID.'
                        SL_CREATION:
                          type: string
                          example: '2026-04-05 15:40:01'
                          description: 'Creation timestamp.'
                        SL_AUTHOR:
                          type: integer
                          example: 5485
                          description: 'Author (operator login) ID.'
                        SL_TYPE:
                          type: string
                          example: FULL
                          description: 'Export type.'
                          enum:
                            - FULL
                            - CHANGES
                        SL_SCL_ID:
                          type: string
                          example: null
                          description: 'Parent contract ID.'
                          nullable: true
                        SL_COLLECTION_TYPE:
                          type: string
                          example: SIPO
                          description: 'Collection type.'
                          enum:
                            - SIPO
                            - FETCH
                        SL_DUE_DATE:
                          type: string
                          example: null
                          description: 'Due date (YYYY-MM-DD).'
                          nullable: true
                        SL_PA_ID:
                          type: integer
                          example: 1839
                          description: 'Payment account ID.'
                          nullable: true
                        SL_DATE_M:
                          type: string
                          example: '1971-11-16'
                          description: 'Maturity reference date (YYYY-MM-DD).'
                          nullable: true
                        SL_PROVIDER_USER_ID:
                          type: string
                          example: null
                          description: 'Provider user ID.'
                          nullable: true
                    required:
                      - SL_ID
                      - SL_DATE
                      - SL_MONTH
                      - SL_YEAR
                      - SL_CT
                      - SL_CREATION
                      - SL_AUTHOR
                      - SL_TYPE
                      - SL_SCL_ID
                      - SL_COLLECTION_TYPE
                      - SL_DUE_DATE
                      - SL_PA_ID
                      - SL_DATE_M
                      - SL_PROVIDER_USER_ID
      tags:
        - SIPO
  '/api/v3/sipo-lists/{id}':
    get:
      summary: 'Get SIPO List'
      operationId: getSIPOList
      description: '  Returns a single SIPO / INKASO prescription list by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    SL_ID: 20939
                    SL_DATE: '1981-11-20'
                    SL_MONTH: 1
                    SL_YEAR: 2024
                    SL_CT: 556
                    SL_CREATION: '2026-04-05 15:40:01'
                    SL_AUTHOR: 5485
                    SL_TYPE: FULL
                    SL_SCL_ID: null
                    SL_COLLECTION_TYPE: SIPO
                    SL_DUE_DATE: null
                    SL_PA_ID: 1839
                    SL_DATE_M: '1971-11-16'
                    SL_PROVIDER_USER_ID: null
                properties:
                  data:
                    type: object
                    properties:
                      SL_ID:
                        type: integer
                        example: 20939
                        description: 'Unique SIPO list ID.'
                      SL_DATE:
                        type: string
                        example: '1981-11-20'
                        description: 'List date (YYYY-MM-DD).'
                      SL_MONTH:
                        type: integer
                        example: 1
                        description: 'Month of the prescription period.'
                      SL_YEAR:
                        type: integer
                        example: 2024
                        description: 'Year of the prescription period.'
                      SL_CT:
                        type: integer
                        example: 556
                        description: 'Location (installation) ID.'
                      SL_CREATION:
                        type: string
                        example: '2026-04-05 15:40:01'
                        description: 'Creation timestamp.'
                      SL_AUTHOR:
                        type: integer
                        example: 5485
                        description: 'Author (operator login) ID.'
                      SL_TYPE:
                        type: string
                        example: FULL
                        description: 'Export type.'
                        enum:
                          - FULL
                          - CHANGES
                      SL_SCL_ID:
                        type: string
                        example: null
                        description: 'Parent contract ID.'
                        nullable: true
                      SL_COLLECTION_TYPE:
                        type: string
                        example: SIPO
                        description: 'Collection type.'
                        enum:
                          - SIPO
                          - FETCH
                      SL_DUE_DATE:
                        type: string
                        example: null
                        description: 'Due date (YYYY-MM-DD).'
                        nullable: true
                      SL_PA_ID:
                        type: integer
                        example: 1839
                        description: 'Payment account ID.'
                        nullable: true
                      SL_DATE_M:
                        type: string
                        example: '1971-11-16'
                        description: 'Maturity reference date (YYYY-MM-DD).'
                        nullable: true
                      SL_PROVIDER_USER_ID:
                        type: string
                        example: null
                        description: 'Provider user ID.'
                        nullable: true
                    required:
                      - SL_ID
                      - SL_DATE
                      - SL_MONTH
                      - SL_YEAR
                      - SL_CT
                      - SL_CREATION
                      - SL_AUTHOR
                      - SL_TYPE
                      - SL_SCL_ID
                      - SL_COLLECTION_TYPE
                      - SL_DUE_DATE
                      - SL_PA_ID
                      - SL_DATE_M
                      - SL_PROVIDER_USER_ID
      tags:
        - SIPO
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the sipo list.'
        example: 15
        required: true
        schema:
          type: integer
  /api/v3/sipo-items:
    get:
      summary: 'List SIPO Items'
      operationId: listSIPOItems
      description: "  Returns a paginated list of SIPO / INKASO prescription line items.\n  **At least one** of the following filters must be provided:\n  `sipo_list`, `customer`.\n  Without a narrowing filter the endpoint returns HTTP 422."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of items per page.'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of items per page.'
            example: 10
        -
          in: query
          name: page
          description: 'Page number.'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number.'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated item IDs.'
          example: '1000,2000'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated item IDs.'
            example: '1000,2000'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '12,14'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '12,14'
        -
          in: query
          name: sipo_list
          description: 'Filter by SIPO list ID. **At least one** of `sipo_list` or `customer` is required.'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by SIPO list ID. **At least one** of `sipo_list` or `customer` is required.'
            example: 100
        -
          in: query
          name: customer
          description: 'Filter by customer (user) ID. **At least one** of `sipo_list` or `customer` is required.'
          example: 345
          required: false
          schema:
            type: integer
            description: 'Filter by customer (user) ID. **At least one** of `sipo_list` or `customer` is required.'
            example: 345
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      SD_ID: 10029429
                      SD_SL_ID: 343
                      SD_USER_ID: 974810
                      SD_SIPO_NUM: null
                      SD_SIPO_CODE: wp
                      SD_PRICE: '66203084.7019'
                      SD_EXPORT_TYPE: Z
                      SD_TYPE: 709
                      SD_TEXT: null
                      SD_ACC_PRE_NUMBER: null
                      SD_ACC_NUMBER: null
                      SD_ACC_BANK: null
                      SD_ACC_SPECSYM: null
                      SD_MATURITY: '1990-01-29'
                      SD_EU: null
                      SD_TAX: null
                      SD_PAY: null
                      SD_TAX_ACTUAL: null
                      SD_FUNDS_IN_TRANSIT: null
                      SD_OVERPAYMENT: null
                    -
                      SD_ID: 10029430
                      SD_SL_ID: 4452
                      SD_USER_ID: 612714
                      SD_SIPO_NUM: 3390204808
                      SD_SIPO_CODE: cp
                      SD_PRICE: '54565323.4621'
                      SD_EXPORT_TYPE: 'N'
                      SD_TYPE: null
                      SD_TEXT: null
                      SD_ACC_PRE_NUMBER: null
                      SD_ACC_NUMBER: null
                      SD_ACC_BANK: null
                      SD_ACC_SPECSYM: null
                      SD_MATURITY: '2019-08-30'
                      SD_EU: null
                      SD_TAX: null
                      SD_PAY: null
                      SD_TAX_ACTUAL: null
                      SD_FUNDS_IN_TRANSIT: null
                      SD_OVERPAYMENT: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        SD_ID: 10029429
                        SD_SL_ID: 343
                        SD_USER_ID: 974810
                        SD_SIPO_NUM: null
                        SD_SIPO_CODE: wp
                        SD_PRICE: '66203084.7019'
                        SD_EXPORT_TYPE: Z
                        SD_TYPE: 709
                        SD_TEXT: null
                        SD_ACC_PRE_NUMBER: null
                        SD_ACC_NUMBER: null
                        SD_ACC_BANK: null
                        SD_ACC_SPECSYM: null
                        SD_MATURITY: '1990-01-29'
                        SD_EU: null
                        SD_TAX: null
                        SD_PAY: null
                        SD_TAX_ACTUAL: null
                        SD_FUNDS_IN_TRANSIT: null
                        SD_OVERPAYMENT: null
                      -
                        SD_ID: 10029430
                        SD_SL_ID: 4452
                        SD_USER_ID: 612714
                        SD_SIPO_NUM: 3390204808
                        SD_SIPO_CODE: cp
                        SD_PRICE: '54565323.4621'
                        SD_EXPORT_TYPE: 'N'
                        SD_TYPE: null
                        SD_TEXT: null
                        SD_ACC_PRE_NUMBER: null
                        SD_ACC_NUMBER: null
                        SD_ACC_BANK: null
                        SD_ACC_SPECSYM: null
                        SD_MATURITY: '2019-08-30'
                        SD_EU: null
                        SD_TAX: null
                        SD_PAY: null
                        SD_TAX_ACTUAL: null
                        SD_FUNDS_IN_TRANSIT: null
                        SD_OVERPAYMENT: null
                    items:
                      type: object
                      properties:
                        SD_ID:
                          type: integer
                          example: 10029429
                          description: 'Unique item ID.'
                        SD_SL_ID:
                          type: integer
                          example: 343
                          description: 'Parent SIPO list ID.'
                        SD_USER_ID:
                          type: integer
                          example: 974810
                          description: 'Customer (user) ID.'
                        SD_SIPO_NUM:
                          type: string
                          example: null
                          description: 'SIPO connector number.'
                          nullable: true
                        SD_SIPO_CODE:
                          type: string
                          example: wp
                          description: 'SIPO code (2-char).'
                        SD_PRICE:
                          type: string
                          example: '66203084.7019'
                          description: 'Price amount (decimal).'
                        SD_EXPORT_TYPE:
                          type: string
                          example: Z
                          description: 'Export type flag (1-char).'
                        SD_TYPE:
                          type: integer
                          example: 709
                          description: 'Item type code.'
                          nullable: true
                        SD_TEXT:
                          type: string
                          example: null
                          description: 'Item description text.'
                          nullable: true
                        SD_ACC_PRE_NUMBER:
                          type: string
                          example: null
                          description: 'Account prefix number.'
                          nullable: true
                        SD_ACC_NUMBER:
                          type: string
                          example: null
                          description: 'Account number.'
                          nullable: true
                        SD_ACC_BANK:
                          type: string
                          example: null
                          description: 'Bank code.'
                          nullable: true
                        SD_ACC_SPECSYM:
                          type: string
                          example: null
                          description: 'Specific symbol.'
                          nullable: true
                        SD_MATURITY:
                          type: string
                          example: '1990-01-29'
                          description: 'Maturity date (YYYY-MM-DD).'
                        SD_EU:
                          type: string
                          example: null
                          description: 'EU flag.'
                          nullable: true
                        SD_TAX:
                          type: string
                          example: null
                          description: 'Tax amount (decimal).'
                          nullable: true
                        SD_PAY:
                          type: string
                          example: null
                          description: 'Payment amount (decimal).'
                          nullable: true
                        SD_TAX_ACTUAL:
                          type: string
                          example: null
                          description: 'Actual tax amount (decimal).'
                          nullable: true
                        SD_FUNDS_IN_TRANSIT:
                          type: string
                          example: null
                          description: 'Funds in transit amount (decimal).'
                          nullable: true
                        SD_OVERPAYMENT:
                          type: string
                          example: null
                          description: 'Overpayment amount (decimal).'
                          nullable: true
                    required:
                      - SD_ID
                      - SD_SL_ID
                      - SD_USER_ID
                      - SD_SIPO_NUM
                      - SD_SIPO_CODE
                      - SD_PRICE
                      - SD_EXPORT_TYPE
                      - SD_TYPE
                      - SD_TEXT
                      - SD_ACC_PRE_NUMBER
                      - SD_ACC_NUMBER
                      - SD_ACC_BANK
                      - SD_ACC_SPECSYM
                      - SD_MATURITY
                      - SD_EU
                      - SD_TAX
                      - SD_PAY
                      - SD_TAX_ACTUAL
                      - SD_FUNDS_IN_TRANSIT
                      - SD_OVERPAYMENT
      tags:
        - SIPO
  /api/v3/service-definitions:
    get:
      summary: 'List Service Definitions'
      operationId: listServiceDefinitions
      description: "Returns a paginated list of service definitions.\nBy default only enabled definitions are returned (SN_DISABLED=0).\nUse the `disabled` filter to include/filter disabled definitions."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: disabled
          description: 'Filter by disabled status. When true, return only disabled. When not set, return only enabled.'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by disabled status. When true, return only disabled. When not set, return only enabled.'
            example: 'true'
        -
          in: query
          name: class
          description: 'Filter by service class ID'
          example: '5'
          required: false
          schema:
            type: integer
            description: 'Filter by service class ID'
            example: '5'
        -
          in: query
          name: kind
          description: 'Filter by service class flag(s) (comma-separated). Valid: SCF_DATA, SCF_TV_ANALOG, SCF_TV_DVB, SCF_TV_IPTV, SCF_VOIP, SCF_GSM, SCF_SMS, SCF_WHOLESALE, SCF_DATA_LINK, SCF_EMAIL, SCF_VPS, SCF_LOC, SCF_3S, SCF_LEASE, SCF_LOAN'
          example: 'SCF_DATA,SCF_VOIP'
          required: false
          schema:
            type: string
            description: 'Filter by service class flag(s) (comma-separated). Valid: SCF_DATA, SCF_TV_ANALOG, SCF_TV_DVB, SCF_TV_IPTV, SCF_VOIP, SCF_GSM, SCF_SMS, SCF_WHOLESALE, SCF_DATA_LINK, SCF_EMAIL, SCF_VPS, SCF_LOC, SCF_3S, SCF_LEASE, SCF_LOAN'
            example: 'SCF_DATA,SCF_VOIP'
        -
          in: query
          name: base_service
          description: 'Filter definitions that can be dependent on the given base service ID'
          example: '10'
          required: false
          schema:
            type: integer
            description: 'Filter definitions that can be dependent on the given base service ID'
            example: '10'
        -
          in: query
          name: search
          description: 'Search by service name (NAME) or end-user name (SN_EU_NAME)'
          example: internet
          required: false
          schema:
            type: string
            description: 'Search by service name (NAME) or end-user name (SN_EU_NAME)'
            example: internet
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 185307
                      NAME: 'nostrum qui commodi'
                      PRICE: '7404.2747'
                      SN_SUGGEST_PRICE: '0.0000'
                      CLASS: '03'
                      TYPE: S
                      SN_DEP_TYPE: dependent
                      NOTE: null
                      CT: '027'
                      SWITCH_TYPE: 0
                      ACC_GROUP_ID: '0045'
                      SN_DISABLED: 0
                      SN_START_RESTRICTION: NONE
                      SN_END_RESTRICTION: NONE
                      SN_ACCOUNTFROM_RESTRICTION: NONE
                      SN_ACCOUNTTO_RESTRICTION: NONE
                      SN_ACCOUNTCHANGE_RESTRICTION: NONE
                      SN_TL_ID: 0
                      SN_TG_ID: null
                      SN_WEB_ENABLE: 0
                      SN_PRICE_WO_VAT: '8852.3678'
                      SN_PRICE_VAT: '275.3415'
                      SN_PRICE_ROUND: null
                      SN_VAR_PRICE_ENABLED: 0
                      SN_MIN_BOND: 0
                      SN_FIXED_MONTHS: 0
                      SN_PERIOD: none
                      SN_BP_ID: '000059'
                      SN_FIXED_BP: 0
                      SN_CODE: null
                      SN_DISABLE_ATTACH_ALL: 0
                      SN_VAT_BOTTOMUP: 0
                      SN_EU_NAME: null
                      SN_INV_VAR_PRICE: null
                      SN_TYPE: S
                      SN_UNIT_PACK: null
                      SN_BARCODE: null
                      SN_WARRANTY_PERIOD: null
                      SN_VAR_SYMBOL_TMPL: null
                      SN_UNICREDIT_ASSIGN: never
                      SN_PROVISIONING: 0
                      SN_TRANSFER_SPLITTED: 0
                      SN_MOVE_SPLITTED: 0
                      SN_PRICE_CHANGE: 3
                      SN_POINTS_DISCOUNT: null
                      SN_POINTS_DISCOUNT_VAT: null
                      SN_POINTS_DISCOUNT_WO_VAT: null
                      SN_POINTS_PRICE: null
                      SN_POINTS_REWARD: null
                      SN_UNICREDIT_TYPE: null
                      SN_PRICE_CALC: LOC_PRICE
                      SN_TRANSPORT: 0
                      SN_FORCE_MOVE_ON_TRANSFER: 0
                      SN_DELIVERY: null
                      SN_NAME_PART: 0
                      SN_PRICE_TOTAL_PERIOD: 0
                      SN_PENALTY: null
                      SN_WAREHOUSE: null
                      SN_SC_AVAIL_TYPE: null
                      SN_SC_AVAIL_TO: null
                      SN_PREMISE_AVAIL_TYPE: null
                      SN_CACHE_WAREHOUSE_AVAILABLE: 0
                      SN_CREATED: null
                      SN_CREATED_L_ID: null
                      SN_CHANGED: null
                      SN_CHANGED_L_ID: null
                      SN_WORK: 0
                      SN_LAST_CHANGE: null
                      ACC_GROUP_ID_OLD: null
                      ACC_GROUP_ID_NEW: null
                      params:
                        -
                          ID: 1867719
                          SERVICES_NAME_ID: 185307
                          CLASS_PAR_NAME: speed_download
                          SNC_PAR_INDEX: null
                          CLASS_PAR_VALUE: null
                          SNC_DOMAIN: null
                          SNC_DOMAIN_EU: null
                          SNC_VALID_FROM: null
                          SNC_VALID_TO: null
                          SNC_EU_VISIBLE: 1
                    -
                      ID: 185308
                      NAME: 'aut dolores enim'
                      PRICE: '7783.7442'
                      SN_SUGGEST_PRICE: '0.0000'
                      CLASS: '08'
                      TYPE: S
                      SN_DEP_TYPE: none
                      NOTE: null
                      CT: '023'
                      SWITCH_TYPE: 0
                      ACC_GROUP_ID: '0091'
                      SN_DISABLED: 0
                      SN_START_RESTRICTION: NONE
                      SN_END_RESTRICTION: NONE
                      SN_ACCOUNTFROM_RESTRICTION: NONE
                      SN_ACCOUNTTO_RESTRICTION: NONE
                      SN_ACCOUNTCHANGE_RESTRICTION: NONE
                      SN_TL_ID: 0
                      SN_TG_ID: null
                      SN_WEB_ENABLE: 0
                      SN_PRICE_WO_VAT: '8661.9358'
                      SN_PRICE_VAT: '7874.8594'
                      SN_PRICE_ROUND: null
                      SN_VAR_PRICE_ENABLED: 0
                      SN_MIN_BOND: 0
                      SN_FIXED_MONTHS: 0
                      SN_PERIOD: none
                      SN_BP_ID: '000024'
                      SN_FIXED_BP: 0
                      SN_CODE: null
                      SN_DISABLE_ATTACH_ALL: 0
                      SN_VAT_BOTTOMUP: 0
                      SN_EU_NAME: null
                      SN_INV_VAR_PRICE: null
                      SN_TYPE: S
                      SN_UNIT_PACK: null
                      SN_BARCODE: null
                      SN_WARRANTY_PERIOD: null
                      SN_VAR_SYMBOL_TMPL: null
                      SN_UNICREDIT_ASSIGN: never
                      SN_PROVISIONING: 0
                      SN_TRANSFER_SPLITTED: 0
                      SN_MOVE_SPLITTED: 0
                      SN_PRICE_CHANGE: 3
                      SN_POINTS_DISCOUNT: null
                      SN_POINTS_DISCOUNT_VAT: null
                      SN_POINTS_DISCOUNT_WO_VAT: null
                      SN_POINTS_PRICE: null
                      SN_POINTS_REWARD: null
                      SN_UNICREDIT_TYPE: null
                      SN_PRICE_CALC: LOC_PRICE
                      SN_TRANSPORT: 0
                      SN_FORCE_MOVE_ON_TRANSFER: 0
                      SN_DELIVERY: null
                      SN_NAME_PART: 0
                      SN_PRICE_TOTAL_PERIOD: 0
                      SN_PENALTY: null
                      SN_WAREHOUSE: null
                      SN_SC_AVAIL_TYPE: null
                      SN_SC_AVAIL_TO: null
                      SN_PREMISE_AVAIL_TYPE: null
                      SN_CACHE_WAREHOUSE_AVAILABLE: 0
                      SN_CREATED: null
                      SN_CREATED_L_ID: null
                      SN_CHANGED: null
                      SN_CHANGED_L_ID: null
                      SN_WORK: 0
                      SN_LAST_CHANGE: null
                      ACC_GROUP_ID_OLD: null
                      ACC_GROUP_ID_NEW: null
                      params:
                        -
                          ID: 1867720
                          SERVICES_NAME_ID: 185308
                          CLASS_PAR_NAME: speed_upload
                          SNC_PAR_INDEX: null
                          CLASS_PAR_VALUE: null
                          SNC_DOMAIN: null
                          SNC_DOMAIN_EU: null
                          SNC_VALID_FROM: null
                          SNC_VALID_TO: null
                          SNC_EU_VISIBLE: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 185307
                        NAME: 'nostrum qui commodi'
                        PRICE: '7404.2747'
                        SN_SUGGEST_PRICE: '0.0000'
                        CLASS: '03'
                        TYPE: S
                        SN_DEP_TYPE: dependent
                        NOTE: null
                        CT: '027'
                        SWITCH_TYPE: 0
                        ACC_GROUP_ID: '0045'
                        SN_DISABLED: 0
                        SN_START_RESTRICTION: NONE
                        SN_END_RESTRICTION: NONE
                        SN_ACCOUNTFROM_RESTRICTION: NONE
                        SN_ACCOUNTTO_RESTRICTION: NONE
                        SN_ACCOUNTCHANGE_RESTRICTION: NONE
                        SN_TL_ID: 0
                        SN_TG_ID: null
                        SN_WEB_ENABLE: 0
                        SN_PRICE_WO_VAT: '8852.3678'
                        SN_PRICE_VAT: '275.3415'
                        SN_PRICE_ROUND: null
                        SN_VAR_PRICE_ENABLED: 0
                        SN_MIN_BOND: 0
                        SN_FIXED_MONTHS: 0
                        SN_PERIOD: none
                        SN_BP_ID: '000059'
                        SN_FIXED_BP: 0
                        SN_CODE: null
                        SN_DISABLE_ATTACH_ALL: 0
                        SN_VAT_BOTTOMUP: 0
                        SN_EU_NAME: null
                        SN_INV_VAR_PRICE: null
                        SN_TYPE: S
                        SN_UNIT_PACK: null
                        SN_BARCODE: null
                        SN_WARRANTY_PERIOD: null
                        SN_VAR_SYMBOL_TMPL: null
                        SN_UNICREDIT_ASSIGN: never
                        SN_PROVISIONING: 0
                        SN_TRANSFER_SPLITTED: 0
                        SN_MOVE_SPLITTED: 0
                        SN_PRICE_CHANGE: 3
                        SN_POINTS_DISCOUNT: null
                        SN_POINTS_DISCOUNT_VAT: null
                        SN_POINTS_DISCOUNT_WO_VAT: null
                        SN_POINTS_PRICE: null
                        SN_POINTS_REWARD: null
                        SN_UNICREDIT_TYPE: null
                        SN_PRICE_CALC: LOC_PRICE
                        SN_TRANSPORT: 0
                        SN_FORCE_MOVE_ON_TRANSFER: 0
                        SN_DELIVERY: null
                        SN_NAME_PART: 0
                        SN_PRICE_TOTAL_PERIOD: 0
                        SN_PENALTY: null
                        SN_WAREHOUSE: null
                        SN_SC_AVAIL_TYPE: null
                        SN_SC_AVAIL_TO: null
                        SN_PREMISE_AVAIL_TYPE: null
                        SN_CACHE_WAREHOUSE_AVAILABLE: 0
                        SN_CREATED: null
                        SN_CREATED_L_ID: null
                        SN_CHANGED: null
                        SN_CHANGED_L_ID: null
                        SN_WORK: 0
                        SN_LAST_CHANGE: null
                        ACC_GROUP_ID_OLD: null
                        ACC_GROUP_ID_NEW: null
                        params:
                          -
                            ID: 1867719
                            SERVICES_NAME_ID: 185307
                            CLASS_PAR_NAME: speed_download
                            SNC_PAR_INDEX: null
                            CLASS_PAR_VALUE: null
                            SNC_DOMAIN: null
                            SNC_DOMAIN_EU: null
                            SNC_VALID_FROM: null
                            SNC_VALID_TO: null
                            SNC_EU_VISIBLE: 1
                      -
                        ID: 185308
                        NAME: 'aut dolores enim'
                        PRICE: '7783.7442'
                        SN_SUGGEST_PRICE: '0.0000'
                        CLASS: '08'
                        TYPE: S
                        SN_DEP_TYPE: none
                        NOTE: null
                        CT: '023'
                        SWITCH_TYPE: 0
                        ACC_GROUP_ID: '0091'
                        SN_DISABLED: 0
                        SN_START_RESTRICTION: NONE
                        SN_END_RESTRICTION: NONE
                        SN_ACCOUNTFROM_RESTRICTION: NONE
                        SN_ACCOUNTTO_RESTRICTION: NONE
                        SN_ACCOUNTCHANGE_RESTRICTION: NONE
                        SN_TL_ID: 0
                        SN_TG_ID: null
                        SN_WEB_ENABLE: 0
                        SN_PRICE_WO_VAT: '8661.9358'
                        SN_PRICE_VAT: '7874.8594'
                        SN_PRICE_ROUND: null
                        SN_VAR_PRICE_ENABLED: 0
                        SN_MIN_BOND: 0
                        SN_FIXED_MONTHS: 0
                        SN_PERIOD: none
                        SN_BP_ID: '000024'
                        SN_FIXED_BP: 0
                        SN_CODE: null
                        SN_DISABLE_ATTACH_ALL: 0
                        SN_VAT_BOTTOMUP: 0
                        SN_EU_NAME: null
                        SN_INV_VAR_PRICE: null
                        SN_TYPE: S
                        SN_UNIT_PACK: null
                        SN_BARCODE: null
                        SN_WARRANTY_PERIOD: null
                        SN_VAR_SYMBOL_TMPL: null
                        SN_UNICREDIT_ASSIGN: never
                        SN_PROVISIONING: 0
                        SN_TRANSFER_SPLITTED: 0
                        SN_MOVE_SPLITTED: 0
                        SN_PRICE_CHANGE: 3
                        SN_POINTS_DISCOUNT: null
                        SN_POINTS_DISCOUNT_VAT: null
                        SN_POINTS_DISCOUNT_WO_VAT: null
                        SN_POINTS_PRICE: null
                        SN_POINTS_REWARD: null
                        SN_UNICREDIT_TYPE: null
                        SN_PRICE_CALC: LOC_PRICE
                        SN_TRANSPORT: 0
                        SN_FORCE_MOVE_ON_TRANSFER: 0
                        SN_DELIVERY: null
                        SN_NAME_PART: 0
                        SN_PRICE_TOTAL_PERIOD: 0
                        SN_PENALTY: null
                        SN_WAREHOUSE: null
                        SN_SC_AVAIL_TYPE: null
                        SN_SC_AVAIL_TO: null
                        SN_PREMISE_AVAIL_TYPE: null
                        SN_CACHE_WAREHOUSE_AVAILABLE: 0
                        SN_CREATED: null
                        SN_CREATED_L_ID: null
                        SN_CHANGED: null
                        SN_CHANGED_L_ID: null
                        SN_WORK: 0
                        SN_LAST_CHANGE: null
                        ACC_GROUP_ID_OLD: null
                        ACC_GROUP_ID_NEW: null
                        params:
                          -
                            ID: 1867720
                            SERVICES_NAME_ID: 185308
                            CLASS_PAR_NAME: speed_upload
                            SNC_PAR_INDEX: null
                            CLASS_PAR_VALUE: null
                            SNC_DOMAIN: null
                            SNC_DOMAIN_EU: null
                            SNC_VALID_FROM: null
                            SNC_VALID_TO: null
                            SNC_EU_VISIBLE: 1
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 185307
                          description: 'Service definition ID (primary key).'
                        NAME:
                          type: string
                          example: 'nostrum qui commodi'
                          description: 'Service definition name.'
                        PRICE:
                          type: string
                          example: '7404.2747'
                          description: 'Price including VAT (one-time or per month).'
                        SN_SUGGEST_PRICE:
                          type: string
                          example: '0.0000'
                          description: 'Suggested price with VAT, used when proposing payment amounts (e.g. when closing resource tasks).'
                          nullable: true
                        CLASS:
                          type: string
                          example: '03'
                          description: 'Service class ID (references services_class). Determines the service category and capabilities.'
                        TYPE:
                          type: string
                          example: S
                          description: "Service periodicity type. 'M' = periodic (monthly), 'S' = one-time. References services_type."
                        SN_DEP_TYPE:
                          type: string
                          example: dependent
                          description: "Service position in hierarchy. 'none' = base service, 'dependent' = dependent (child) service."
                          enum:
                            - none
                            - dependent
                        NOTE:
                          type: string
                          example: null
                          description: 'Note / remark for the service definition.'
                          nullable: true
                        CT:
                          type: string
                          example: '027'
                          description: 'Location (CT) ID. Identifies which Mango location this definition belongs to.'
                        SWITCH_TYPE:
                          type: integer
                          example: 0
                          description: 'Separate activation and provisioning flag. 0 = activation and provisioning happen together, 1 = separate steps.'
                        ACC_GROUP_ID:
                          type: string
                          example: '0045'
                          description: 'Accounting group ID (references acc_groups).'
                        SN_DISABLED:
                          type: integer
                          example: 0
                          description: 'Disabled flag. 1 = service definition is no longer available in the current offer.'
                        SN_START_RESTRICTION:
                          type: string
                          example: NONE
                          description: "Restriction for service provision start date. 'NONE' = no restriction, 'START_MONTH' = first day of month only, 'START_NEXT_MONTH' = first day of the following month only."
                        SN_END_RESTRICTION:
                          type: string
                          example: NONE
                          description: "Restriction for service provision end date. 'NONE' = no restriction, 'END_MONTH' = last day of month only, 'END_NEXT_MONTH' = last day of the following month only."
                        SN_ACCOUNTFROM_RESTRICTION:
                          type: string
                          example: NONE
                          description: "Restriction for billing start date. 'NONE' = no restriction, 'START_MONTH' = first day of month only, 'START_NEXT_MONTH' = first day of the following month only."
                        SN_ACCOUNTTO_RESTRICTION:
                          type: string
                          example: NONE
                          description: "Restriction for billing end date. 'NONE' = no restriction, 'END_MONTH' = last day of month only, 'END_NEXT_MONTH' = last day of the following month only."
                        SN_ACCOUNTCHANGE_RESTRICTION:
                          type: string
                          example: NONE
                          description: "Restriction for billing change date (price, payment, period). 'NONE' = no restriction, 'START_MONTH' = first day of month only, 'START_NEXT_MONTH' = first day of the following month only."
                        SN_TL_ID:
                          type: integer
                          example: 0
                          description: 'VAT rate ID (references taxation_list). Defines the VAT percentage applied to this service.'
                        SN_TG_ID:
                          type: string
                          example: null
                          description: 'Tax group ID (references taxation_groups).'
                          nullable: true
                        SN_WEB_ENABLE:
                          type: integer
                          example: 0
                          description: 'Web visibility flag. 1 = service is visible on the external web price list.'
                        SN_PRICE_WO_VAT:
                          type: string
                          example: '8852.3678'
                          description: 'Price excluding VAT.'
                        SN_PRICE_VAT:
                          type: string
                          example: '275.3415'
                          description: 'VAT amount (one-time or per month).'
                        SN_PRICE_ROUND:
                          type: string
                          example: null
                          description: 'Rounding amount when computing price from the price without VAT.'
                          nullable: true
                        SN_VAR_PRICE_ENABLED:
                          type: integer
                          example: 0
                          description: 'Variable price flag. 1 = service has a variable (consumption-based) price component.'
                        SN_MIN_BOND:
                          type: integer
                          example: 0
                          description: "Minimum commitment type (references code_list, CL_CATEGORY='SN_MIN_BOND'). 0 = no minimum commitment."
                        SN_FIXED_MONTHS:
                          type: integer
                          example: 0
                          description: 'Fixed contract duration in months. 0 = open-ended (no fixed term).'
                        SN_PERIOD:
                          type: string
                          example: none
                          description: "Billing period. Possible values: 'none', 'month', 'cquarter', 'chalfyear', 'cyear', 'cyears2', 'cyears3', 'cmonths18', 'vmonth', 'vquarter', 'vhalfyear', 'vyear', 'vyears2', 'vyears3', 'vmonths18', 'all', 'optional'. Prefix 'c' = calendar-aligned, 'v' = anniversary-aligned, 'optional' = chosen at activation."
                          enum:
                            - all
                            - chalfyear
                            - cquarter
                            - cyear
                            - month
                            - none
                            - vhalfyear
                            - vmonth
                            - vquarter
                            - vyear
                            - cyears2
                            - cyears3
                            - cmonths18
                            - vyears2
                            - vyears3
                            - vmonths18
                            - optional
                        SN_BP_ID:
                          type: string
                          example: '000059'
                          description: 'Default billing plan ID (references billing_plans).'
                        SN_FIXED_BP:
                          type: integer
                          example: 0
                          description: 'Fixed billing plan flag. 1 = billing plan is enforced and cannot be changed by the operator.'
                        SN_CODE:
                          type: string
                          example: null
                          description: 'Service code identifier.'
                          nullable: true
                        SN_DISABLE_ATTACH_ALL:
                          type: integer
                          example: 0
                          description: 'Disable automatic payment matching flag. 1 = payments will not be matched to this service via automatic bulk matching to oldest debts.'
                        SN_VAT_BOTTOMUP:
                          type: integer
                          example: 0
                          description: 'VAT calculation direction. 0 = price entered with VAT (top-down), 1 = price entered without VAT (bottom-up).'
                        SN_EU_NAME:
                          type: string
                          example: null
                          description: 'Alternative service name displayed on the end-user (SelfCare) portal.'
                          nullable: true
                        SN_INV_VAR_PRICE:
                          type: string
                          example: null
                          description: 'Alternative label for the variable price component on printed invoices.'
                          nullable: true
                        SN_TYPE:
                          type: string
                          example: S
                          description: "Definition type. 'S' = service, 'P' = product."
                          enum:
                            - S
                            - P
                        SN_UNIT_PACK:
                          type: string
                          example: null
                          description: 'Packaging unit quantity (for products).'
                          nullable: true
                        SN_BARCODE:
                          type: string
                          example: null
                          description: 'Barcode number (EAN) for the product.'
                          nullable: true
                        SN_WARRANTY_PERIOD:
                          type: string
                          example: null
                          description: 'Warranty period in months (for products).'
                          nullable: true
                        SN_VAR_SYMBOL_TMPL:
                          type: string
                          example: null
                          description: 'Template for generating a variable symbol (payment identifier) upon service activation.'
                          nullable: true
                        SN_UNICREDIT_ASSIGN:
                          type: string
                          example: never
                          description: "UniCredit assignment policy on activation. 'never' = cannot assign, 'default_yes' = can assign (default: yes), 'default_no' = can assign (default: no), 'always' = always assign."
                          nullable: true
                          enum:
                            - never
                            - default_yes
                            - default_no
                            - always
                        SN_PROVISIONING:
                          type: integer
                          example: 0
                          description: 'Provisioning flag. Controls whether automatic reminding and blocking is enabled for this service.'
                        SN_TRANSFER_SPLITTED:
                          type: integer
                          example: 0
                          description: 'Split transfer flag. 1 = provisioning is performed as a separate step during service transfer.'
                        SN_MOVE_SPLITTED:
                          type: integer
                          example: 0
                          description: 'Split move flag. 0 = the move operation is done at once, 1 = the move is initiated and completed as separate steps.'
                        SN_PRICE_CHANGE:
                          type: integer
                          example: 3
                          description: 'Price change permission level. Controls whether and how the price can be changed on active services.'
                        SN_POINTS_DISCOUNT:
                          type: string
                          example: null
                          description: 'Points discount price with VAT.'
                          nullable: true
                        SN_POINTS_DISCOUNT_VAT:
                          type: string
                          example: null
                          description: 'Points discount VAT amount.'
                          nullable: true
                        SN_POINTS_DISCOUNT_WO_VAT:
                          type: string
                          example: null
                          description: 'Points discount price without VAT.'
                          nullable: true
                        SN_POINTS_PRICE:
                          type: string
                          example: null
                          description: 'Price in loyalty points.'
                          nullable: true
                        SN_POINTS_REWARD:
                          type: string
                          example: null
                          description: 'Loyalty points reward for purchasing this service.'
                          nullable: true
                        SN_UNICREDIT_TYPE:
                          type: string
                          example: null
                          description: "UniCredit type. 'finance' = financial credit, 'points' = loyalty points."
                          nullable: true
                          enum:
                            - finance
                            - points
                        SN_PRICE_CALC:
                          type: string
                          example: LOC_PRICE
                          description: "Price calculation type. 'LOC_PRICE' = location/time-dependent price (default), 'CALCULATION' = volume/delivery-based calculation, 'UNIT' = unit price with quantity recalculation."
                          enum:
                            - LOC_PRICE
                            - CALCULATION
                            - UNIT
                        SN_TRANSPORT:
                          type: integer
                          example: 0
                          description: 'Transport/shipping requirement flag. 1 = transport expedition is required for this service/product.'
                        SN_FORCE_MOVE_ON_TRANSFER:
                          type: integer
                          example: 0
                          description: 'Force move on transfer flag (relevant for dependent services only). 1 = this dependent service is always moved to the new base service during transfer.'
                        SN_DELIVERY:
                          type: string
                          example: null
                          description: 'Delivery option flag.'
                          nullable: true
                        SN_NAME_PART:
                          type: integer
                          example: 0
                          description: "Name part flag. 1 = this service's name is used for naming the customer's overall service assembly."
                        SN_PRICE_TOTAL_PERIOD:
                          type: integer
                          example: 0
                          description: 'Price total period flag. Controls whether the price is shown for the total period.'
                          nullable: true
                        SN_PENALTY:
                          type: string
                          example: null
                          description: 'Penalty flag. Controls early termination penalty for this service.'
                          nullable: true
                        SN_WAREHOUSE:
                          type: string
                          example: null
                          description: 'Warehouse flag. Links this product to warehouse/stock management.'
                          nullable: true
                        SN_SC_AVAIL_TYPE:
                          type: string
                          example: null
                          description: "SelfCare availability type. 'none' = not available, 'all' = available to all, 'user_group' = available to a specific customer group, 'user' = available to a specific customer."
                          nullable: true
                          enum:
                            - none
                            - all
                            - user_group
                            - user
                        SN_SC_AVAIL_TO:
                          type: string
                          example: null
                          description: 'SelfCare availability target ID. References a customer (USER_ID) or customer group (GROUP_ID) depending on SN_SC_AVAIL_TYPE.'
                          nullable: true
                        SN_PREMISE_AVAIL_TYPE:
                          type: string
                          example: null
                          description: "Premise availability type. 'all' = available at all premises, 'selected' = available only at selected premises."
                          nullable: true
                          enum:
                            - all
                            - selected
                        SN_CACHE_WAREHOUSE_AVAILABLE:
                          type: integer
                          example: 0
                          description: 'Cached count of available products in the sales warehouse (warehouse_item_count minus warehouse_item_blocked).'
                        SN_CREATED:
                          type: string
                          example: null
                          description: 'Datetime when this service definition was created.'
                          nullable: true
                        SN_CREATED_L_ID:
                          type: string
                          example: null
                          description: 'Login ID of the user who created this service definition.'
                          nullable: true
                        SN_CHANGED:
                          type: string
                          example: null
                          description: 'Datetime when this service definition was last modified.'
                          nullable: true
                        SN_CHANGED_L_ID:
                          type: string
                          example: null
                          description: 'Login ID of the user who last modified this service definition.'
                          nullable: true
                        SN_WORK:
                          type: integer
                          example: 0
                          description: 'Work tracking flag. 1 = this service definition is used for time tracking / work management.'
                          nullable: true
                        SN_LAST_CHANGE:
                          type: string
                          example: null
                          description: 'Datetime of the last change (auto-updated).'
                          nullable: true
                        ACC_GROUP_ID_OLD:
                          type: string
                          example: null
                          description: 'Previous accounting group ID (before the last change).'
                          nullable: true
                        ACC_GROUP_ID_NEW:
                          type: string
                          example: null
                          description: 'New accounting group ID (after the last change).'
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              ID: 1867719
                              SERVICES_NAME_ID: 185307
                              CLASS_PAR_NAME: speed_download
                              SNC_PAR_INDEX: null
                              CLASS_PAR_VALUE: null
                              SNC_DOMAIN: null
                              SNC_DOMAIN_EU: null
                              SNC_VALID_FROM: null
                              SNC_VALID_TO: null
                              SNC_EU_VISIBLE: 1
                          description: 'Service definition parameters (configuration values). Array of ServiceDefinitionParam objects.'
                          items:
                            type: object
                            properties:
                              ID:
                                type: integer
                                example: 1867719
                              SERVICES_NAME_ID:
                                type: integer
                                example: 185307
                              CLASS_PAR_NAME:
                                type: string
                                example: speed_download
                              SNC_PAR_INDEX:
                                type: string
                                example: null
                                nullable: true
                              CLASS_PAR_VALUE:
                                type: string
                                example: null
                                nullable: true
                              SNC_DOMAIN:
                                type: string
                                example: null
                                nullable: true
                              SNC_DOMAIN_EU:
                                type: string
                                example: null
                                nullable: true
                              SNC_VALID_FROM:
                                type: string
                                example: null
                                nullable: true
                              SNC_VALID_TO:
                                type: string
                                example: null
                                nullable: true
                              SNC_EU_VISIBLE:
                                type: integer
                                example: 1
                    required:
                      - ID
                      - NAME
                      - PRICE
                      - SN_SUGGEST_PRICE
                      - CLASS
                      - TYPE
                      - SN_DEP_TYPE
                      - NOTE
                      - CT
                      - SWITCH_TYPE
                      - ACC_GROUP_ID
                      - SN_DISABLED
                      - SN_START_RESTRICTION
                      - SN_END_RESTRICTION
                      - SN_ACCOUNTFROM_RESTRICTION
                      - SN_ACCOUNTTO_RESTRICTION
                      - SN_ACCOUNTCHANGE_RESTRICTION
                      - SN_TL_ID
                      - SN_TG_ID
                      - SN_WEB_ENABLE
                      - SN_PRICE_WO_VAT
                      - SN_PRICE_VAT
                      - SN_PRICE_ROUND
                      - SN_VAR_PRICE_ENABLED
                      - SN_MIN_BOND
                      - SN_FIXED_MONTHS
                      - SN_PERIOD
                      - SN_BP_ID
                      - SN_FIXED_BP
                      - SN_CODE
                      - SN_DISABLE_ATTACH_ALL
                      - SN_VAT_BOTTOMUP
                      - SN_EU_NAME
                      - SN_INV_VAR_PRICE
                      - SN_TYPE
                      - SN_UNIT_PACK
                      - SN_BARCODE
                      - SN_WARRANTY_PERIOD
                      - SN_VAR_SYMBOL_TMPL
                      - SN_UNICREDIT_ASSIGN
                      - SN_PROVISIONING
                      - SN_TRANSFER_SPLITTED
                      - SN_MOVE_SPLITTED
                      - SN_PRICE_CHANGE
                      - SN_POINTS_DISCOUNT
                      - SN_POINTS_DISCOUNT_VAT
                      - SN_POINTS_DISCOUNT_WO_VAT
                      - SN_POINTS_PRICE
                      - SN_POINTS_REWARD
                      - SN_UNICREDIT_TYPE
                      - SN_PRICE_CALC
                      - SN_TRANSPORT
                      - SN_FORCE_MOVE_ON_TRANSFER
                      - SN_DELIVERY
                      - SN_NAME_PART
                      - SN_PRICE_TOTAL_PERIOD
                      - SN_PENALTY
                      - SN_WAREHOUSE
                      - SN_SC_AVAIL_TYPE
                      - SN_SC_AVAIL_TO
                      - SN_PREMISE_AVAIL_TYPE
                      - SN_CACHE_WAREHOUSE_AVAILABLE
                      - SN_CREATED
                      - SN_CREATED_L_ID
                      - SN_CHANGED
                      - SN_CHANGED_L_ID
                      - SN_WORK
                      - SN_LAST_CHANGE
                      - ACC_GROUP_ID_OLD
                      - ACC_GROUP_ID_NEW
                      - params
      tags:
        - 'Service Definitions'
  '/api/v3/service-definitions/{id}':
    get:
      summary: 'Get Service Definition'
      operationId: getServiceDefinition
      description: 'Returns a single service definition by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    ID: 185309
                    NAME: 'incidunt iure odit'
                    PRICE: '1119.7570'
                    SN_SUGGEST_PRICE: '0.0000'
                    CLASS: '05'
                    TYPE: S
                    SN_DEP_TYPE: dependent
                    NOTE: null
                    CT: '076'
                    SWITCH_TYPE: 0
                    ACC_GROUP_ID: '0066'
                    SN_DISABLED: 0
                    SN_START_RESTRICTION: NONE
                    SN_END_RESTRICTION: NONE
                    SN_ACCOUNTFROM_RESTRICTION: NONE
                    SN_ACCOUNTTO_RESTRICTION: NONE
                    SN_ACCOUNTCHANGE_RESTRICTION: NONE
                    SN_TL_ID: 0
                    SN_TG_ID: null
                    SN_WEB_ENABLE: 0
                    SN_PRICE_WO_VAT: '5455.9867'
                    SN_PRICE_VAT: '5813.9895'
                    SN_PRICE_ROUND: null
                    SN_VAR_PRICE_ENABLED: 0
                    SN_MIN_BOND: 0
                    SN_FIXED_MONTHS: 0
                    SN_PERIOD: vyear
                    SN_BP_ID: '000068'
                    SN_FIXED_BP: 0
                    SN_CODE: null
                    SN_DISABLE_ATTACH_ALL: 0
                    SN_VAT_BOTTOMUP: 0
                    SN_EU_NAME: null
                    SN_INV_VAR_PRICE: null
                    SN_TYPE: S
                    SN_UNIT_PACK: null
                    SN_BARCODE: null
                    SN_WARRANTY_PERIOD: null
                    SN_VAR_SYMBOL_TMPL: null
                    SN_UNICREDIT_ASSIGN: never
                    SN_PROVISIONING: 0
                    SN_TRANSFER_SPLITTED: 0
                    SN_MOVE_SPLITTED: 0
                    SN_PRICE_CHANGE: 3
                    SN_POINTS_DISCOUNT: null
                    SN_POINTS_DISCOUNT_VAT: null
                    SN_POINTS_DISCOUNT_WO_VAT: null
                    SN_POINTS_PRICE: null
                    SN_POINTS_REWARD: null
                    SN_UNICREDIT_TYPE: null
                    SN_PRICE_CALC: LOC_PRICE
                    SN_TRANSPORT: 0
                    SN_FORCE_MOVE_ON_TRANSFER: 0
                    SN_DELIVERY: null
                    SN_NAME_PART: 0
                    SN_PRICE_TOTAL_PERIOD: 0
                    SN_PENALTY: null
                    SN_WAREHOUSE: null
                    SN_SC_AVAIL_TYPE: null
                    SN_SC_AVAIL_TO: null
                    SN_PREMISE_AVAIL_TYPE: null
                    SN_CACHE_WAREHOUSE_AVAILABLE: 0
                    SN_CREATED: null
                    SN_CREATED_L_ID: null
                    SN_CHANGED: null
                    SN_CHANGED_L_ID: null
                    SN_WORK: 0
                    SN_LAST_CHANGE: null
                    ACC_GROUP_ID_OLD: null
                    ACC_GROUP_ID_NEW: null
                    params:
                      -
                        ID: 1867721
                        SERVICES_NAME_ID: 185309
                        CLASS_PAR_NAME: speed_upload
                        SNC_PAR_INDEX: null
                        CLASS_PAR_VALUE: non
                        SNC_DOMAIN: null
                        SNC_DOMAIN_EU: null
                        SNC_VALID_FROM: null
                        SNC_VALID_TO: null
                        SNC_EU_VISIBLE: 1
                properties:
                  data:
                    type: object
                    properties:
                      ID:
                        type: integer
                        example: 185309
                        description: 'Service definition ID (primary key).'
                      NAME:
                        type: string
                        example: 'incidunt iure odit'
                        description: 'Service definition name.'
                      PRICE:
                        type: string
                        example: '1119.7570'
                        description: 'Price including VAT (one-time or per month).'
                      SN_SUGGEST_PRICE:
                        type: string
                        example: '0.0000'
                        description: 'Suggested price with VAT, used when proposing payment amounts (e.g. when closing resource tasks).'
                        nullable: true
                      CLASS:
                        type: string
                        example: '05'
                        description: 'Service class ID (references services_class). Determines the service category and capabilities.'
                      TYPE:
                        type: string
                        example: S
                        description: "Service periodicity type. 'M' = periodic (monthly), 'S' = one-time. References services_type."
                      SN_DEP_TYPE:
                        type: string
                        example: dependent
                        description: "Service position in hierarchy. 'none' = base service, 'dependent' = dependent (child) service."
                        enum:
                          - none
                          - dependent
                      NOTE:
                        type: string
                        example: null
                        description: 'Note / remark for the service definition.'
                        nullable: true
                      CT:
                        type: string
                        example: '076'
                        description: 'Location (CT) ID. Identifies which Mango location this definition belongs to.'
                      SWITCH_TYPE:
                        type: integer
                        example: 0
                        description: 'Separate activation and provisioning flag. 0 = activation and provisioning happen together, 1 = separate steps.'
                      ACC_GROUP_ID:
                        type: string
                        example: '0066'
                        description: 'Accounting group ID (references acc_groups).'
                      SN_DISABLED:
                        type: integer
                        example: 0
                        description: 'Disabled flag. 1 = service definition is no longer available in the current offer.'
                      SN_START_RESTRICTION:
                        type: string
                        example: NONE
                        description: "Restriction for service provision start date. 'NONE' = no restriction, 'START_MONTH' = first day of month only, 'START_NEXT_MONTH' = first day of the following month only."
                      SN_END_RESTRICTION:
                        type: string
                        example: NONE
                        description: "Restriction for service provision end date. 'NONE' = no restriction, 'END_MONTH' = last day of month only, 'END_NEXT_MONTH' = last day of the following month only."
                      SN_ACCOUNTFROM_RESTRICTION:
                        type: string
                        example: NONE
                        description: "Restriction for billing start date. 'NONE' = no restriction, 'START_MONTH' = first day of month only, 'START_NEXT_MONTH' = first day of the following month only."
                      SN_ACCOUNTTO_RESTRICTION:
                        type: string
                        example: NONE
                        description: "Restriction for billing end date. 'NONE' = no restriction, 'END_MONTH' = last day of month only, 'END_NEXT_MONTH' = last day of the following month only."
                      SN_ACCOUNTCHANGE_RESTRICTION:
                        type: string
                        example: NONE
                        description: "Restriction for billing change date (price, payment, period). 'NONE' = no restriction, 'START_MONTH' = first day of month only, 'START_NEXT_MONTH' = first day of the following month only."
                      SN_TL_ID:
                        type: integer
                        example: 0
                        description: 'VAT rate ID (references taxation_list). Defines the VAT percentage applied to this service.'
                      SN_TG_ID:
                        type: string
                        example: null
                        description: 'Tax group ID (references taxation_groups).'
                        nullable: true
                      SN_WEB_ENABLE:
                        type: integer
                        example: 0
                        description: 'Web visibility flag. 1 = service is visible on the external web price list.'
                      SN_PRICE_WO_VAT:
                        type: string
                        example: '5455.9867'
                        description: 'Price excluding VAT.'
                      SN_PRICE_VAT:
                        type: string
                        example: '5813.9895'
                        description: 'VAT amount (one-time or per month).'
                      SN_PRICE_ROUND:
                        type: string
                        example: null
                        description: 'Rounding amount when computing price from the price without VAT.'
                        nullable: true
                      SN_VAR_PRICE_ENABLED:
                        type: integer
                        example: 0
                        description: 'Variable price flag. 1 = service has a variable (consumption-based) price component.'
                      SN_MIN_BOND:
                        type: integer
                        example: 0
                        description: "Minimum commitment type (references code_list, CL_CATEGORY='SN_MIN_BOND'). 0 = no minimum commitment."
                      SN_FIXED_MONTHS:
                        type: integer
                        example: 0
                        description: 'Fixed contract duration in months. 0 = open-ended (no fixed term).'
                      SN_PERIOD:
                        type: string
                        example: vyear
                        description: "Billing period. Possible values: 'none', 'month', 'cquarter', 'chalfyear', 'cyear', 'cyears2', 'cyears3', 'cmonths18', 'vmonth', 'vquarter', 'vhalfyear', 'vyear', 'vyears2', 'vyears3', 'vmonths18', 'all', 'optional'. Prefix 'c' = calendar-aligned, 'v' = anniversary-aligned, 'optional' = chosen at activation."
                        enum:
                          - all
                          - chalfyear
                          - cquarter
                          - cyear
                          - month
                          - none
                          - vhalfyear
                          - vmonth
                          - vquarter
                          - vyear
                          - cyears2
                          - cyears3
                          - cmonths18
                          - vyears2
                          - vyears3
                          - vmonths18
                          - optional
                      SN_BP_ID:
                        type: string
                        example: '000068'
                        description: 'Default billing plan ID (references billing_plans).'
                      SN_FIXED_BP:
                        type: integer
                        example: 0
                        description: 'Fixed billing plan flag. 1 = billing plan is enforced and cannot be changed by the operator.'
                      SN_CODE:
                        type: string
                        example: null
                        description: 'Service code identifier.'
                        nullable: true
                      SN_DISABLE_ATTACH_ALL:
                        type: integer
                        example: 0
                        description: 'Disable automatic payment matching flag. 1 = payments will not be matched to this service via automatic bulk matching to oldest debts.'
                      SN_VAT_BOTTOMUP:
                        type: integer
                        example: 0
                        description: 'VAT calculation direction. 0 = price entered with VAT (top-down), 1 = price entered without VAT (bottom-up).'
                      SN_EU_NAME:
                        type: string
                        example: null
                        description: 'Alternative service name displayed on the end-user (SelfCare) portal.'
                        nullable: true
                      SN_INV_VAR_PRICE:
                        type: string
                        example: null
                        description: 'Alternative label for the variable price component on printed invoices.'
                        nullable: true
                      SN_TYPE:
                        type: string
                        example: S
                        description: "Definition type. 'S' = service, 'P' = product."
                        enum:
                          - S
                          - P
                      SN_UNIT_PACK:
                        type: string
                        example: null
                        description: 'Packaging unit quantity (for products).'
                        nullable: true
                      SN_BARCODE:
                        type: string
                        example: null
                        description: 'Barcode number (EAN) for the product.'
                        nullable: true
                      SN_WARRANTY_PERIOD:
                        type: string
                        example: null
                        description: 'Warranty period in months (for products).'
                        nullable: true
                      SN_VAR_SYMBOL_TMPL:
                        type: string
                        example: null
                        description: 'Template for generating a variable symbol (payment identifier) upon service activation.'
                        nullable: true
                      SN_UNICREDIT_ASSIGN:
                        type: string
                        example: never
                        description: "UniCredit assignment policy on activation. 'never' = cannot assign, 'default_yes' = can assign (default: yes), 'default_no' = can assign (default: no), 'always' = always assign."
                        nullable: true
                        enum:
                          - never
                          - default_yes
                          - default_no
                          - always
                      SN_PROVISIONING:
                        type: integer
                        example: 0
                        description: 'Provisioning flag. Controls whether automatic reminding and blocking is enabled for this service.'
                      SN_TRANSFER_SPLITTED:
                        type: integer
                        example: 0
                        description: 'Split transfer flag. 1 = provisioning is performed as a separate step during service transfer.'
                      SN_MOVE_SPLITTED:
                        type: integer
                        example: 0
                        description: 'Split move flag. 0 = the move operation is done at once, 1 = the move is initiated and completed as separate steps.'
                      SN_PRICE_CHANGE:
                        type: integer
                        example: 3
                        description: 'Price change permission level. Controls whether and how the price can be changed on active services.'
                      SN_POINTS_DISCOUNT:
                        type: string
                        example: null
                        description: 'Points discount price with VAT.'
                        nullable: true
                      SN_POINTS_DISCOUNT_VAT:
                        type: string
                        example: null
                        description: 'Points discount VAT amount.'
                        nullable: true
                      SN_POINTS_DISCOUNT_WO_VAT:
                        type: string
                        example: null
                        description: 'Points discount price without VAT.'
                        nullable: true
                      SN_POINTS_PRICE:
                        type: string
                        example: null
                        description: 'Price in loyalty points.'
                        nullable: true
                      SN_POINTS_REWARD:
                        type: string
                        example: null
                        description: 'Loyalty points reward for purchasing this service.'
                        nullable: true
                      SN_UNICREDIT_TYPE:
                        type: string
                        example: null
                        description: "UniCredit type. 'finance' = financial credit, 'points' = loyalty points."
                        nullable: true
                        enum:
                          - finance
                          - points
                      SN_PRICE_CALC:
                        type: string
                        example: LOC_PRICE
                        description: "Price calculation type. 'LOC_PRICE' = location/time-dependent price (default), 'CALCULATION' = volume/delivery-based calculation, 'UNIT' = unit price with quantity recalculation."
                        enum:
                          - LOC_PRICE
                          - CALCULATION
                          - UNIT
                      SN_TRANSPORT:
                        type: integer
                        example: 0
                        description: 'Transport/shipping requirement flag. 1 = transport expedition is required for this service/product.'
                      SN_FORCE_MOVE_ON_TRANSFER:
                        type: integer
                        example: 0
                        description: 'Force move on transfer flag (relevant for dependent services only). 1 = this dependent service is always moved to the new base service during transfer.'
                      SN_DELIVERY:
                        type: string
                        example: null
                        description: 'Delivery option flag.'
                        nullable: true
                      SN_NAME_PART:
                        type: integer
                        example: 0
                        description: "Name part flag. 1 = this service's name is used for naming the customer's overall service assembly."
                      SN_PRICE_TOTAL_PERIOD:
                        type: integer
                        example: 0
                        description: 'Price total period flag. Controls whether the price is shown for the total period.'
                        nullable: true
                      SN_PENALTY:
                        type: string
                        example: null
                        description: 'Penalty flag. Controls early termination penalty for this service.'
                        nullable: true
                      SN_WAREHOUSE:
                        type: string
                        example: null
                        description: 'Warehouse flag. Links this product to warehouse/stock management.'
                        nullable: true
                      SN_SC_AVAIL_TYPE:
                        type: string
                        example: null
                        description: "SelfCare availability type. 'none' = not available, 'all' = available to all, 'user_group' = available to a specific customer group, 'user' = available to a specific customer."
                        nullable: true
                        enum:
                          - none
                          - all
                          - user_group
                          - user
                      SN_SC_AVAIL_TO:
                        type: string
                        example: null
                        description: 'SelfCare availability target ID. References a customer (USER_ID) or customer group (GROUP_ID) depending on SN_SC_AVAIL_TYPE.'
                        nullable: true
                      SN_PREMISE_AVAIL_TYPE:
                        type: string
                        example: null
                        description: "Premise availability type. 'all' = available at all premises, 'selected' = available only at selected premises."
                        nullable: true
                        enum:
                          - all
                          - selected
                      SN_CACHE_WAREHOUSE_AVAILABLE:
                        type: integer
                        example: 0
                        description: 'Cached count of available products in the sales warehouse (warehouse_item_count minus warehouse_item_blocked).'
                      SN_CREATED:
                        type: string
                        example: null
                        description: 'Datetime when this service definition was created.'
                        nullable: true
                      SN_CREATED_L_ID:
                        type: string
                        example: null
                        description: 'Login ID of the user who created this service definition.'
                        nullable: true
                      SN_CHANGED:
                        type: string
                        example: null
                        description: 'Datetime when this service definition was last modified.'
                        nullable: true
                      SN_CHANGED_L_ID:
                        type: string
                        example: null
                        description: 'Login ID of the user who last modified this service definition.'
                        nullable: true
                      SN_WORK:
                        type: integer
                        example: 0
                        description: 'Work tracking flag. 1 = this service definition is used for time tracking / work management.'
                        nullable: true
                      SN_LAST_CHANGE:
                        type: string
                        example: null
                        description: 'Datetime of the last change (auto-updated).'
                        nullable: true
                      ACC_GROUP_ID_OLD:
                        type: string
                        example: null
                        description: 'Previous accounting group ID (before the last change).'
                        nullable: true
                      ACC_GROUP_ID_NEW:
                        type: string
                        example: null
                        description: 'New accounting group ID (after the last change).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            ID: 1867721
                            SERVICES_NAME_ID: 185309
                            CLASS_PAR_NAME: speed_upload
                            SNC_PAR_INDEX: null
                            CLASS_PAR_VALUE: non
                            SNC_DOMAIN: null
                            SNC_DOMAIN_EU: null
                            SNC_VALID_FROM: null
                            SNC_VALID_TO: null
                            SNC_EU_VISIBLE: 1
                        description: 'Service definition parameters (configuration values). Array of ServiceDefinitionParam objects.'
                        items:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 1867721
                            SERVICES_NAME_ID:
                              type: integer
                              example: 185309
                            CLASS_PAR_NAME:
                              type: string
                              example: speed_upload
                            SNC_PAR_INDEX:
                              type: string
                              example: null
                              nullable: true
                            CLASS_PAR_VALUE:
                              type: string
                              example: non
                            SNC_DOMAIN:
                              type: string
                              example: null
                              nullable: true
                            SNC_DOMAIN_EU:
                              type: string
                              example: null
                              nullable: true
                            SNC_VALID_FROM:
                              type: string
                              example: null
                              nullable: true
                            SNC_VALID_TO:
                              type: string
                              example: null
                              nullable: true
                            SNC_EU_VISIBLE:
                              type: integer
                              example: 1
                    required:
                      - ID
                      - NAME
                      - PRICE
                      - SN_SUGGEST_PRICE
                      - CLASS
                      - TYPE
                      - SN_DEP_TYPE
                      - NOTE
                      - CT
                      - SWITCH_TYPE
                      - ACC_GROUP_ID
                      - SN_DISABLED
                      - SN_START_RESTRICTION
                      - SN_END_RESTRICTION
                      - SN_ACCOUNTFROM_RESTRICTION
                      - SN_ACCOUNTTO_RESTRICTION
                      - SN_ACCOUNTCHANGE_RESTRICTION
                      - SN_TL_ID
                      - SN_TG_ID
                      - SN_WEB_ENABLE
                      - SN_PRICE_WO_VAT
                      - SN_PRICE_VAT
                      - SN_PRICE_ROUND
                      - SN_VAR_PRICE_ENABLED
                      - SN_MIN_BOND
                      - SN_FIXED_MONTHS
                      - SN_PERIOD
                      - SN_BP_ID
                      - SN_FIXED_BP
                      - SN_CODE
                      - SN_DISABLE_ATTACH_ALL
                      - SN_VAT_BOTTOMUP
                      - SN_EU_NAME
                      - SN_INV_VAR_PRICE
                      - SN_TYPE
                      - SN_UNIT_PACK
                      - SN_BARCODE
                      - SN_WARRANTY_PERIOD
                      - SN_VAR_SYMBOL_TMPL
                      - SN_UNICREDIT_ASSIGN
                      - SN_PROVISIONING
                      - SN_TRANSFER_SPLITTED
                      - SN_MOVE_SPLITTED
                      - SN_PRICE_CHANGE
                      - SN_POINTS_DISCOUNT
                      - SN_POINTS_DISCOUNT_VAT
                      - SN_POINTS_DISCOUNT_WO_VAT
                      - SN_POINTS_PRICE
                      - SN_POINTS_REWARD
                      - SN_UNICREDIT_TYPE
                      - SN_PRICE_CALC
                      - SN_TRANSPORT
                      - SN_FORCE_MOVE_ON_TRANSFER
                      - SN_DELIVERY
                      - SN_NAME_PART
                      - SN_PRICE_TOTAL_PERIOD
                      - SN_PENALTY
                      - SN_WAREHOUSE
                      - SN_SC_AVAIL_TYPE
                      - SN_SC_AVAIL_TO
                      - SN_PREMISE_AVAIL_TYPE
                      - SN_CACHE_WAREHOUSE_AVAILABLE
                      - SN_CREATED
                      - SN_CREATED_L_ID
                      - SN_CHANGED
                      - SN_CHANGED_L_ID
                      - SN_WORK
                      - SN_LAST_CHANGE
                      - ACC_GROUP_ID_OLD
                      - ACC_GROUP_ID_NEW
                      - params
      tags:
        - 'Service Definitions'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the service definition.'
        example: 19
        required: true
        schema:
          type: integer
  /api/v3/service-groups:
    get:
      summary: 'List Service Groups'
      operationId: listServiceGroups
      description: 'Returns a paginated list of service groups.'
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: active
          description: 'Filter by active status (true/false). Default: only active groups are returned.'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by active status (true/false). Default: only active groups are returned.'
            example: 'true'
        -
          in: query
          name: type
          description: 'Filter by comma-separated SGD_TYPE values (OTHER, NODE_AVAIL, SELFCARE, ACCESS, DELIVERY_SCHEDULE, STATISTICS)'
          example: 'SELFCARE,ACCESS'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated SGD_TYPE values (OTHER, NODE_AVAIL, SELFCARE, ACCESS, DELIVERY_SCHEDULE, STATISTICS)'
            example: 'SELFCARE,ACCESS'
        -
          in: query
          name: search
          description: 'Search by group name (partial match)'
          example: internet
          required: false
          schema:
            type: string
            description: 'Search by group name (partial match)'
            example: internet
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      SGD_ID: 126942
                      SGD_NAME: 'aut adipisci'
                      SGD_CP_ID: 33
                      SGD_NOTE: null
                      SGD_TYPE: TREENODE
                      SGD_PRIORITY: 50
                      SGD_CREATED: null
                      SGD_ACTIVE: 1
                      SGD_CREATOR: null
                      SGD_PARENT_ID: null
                      SGD_ORDER: 100
                      SGD_FIRSTCLASS: 1
                      SGD_COLLECT: 0
                      SGD_MINPRICE_EXCLUDE: 0
                      SGD_CODE: null
                      SGD_INFO: ''
                      SGD_PB_HIDE: 0
                      SGD_LAST_CHANGE: null
                    -
                      SGD_ID: 126943
                      SGD_NAME: 'incidunt iure'
                      SGD_CP_ID: null
                      SGD_NOTE: 'Modi ipsum nostrum omnis autem et.'
                      SGD_TYPE: SELFCARE
                      SGD_PRIORITY: 50
                      SGD_CREATED: null
                      SGD_ACTIVE: 1
                      SGD_CREATOR: null
                      SGD_PARENT_ID: null
                      SGD_ORDER: 100
                      SGD_FIRSTCLASS: 1
                      SGD_COLLECT: 0
                      SGD_MINPRICE_EXCLUDE: 0
                      SGD_CODE: null
                      SGD_INFO: ''
                      SGD_PB_HIDE: 0
                      SGD_LAST_CHANGE: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        SGD_ID: 126942
                        SGD_NAME: 'aut adipisci'
                        SGD_CP_ID: 33
                        SGD_NOTE: null
                        SGD_TYPE: TREENODE
                        SGD_PRIORITY: 50
                        SGD_CREATED: null
                        SGD_ACTIVE: 1
                        SGD_CREATOR: null
                        SGD_PARENT_ID: null
                        SGD_ORDER: 100
                        SGD_FIRSTCLASS: 1
                        SGD_COLLECT: 0
                        SGD_MINPRICE_EXCLUDE: 0
                        SGD_CODE: null
                        SGD_INFO: ''
                        SGD_PB_HIDE: 0
                        SGD_LAST_CHANGE: null
                      -
                        SGD_ID: 126943
                        SGD_NAME: 'incidunt iure'
                        SGD_CP_ID: null
                        SGD_NOTE: 'Modi ipsum nostrum omnis autem et.'
                        SGD_TYPE: SELFCARE
                        SGD_PRIORITY: 50
                        SGD_CREATED: null
                        SGD_ACTIVE: 1
                        SGD_CREATOR: null
                        SGD_PARENT_ID: null
                        SGD_ORDER: 100
                        SGD_FIRSTCLASS: 1
                        SGD_COLLECT: 0
                        SGD_MINPRICE_EXCLUDE: 0
                        SGD_CODE: null
                        SGD_INFO: ''
                        SGD_PB_HIDE: 0
                        SGD_LAST_CHANGE: null
                    items:
                      type: object
                      properties:
                        SGD_ID:
                          type: integer
                          example: 126942
                          description: 'Service group ID.'
                        SGD_NAME:
                          type: string
                          example: 'aut adipisci'
                          description: 'Service group name.'
                        SGD_CP_ID:
                          type: integer
                          example: 33
                          description: 'CIBS partner ID. References the partner (operator) this group belongs to.'
                          nullable: true
                        SGD_NOTE:
                          type: string
                          example: null
                          description: 'Group description or note.'
                          nullable: true
                        SGD_TYPE:
                          type: string
                          example: TREENODE
                          description: 'Group type. Possible values: "OTHER" = general group, "NODE_AVAIL" = node availability, "SELFCARE" = self-care portal, "ACCESS" = access, "TREENODE" = tree node (product board category), "ESHOP_ACTION" = e-shop promotion, "DELIVERY_SCHEDULE" = delivery schedule, "COUPON" = coupon, "STATISTICS" = statistics.'
                          nullable: true
                          enum:
                            - OTHER
                            - NODE_AVAIL
                            - SELFCARE
                            - ACCESS
                            - TREENODE
                            - ESHOP_ACTION
                            - DELIVERY_SCHEDULE
                            - COUPON
                            - STATISTICS
                        SGD_PRIORITY:
                          type: integer
                          example: 50
                          description: 'Priority for selecting one group per service (0–100, higher = more preferred). Default: 50.'
                        SGD_CREATED:
                          type: string
                          example: null
                          description: 'Timestamp when the group was created.'
                          nullable: true
                        SGD_ACTIVE:
                          type: integer
                          example: 1
                          description: 'Whether the group is active. 1 = active, 0 = inactive.'
                          nullable: true
                        SGD_CREATOR:
                          type: string
                          example: null
                          description: 'ID of the user who created this group.'
                          nullable: true
                        SGD_PARENT_ID:
                          type: string
                          example: null
                          description: 'Parent group ID for tree hierarchy. Null for root-level groups.'
                          nullable: true
                        SGD_ORDER:
                          type: integer
                          example: 100
                          description: 'Sort order within the tree level. Lower values appear first. Default: 100.'
                          nullable: true
                        SGD_FIRSTCLASS:
                          type: integer
                          example: 1
                          description: 'Whether to display this group with priority (first-class). 1 = yes, 0 = no.'
                        SGD_COLLECT:
                          type: integer
                          example: 0
                          description: 'Whether to collect services from subcategories. 1 = yes, 0 = no.'
                        SGD_MINPRICE_EXCLUDE:
                          type: integer
                          example: 0
                          description: 'Whether to exclude this group from minimum price calculation. 1 = exclude, 0 = include.'
                        SGD_CODE:
                          type: string
                          example: null
                          description: 'Short code identifier for the group.'
                          nullable: true
                        SGD_INFO:
                          type: string
                          example: ''
                          description: 'Information text displayed to the customer (e.g. on the product board).'
                        SGD_PB_HIDE:
                          type: integer
                          example: 0
                          description: 'Whether to hide this group on the product board. 1 = hidden, 0 = visible.'
                        SGD_LAST_CHANGE:
                          type: string
                          example: null
                          description: 'Timestamp of the last modification.'
                          nullable: true
                    required:
                      - SGD_ID
                      - SGD_NAME
                      - SGD_CP_ID
                      - SGD_NOTE
                      - SGD_TYPE
                      - SGD_PRIORITY
                      - SGD_CREATED
                      - SGD_ACTIVE
                      - SGD_CREATOR
                      - SGD_PARENT_ID
                      - SGD_ORDER
                      - SGD_FIRSTCLASS
                      - SGD_COLLECT
                      - SGD_MINPRICE_EXCLUDE
                      - SGD_CODE
                      - SGD_INFO
                      - SGD_PB_HIDE
                      - SGD_LAST_CHANGE
      tags:
        - 'Service Groups'
  '/api/v3/service-groups/{id}':
    get:
      summary: 'Get Service Group'
      operationId: getServiceGroup
      description: 'Returns a single service group by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    SGD_ID: 126944
                    SGD_NAME: 'quidem nostrum'
                    SGD_CP_ID: null
                    SGD_NOTE: 'Iure odit et et modi ipsum nostrum omnis.'
                    SGD_TYPE: NODE_AVAIL
                    SGD_PRIORITY: 50
                    SGD_CREATED: null
                    SGD_ACTIVE: 1
                    SGD_CREATOR: null
                    SGD_PARENT_ID: null
                    SGD_ORDER: 100
                    SGD_FIRSTCLASS: 1
                    SGD_COLLECT: 0
                    SGD_MINPRICE_EXCLUDE: 0
                    SGD_CODE: null
                    SGD_INFO: ''
                    SGD_PB_HIDE: 0
                    SGD_LAST_CHANGE: null
                properties:
                  data:
                    type: object
                    properties:
                      SGD_ID:
                        type: integer
                        example: 126944
                        description: 'Service group ID.'
                      SGD_NAME:
                        type: string
                        example: 'quidem nostrum'
                        description: 'Service group name.'
                      SGD_CP_ID:
                        type: string
                        example: null
                        description: 'CIBS partner ID. References the partner (operator) this group belongs to.'
                        nullable: true
                      SGD_NOTE:
                        type: string
                        example: 'Iure odit et et modi ipsum nostrum omnis.'
                        description: 'Group description or note.'
                        nullable: true
                      SGD_TYPE:
                        type: string
                        example: NODE_AVAIL
                        description: 'Group type. Possible values: "OTHER" = general group, "NODE_AVAIL" = node availability, "SELFCARE" = self-care portal, "ACCESS" = access, "TREENODE" = tree node (product board category), "ESHOP_ACTION" = e-shop promotion, "DELIVERY_SCHEDULE" = delivery schedule, "COUPON" = coupon, "STATISTICS" = statistics.'
                        nullable: true
                        enum:
                          - OTHER
                          - NODE_AVAIL
                          - SELFCARE
                          - ACCESS
                          - TREENODE
                          - ESHOP_ACTION
                          - DELIVERY_SCHEDULE
                          - COUPON
                          - STATISTICS
                      SGD_PRIORITY:
                        type: integer
                        example: 50
                        description: 'Priority for selecting one group per service (0–100, higher = more preferred). Default: 50.'
                      SGD_CREATED:
                        type: string
                        example: null
                        description: 'Timestamp when the group was created.'
                        nullable: true
                      SGD_ACTIVE:
                        type: integer
                        example: 1
                        description: 'Whether the group is active. 1 = active, 0 = inactive.'
                        nullable: true
                      SGD_CREATOR:
                        type: string
                        example: null
                        description: 'ID of the user who created this group.'
                        nullable: true
                      SGD_PARENT_ID:
                        type: string
                        example: null
                        description: 'Parent group ID for tree hierarchy. Null for root-level groups.'
                        nullable: true
                      SGD_ORDER:
                        type: integer
                        example: 100
                        description: 'Sort order within the tree level. Lower values appear first. Default: 100.'
                        nullable: true
                      SGD_FIRSTCLASS:
                        type: integer
                        example: 1
                        description: 'Whether to display this group with priority (first-class). 1 = yes, 0 = no.'
                      SGD_COLLECT:
                        type: integer
                        example: 0
                        description: 'Whether to collect services from subcategories. 1 = yes, 0 = no.'
                      SGD_MINPRICE_EXCLUDE:
                        type: integer
                        example: 0
                        description: 'Whether to exclude this group from minimum price calculation. 1 = exclude, 0 = include.'
                      SGD_CODE:
                        type: string
                        example: null
                        description: 'Short code identifier for the group.'
                        nullable: true
                      SGD_INFO:
                        type: string
                        example: ''
                        description: 'Information text displayed to the customer (e.g. on the product board).'
                      SGD_PB_HIDE:
                        type: integer
                        example: 0
                        description: 'Whether to hide this group on the product board. 1 = hidden, 0 = visible.'
                      SGD_LAST_CHANGE:
                        type: string
                        example: null
                        description: 'Timestamp of the last modification.'
                        nullable: true
                    required:
                      - SGD_ID
                      - SGD_NAME
                      - SGD_CP_ID
                      - SGD_NOTE
                      - SGD_TYPE
                      - SGD_PRIORITY
                      - SGD_CREATED
                      - SGD_ACTIVE
                      - SGD_CREATOR
                      - SGD_PARENT_ID
                      - SGD_ORDER
                      - SGD_FIRSTCLASS
                      - SGD_COLLECT
                      - SGD_MINPRICE_EXCLUDE
                      - SGD_CODE
                      - SGD_INFO
                      - SGD_PB_HIDE
                      - SGD_LAST_CHANGE
      tags:
        - 'Service Groups'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the service group.'
        example: 4
        required: true
        schema:
          type: integer
  /api/v3/service-periods:
    get:
      summary: 'List Service Periods'
      operationId: listServicePeriods
      description: "Returns a paginated list of billing periods (monthly, quarterly, annual, etc.)\nwith their location availability and default maturity settings."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated period IDs (string enum values, e.g. "month,cyear").'
          example: 'month,cyear'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated period IDs (string enum values, e.g. "month,cyear").'
            example: 'month,cyear'
        -
          in: query
          name: active
          description: 'Filter by active status. Pass "true" for active only, "false" for inactive only. Default: no filtering (return all).'
          example: 'true'
          required: false
          schema:
            type: string
            description: 'Filter by active status. Pass "true" for active only, "false" for inactive only. Default: no filtering (return all).'
            example: 'true'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: cmonths18
                      NAME: '18 měsíců'
                      PP_FLOATING: 0
                      PP_MONTHS: 18
                      PP_ACTIVE: 1
                      PP_DISCOUNT: months18
                      PP_NUMBER: 1
                      locations:
                        -
                          PPL_ID: 519
                          PPL_PP_ID: cmonths18
                          PPL_CT: null
                          PPL_CP: 151
                      maturity_defaults: []
                    -
                      ID: vhalfyear
                      NAME: 'plovoucí pololetí'
                      PP_FLOATING: 1
                      PP_MONTHS: 6
                      PP_ACTIVE: 1
                      PP_DISCOUNT: halfyear
                      PP_NUMBER: 2
                      locations:
                        -
                          PPL_ID: 5
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 1
                        -
                          PPL_ID: 13
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 3
                        -
                          PPL_ID: 21
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 4
                        -
                          PPL_ID: 29
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 5
                        -
                          PPL_ID: 37
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 6
                        -
                          PPL_ID: 45
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 7
                        -
                          PPL_ID: 53
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 10
                        -
                          PPL_ID: 61
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 13
                        -
                          PPL_ID: 69
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 15
                        -
                          PPL_ID: 77
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 39
                        -
                          PPL_ID: 85
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 45
                        -
                          PPL_ID: 93
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 46
                        -
                          PPL_ID: 101
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 58
                        -
                          PPL_ID: 109
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 59
                        -
                          PPL_ID: 117
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 63
                        -
                          PPL_ID: 125
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 65
                        -
                          PPL_ID: 133
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 66
                        -
                          PPL_ID: 141
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 67
                        -
                          PPL_ID: 149
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 69
                        -
                          PPL_ID: 157
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 70
                        -
                          PPL_ID: 165
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 71
                        -
                          PPL_ID: 173
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 72
                        -
                          PPL_ID: 181
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 73
                        -
                          PPL_ID: 189
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 75
                        -
                          PPL_ID: 197
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 78
                        -
                          PPL_ID: 205
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 82
                        -
                          PPL_ID: 213
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 90
                        -
                          PPL_ID: 221
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 98
                        -
                          PPL_ID: 229
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 100
                        -
                          PPL_ID: 237
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 105
                        -
                          PPL_ID: 245
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 107
                        -
                          PPL_ID: 253
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 108
                        -
                          PPL_ID: 261
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 110
                        -
                          PPL_ID: 269
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 111
                        -
                          PPL_ID: 277
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 112
                        -
                          PPL_ID: 285
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 113
                        -
                          PPL_ID: 293
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 114
                        -
                          PPL_ID: 301
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 119
                        -
                          PPL_ID: 309
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 122
                        -
                          PPL_ID: 317
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 123
                        -
                          PPL_ID: 325
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 126
                        -
                          PPL_ID: 333
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 129
                        -
                          PPL_ID: 341
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 131
                        -
                          PPL_ID: 349
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 133
                        -
                          PPL_ID: 357
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 134
                        -
                          PPL_ID: 365
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 139
                        -
                          PPL_ID: 373
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 140
                        -
                          PPL_ID: 381
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 141
                        -
                          PPL_ID: 389
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 142
                        -
                          PPL_ID: 397
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 145
                        -
                          PPL_ID: 405
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 146
                        -
                          PPL_ID: 413
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 147
                        -
                          PPL_ID: 421
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 148
                        -
                          PPL_ID: 429
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 151
                        -
                          PPL_ID: 437
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 152
                        -
                          PPL_ID: 445
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 153
                        -
                          PPL_ID: 534
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 157
                        -
                          PPL_ID: 563
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 179
                        -
                          PPL_ID: 581
                          PPL_PP_ID: vhalfyear
                          PPL_CT: null
                          PPL_CP: 182
                      maturity_defaults: []
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: cmonths18
                        NAME: '18 měsíců'
                        PP_FLOATING: 0
                        PP_MONTHS: 18
                        PP_ACTIVE: 1
                        PP_DISCOUNT: months18
                        PP_NUMBER: 1
                        locations:
                          -
                            PPL_ID: 519
                            PPL_PP_ID: cmonths18
                            PPL_CT: null
                            PPL_CP: 151
                        maturity_defaults: []
                      -
                        ID: vhalfyear
                        NAME: 'plovoucí pololetí'
                        PP_FLOATING: 1
                        PP_MONTHS: 6
                        PP_ACTIVE: 1
                        PP_DISCOUNT: halfyear
                        PP_NUMBER: 2
                        locations:
                          -
                            PPL_ID: 5
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 1
                          -
                            PPL_ID: 13
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 3
                          -
                            PPL_ID: 21
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 4
                          -
                            PPL_ID: 29
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 5
                          -
                            PPL_ID: 37
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 6
                          -
                            PPL_ID: 45
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 7
                          -
                            PPL_ID: 53
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 10
                          -
                            PPL_ID: 61
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 13
                          -
                            PPL_ID: 69
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 15
                          -
                            PPL_ID: 77
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 39
                          -
                            PPL_ID: 85
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 45
                          -
                            PPL_ID: 93
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 46
                          -
                            PPL_ID: 101
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 58
                          -
                            PPL_ID: 109
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 59
                          -
                            PPL_ID: 117
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 63
                          -
                            PPL_ID: 125
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 65
                          -
                            PPL_ID: 133
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 66
                          -
                            PPL_ID: 141
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 67
                          -
                            PPL_ID: 149
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 69
                          -
                            PPL_ID: 157
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 70
                          -
                            PPL_ID: 165
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 71
                          -
                            PPL_ID: 173
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 72
                          -
                            PPL_ID: 181
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 73
                          -
                            PPL_ID: 189
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 75
                          -
                            PPL_ID: 197
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 78
                          -
                            PPL_ID: 205
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 82
                          -
                            PPL_ID: 213
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 90
                          -
                            PPL_ID: 221
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 98
                          -
                            PPL_ID: 229
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 100
                          -
                            PPL_ID: 237
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 105
                          -
                            PPL_ID: 245
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 107
                          -
                            PPL_ID: 253
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 108
                          -
                            PPL_ID: 261
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 110
                          -
                            PPL_ID: 269
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 111
                          -
                            PPL_ID: 277
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 112
                          -
                            PPL_ID: 285
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 113
                          -
                            PPL_ID: 293
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 114
                          -
                            PPL_ID: 301
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 119
                          -
                            PPL_ID: 309
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 122
                          -
                            PPL_ID: 317
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 123
                          -
                            PPL_ID: 325
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 126
                          -
                            PPL_ID: 333
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 129
                          -
                            PPL_ID: 341
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 131
                          -
                            PPL_ID: 349
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 133
                          -
                            PPL_ID: 357
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 134
                          -
                            PPL_ID: 365
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 139
                          -
                            PPL_ID: 373
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 140
                          -
                            PPL_ID: 381
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 141
                          -
                            PPL_ID: 389
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 142
                          -
                            PPL_ID: 397
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 145
                          -
                            PPL_ID: 405
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 146
                          -
                            PPL_ID: 413
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 147
                          -
                            PPL_ID: 421
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 148
                          -
                            PPL_ID: 429
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 151
                          -
                            PPL_ID: 437
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 152
                          -
                            PPL_ID: 445
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 153
                          -
                            PPL_ID: 534
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 157
                          -
                            PPL_ID: 563
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 179
                          -
                            PPL_ID: 581
                            PPL_PP_ID: vhalfyear
                            PPL_CT: null
                            PPL_CP: 182
                        maturity_defaults: []
                    items:
                      type: object
                      properties:
                        ID:
                          type: string
                          example: cmonths18
                          description: 'Period identifier (enum string, e.g. "month", "cyear", "vquarter").'
                        NAME:
                          type: string
                          example: '18 měsíců'
                          description: 'Czech name of the period.'
                          nullable: true
                        PP_FLOATING:
                          type: integer
                          example: 0
                          description: 'Whether this is a floating (variable start date) period. 0 = calendar-fixed, 1 = floating.'
                          nullable: true
                        PP_MONTHS:
                          type: integer
                          example: 18
                          description: 'Duration of the period in months.'
                          nullable: true
                        PP_ACTIVE:
                          type: integer
                          example: 1
                          description: 'Whether this period is currently active. 1 = active, 0 = inactive.'
                        PP_DISCOUNT:
                          type: string
                          example: months18
                          description: 'Discount category identifier for price lookups.'
                          nullable: true
                        PP_NUMBER:
                          type: integer
                          example: 1
                          description: 'Number of billing cycles per year for this period.'
                        locations:
                          type: array
                          example:
                            -
                              PPL_ID: 519
                              PPL_PP_ID: cmonths18
                              PPL_CT: null
                              PPL_CP: 151
                          description: 'Location availability records (CT/CIBS partner mappings).'
                          nullable: true
                          items:
                            type: object
                            properties:
                              PPL_ID:
                                type: integer
                                example: 519
                              PPL_PP_ID:
                                type: string
                                example: cmonths18
                              PPL_CT:
                                type: string
                                example: null
                                nullable: true
                              PPL_CP:
                                type: integer
                                example: 151
                        maturity_defaults:
                          type: array
                          example: []
                          description: 'Default maturity day settings per location.'
                          nullable: true
                    required:
                      - ID
                      - NAME
                      - PP_FLOATING
                      - PP_MONTHS
                      - PP_ACTIVE
                      - PP_DISCOUNT
                      - PP_NUMBER
                      - locations
                      - maturity_defaults
      tags:
        - 'Service Periods'
  /api/v3/service-states:
    get:
      summary: 'List Service States'
      operationId: listServiceStates
      description: "Returns a paginated list of service lifecycle states.\nThis is a small static codelist (4 rows): blocked, active, cancelled, not connected."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs.'
          example: '1,2'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs.'
            example: '1,2'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      ID: 80
                      NAME: adipisci
                      SS_EU_NAME: quidem
                    -
                      ID: 32
                      NAME: qui
                      SS_EU_NAME: commodi
                properties:
                  data:
                    type: array
                    example:
                      -
                        ID: 80
                        NAME: adipisci
                        SS_EU_NAME: quidem
                      -
                        ID: 32
                        NAME: qui
                        SS_EU_NAME: commodi
                    items:
                      type: object
                      properties:
                        ID:
                          type: integer
                          example: 80
                          description: 'Service state ID (zero-padded in DB, cast to integer).'
                        NAME:
                          type: string
                          example: adipisci
                          description: 'Internal Czech name of the state.'
                          nullable: true
                        SS_EU_NAME:
                          type: string
                          example: quidem
                          description: 'End-user portal name of the state.'
                          nullable: true
                    required:
                      - ID
                      - NAME
                      - SS_EU_NAME
      tags:
        - 'Service States'
  /api/v3/templates:
    get:
      summary: 'List Text Templates'
      operationId: listTextTemplates
      description: "Returns a paginated list of text templates.\nThe template body (TT_TEMPLATE) is excluded from the list response for performance.\nUse the detail endpoint to retrieve the full body."
      parameters:
        -
          in: query
          name: per_page
          description: 'Number of templates to return per page (optional)'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Number of templates to return per page (optional)'
            example: 10
        -
          in: query
          name: page
          description: 'Page number to return (optional)'
          example: 1
          required: false
          schema:
            type: integer
            description: 'Page number to return (optional)'
            example: 1
        -
          in: query
          name: ids
          description: 'Filter by comma-separated template IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated template IDs'
            example: '1,2,3'
        -
          in: query
          name: cts
          description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated location (installation) IDs. Overrides X-CT header default.'
            example: '1,2,3'
        -
          in: query
          name: type
          description: 'Filter by comma-separated template type IDs'
          example: '1,2'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated template type IDs'
            example: '1,2'
        -
          in: query
          name: content_type
          description: 'Filter by content type'
          example: html
          required: false
          schema:
            type: string
            description: 'Filter by content type'
            example: html
        -
          in: query
          name: search
          description: 'Search in template name and description'
          example: invoice
          required: false
          schema:
            type: string
            description: 'Search in template name and description'
            example: invoice
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      TT_ID: 13745
                      TT_CT: 49
                      TT_NAME: TMPL_WPWLVQWR
                      TT_TEMPLATE: 'Modi ipsum nostrum omnis autem et. Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis.'
                      TT_DESCRIPTION: 'Alias tenetur ratione nemo voluptate accusamus.'
                      TT_CONTENT_TYPE: text
                      TT_TTT_ID: 74
                      TT_FORMAT: null
                      params:
                        -
                          TTP_ID: 183057
                          TTP_TT_ID: 13745
                          TTP_NAME: AB
                          TTP_VALUE: '17'
                      type:
                        TTT_ID: 74
                        TTT_TYPE: et
                        TTT_TITLE: 'Modi rerum ex repellendus.'
                        TTT_CONTENT_TYPE: text
                        TTT_USER_EDITABLE: 1
                        TTT_VAR_PREFIX: '{'
                        TTT_VAR_SUFFIX: '}'
                        TTT_AUTOSELECT: DISABLE
                    -
                      TT_ID: 13746
                      TT_CT: 8
                      TT_NAME: TMPL_TWBKMKFT
                      TT_TEMPLATE: 'Doloribus repellat officiis corporis nesciunt ut ratione iure. Molestiae ut rem est esse. Aut molestiae sunt suscipit doloribus fugiat. Aut deserunt et error neque recusandae et. Dolorem et ut dicta.'
                      TT_DESCRIPTION: 'Id a consectetur assumenda eaque neque.'
                      TT_CONTENT_TYPE: text
                      TT_TTT_ID: 75
                      TT_FORMAT: null
                      params:
                        -
                          TTP_ID: 183058
                          TTP_TT_ID: 13746
                          TTP_NAME: DOLOREM
                          TTP_VALUE: '33'
                      type:
                        TTT_ID: 75
                        TTT_TYPE: sunt
                        TTT_TITLE: 'Accusantium odit.'
                        TTT_CONTENT_TYPE: html
                        TTT_USER_EDITABLE: 0
                        TTT_VAR_PREFIX: '{'
                        TTT_VAR_SUFFIX: '}'
                        TTT_AUTOSELECT: DISABLE
                properties:
                  data:
                    type: array
                    example:
                      -
                        TT_ID: 13745
                        TT_CT: 49
                        TT_NAME: TMPL_WPWLVQWR
                        TT_TEMPLATE: 'Modi ipsum nostrum omnis autem et. Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis.'
                        TT_DESCRIPTION: 'Alias tenetur ratione nemo voluptate accusamus.'
                        TT_CONTENT_TYPE: text
                        TT_TTT_ID: 74
                        TT_FORMAT: null
                        params:
                          -
                            TTP_ID: 183057
                            TTP_TT_ID: 13745
                            TTP_NAME: AB
                            TTP_VALUE: '17'
                        type:
                          TTT_ID: 74
                          TTT_TYPE: et
                          TTT_TITLE: 'Modi rerum ex repellendus.'
                          TTT_CONTENT_TYPE: text
                          TTT_USER_EDITABLE: 1
                          TTT_VAR_PREFIX: '{'
                          TTT_VAR_SUFFIX: '}'
                          TTT_AUTOSELECT: DISABLE
                      -
                        TT_ID: 13746
                        TT_CT: 8
                        TT_NAME: TMPL_TWBKMKFT
                        TT_TEMPLATE: 'Doloribus repellat officiis corporis nesciunt ut ratione iure. Molestiae ut rem est esse. Aut molestiae sunt suscipit doloribus fugiat. Aut deserunt et error neque recusandae et. Dolorem et ut dicta.'
                        TT_DESCRIPTION: 'Id a consectetur assumenda eaque neque.'
                        TT_CONTENT_TYPE: text
                        TT_TTT_ID: 75
                        TT_FORMAT: null
                        params:
                          -
                            TTP_ID: 183058
                            TTP_TT_ID: 13746
                            TTP_NAME: DOLOREM
                            TTP_VALUE: '33'
                        type:
                          TTT_ID: 75
                          TTT_TYPE: sunt
                          TTT_TITLE: 'Accusantium odit.'
                          TTT_CONTENT_TYPE: html
                          TTT_USER_EDITABLE: 0
                          TTT_VAR_PREFIX: '{'
                          TTT_VAR_SUFFIX: '}'
                          TTT_AUTOSELECT: DISABLE
                    items:
                      type: object
                      properties:
                        TT_ID:
                          type: integer
                          example: 13745
                          description: 'Unique template identifier (primary key).'
                        TT_CT:
                          type: integer
                          example: 49
                          description: 'Location (installation) identifier. 0 = global/system template.'
                        TT_NAME:
                          type: string
                          example: TMPL_WPWLVQWR
                          description: 'Template name (internal identifier, max 40 chars).'
                        TT_TEMPLATE:
                          type: string
                          example: 'Modi ipsum nostrum omnis autem et. Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis.'
                          description: 'Template body content (longtext). Only included in the detail endpoint, excluded from list for performance.'
                        TT_DESCRIPTION:
                          type: string
                          example: 'Alias tenetur ratione nemo voluptate accusamus.'
                          description: 'Human-readable template description.'
                          nullable: true
                        TT_CONTENT_TYPE:
                          type: string
                          example: text
                          description: 'Output content type of the template.'
                          nullable: true
                          enum:
                            - text
                            - html
                            - pdf
                        TT_TTT_ID:
                          type: integer
                          example: 74
                          description: 'Template type ID. See the nested `type` relation.'
                        TT_FORMAT:
                          type: string
                          example: null
                          description: 'Template format specification (e.g. paper size).'
                          nullable: true
                        params:
                          type: array
                          example:
                            -
                              TTP_ID: 183057
                              TTP_TT_ID: 13745
                              TTP_NAME: AB
                              TTP_VALUE: '17'
                          description: 'Template parameters — configuration key-value pairs (e.g. margins, header height).'
                          items:
                            type: object
                            properties:
                              TTP_ID:
                                type: integer
                                example: 183057
                              TTP_TT_ID:
                                type: integer
                                example: 13745
                              TTP_NAME:
                                type: string
                                example: AB
                              TTP_VALUE:
                                type: string
                                example: '17'
                        type:
                          type: object
                          properties:
                            TTT_ID:
                              type: integer
                              example: 74
                              description: 'Template type ID.'
                            TTT_TYPE:
                              type: string
                              example: et
                              description: 'Type code (e.g. invoice, reminder, agreement).'
                            TTT_TITLE:
                              type: string
                              example: 'Modi rerum ex repellendus.'
                              description: 'Human-readable type title.'
                            TTT_CONTENT_TYPE:
                              type: string
                              example: text
                              description: 'Supported content types for this type (SET: text, html, pdf).'
                            TTT_USER_EDITABLE:
                              type: integer
                              example: 1
                              description: 'Whether templates of this type can be edited by users. 1 = editable.'
                            TTT_VAR_PREFIX:
                              type: string
                              example: '{'
                              description: 'Variable placeholder prefix character (default: "{").'
                            TTT_VAR_SUFFIX:
                              type: string
                              example: '}'
                              description: 'Variable placeholder suffix character (default: "}").'
                            TTT_AUTOSELECT:
                              type: string
                              example: DISABLE
                              description: 'Autoselect behavior for this template type.'
                              enum:
                                - DISABLE
                                - ENABLE
                                - ALWAYS
                          required:
                            - TTT_ID
                            - TTT_TYPE
                            - TTT_TITLE
                            - TTT_CONTENT_TYPE
                            - TTT_USER_EDITABLE
                            - TTT_VAR_PREFIX
                            - TTT_VAR_SUFFIX
                            - TTT_AUTOSELECT
                          description: 'Template type definition — classifies the template purpose and rendering rules.'
                          nullable: true
                    required:
                      - TT_ID
                      - TT_CT
                      - TT_NAME
                      - TT_TEMPLATE
                      - TT_DESCRIPTION
                      - TT_CONTENT_TYPE
                      - TT_TTT_ID
                      - TT_FORMAT
                      - params
                      - type
      tags:
        - 'Text Templates'
  '/api/v3/templates/{id}':
    get:
      summary: 'Get Text Template'
      operationId: getTextTemplate
      description: 'Returns a single text template by ID, including the full template body (TT_TEMPLATE).'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TT_ID: 13747
                    TT_CT: 49
                    TT_NAME: TMPL_SITCPSCQ
                    TT_TEMPLATE: 'Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci. Fugit deleniti distinctio eum doloremque id aut libero. Veniam corporis dolorem mollitia.'
                    TT_DESCRIPTION: 'Modi rerum ex repellendus assumenda.'
                    TT_CONTENT_TYPE: text
                    TT_TTT_ID: 76
                    TT_FORMAT: null
                    params:
                      -
                        TTP_ID: 183059
                        TTP_TT_ID: 13747
                        TTP_NAME: DOLORES
                        TTP_VALUE: '44'
                    type:
                      TTT_ID: 76
                      TTT_TYPE: tenetur
                      TTT_TITLE: 'Reiciendis quia perspiciatis deserunt.'
                      TTT_CONTENT_TYPE: 'text,html,pdf'
                      TTT_USER_EDITABLE: 0
                      TTT_VAR_PREFIX: '{'
                      TTT_VAR_SUFFIX: '}'
                      TTT_AUTOSELECT: ENABLE
                properties:
                  data:
                    type: object
                    properties:
                      TT_ID:
                        type: integer
                        example: 13747
                        description: 'Unique template identifier (primary key).'
                      TT_CT:
                        type: integer
                        example: 49
                        description: 'Location (installation) identifier. 0 = global/system template.'
                      TT_NAME:
                        type: string
                        example: TMPL_SITCPSCQ
                        description: 'Template name (internal identifier, max 40 chars).'
                      TT_TEMPLATE:
                        type: string
                        example: 'Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci. Fugit deleniti distinctio eum doloremque id aut libero. Veniam corporis dolorem mollitia.'
                        description: 'Template body content (longtext). Only included in the detail endpoint, excluded from list for performance.'
                      TT_DESCRIPTION:
                        type: string
                        example: 'Modi rerum ex repellendus assumenda.'
                        description: 'Human-readable template description.'
                        nullable: true
                      TT_CONTENT_TYPE:
                        type: string
                        example: text
                        description: 'Output content type of the template.'
                        nullable: true
                        enum:
                          - text
                          - html
                          - pdf
                      TT_TTT_ID:
                        type: integer
                        example: 76
                        description: 'Template type ID. See the nested `type` relation.'
                      TT_FORMAT:
                        type: string
                        example: null
                        description: 'Template format specification (e.g. paper size).'
                        nullable: true
                      params:
                        type: array
                        example:
                          -
                            TTP_ID: 183059
                            TTP_TT_ID: 13747
                            TTP_NAME: DOLORES
                            TTP_VALUE: '44'
                        description: 'Template parameters — configuration key-value pairs (e.g. margins, header height).'
                        items:
                          type: object
                          properties:
                            TTP_ID:
                              type: integer
                              example: 183059
                            TTP_TT_ID:
                              type: integer
                              example: 13747
                            TTP_NAME:
                              type: string
                              example: DOLORES
                            TTP_VALUE:
                              type: string
                              example: '44'
                      type:
                        type: object
                        properties:
                          TTT_ID:
                            type: integer
                            example: 76
                            description: 'Template type ID.'
                          TTT_TYPE:
                            type: string
                            example: tenetur
                            description: 'Type code (e.g. invoice, reminder, agreement).'
                          TTT_TITLE:
                            type: string
                            example: 'Reiciendis quia perspiciatis deserunt.'
                            description: 'Human-readable type title.'
                          TTT_CONTENT_TYPE:
                            type: string
                            example: 'text,html,pdf'
                            description: 'Supported content types for this type (SET: text, html, pdf).'
                          TTT_USER_EDITABLE:
                            type: integer
                            example: 0
                            description: 'Whether templates of this type can be edited by users. 1 = editable.'
                          TTT_VAR_PREFIX:
                            type: string
                            example: '{'
                            description: 'Variable placeholder prefix character (default: "{").'
                          TTT_VAR_SUFFIX:
                            type: string
                            example: '}'
                            description: 'Variable placeholder suffix character (default: "}").'
                          TTT_AUTOSELECT:
                            type: string
                            example: ENABLE
                            description: 'Autoselect behavior for this template type.'
                            enum:
                              - DISABLE
                              - ENABLE
                              - ALWAYS
                        required:
                          - TTT_ID
                          - TTT_TYPE
                          - TTT_TITLE
                          - TTT_CONTENT_TYPE
                          - TTT_USER_EDITABLE
                          - TTT_VAR_PREFIX
                          - TTT_VAR_SUFFIX
                          - TTT_AUTOSELECT
                        description: 'Template type definition — classifies the template purpose and rendering rules.'
                        nullable: true
                    required:
                      - TT_ID
                      - TT_CT
                      - TT_NAME
                      - TT_TEMPLATE
                      - TT_DESCRIPTION
                      - TT_CONTENT_TYPE
                      - TT_TTT_ID
                      - TT_FORMAT
                      - params
                      - type
      tags:
        - 'Text Templates'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the template.'
        example: architecto
        required: true
        schema:
          type: string
  /api/v3/time-tracking/works:
    get:
      summary: 'List Time Tracking Works'
      operationId: listTimeTrackingWorks
      description: "   This endpoint gets a list of time tracking works.\n   The list can be filtered and sorted."
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: customer_id
          description: 'Filter by bound customer (user) ID'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Filter by bound customer (user) ID'
            example: 10
        -
          in: query
          name: process_id
          description: 'Filter by bound process (maintenance) ID'
          example: 5
          required: false
          schema:
            type: integer
            description: 'Filter by bound process (maintenance) ID'
            example: 5
        -
          in: query
          name: activity_id
          description: 'Filter by activity ID (reverse lookup via time_tracking_activities)'
          example: 100
          required: false
          schema:
            type: integer
            description: 'Filter by activity ID (reverse lookup via time_tracking_activities)'
            example: 100
        -
          in: query
          name: state
          description: 'Filter by work status: ACTIVE, CLOSED, FINISHED'
          example: ACTIVE
          required: false
          schema:
            type: string
            description: 'Filter by work status: ACTIVE, CLOSED, FINISHED'
            example: ACTIVE
        -
          in: query
          name: created_from
          description: 'Filter works with TTW_START >= this date (YYYY-MM-DD)'
          example: '2024-01-01'
          required: false
          schema:
            type: string
            description: 'Filter works with TTW_START >= this date (YYYY-MM-DD)'
            example: '2024-01-01'
        -
          in: query
          name: created_to
          description: 'Filter works with TTW_START <= this date (YYYY-MM-DD)'
          example: '2024-12-31'
          required: false
          schema:
            type: string
            description: 'Filter works with TTW_START <= this date (YYYY-MM-DD)'
            example: '2024-12-31'
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      TTW_ID: 32163
                      TTW_NAME: 'et et modi'
                      TTW_MINUTES_PLANNED_ORIGIN: 431
                      TTW_MINUTES_PLANNED: null
                      TTW_LIMIT_PLANNED: null
                      TTW_REAL_MINUTES_PLANNED: 0
                      TTW_START: null
                      TTW_FINISH: null
                      TTW_L_ID: 776
                      TTW_SG_ID: null
                      TTW_L_MAINTENANCE: NONE
                      TTW_ACTIVE: CLOSED
                      TTW_TYPE: NORMAL
                      TTW_PRICE: '2307.6926'
                      TTW_CP: null
                      TTW_TTC_ID: null
                      TTW_EXTRA_WORK: 0
                      TTW_EXTRA_WORK_DETAIL: 0
                      TTW_COUNT_STRATEGY: MINS
                      TTW_SN_ID: null
                      TTW_VALID: 1
                      TTW_VALID_NOTE: null
                      TTW_CREATOR_ID: null
                      TTW_CACHE_FULLNAME: null
                      TTW_MANDATORY_DESC: null
                      bound_objects:
                        -
                          TTWBO_ID: 34125
                          TTWBO_TTW_ID: 32163
                          TTWBO_OBJECT_ID: 2327
                          TTWBO_OBJECT_TYPE: maintenance_job
                    -
                      TTW_ID: 32164
                      TTW_NAME: 'ex voluptatem laboriosam'
                      TTW_MINUTES_PLANNED_ORIGIN: 217
                      TTW_MINUTES_PLANNED: 388
                      TTW_LIMIT_PLANNED: null
                      TTW_REAL_MINUTES_PLANNED: 0
                      TTW_START: null
                      TTW_FINISH: null
                      TTW_L_ID: 132
                      TTW_SG_ID: null
                      TTW_L_MAINTENANCE: NONE
                      TTW_ACTIVE: FINISHED
                      TTW_TYPE: PRIVATE
                      TTW_PRICE: null
                      TTW_CP: null
                      TTW_TTC_ID: null
                      TTW_EXTRA_WORK: 0
                      TTW_EXTRA_WORK_DETAIL: 0
                      TTW_COUNT_STRATEGY: MINS
                      TTW_SN_ID: null
                      TTW_VALID: 1
                      TTW_VALID_NOTE: null
                      TTW_CREATOR_ID: null
                      TTW_CACHE_FULLNAME: null
                      TTW_MANDATORY_DESC: null
                      bound_objects:
                        -
                          TTWBO_ID: 34126
                          TTWBO_TTW_ID: 32164
                          TTWBO_OBJECT_ID: 4781
                          TTWBO_OBJECT_TYPE: users
                properties:
                  data:
                    type: array
                    example:
                      -
                        TTW_ID: 32163
                        TTW_NAME: 'et et modi'
                        TTW_MINUTES_PLANNED_ORIGIN: 431
                        TTW_MINUTES_PLANNED: null
                        TTW_LIMIT_PLANNED: null
                        TTW_REAL_MINUTES_PLANNED: 0
                        TTW_START: null
                        TTW_FINISH: null
                        TTW_L_ID: 776
                        TTW_SG_ID: null
                        TTW_L_MAINTENANCE: NONE
                        TTW_ACTIVE: CLOSED
                        TTW_TYPE: NORMAL
                        TTW_PRICE: '2307.6926'
                        TTW_CP: null
                        TTW_TTC_ID: null
                        TTW_EXTRA_WORK: 0
                        TTW_EXTRA_WORK_DETAIL: 0
                        TTW_COUNT_STRATEGY: MINS
                        TTW_SN_ID: null
                        TTW_VALID: 1
                        TTW_VALID_NOTE: null
                        TTW_CREATOR_ID: null
                        TTW_CACHE_FULLNAME: null
                        TTW_MANDATORY_DESC: null
                        bound_objects:
                          -
                            TTWBO_ID: 34125
                            TTWBO_TTW_ID: 32163
                            TTWBO_OBJECT_ID: 2327
                            TTWBO_OBJECT_TYPE: maintenance_job
                      -
                        TTW_ID: 32164
                        TTW_NAME: 'ex voluptatem laboriosam'
                        TTW_MINUTES_PLANNED_ORIGIN: 217
                        TTW_MINUTES_PLANNED: 388
                        TTW_LIMIT_PLANNED: null
                        TTW_REAL_MINUTES_PLANNED: 0
                        TTW_START: null
                        TTW_FINISH: null
                        TTW_L_ID: 132
                        TTW_SG_ID: null
                        TTW_L_MAINTENANCE: NONE
                        TTW_ACTIVE: FINISHED
                        TTW_TYPE: PRIVATE
                        TTW_PRICE: null
                        TTW_CP: null
                        TTW_TTC_ID: null
                        TTW_EXTRA_WORK: 0
                        TTW_EXTRA_WORK_DETAIL: 0
                        TTW_COUNT_STRATEGY: MINS
                        TTW_SN_ID: null
                        TTW_VALID: 1
                        TTW_VALID_NOTE: null
                        TTW_CREATOR_ID: null
                        TTW_CACHE_FULLNAME: null
                        TTW_MANDATORY_DESC: null
                        bound_objects:
                          -
                            TTWBO_ID: 34126
                            TTWBO_TTW_ID: 32164
                            TTWBO_OBJECT_ID: 4781
                            TTWBO_OBJECT_TYPE: users
                    items:
                      type: object
                      properties:
                        TTW_ID:
                          type: integer
                          example: 32163
                          description: 'Work ID (primary key).'
                        TTW_NAME:
                          type: string
                          example: 'et et modi'
                          description: 'Base work name.'
                          nullable: true
                        TTW_MINUTES_PLANNED_ORIGIN:
                          type: integer
                          example: 431
                          description: 'Originally planned work volume in minutes.'
                        TTW_MINUTES_PLANNED:
                          type: string
                          example: null
                          description: 'Total planned work volume in minutes (including plan adjustments).'
                          nullable: true
                        TTW_LIMIT_PLANNED:
                          type: string
                          example: null
                          description: 'Planned volume limit in minutes.'
                          nullable: true
                        TTW_REAL_MINUTES_PLANNED:
                          type: integer
                          example: 0
                          description: 'Real (estimated) total work volume in minutes.'
                        TTW_START:
                          type: string
                          example: null
                          description: 'Work creation datetime.'
                          nullable: true
                        TTW_FINISH:
                          type: string
                          example: null
                          description: 'Planned completion datetime.'
                          nullable: true
                        TTW_L_ID:
                          type: integer
                          example: 776
                          description: 'Assigned login (operator) ID.'
                          nullable: true
                        TTW_SG_ID:
                          type: string
                          example: null
                          description: 'Assigned service group ID.'
                          nullable: true
                        TTW_L_MAINTENANCE:
                          type: string
                          example: NONE
                          description: "Assignment mode. 'EDIT' = assigned via maintenance (customer), 'NONE' = assigned directly to a login or group."
                          nullable: true
                          enum:
                            - EDIT
                            - NONE
                        TTW_ACTIVE:
                          type: string
                          example: CLOSED
                          description: "Work status. 'ACTIVE' = active, 'CLOSED' = closed (unconfirmed activities remain), 'FINISHED' = finished."
                          nullable: true
                          enum:
                            - ACTIVE
                            - CLOSED
                            - FINISHED
                        TTW_TYPE:
                          type: string
                          example: NORMAL
                          description: "Work type. Determines how the work counts toward the working time fund. 'NORMAL' = regular (counts toward working hours), 'SPECIAL' = extraordinary (does not count), 'PRIVATE' = private (does not count)."
                          nullable: true
                          enum:
                            - NORMAL
                            - SPECIAL
                            - PRIVATE
                        TTW_PRICE:
                          type: string
                          example: '2307.6926'
                          description: 'Hourly price (excluding VAT).'
                          nullable: true
                        TTW_CP:
                          type: string
                          example: null
                          description: 'Company (installation) ID this work belongs to.'
                          nullable: true
                        TTW_TTC_ID:
                          type: string
                          example: null
                          description: 'Time tracking category ID (references time_tracking_categories).'
                          nullable: true
                        TTW_EXTRA_WORK:
                          type: integer
                          example: 0
                          description: 'Extra work allowed flag. 1 = completed work is automatically added to the order.'
                          nullable: true
                        TTW_EXTRA_WORK_DETAIL:
                          type: integer
                          example: 0
                          description: 'Detailed extra work billing flag. 1 = creates a separate order item for each activity.'
                          nullable: true
                        TTW_COUNT_STRATEGY:
                          type: string
                          example: MINS
                          description: "Rounding strategy for worked hours. 'MINS' = exact minutes, 'COMM_15/30/60' = commenced quarter/half/full hours, 'ROUND_15/30/60' = rounded quarter/half/full hours."
                          nullable: true
                          enum:
                            - MINS
                            - COMM_15
                            - COMM_30
                            - COMM_60
                            - ROUND_15
                            - ROUND_30
                            - ROUND_60
                        TTW_SN_ID:
                          type: string
                          example: null
                          description: 'Linked product (service definition) ID (references services_name).'
                          nullable: true
                        TTW_VALID:
                          type: integer
                          example: 1
                          description: 'Validity flag. 1 = valid, 0 = invalid.'
                          nullable: true
                        TTW_VALID_NOTE:
                          type: string
                          example: null
                          description: 'Validation note explaining invalidity reason.'
                          nullable: true
                        TTW_CREATOR_ID:
                          type: string
                          example: null
                          description: 'Login ID of the user who created this work.'
                          nullable: true
                        TTW_CACHE_FULLNAME:
                          type: string
                          example: null
                          description: 'Cached full work name (raw, including category and bound objects).'
                          nullable: true
                        TTW_MANDATORY_DESC:
                          type: string
                          example: null
                          description: 'Mandatory activity description flag. 1 = all activities for this work must have a description.'
                          nullable: true
                        bound_objects:
                          type: array
                          example:
                            -
                              TTWBO_ID: 34125
                              TTWBO_TTW_ID: 32163
                              TTWBO_OBJECT_ID: 2327
                              TTWBO_OBJECT_TYPE: maintenance_job
                          description: 'Bound objects linked to this work (e.g. maintenances, users, orders). Array of TimeTrackingWorkBoundObject objects.'
                          items:
                            type: object
                            properties:
                              TTWBO_ID:
                                type: integer
                                example: 34125
                              TTWBO_TTW_ID:
                                type: integer
                                example: 32163
                              TTWBO_OBJECT_ID:
                                type: integer
                                example: 2327
                              TTWBO_OBJECT_TYPE:
                                type: string
                                example: maintenance_job
                    required:
                      - TTW_ID
                      - TTW_NAME
                      - TTW_MINUTES_PLANNED_ORIGIN
                      - TTW_MINUTES_PLANNED
                      - TTW_LIMIT_PLANNED
                      - TTW_REAL_MINUTES_PLANNED
                      - TTW_START
                      - TTW_FINISH
                      - TTW_L_ID
                      - TTW_SG_ID
                      - TTW_L_MAINTENANCE
                      - TTW_ACTIVE
                      - TTW_TYPE
                      - TTW_PRICE
                      - TTW_CP
                      - TTW_TTC_ID
                      - TTW_EXTRA_WORK
                      - TTW_EXTRA_WORK_DETAIL
                      - TTW_COUNT_STRATEGY
                      - TTW_SN_ID
                      - TTW_VALID
                      - TTW_VALID_NOTE
                      - TTW_CREATOR_ID
                      - TTW_CACHE_FULLNAME
                      - TTW_MANDATORY_DESC
                      - bound_objects
      tags:
        - 'Time Tracking'
    post:
      summary: 'Create Time Tracking Work'
      operationId: createTimeTrackingWork
      description: '   This endpoint creates a new time tracking work.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TTW_ID: 32165
                    TTW_NAME: 'eius et animi'
                    TTW_MINUTES_PLANNED_ORIGIN: 298
                    TTW_MINUTES_PLANNED: null
                    TTW_LIMIT_PLANNED: null
                    TTW_REAL_MINUTES_PLANNED: 0
                    TTW_START: '2026-02-26 23:08:45'
                    TTW_FINISH: null
                    TTW_L_ID: null
                    TTW_SG_ID: null
                    TTW_L_MAINTENANCE: NONE
                    TTW_ACTIVE: ACTIVE
                    TTW_TYPE: NORMAL
                    TTW_PRICE: '5528.7323'
                    TTW_CP: null
                    TTW_TTC_ID: null
                    TTW_EXTRA_WORK: 0
                    TTW_EXTRA_WORK_DETAIL: 0
                    TTW_COUNT_STRATEGY: MINS
                    TTW_SN_ID: null
                    TTW_VALID: 1
                    TTW_VALID_NOTE: null
                    TTW_CREATOR_ID: null
                    TTW_CACHE_FULLNAME: null
                    TTW_MANDATORY_DESC: null
                    bound_objects:
                      -
                        TTWBO_ID: 34127
                        TTWBO_TTW_ID: 32165
                        TTWBO_OBJECT_ID: 9199
                        TTWBO_OBJECT_TYPE: orders_items
                properties:
                  data:
                    type: object
                    properties:
                      TTW_ID:
                        type: integer
                        example: 32165
                        description: 'Work ID (primary key).'
                      TTW_NAME:
                        type: string
                        example: 'eius et animi'
                        description: 'Base work name.'
                        nullable: true
                      TTW_MINUTES_PLANNED_ORIGIN:
                        type: integer
                        example: 298
                        description: 'Originally planned work volume in minutes.'
                      TTW_MINUTES_PLANNED:
                        type: string
                        example: null
                        description: 'Total planned work volume in minutes (including plan adjustments).'
                        nullable: true
                      TTW_LIMIT_PLANNED:
                        type: string
                        example: null
                        description: 'Planned volume limit in minutes.'
                        nullable: true
                      TTW_REAL_MINUTES_PLANNED:
                        type: integer
                        example: 0
                        description: 'Real (estimated) total work volume in minutes.'
                      TTW_START:
                        type: string
                        example: '2026-02-26 23:08:45'
                        description: 'Work creation datetime.'
                        nullable: true
                      TTW_FINISH:
                        type: string
                        example: null
                        description: 'Planned completion datetime.'
                        nullable: true
                      TTW_L_ID:
                        type: string
                        example: null
                        description: 'Assigned login (operator) ID.'
                        nullable: true
                      TTW_SG_ID:
                        type: string
                        example: null
                        description: 'Assigned service group ID.'
                        nullable: true
                      TTW_L_MAINTENANCE:
                        type: string
                        example: NONE
                        description: "Assignment mode. 'EDIT' = assigned via maintenance (customer), 'NONE' = assigned directly to a login or group."
                        nullable: true
                        enum:
                          - EDIT
                          - NONE
                      TTW_ACTIVE:
                        type: string
                        example: ACTIVE
                        description: "Work status. 'ACTIVE' = active, 'CLOSED' = closed (unconfirmed activities remain), 'FINISHED' = finished."
                        nullable: true
                        enum:
                          - ACTIVE
                          - CLOSED
                          - FINISHED
                      TTW_TYPE:
                        type: string
                        example: NORMAL
                        description: "Work type. Determines how the work counts toward the working time fund. 'NORMAL' = regular (counts toward working hours), 'SPECIAL' = extraordinary (does not count), 'PRIVATE' = private (does not count)."
                        nullable: true
                        enum:
                          - NORMAL
                          - SPECIAL
                          - PRIVATE
                      TTW_PRICE:
                        type: string
                        example: '5528.7323'
                        description: 'Hourly price (excluding VAT).'
                        nullable: true
                      TTW_CP:
                        type: string
                        example: null
                        description: 'Company (installation) ID this work belongs to.'
                        nullable: true
                      TTW_TTC_ID:
                        type: string
                        example: null
                        description: 'Time tracking category ID (references time_tracking_categories).'
                        nullable: true
                      TTW_EXTRA_WORK:
                        type: integer
                        example: 0
                        description: 'Extra work allowed flag. 1 = completed work is automatically added to the order.'
                        nullable: true
                      TTW_EXTRA_WORK_DETAIL:
                        type: integer
                        example: 0
                        description: 'Detailed extra work billing flag. 1 = creates a separate order item for each activity.'
                        nullable: true
                      TTW_COUNT_STRATEGY:
                        type: string
                        example: MINS
                        description: "Rounding strategy for worked hours. 'MINS' = exact minutes, 'COMM_15/30/60' = commenced quarter/half/full hours, 'ROUND_15/30/60' = rounded quarter/half/full hours."
                        nullable: true
                        enum:
                          - MINS
                          - COMM_15
                          - COMM_30
                          - COMM_60
                          - ROUND_15
                          - ROUND_30
                          - ROUND_60
                      TTW_SN_ID:
                        type: string
                        example: null
                        description: 'Linked product (service definition) ID (references services_name).'
                        nullable: true
                      TTW_VALID:
                        type: integer
                        example: 1
                        description: 'Validity flag. 1 = valid, 0 = invalid.'
                        nullable: true
                      TTW_VALID_NOTE:
                        type: string
                        example: null
                        description: 'Validation note explaining invalidity reason.'
                        nullable: true
                      TTW_CREATOR_ID:
                        type: string
                        example: null
                        description: 'Login ID of the user who created this work.'
                        nullable: true
                      TTW_CACHE_FULLNAME:
                        type: string
                        example: null
                        description: 'Cached full work name (raw, including category and bound objects).'
                        nullable: true
                      TTW_MANDATORY_DESC:
                        type: string
                        example: null
                        description: 'Mandatory activity description flag. 1 = all activities for this work must have a description.'
                        nullable: true
                      bound_objects:
                        type: array
                        example:
                          -
                            TTWBO_ID: 34127
                            TTWBO_TTW_ID: 32165
                            TTWBO_OBJECT_ID: 9199
                            TTWBO_OBJECT_TYPE: orders_items
                        description: 'Bound objects linked to this work (e.g. maintenances, users, orders). Array of TimeTrackingWorkBoundObject objects.'
                        items:
                          type: object
                          properties:
                            TTWBO_ID:
                              type: integer
                              example: 34127
                            TTWBO_TTW_ID:
                              type: integer
                              example: 32165
                            TTWBO_OBJECT_ID:
                              type: integer
                              example: 9199
                            TTWBO_OBJECT_TYPE:
                              type: string
                              example: orders_items
                    required:
                      - TTW_ID
                      - TTW_NAME
                      - TTW_MINUTES_PLANNED_ORIGIN
                      - TTW_MINUTES_PLANNED
                      - TTW_LIMIT_PLANNED
                      - TTW_REAL_MINUTES_PLANNED
                      - TTW_START
                      - TTW_FINISH
                      - TTW_L_ID
                      - TTW_SG_ID
                      - TTW_L_MAINTENANCE
                      - TTW_ACTIVE
                      - TTW_TYPE
                      - TTW_PRICE
                      - TTW_CP
                      - TTW_TTC_ID
                      - TTW_EXTRA_WORK
                      - TTW_EXTRA_WORK_DETAIL
                      - TTW_COUNT_STRATEGY
                      - TTW_SN_ID
                      - TTW_VALID
                      - TTW_VALID_NOTE
                      - TTW_CREATOR_ID
                      - TTW_CACHE_FULLNAME
                      - TTW_MANDATORY_DESC
                      - bound_objects
      tags:
        - 'Time Tracking'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Work name/title'
                  example: 'Server maintenance'
                minutes_planned_origin:
                  type: integer
                  description: 'Original planned minutes'
                  example: 120
                minutes_planned:
                  type: integer
                  description: 'Current planned minutes'
                  example: 120
                limit_planned:
                  type: integer
                  description: 'Limit strategy (0=no limit, 1=warn, 2=update order, 3=block)'
                  example: 0
                real_minutes_planned:
                  type: integer
                  description: 'Real/actual planned minutes'
                  example: 120
                start:
                  type: string
                  description: 'Work start time (YYYY-MM-DD HH:MM:SS)'
                  example: '2024-01-15 08:00:00'
                finish:
                  type: string
                  description: 'Work finish time (YYYY-MM-DD HH:MM:SS)'
                  example: '2024-01-15 16:00:00'
                l_id:
                  type: integer
                  description: 'Operator (login) ID'
                  example: 294
                sg_id:
                  type: integer
                  description: 'Service group ID'
                  example: 1
                l_maintenance:
                  type: string
                  description: 'Maintenance editing mode: EDIT or NONE'
                  example: NONE
                active:
                  type: integer
                  description: 'Work status (tinyint for SP)'
                  example: 1
                type:
                  type: string
                  description: 'Work type: NORMAL, SPECIAL, PRIVATE'
                  example: NORMAL
                price:
                  type: number
                  description: Price/rate
                  example: 500.0
                cp:
                  type: integer
                  description: 'Cost position'
                  example: 0
                ttc_id:
                  type: integer
                  description: 'Time tracking category ID'
                  example: 1
                extra_work:
                  type: integer
                  description: 'Allow extra work/overtime (0 or 1)'
                  example: 0
                extra_work_detail:
                  type: integer
                  description: 'Detailed extra work accounting (0 or 1)'
                  example: 0
                count_strategy:
                  type: string
                  description: 'Time rounding strategy'
                  example: MINS
                sn_id:
                  type: integer
                  description: 'Service name ID'
                  example: 16
                mandatory_desc:
                  type: integer
                  description: 'Description mandatory for activities (0 or 1)'
                  example: 0
                maintenances:
                  type: array
                  description: 'Bound process IDs'
                  example:
                    - 16
                  items:
                    type: integer
                users:
                  type: array
                  description: 'Bound customer IDs'
                  example:
                    - 16
                  items:
                    type: integer
                orders_items:
                  type: array
                  description: 'Bound order item IDs'
                  example:
                    - 16
                  items:
                    type: integer
                orders:
                  type: array
                  description: 'Bound order IDs'
                  example:
                    - 16
                  items:
                    type: integer
                maintenance_jobs:
                  type: array
                  description: 'Bound job IDs'
                  example:
                    - 16
                  items:
                    type: integer
              required:
                - name
  '/api/v3/time-tracking/works/{id}':
    get:
      summary: 'Get Time Tracking Work'
      operationId: getTimeTrackingWork
      description: '   This endpoint retrieves a specific time tracking work by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TTW_ID: 32166
                    TTW_NAME: 'ipsum nostrum omnis'
                    TTW_MINUTES_PLANNED_ORIGIN: 340
                    TTW_MINUTES_PLANNED: null
                    TTW_LIMIT_PLANNED: null
                    TTW_REAL_MINUTES_PLANNED: 0
                    TTW_START: null
                    TTW_FINISH: null
                    TTW_L_ID: null
                    TTW_SG_ID: null
                    TTW_L_MAINTENANCE: NONE
                    TTW_ACTIVE: ACTIVE
                    TTW_TYPE: SPECIAL
                    TTW_PRICE: null
                    TTW_CP: null
                    TTW_TTC_ID: null
                    TTW_EXTRA_WORK: 0
                    TTW_EXTRA_WORK_DETAIL: 0
                    TTW_COUNT_STRATEGY: MINS
                    TTW_SN_ID: null
                    TTW_VALID: 1
                    TTW_VALID_NOTE: null
                    TTW_CREATOR_ID: null
                    TTW_CACHE_FULLNAME: null
                    TTW_MANDATORY_DESC: null
                    bound_objects:
                      -
                        TTWBO_ID: 34128
                        TTWBO_TTW_ID: 32166
                        TTWBO_OBJECT_ID: 5040
                        TTWBO_OBJECT_TYPE: orders
                properties:
                  data:
                    type: object
                    properties:
                      TTW_ID:
                        type: integer
                        example: 32166
                        description: 'Work ID (primary key).'
                      TTW_NAME:
                        type: string
                        example: 'ipsum nostrum omnis'
                        description: 'Base work name.'
                        nullable: true
                      TTW_MINUTES_PLANNED_ORIGIN:
                        type: integer
                        example: 340
                        description: 'Originally planned work volume in minutes.'
                      TTW_MINUTES_PLANNED:
                        type: string
                        example: null
                        description: 'Total planned work volume in minutes (including plan adjustments).'
                        nullable: true
                      TTW_LIMIT_PLANNED:
                        type: string
                        example: null
                        description: 'Planned volume limit in minutes.'
                        nullable: true
                      TTW_REAL_MINUTES_PLANNED:
                        type: integer
                        example: 0
                        description: 'Real (estimated) total work volume in minutes.'
                      TTW_START:
                        type: string
                        example: null
                        description: 'Work creation datetime.'
                        nullable: true
                      TTW_FINISH:
                        type: string
                        example: null
                        description: 'Planned completion datetime.'
                        nullable: true
                      TTW_L_ID:
                        type: string
                        example: null
                        description: 'Assigned login (operator) ID.'
                        nullable: true
                      TTW_SG_ID:
                        type: string
                        example: null
                        description: 'Assigned service group ID.'
                        nullable: true
                      TTW_L_MAINTENANCE:
                        type: string
                        example: NONE
                        description: "Assignment mode. 'EDIT' = assigned via maintenance (customer), 'NONE' = assigned directly to a login or group."
                        nullable: true
                        enum:
                          - EDIT
                          - NONE
                      TTW_ACTIVE:
                        type: string
                        example: ACTIVE
                        description: "Work status. 'ACTIVE' = active, 'CLOSED' = closed (unconfirmed activities remain), 'FINISHED' = finished."
                        nullable: true
                        enum:
                          - ACTIVE
                          - CLOSED
                          - FINISHED
                      TTW_TYPE:
                        type: string
                        example: SPECIAL
                        description: "Work type. Determines how the work counts toward the working time fund. 'NORMAL' = regular (counts toward working hours), 'SPECIAL' = extraordinary (does not count), 'PRIVATE' = private (does not count)."
                        nullable: true
                        enum:
                          - NORMAL
                          - SPECIAL
                          - PRIVATE
                      TTW_PRICE:
                        type: string
                        example: null
                        description: 'Hourly price (excluding VAT).'
                        nullable: true
                      TTW_CP:
                        type: string
                        example: null
                        description: 'Company (installation) ID this work belongs to.'
                        nullable: true
                      TTW_TTC_ID:
                        type: string
                        example: null
                        description: 'Time tracking category ID (references time_tracking_categories).'
                        nullable: true
                      TTW_EXTRA_WORK:
                        type: integer
                        example: 0
                        description: 'Extra work allowed flag. 1 = completed work is automatically added to the order.'
                        nullable: true
                      TTW_EXTRA_WORK_DETAIL:
                        type: integer
                        example: 0
                        description: 'Detailed extra work billing flag. 1 = creates a separate order item for each activity.'
                        nullable: true
                      TTW_COUNT_STRATEGY:
                        type: string
                        example: MINS
                        description: "Rounding strategy for worked hours. 'MINS' = exact minutes, 'COMM_15/30/60' = commenced quarter/half/full hours, 'ROUND_15/30/60' = rounded quarter/half/full hours."
                        nullable: true
                        enum:
                          - MINS
                          - COMM_15
                          - COMM_30
                          - COMM_60
                          - ROUND_15
                          - ROUND_30
                          - ROUND_60
                      TTW_SN_ID:
                        type: string
                        example: null
                        description: 'Linked product (service definition) ID (references services_name).'
                        nullable: true
                      TTW_VALID:
                        type: integer
                        example: 1
                        description: 'Validity flag. 1 = valid, 0 = invalid.'
                        nullable: true
                      TTW_VALID_NOTE:
                        type: string
                        example: null
                        description: 'Validation note explaining invalidity reason.'
                        nullable: true
                      TTW_CREATOR_ID:
                        type: string
                        example: null
                        description: 'Login ID of the user who created this work.'
                        nullable: true
                      TTW_CACHE_FULLNAME:
                        type: string
                        example: null
                        description: 'Cached full work name (raw, including category and bound objects).'
                        nullable: true
                      TTW_MANDATORY_DESC:
                        type: string
                        example: null
                        description: 'Mandatory activity description flag. 1 = all activities for this work must have a description.'
                        nullable: true
                      bound_objects:
                        type: array
                        example:
                          -
                            TTWBO_ID: 34128
                            TTWBO_TTW_ID: 32166
                            TTWBO_OBJECT_ID: 5040
                            TTWBO_OBJECT_TYPE: orders
                        description: 'Bound objects linked to this work (e.g. maintenances, users, orders). Array of TimeTrackingWorkBoundObject objects.'
                        items:
                          type: object
                          properties:
                            TTWBO_ID:
                              type: integer
                              example: 34128
                            TTWBO_TTW_ID:
                              type: integer
                              example: 32166
                            TTWBO_OBJECT_ID:
                              type: integer
                              example: 5040
                            TTWBO_OBJECT_TYPE:
                              type: string
                              example: orders
                    required:
                      - TTW_ID
                      - TTW_NAME
                      - TTW_MINUTES_PLANNED_ORIGIN
                      - TTW_MINUTES_PLANNED
                      - TTW_LIMIT_PLANNED
                      - TTW_REAL_MINUTES_PLANNED
                      - TTW_START
                      - TTW_FINISH
                      - TTW_L_ID
                      - TTW_SG_ID
                      - TTW_L_MAINTENANCE
                      - TTW_ACTIVE
                      - TTW_TYPE
                      - TTW_PRICE
                      - TTW_CP
                      - TTW_TTC_ID
                      - TTW_EXTRA_WORK
                      - TTW_EXTRA_WORK_DETAIL
                      - TTW_COUNT_STRATEGY
                      - TTW_SN_ID
                      - TTW_VALID
                      - TTW_VALID_NOTE
                      - TTW_CREATOR_ID
                      - TTW_CACHE_FULLNAME
                      - TTW_MANDATORY_DESC
                      - bound_objects
      tags:
        - 'Time Tracking'
    put:
      summary: 'Update Time Tracking Work'
      operationId: updateTimeTrackingWork
      description: '   This endpoint updates an existing time tracking work.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TTW_ID: 32167
                    TTW_NAME: 'quos velit et'
                    TTW_MINUTES_PLANNED_ORIGIN: 203
                    TTW_MINUTES_PLANNED: null
                    TTW_LIMIT_PLANNED: null
                    TTW_REAL_MINUTES_PLANNED: 0
                    TTW_START: '2026-04-06 07:33:21'
                    TTW_FINISH: null
                    TTW_L_ID: 548
                    TTW_SG_ID: null
                    TTW_L_MAINTENANCE: NONE
                    TTW_ACTIVE: CLOSED
                    TTW_TYPE: NORMAL
                    TTW_PRICE: '9161.8708'
                    TTW_CP: null
                    TTW_TTC_ID: null
                    TTW_EXTRA_WORK: 0
                    TTW_EXTRA_WORK_DETAIL: 0
                    TTW_COUNT_STRATEGY: MINS
                    TTW_SN_ID: null
                    TTW_VALID: 1
                    TTW_VALID_NOTE: null
                    TTW_CREATOR_ID: null
                    TTW_CACHE_FULLNAME: null
                    TTW_MANDATORY_DESC: null
                    bound_objects:
                      -
                        TTWBO_ID: 34129
                        TTWBO_TTW_ID: 32167
                        TTWBO_OBJECT_ID: 8290
                        TTWBO_OBJECT_TYPE: orders_items
                properties:
                  data:
                    type: object
                    properties:
                      TTW_ID:
                        type: integer
                        example: 32167
                        description: 'Work ID (primary key).'
                      TTW_NAME:
                        type: string
                        example: 'quos velit et'
                        description: 'Base work name.'
                        nullable: true
                      TTW_MINUTES_PLANNED_ORIGIN:
                        type: integer
                        example: 203
                        description: 'Originally planned work volume in minutes.'
                      TTW_MINUTES_PLANNED:
                        type: string
                        example: null
                        description: 'Total planned work volume in minutes (including plan adjustments).'
                        nullable: true
                      TTW_LIMIT_PLANNED:
                        type: string
                        example: null
                        description: 'Planned volume limit in minutes.'
                        nullable: true
                      TTW_REAL_MINUTES_PLANNED:
                        type: integer
                        example: 0
                        description: 'Real (estimated) total work volume in minutes.'
                      TTW_START:
                        type: string
                        example: '2026-04-06 07:33:21'
                        description: 'Work creation datetime.'
                        nullable: true
                      TTW_FINISH:
                        type: string
                        example: null
                        description: 'Planned completion datetime.'
                        nullable: true
                      TTW_L_ID:
                        type: integer
                        example: 548
                        description: 'Assigned login (operator) ID.'
                        nullable: true
                      TTW_SG_ID:
                        type: string
                        example: null
                        description: 'Assigned service group ID.'
                        nullable: true
                      TTW_L_MAINTENANCE:
                        type: string
                        example: NONE
                        description: "Assignment mode. 'EDIT' = assigned via maintenance (customer), 'NONE' = assigned directly to a login or group."
                        nullable: true
                        enum:
                          - EDIT
                          - NONE
                      TTW_ACTIVE:
                        type: string
                        example: CLOSED
                        description: "Work status. 'ACTIVE' = active, 'CLOSED' = closed (unconfirmed activities remain), 'FINISHED' = finished."
                        nullable: true
                        enum:
                          - ACTIVE
                          - CLOSED
                          - FINISHED
                      TTW_TYPE:
                        type: string
                        example: NORMAL
                        description: "Work type. Determines how the work counts toward the working time fund. 'NORMAL' = regular (counts toward working hours), 'SPECIAL' = extraordinary (does not count), 'PRIVATE' = private (does not count)."
                        nullable: true
                        enum:
                          - NORMAL
                          - SPECIAL
                          - PRIVATE
                      TTW_PRICE:
                        type: string
                        example: '9161.8708'
                        description: 'Hourly price (excluding VAT).'
                        nullable: true
                      TTW_CP:
                        type: string
                        example: null
                        description: 'Company (installation) ID this work belongs to.'
                        nullable: true
                      TTW_TTC_ID:
                        type: string
                        example: null
                        description: 'Time tracking category ID (references time_tracking_categories).'
                        nullable: true
                      TTW_EXTRA_WORK:
                        type: integer
                        example: 0
                        description: 'Extra work allowed flag. 1 = completed work is automatically added to the order.'
                        nullable: true
                      TTW_EXTRA_WORK_DETAIL:
                        type: integer
                        example: 0
                        description: 'Detailed extra work billing flag. 1 = creates a separate order item for each activity.'
                        nullable: true
                      TTW_COUNT_STRATEGY:
                        type: string
                        example: MINS
                        description: "Rounding strategy for worked hours. 'MINS' = exact minutes, 'COMM_15/30/60' = commenced quarter/half/full hours, 'ROUND_15/30/60' = rounded quarter/half/full hours."
                        nullable: true
                        enum:
                          - MINS
                          - COMM_15
                          - COMM_30
                          - COMM_60
                          - ROUND_15
                          - ROUND_30
                          - ROUND_60
                      TTW_SN_ID:
                        type: string
                        example: null
                        description: 'Linked product (service definition) ID (references services_name).'
                        nullable: true
                      TTW_VALID:
                        type: integer
                        example: 1
                        description: 'Validity flag. 1 = valid, 0 = invalid.'
                        nullable: true
                      TTW_VALID_NOTE:
                        type: string
                        example: null
                        description: 'Validation note explaining invalidity reason.'
                        nullable: true
                      TTW_CREATOR_ID:
                        type: string
                        example: null
                        description: 'Login ID of the user who created this work.'
                        nullable: true
                      TTW_CACHE_FULLNAME:
                        type: string
                        example: null
                        description: 'Cached full work name (raw, including category and bound objects).'
                        nullable: true
                      TTW_MANDATORY_DESC:
                        type: string
                        example: null
                        description: 'Mandatory activity description flag. 1 = all activities for this work must have a description.'
                        nullable: true
                      bound_objects:
                        type: array
                        example:
                          -
                            TTWBO_ID: 34129
                            TTWBO_TTW_ID: 32167
                            TTWBO_OBJECT_ID: 8290
                            TTWBO_OBJECT_TYPE: orders_items
                        description: 'Bound objects linked to this work (e.g. maintenances, users, orders). Array of TimeTrackingWorkBoundObject objects.'
                        items:
                          type: object
                          properties:
                            TTWBO_ID:
                              type: integer
                              example: 34129
                            TTWBO_TTW_ID:
                              type: integer
                              example: 32167
                            TTWBO_OBJECT_ID:
                              type: integer
                              example: 8290
                            TTWBO_OBJECT_TYPE:
                              type: string
                              example: orders_items
                    required:
                      - TTW_ID
                      - TTW_NAME
                      - TTW_MINUTES_PLANNED_ORIGIN
                      - TTW_MINUTES_PLANNED
                      - TTW_LIMIT_PLANNED
                      - TTW_REAL_MINUTES_PLANNED
                      - TTW_START
                      - TTW_FINISH
                      - TTW_L_ID
                      - TTW_SG_ID
                      - TTW_L_MAINTENANCE
                      - TTW_ACTIVE
                      - TTW_TYPE
                      - TTW_PRICE
                      - TTW_CP
                      - TTW_TTC_ID
                      - TTW_EXTRA_WORK
                      - TTW_EXTRA_WORK_DETAIL
                      - TTW_COUNT_STRATEGY
                      - TTW_SN_ID
                      - TTW_VALID
                      - TTW_VALID_NOTE
                      - TTW_CREATOR_ID
                      - TTW_CACHE_FULLNAME
                      - TTW_MANDATORY_DESC
                      - bound_objects
      tags:
        - 'Time Tracking'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Work name/title'
                  example: 'Server maintenance'
                minutes_planned_origin:
                  type: integer
                  description: 'Original planned minutes'
                  example: 120
                minutes_planned:
                  type: integer
                  description: 'Current planned minutes'
                  example: 120
                limit_planned:
                  type: integer
                  description: 'Limit strategy (0=no limit, 1=warn, 2=update order, 3=block)'
                  example: 0
                real_minutes_planned:
                  type: integer
                  description: 'Real/actual planned minutes'
                  example: 120
                start:
                  type: string
                  description: 'Work start time (YYYY-MM-DD HH:MM:SS)'
                  example: '2024-01-15 08:00:00'
                finish:
                  type: string
                  description: 'Work finish time (YYYY-MM-DD HH:MM:SS)'
                  example: '2024-01-15 16:00:00'
                l_id:
                  type: integer
                  description: 'Operator (login) ID'
                  example: 294
                sg_id:
                  type: integer
                  description: 'Service group ID'
                  example: 1
                l_maintenance:
                  type: string
                  description: 'Maintenance editing mode: EDIT or NONE'
                  example: NONE
                active:
                  type: integer
                  description: 'Work status (tinyint for SP)'
                  example: 1
                type:
                  type: string
                  description: 'Work type: NORMAL, SPECIAL, PRIVATE'
                  example: NORMAL
                price:
                  type: number
                  description: Price/rate
                  example: 500.0
                cp:
                  type: integer
                  description: 'Cost position'
                  example: 0
                ttc_id:
                  type: integer
                  description: 'Time tracking category ID'
                  example: 1
                extra_work:
                  type: integer
                  description: 'Allow extra work/overtime (0 or 1)'
                  example: 0
                extra_work_detail:
                  type: integer
                  description: 'Detailed extra work accounting (0 or 1)'
                  example: 0
                count_strategy:
                  type: string
                  description: 'Time rounding strategy'
                  example: MINS
                sn_id:
                  type: integer
                  description: 'Service name ID'
                  example: 16
                mandatory_desc:
                  type: integer
                  description: 'Description mandatory for activities (0 or 1)'
                  example: 0
                maintenances:
                  type: array
                  description: 'Bound process IDs'
                  example:
                    - 16
                  items:
                    type: integer
                users:
                  type: array
                  description: 'Bound customer IDs'
                  example:
                    - 16
                  items:
                    type: integer
                orders_items:
                  type: array
                  description: 'Bound order item IDs'
                  example:
                    - 16
                  items:
                    type: integer
                orders:
                  type: array
                  description: 'Bound order IDs'
                  example:
                    - 16
                  items:
                    type: integer
                maintenance_jobs:
                  type: array
                  description: 'Bound job IDs'
                  example:
                    - 16
                  items:
                    type: integer
    delete:
      summary: 'Delete Time Tracking Work'
      operationId: deleteTimeTrackingWork
      description: '   This endpoint deletes a time tracking work.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Time Tracking'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the work.'
        example: architecto
        required: true
        schema:
          type: string
  /api/v3/time-tracking/activities:
    get:
      summary: 'List Time Tracking Activities'
      operationId: listTimeTrackingActivities
      description: "   This endpoint gets a list of time tracking activities.\n   The list can be filtered and sorted.\n\n   Business rules (enforced by stored procedures):\n   - No overlapping activities per user per day\n   - No future activities\n   - Cannot add/edit activities before last confirmed date\n   - Only owner can edit unless user has TIMETRACKING.EDIT_OTHERS_ACTIVITIES right\n   - Only one running activity (time_to IS NULL) per user at a time"
      parameters:
        -
          in: query
          name: ids
          description: 'Filter by comma-separated IDs'
          example: '1,2,3'
          required: false
          schema:
            type: string
            description: 'Filter by comma-separated IDs'
            example: '1,2,3'
        -
          in: query
          name: worker_id
          description: 'Filter by worker/operator login ID'
          example: 294
          required: false
          schema:
            type: integer
            description: 'Filter by worker/operator login ID'
            example: 294
        -
          in: query
          name: work_id
          description: 'Filter by parent work ID'
          example: 10
          required: false
          schema:
            type: integer
            description: 'Filter by parent work ID'
            example: 10
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      TTA_ID: 633390
                      TTA_TTW_ID: 592
                      TTA_L_ID: 751
                      TTA_DATE: '2006-09-20'
                      TTA_TIME_FROM: '20:47:12'
                      TTA_TIME_TO: '05:12:07'
                      TTA_TIME_TOTAL_MINS: 160
                      TTA_APPROVED: 0
                      TTA_DESCRIPTION: null
                      TTA_TIME_ACCOUNTED_MINS: null
                    -
                      TTA_ID: 633391
                      TTA_TTW_ID: 765
                      TTA_L_ID: 633
                      TTA_DATE: '1973-12-12'
                      TTA_TIME_FROM: '10:24:12'
                      TTA_TIME_TO: '18:42:45'
                      TTA_TIME_TOTAL_MINS: 259
                      TTA_APPROVED: 0
                      TTA_DESCRIPTION: null
                      TTA_TIME_ACCOUNTED_MINS: null
                properties:
                  data:
                    type: array
                    example:
                      -
                        TTA_ID: 633390
                        TTA_TTW_ID: 592
                        TTA_L_ID: 751
                        TTA_DATE: '2006-09-20'
                        TTA_TIME_FROM: '20:47:12'
                        TTA_TIME_TO: '05:12:07'
                        TTA_TIME_TOTAL_MINS: 160
                        TTA_APPROVED: 0
                        TTA_DESCRIPTION: null
                        TTA_TIME_ACCOUNTED_MINS: null
                      -
                        TTA_ID: 633391
                        TTA_TTW_ID: 765
                        TTA_L_ID: 633
                        TTA_DATE: '1973-12-12'
                        TTA_TIME_FROM: '10:24:12'
                        TTA_TIME_TO: '18:42:45'
                        TTA_TIME_TOTAL_MINS: 259
                        TTA_APPROVED: 0
                        TTA_DESCRIPTION: null
                        TTA_TIME_ACCOUNTED_MINS: null
                    items:
                      type: object
                      properties:
                        TTA_ID:
                          type: integer
                          example: 633390
                          description: 'Time tracking activity ID (primary key).'
                        TTA_TTW_ID:
                          type: integer
                          example: 592
                          description: 'Work ID (references time_tracking_works). Identifies which work item this activity belongs to.'
                          nullable: true
                        TTA_L_ID:
                          type: integer
                          example: 751
                          description: 'Login (resource/worker) ID (references logins). The user who performed this activity.'
                          nullable: true
                        TTA_DATE:
                          type: string
                          example: '2006-09-20'
                          description: 'Activity date (format: YYYY-MM-DD).'
                          nullable: true
                        TTA_TIME_FROM:
                          type: string
                          example: '20:47:12'
                          description: 'Activity start time (format: HH:MM:SS).'
                          nullable: true
                        TTA_TIME_TO:
                          type: string
                          example: '05:12:07'
                          description: 'Activity end time (format: HH:MM:SS). NULL indicates a currently running activity.'
                          nullable: true
                        TTA_TIME_TOTAL_MINS:
                          type: integer
                          example: 160
                          description: 'Total tracked time in minutes. Computed from time_from/time_to when not set explicitly.'
                          nullable: true
                        TTA_APPROVED:
                          type: integer
                          example: 0
                          description: 'Confirmed/approved flag. 1 = activity has been confirmed, 0 = not yet confirmed.'
                          nullable: true
                        TTA_DESCRIPTION:
                          type: string
                          example: null
                          description: "Activity description. May be mandatory depending on the parent work's settings."
                          nullable: true
                        TTA_TIME_ACCOUNTED_MINS:
                          type: string
                          example: null
                          description: 'Accounted (billable) time in minutes. May differ from total time for billing purposes.'
                          nullable: true
                    required:
                      - TTA_ID
                      - TTA_TTW_ID
                      - TTA_L_ID
                      - TTA_DATE
                      - TTA_TIME_FROM
                      - TTA_TIME_TO
                      - TTA_TIME_TOTAL_MINS
                      - TTA_APPROVED
                      - TTA_DESCRIPTION
                      - TTA_TIME_ACCOUNTED_MINS
      tags:
        - 'Time Tracking'
    post:
      summary: 'Create Time Tracking Activity'
      operationId: createTimeTrackingActivity
      description: "   This endpoint creates a new time tracking activity.\n\n   Time input: provide either `time_from` + `time_to` OR `time_total`. Minimum 1 minute.\n   Description is required if the parent work has mandatory description enabled."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TTA_ID: 633392
                    TTA_TTW_ID: 592
                    TTA_L_ID: 751
                    TTA_DATE: '2006-09-20'
                    TTA_TIME_FROM: '20:47:12'
                    TTA_TIME_TO: '05:12:07'
                    TTA_TIME_TOTAL_MINS: 160
                    TTA_APPROVED: 0
                    TTA_DESCRIPTION: null
                    TTA_TIME_ACCOUNTED_MINS: null
                properties:
                  data:
                    type: object
                    properties:
                      TTA_ID:
                        type: integer
                        example: 633392
                        description: 'Time tracking activity ID (primary key).'
                      TTA_TTW_ID:
                        type: integer
                        example: 592
                        description: 'Work ID (references time_tracking_works). Identifies which work item this activity belongs to.'
                        nullable: true
                      TTA_L_ID:
                        type: integer
                        example: 751
                        description: 'Login (resource/worker) ID (references logins). The user who performed this activity.'
                        nullable: true
                      TTA_DATE:
                        type: string
                        example: '2006-09-20'
                        description: 'Activity date (format: YYYY-MM-DD).'
                        nullable: true
                      TTA_TIME_FROM:
                        type: string
                        example: '20:47:12'
                        description: 'Activity start time (format: HH:MM:SS).'
                        nullable: true
                      TTA_TIME_TO:
                        type: string
                        example: '05:12:07'
                        description: 'Activity end time (format: HH:MM:SS). NULL indicates a currently running activity.'
                        nullable: true
                      TTA_TIME_TOTAL_MINS:
                        type: integer
                        example: 160
                        description: 'Total tracked time in minutes. Computed from time_from/time_to when not set explicitly.'
                        nullable: true
                      TTA_APPROVED:
                        type: integer
                        example: 0
                        description: 'Confirmed/approved flag. 1 = activity has been confirmed, 0 = not yet confirmed.'
                        nullable: true
                      TTA_DESCRIPTION:
                        type: string
                        example: null
                        description: "Activity description. May be mandatory depending on the parent work's settings."
                        nullable: true
                      TTA_TIME_ACCOUNTED_MINS:
                        type: string
                        example: null
                        description: 'Accounted (billable) time in minutes. May differ from total time for billing purposes.'
                        nullable: true
                    required:
                      - TTA_ID
                      - TTA_TTW_ID
                      - TTA_L_ID
                      - TTA_DATE
                      - TTA_TIME_FROM
                      - TTA_TIME_TO
                      - TTA_TIME_TOTAL_MINS
                      - TTA_APPROVED
                      - TTA_DESCRIPTION
                      - TTA_TIME_ACCOUNTED_MINS
      tags:
        - 'Time Tracking'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                ttw_id:
                  type: integer
                  description: 'Parent work ID'
                  example: 10
                l_id:
                  type: integer
                  description: 'Worker/operator login ID'
                  example: 294
                date:
                  type: string
                  description: 'Activity date (YYYY-MM-DD). No future dates allowed.'
                  example: '2024-06-15'
                time_from:
                  type: string
                  description: 'Activity start time (HH:MM:SS). Provide with time_to, or use time_total instead.'
                  example: '08:00:00'
                time_to:
                  type: string
                  description: 'Activity end time (HH:MM:SS). Provide with time_from, or use time_total instead.'
                  example: '10:30:00'
                time_total:
                  type: string
                  description: 'Total time (HH:MM:SS). Alternative to time_from + time_to. Minimum 00:01:00.'
                  example: '02:30:00'
                approved:
                  type: boolean
                  description: 'Approved/confirmed flag (false=draft, true=confirmed)'
                  example: false
                description:
                  type: string
                  description: 'Activity description (max 255 chars). Required if parent work has mandatory description.'
                  example: 'Server maintenance work'
                time_accounted:
                  type: string
                  description: 'Accounted time for billing (HH:MM:SS). May differ from total due to rounding rules.'
                  example: '02:30:00'
              required:
                - ttw_id
                - l_id
                - date
  '/api/v3/time-tracking/activities/{id}':
    get:
      summary: 'Get Time Tracking Activity'
      operationId: getTimeTrackingActivity
      description: '   This endpoint retrieves a specific time tracking activity by ID.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TTA_ID: 633393
                    TTA_TTW_ID: 592
                    TTA_L_ID: 751
                    TTA_DATE: '2006-09-20'
                    TTA_TIME_FROM: '20:47:12'
                    TTA_TIME_TO: '05:12:07'
                    TTA_TIME_TOTAL_MINS: 160
                    TTA_APPROVED: 0
                    TTA_DESCRIPTION: null
                    TTA_TIME_ACCOUNTED_MINS: null
                properties:
                  data:
                    type: object
                    properties:
                      TTA_ID:
                        type: integer
                        example: 633393
                        description: 'Time tracking activity ID (primary key).'
                      TTA_TTW_ID:
                        type: integer
                        example: 592
                        description: 'Work ID (references time_tracking_works). Identifies which work item this activity belongs to.'
                        nullable: true
                      TTA_L_ID:
                        type: integer
                        example: 751
                        description: 'Login (resource/worker) ID (references logins). The user who performed this activity.'
                        nullable: true
                      TTA_DATE:
                        type: string
                        example: '2006-09-20'
                        description: 'Activity date (format: YYYY-MM-DD).'
                        nullable: true
                      TTA_TIME_FROM:
                        type: string
                        example: '20:47:12'
                        description: 'Activity start time (format: HH:MM:SS).'
                        nullable: true
                      TTA_TIME_TO:
                        type: string
                        example: '05:12:07'
                        description: 'Activity end time (format: HH:MM:SS). NULL indicates a currently running activity.'
                        nullable: true
                      TTA_TIME_TOTAL_MINS:
                        type: integer
                        example: 160
                        description: 'Total tracked time in minutes. Computed from time_from/time_to when not set explicitly.'
                        nullable: true
                      TTA_APPROVED:
                        type: integer
                        example: 0
                        description: 'Confirmed/approved flag. 1 = activity has been confirmed, 0 = not yet confirmed.'
                        nullable: true
                      TTA_DESCRIPTION:
                        type: string
                        example: null
                        description: "Activity description. May be mandatory depending on the parent work's settings."
                        nullable: true
                      TTA_TIME_ACCOUNTED_MINS:
                        type: string
                        example: null
                        description: 'Accounted (billable) time in minutes. May differ from total time for billing purposes.'
                        nullable: true
                    required:
                      - TTA_ID
                      - TTA_TTW_ID
                      - TTA_L_ID
                      - TTA_DATE
                      - TTA_TIME_FROM
                      - TTA_TIME_TO
                      - TTA_TIME_TOTAL_MINS
                      - TTA_APPROVED
                      - TTA_DESCRIPTION
                      - TTA_TIME_ACCOUNTED_MINS
      tags:
        - 'Time Tracking'
    put:
      summary: 'Update Time Tracking Activity'
      operationId: updateTimeTrackingActivity
      description: "   This endpoint updates an existing time tracking activity.\n\n   Only the activity owner can edit unless the user has TIMETRACKING.EDIT_OTHERS_ACTIVITIES right."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    TTA_ID: 633394
                    TTA_TTW_ID: 592
                    TTA_L_ID: 751
                    TTA_DATE: '2006-09-20'
                    TTA_TIME_FROM: '20:47:12'
                    TTA_TIME_TO: '05:12:07'
                    TTA_TIME_TOTAL_MINS: 160
                    TTA_APPROVED: 0
                    TTA_DESCRIPTION: null
                    TTA_TIME_ACCOUNTED_MINS: null
                properties:
                  data:
                    type: object
                    properties:
                      TTA_ID:
                        type: integer
                        example: 633394
                        description: 'Time tracking activity ID (primary key).'
                      TTA_TTW_ID:
                        type: integer
                        example: 592
                        description: 'Work ID (references time_tracking_works). Identifies which work item this activity belongs to.'
                        nullable: true
                      TTA_L_ID:
                        type: integer
                        example: 751
                        description: 'Login (resource/worker) ID (references logins). The user who performed this activity.'
                        nullable: true
                      TTA_DATE:
                        type: string
                        example: '2006-09-20'
                        description: 'Activity date (format: YYYY-MM-DD).'
                        nullable: true
                      TTA_TIME_FROM:
                        type: string
                        example: '20:47:12'
                        description: 'Activity start time (format: HH:MM:SS).'
                        nullable: true
                      TTA_TIME_TO:
                        type: string
                        example: '05:12:07'
                        description: 'Activity end time (format: HH:MM:SS). NULL indicates a currently running activity.'
                        nullable: true
                      TTA_TIME_TOTAL_MINS:
                        type: integer
                        example: 160
                        description: 'Total tracked time in minutes. Computed from time_from/time_to when not set explicitly.'
                        nullable: true
                      TTA_APPROVED:
                        type: integer
                        example: 0
                        description: 'Confirmed/approved flag. 1 = activity has been confirmed, 0 = not yet confirmed.'
                        nullable: true
                      TTA_DESCRIPTION:
                        type: string
                        example: null
                        description: "Activity description. May be mandatory depending on the parent work's settings."
                        nullable: true
                      TTA_TIME_ACCOUNTED_MINS:
                        type: string
                        example: null
                        description: 'Accounted (billable) time in minutes. May differ from total time for billing purposes.'
                        nullable: true
                    required:
                      - TTA_ID
                      - TTA_TTW_ID
                      - TTA_L_ID
                      - TTA_DATE
                      - TTA_TIME_FROM
                      - TTA_TIME_TO
                      - TTA_TIME_TOTAL_MINS
                      - TTA_APPROVED
                      - TTA_DESCRIPTION
                      - TTA_TIME_ACCOUNTED_MINS
      tags:
        - 'Time Tracking'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                ttw_id:
                  type: integer
                  description: 'Parent work ID'
                  example: 10
                l_id:
                  type: integer
                  description: 'Worker/operator login ID'
                  example: 294
                date:
                  type: string
                  description: 'Activity date (YYYY-MM-DD). No future dates allowed.'
                  example: '2024-06-15'
                time_from:
                  type: string
                  description: 'Activity start time (HH:MM:SS)'
                  example: '08:00:00'
                time_to:
                  type: string
                  description: 'Activity end time (HH:MM:SS)'
                  example: '10:30:00'
                time_total:
                  type: string
                  description: 'Total time (HH:MM:SS). Alternative to time_from + time_to.'
                  example: '02:30:00'
                approved:
                  type: boolean
                  description: 'Approved/confirmed flag'
                  example: false
                description:
                  type: string
                  description: 'Activity description (max 255 chars)'
                  example: 'Updated description'
                time_accounted:
                  type: string
                  description: 'Accounted time for billing (HH:MM:SS)'
                  example: '02:30:00'
    delete:
      summary: 'Delete Time Tracking Activity'
      operationId: deleteTimeTrackingActivity
      description: "   This endpoint deletes a time tracking activity.\n\n   Only the activity owner can delete unless the user has TIMETRACKING.EDIT_OTHERS_ACTIVITIES right."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Time Tracking'
    parameters:
      -
        in: path
        name: id
        description: 'The ID of the activity.'
        example: architecto
        required: true
        schema:
          type: string
  /api/v3/locations/tokens:
    get:
      summary: 'List Location Tokens'
      operationId: listLocationTokens
      description: '   Returns location tokens visible to the current login within allowed CT scope.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: 'List of location personal access tokens'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 29
                      name: aut
                      abilities:
                        - all
                      last_used_at: null
                      expires_at: null
                      created_at: '2026-04-20T09:25:43.000000Z'
                      tokenable_type: App\Models\Login
                      tokenable:
                        ID: 5536
                        FIRST_NAME: Noah
                        SURNAME: Cronin
                        LOGIN: emelie.baumbach
                        PASSWORD: random_password
                        L_LEVEL: 10
                        MAIL: ferne52@example.com
                        PHONE: null
                        NOTE: 'Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia.'
                        SALESMAN: 0
                        L_SMS_ENABLE: 0
                        L_PIN: null
                        LOG_LEVEL: INFO
                        L_CP_ID: '0484'
                        L_CREATED: '2026-03-17 04:28:23'
                        L_L_ID: 82
                        L_ACTIVE: 0
                        L_PASS_EXPIRE: -19
                        L_PASS_CHANGE: null
                        L_TYPE: COOPERATION
                        L_SIGNATURE: 'Aut quis ut dolores omnis et earum. Asperiores est vel id aut officiis eos. Et qui unde et.'
                        L_SELFCARE: 1
                        L_PASS_CODE: '847820'
                        L_PASS_CODE_CREATED: null
                        L_CACHE_INITIALS: ew
                        L_INITIALS: null
                        L_STATISTICS_ENABLE: 1
                    -
                      id: 30
                      name: molestiae
                      abilities:
                        - all
                      last_used_at: null
                      expires_at: null
                      created_at: '2026-04-20T09:25:44.000000Z'
                      tokenable_type: App\Models\Login
                      tokenable:
                        ID: 5537
                        FIRST_NAME: Nina
                        SURNAME: Wisoky
                        LOGIN: jazmyne.heathcote
                        PASSWORD: random_password
                        L_LEVEL: 3
                        MAIL: zstoltenberg@example.org
                        PHONE: null
                        NOTE: null
                        SALESMAN: 1
                        L_SMS_ENABLE: 1
                        L_PIN: '3735'
                        LOG_LEVEL: INFO
                        L_CP_ID: null
                        L_CREATED: '2026-03-25 03:41:18'
                        L_L_ID: 95
                        L_ACTIVE: 1
                        L_PASS_EXPIRE: null
                        L_PASS_CHANGE: null
                        L_TYPE: COOPERATION
                        L_SIGNATURE: null
                        L_SELFCARE: 0
                        L_PASS_CODE: null
                        L_PASS_CODE_CREATED: '2026-03-12 21:06:37'
                        L_CACHE_INITIALS: ix
                        L_INITIALS: null
                        L_STATISTICS_ENABLE: 1
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 29
                        name: aut
                        abilities:
                          - all
                        last_used_at: null
                        expires_at: null
                        created_at: '2026-04-20T09:25:43.000000Z'
                        tokenable_type: App\Models\Login
                        tokenable:
                          ID: 5536
                          FIRST_NAME: Noah
                          SURNAME: Cronin
                          LOGIN: emelie.baumbach
                          PASSWORD: random_password
                          L_LEVEL: 10
                          MAIL: ferne52@example.com
                          PHONE: null
                          NOTE: 'Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia.'
                          SALESMAN: 0
                          L_SMS_ENABLE: 0
                          L_PIN: null
                          LOG_LEVEL: INFO
                          L_CP_ID: '0484'
                          L_CREATED: '2026-03-17 04:28:23'
                          L_L_ID: 82
                          L_ACTIVE: 0
                          L_PASS_EXPIRE: -19
                          L_PASS_CHANGE: null
                          L_TYPE: COOPERATION
                          L_SIGNATURE: 'Aut quis ut dolores omnis et earum. Asperiores est vel id aut officiis eos. Et qui unde et.'
                          L_SELFCARE: 1
                          L_PASS_CODE: '847820'
                          L_PASS_CODE_CREATED: null
                          L_CACHE_INITIALS: ew
                          L_INITIALS: null
                          L_STATISTICS_ENABLE: 1
                      -
                        id: 30
                        name: molestiae
                        abilities:
                          - all
                        last_used_at: null
                        expires_at: null
                        created_at: '2026-04-20T09:25:44.000000Z'
                        tokenable_type: App\Models\Login
                        tokenable:
                          ID: 5537
                          FIRST_NAME: Nina
                          SURNAME: Wisoky
                          LOGIN: jazmyne.heathcote
                          PASSWORD: random_password
                          L_LEVEL: 3
                          MAIL: zstoltenberg@example.org
                          PHONE: null
                          NOTE: null
                          SALESMAN: 1
                          L_SMS_ENABLE: 1
                          L_PIN: '3735'
                          LOG_LEVEL: INFO
                          L_CP_ID: null
                          L_CREATED: '2026-03-25 03:41:18'
                          L_L_ID: 95
                          L_ACTIVE: 1
                          L_PASS_EXPIRE: null
                          L_PASS_CHANGE: null
                          L_TYPE: COOPERATION
                          L_SIGNATURE: null
                          L_SELFCARE: 0
                          L_PASS_CODE: null
                          L_PASS_CODE_CREATED: '2026-03-12 21:06:37'
                          L_CACHE_INITIALS: ix
                          L_INITIALS: null
                          L_STATISTICS_ENABLE: 1
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 29
                          description: 'Unique token identifier.'
                        name:
                          type: string
                          example: aut
                          description: 'Token display name.'
                        abilities:
                          type: array
                          example:
                            - all
                          description: 'List of token abilities/scopes.'
                          items:
                            type: string
                        last_used_at:
                          type: string
                          example: null
                          description: 'Timestamp when token was last used.'
                          nullable: true
                        expires_at:
                          type: string
                          example: null
                          description: 'Token expiration timestamp.'
                          nullable: true
                        created_at:
                          type: string
                          example: '2026-04-20T09:25:43.000000Z'
                          description: 'Token creation timestamp.'
                        tokenable_type:
                          type: string
                          example: App\Models\Login
                          description: 'Type of the tokenable model.'
                        tokenable:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 5536
                            FIRST_NAME:
                              type: string
                              example: Noah
                            SURNAME:
                              type: string
                              example: Cronin
                            LOGIN:
                              type: string
                              example: emelie.baumbach
                            PASSWORD:
                              type: string
                              example: random_password
                            L_LEVEL:
                              type: integer
                              example: 10
                            MAIL:
                              type: string
                              example: ferne52@example.com
                            PHONE:
                              type: string
                              example: null
                              nullable: true
                            NOTE:
                              type: string
                              example: 'Aut dolores enim non facere tempora ex voluptatem. Praesentium quis adipisci molestias fugit. Distinctio eum doloremque id aut libero aliquam veniam corporis. Mollitia deleniti nemo odit quia officia.'
                            SALESMAN:
                              type: integer
                              example: 0
                            L_SMS_ENABLE:
                              type: integer
                              example: 0
                            L_PIN:
                              type: string
                              example: null
                              nullable: true
                            LOG_LEVEL:
                              type: string
                              example: INFO
                            L_CP_ID:
                              type: string
                              example: '0484'
                            L_CREATED:
                              type: string
                              example: '2026-03-17 04:28:23'
                            L_L_ID:
                              type: integer
                              example: 82
                            L_ACTIVE:
                              type: integer
                              example: 0
                            L_PASS_EXPIRE:
                              type: integer
                              example: -19
                            L_PASS_CHANGE:
                              type: string
                              example: null
                              nullable: true
                            L_TYPE:
                              type: string
                              example: COOPERATION
                            L_SIGNATURE:
                              type: string
                              example: 'Aut quis ut dolores omnis et earum. Asperiores est vel id aut officiis eos. Et qui unde et.'
                            L_SELFCARE:
                              type: integer
                              example: 1
                            L_PASS_CODE:
                              type: string
                              example: '847820'
                            L_PASS_CODE_CREATED:
                              type: string
                              example: null
                              nullable: true
                            L_CACHE_INITIALS:
                              type: string
                              example: ew
                            L_INITIALS:
                              type: string
                              example: null
                              nullable: true
                            L_STATISTICS_ENABLE:
                              type: integer
                              example: 1
                          description: 'Tokenable model instance.'
                    required:
                      - id
                      - name
                      - abilities
                      - last_used_at
                      - expires_at
                      - created_at
                      - tokenable_type
                      - tokenable
      tags:
        - 'Token Management'
  '/api/v3/locations/{location_ID}/tokens':
    post:
      summary: 'Create Location Token'
      operationId: createLocationToken
      description: "   Creates a personal access token for a specific location.\n   This operation is allowed only for administrator logins (L_CP_ID is null)."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        201:
          description: 'Location token created successfully'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    plain_text_token: null
                    token: null
                properties:
                  data:
                    type: object
                    properties:
                      plain_text_token:
                        type: string
                        example: null
                        description: 'Plain text token value shown only once after token creation.'
                      token:
                        type: string
                        example: null
                        description: 'Created token metadata.'
                    required:
                      - plain_text_token
                      - token
      tags:
        - 'Token Management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Token name.'
                  example: 'Mobile app token'
                abilities:
                  type: array
                  description: 'Token abilities.'
                  example:
                    - all
                  items:
                    type: string
                expires_at:
                  type: string
                  description: 'Token expiration timestamp (ISO 8601).'
                  example: '2026-12-31T23:59:59Z'
              required:
                - name
    parameters:
      -
        in: path
        name: location_ID
        description: ''
        example: '001'
        required: true
        schema:
          type: string
  '/api/v3/locations/{location_ID}/tokens/{tokenId}':
    delete:
      summary: 'Revoke Location Token'
      operationId: revokeLocationToken
      description: '   Revokes a personal access token for a specific location within current scope.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Token Management'
    parameters:
      -
        in: path
        name: location_ID
        description: ''
        example: '001'
        required: true
        schema:
          type: string
      -
        in: path
        name: tokenId
        description: ''
        example: architecto
        required: true
        schema:
          type: string
  /api/v3/tokens/login:
    get:
      summary: 'List Login Tokens'
      operationId: listLoginTokens
      description: "   Returns personal access tokens for the currently authenticated login.\n   Tokens created through the login endpoint are excluded from this list."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        200:
          description: 'List of login personal access tokens'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    -
                      id: 32
                      name: quidem
                      abilities:
                        - all
                      last_used_at: null
                      expires_at: null
                      created_at: '2026-04-20T09:25:44.000000Z'
                      tokenable_type: App\Models\Login
                      tokenable:
                        ID: 5539
                        FIRST_NAME: Theo
                        SURNAME: Hauck
                        LOGIN: leo34
                        PASSWORD: random_password
                        L_LEVEL: 5
                        MAIL: pfritsch@example.com
                        PHONE: 7909150667
                        NOTE: null
                        SALESMAN: 1
                        L_SMS_ENABLE: 0
                        L_PIN: null
                        LOG_LEVEL: INFO
                        L_CP_ID: '0044'
                        L_CREATED: '2026-02-10 07:40:05'
                        L_L_ID: 28
                        L_ACTIVE: 0
                        L_PASS_EXPIRE: 89
                        L_PASS_CHANGE: null
                        L_TYPE: MACHINE
                        L_SIGNATURE: null
                        L_SELFCARE: 1
                        L_PASS_CODE: null
                        L_PASS_CODE_CREATED: null
                        L_CACHE_INITIALS: pw
                        L_INITIALS: be
                        L_STATISTICS_ENABLE: 0
                    -
                      id: 33
                      name: dolorem
                      abilities:
                        - all
                      last_used_at: null
                      expires_at: null
                      created_at: '2026-04-20T09:25:44.000000Z'
                      tokenable_type: App\Models\Login
                      tokenable:
                        ID: 5540
                        FIRST_NAME: Cynthia
                        SURNAME: Fahey
                        LOGIN: balistreri.josiane
                        PASSWORD: random_password
                        L_LEVEL: 6
                        MAIL: lward@example.com
                        PHONE: null
                        NOTE: 'Qui repudiandae laboriosam est alias. Ratione nemo voluptate accusamus ut et recusandae modi rerum. Repellendus assumenda et tenetur ab reiciendis.'
                        SALESMAN: 0
                        L_SMS_ENABLE: 1
                        L_PIN: null
                        LOG_LEVEL: INFO
                        L_CP_ID: null
                        L_CREATED: '2026-03-07 13:33:01'
                        L_L_ID: 52
                        L_ACTIVE: 1
                        L_PASS_EXPIRE: -357
                        L_PASS_CHANGE: '2026-03-16 10:40:16'
                        L_TYPE: PERSON
                        L_SIGNATURE: null
                        L_SELFCARE: 1
                        L_PASS_CODE: null
                        L_PASS_CODE_CREATED: '2026-02-11 16:13:00'
                        L_CACHE_INITIALS: qz
                        L_INITIALS: null
                        L_STATISTICS_ENABLE: 0
                properties:
                  data:
                    type: array
                    example:
                      -
                        id: 32
                        name: quidem
                        abilities:
                          - all
                        last_used_at: null
                        expires_at: null
                        created_at: '2026-04-20T09:25:44.000000Z'
                        tokenable_type: App\Models\Login
                        tokenable:
                          ID: 5539
                          FIRST_NAME: Theo
                          SURNAME: Hauck
                          LOGIN: leo34
                          PASSWORD: random_password
                          L_LEVEL: 5
                          MAIL: pfritsch@example.com
                          PHONE: 7909150667
                          NOTE: null
                          SALESMAN: 1
                          L_SMS_ENABLE: 0
                          L_PIN: null
                          LOG_LEVEL: INFO
                          L_CP_ID: '0044'
                          L_CREATED: '2026-02-10 07:40:05'
                          L_L_ID: 28
                          L_ACTIVE: 0
                          L_PASS_EXPIRE: 89
                          L_PASS_CHANGE: null
                          L_TYPE: MACHINE
                          L_SIGNATURE: null
                          L_SELFCARE: 1
                          L_PASS_CODE: null
                          L_PASS_CODE_CREATED: null
                          L_CACHE_INITIALS: pw
                          L_INITIALS: be
                          L_STATISTICS_ENABLE: 0
                      -
                        id: 33
                        name: dolorem
                        abilities:
                          - all
                        last_used_at: null
                        expires_at: null
                        created_at: '2026-04-20T09:25:44.000000Z'
                        tokenable_type: App\Models\Login
                        tokenable:
                          ID: 5540
                          FIRST_NAME: Cynthia
                          SURNAME: Fahey
                          LOGIN: balistreri.josiane
                          PASSWORD: random_password
                          L_LEVEL: 6
                          MAIL: lward@example.com
                          PHONE: null
                          NOTE: 'Qui repudiandae laboriosam est alias. Ratione nemo voluptate accusamus ut et recusandae modi rerum. Repellendus assumenda et tenetur ab reiciendis.'
                          SALESMAN: 0
                          L_SMS_ENABLE: 1
                          L_PIN: null
                          LOG_LEVEL: INFO
                          L_CP_ID: null
                          L_CREATED: '2026-03-07 13:33:01'
                          L_L_ID: 52
                          L_ACTIVE: 1
                          L_PASS_EXPIRE: -357
                          L_PASS_CHANGE: '2026-03-16 10:40:16'
                          L_TYPE: PERSON
                          L_SIGNATURE: null
                          L_SELFCARE: 1
                          L_PASS_CODE: null
                          L_PASS_CODE_CREATED: '2026-02-11 16:13:00'
                          L_CACHE_INITIALS: qz
                          L_INITIALS: null
                          L_STATISTICS_ENABLE: 0
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 32
                          description: 'Unique token identifier.'
                        name:
                          type: string
                          example: quidem
                          description: 'Token display name.'
                        abilities:
                          type: array
                          example:
                            - all
                          description: 'List of token abilities/scopes.'
                          items:
                            type: string
                        last_used_at:
                          type: string
                          example: null
                          description: 'Timestamp when token was last used.'
                          nullable: true
                        expires_at:
                          type: string
                          example: null
                          description: 'Token expiration timestamp.'
                          nullable: true
                        created_at:
                          type: string
                          example: '2026-04-20T09:25:44.000000Z'
                          description: 'Token creation timestamp.'
                        tokenable_type:
                          type: string
                          example: App\Models\Login
                          description: 'Type of the tokenable model.'
                        tokenable:
                          type: object
                          properties:
                            ID:
                              type: integer
                              example: 5539
                            FIRST_NAME:
                              type: string
                              example: Theo
                            SURNAME:
                              type: string
                              example: Hauck
                            LOGIN:
                              type: string
                              example: leo34
                            PASSWORD:
                              type: string
                              example: random_password
                            L_LEVEL:
                              type: integer
                              example: 5
                            MAIL:
                              type: string
                              example: pfritsch@example.com
                            PHONE:
                              type: integer
                              example: 7909150667
                            NOTE:
                              type: string
                              example: null
                              nullable: true
                            SALESMAN:
                              type: integer
                              example: 1
                            L_SMS_ENABLE:
                              type: integer
                              example: 0
                            L_PIN:
                              type: string
                              example: null
                              nullable: true
                            LOG_LEVEL:
                              type: string
                              example: INFO
                            L_CP_ID:
                              type: string
                              example: '0044'
                            L_CREATED:
                              type: string
                              example: '2026-02-10 07:40:05'
                            L_L_ID:
                              type: integer
                              example: 28
                            L_ACTIVE:
                              type: integer
                              example: 0
                            L_PASS_EXPIRE:
                              type: integer
                              example: 89
                            L_PASS_CHANGE:
                              type: string
                              example: null
                              nullable: true
                            L_TYPE:
                              type: string
                              example: MACHINE
                            L_SIGNATURE:
                              type: string
                              example: null
                              nullable: true
                            L_SELFCARE:
                              type: integer
                              example: 1
                            L_PASS_CODE:
                              type: string
                              example: null
                              nullable: true
                            L_PASS_CODE_CREATED:
                              type: string
                              example: null
                              nullable: true
                            L_CACHE_INITIALS:
                              type: string
                              example: pw
                            L_INITIALS:
                              type: string
                              example: be
                            L_STATISTICS_ENABLE:
                              type: integer
                              example: 0
                          description: 'Tokenable model instance.'
                    required:
                      - id
                      - name
                      - abilities
                      - last_used_at
                      - expires_at
                      - created_at
                      - tokenable_type
                      - tokenable
      tags:
        - 'Token Management'
    post:
      summary: 'Create Login Token'
      operationId: createLoginToken
      description: "   Creates a new personal access token for the currently authenticated login.\n   The plain text token is returned only once in the response."
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        201:
          description: 'Login token created successfully'
          content:
            application/json:
              schema:
                type: object
                example:
                  data:
                    plain_text_token: null
                    token: null
                properties:
                  data:
                    type: object
                    properties:
                      plain_text_token:
                        type: string
                        example: null
                        description: 'Plain text token value shown only once after token creation.'
                      token:
                        type: string
                        example: null
                        description: 'Created token metadata.'
                    required:
                      - plain_text_token
                      - token
      tags:
        - 'Token Management'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: 'Token name.'
                  example: 'Mobile app token'
                abilities:
                  type: array
                  description: 'Token abilities.'
                  example:
                    - all
                  items:
                    type: string
                expires_at:
                  type: string
                  description: 'Token expiration timestamp (ISO 8601).'
                  example: '2026-12-31T23:59:59Z'
              required:
                - name
  '/api/v3/tokens/login/{tokenId}':
    delete:
      summary: 'Revoke Login Token'
      operationId: revokeLoginToken
      description: '   Revokes a personal access token owned by the currently authenticated login.'
      parameters:
        -
          in: header
          name: X-CT
          description: ''
          example: '{{ct}}'
          schema:
            type: string
        -
          in: header
          name: X-Login-Id
          description: ''
          example: '{{loginId}}'
          schema:
            type: string
      responses:
        204:
          description: ''
          content:
            application/json:
              schema:
                type: object
                nullable: true
      tags:
        - 'Token Management'
    parameters:
      -
        in: path
        name: tokenId
        description: ''
        example: 0
        required: true
        schema:
          type: integer
