swagger: '2.0'
info:
  title: prepaybalance
  description: This is the Swagger UI environment generated for the prepaybalance specification
  version: 1.0.0
host: apig-mlbstg1.ooredoo.ps
basePath: /tmf-api/oauth
schemes:
  - https
consumes:
  - application/x-www-form-urlencoded
produces:
  - application/json;charset=utf-8
security:
  - Oauth: []
paths:
  /token:
    post:
      operationId: Auth
      summary: Auth
      description: This operation creates a PartyAccount entity.
      tags:
        - Token
      parameters:
        - name: client_id
          in: formData
          description: Client ID
          required: true
          type: string
          default: AHMAD01
        - name: client_secret
          in: formData
          description: Client Secret
          required: true
          type: string
          default: AHMAD001
        - name: grant_type
          in: formData
          description: Grant Type
          required: true
          type: string
          default: client_credentials
      responses:
        '201':
          description: Created
          schema:
            type: object
            properties:
              refresh_token_expires_in:
                type: string
              api_product_list:
                type: string
              organization_name:
                type: string
              token_type:
                type: string
              issued_at:
                type: string
              client_id:
                type: string
              access_token:
                type: string
              application_name:
                type: string
              scope:
                type: string
              expires_in:
                type: string
              refresh_count:
                type: string
              status:
                type: string
        '400':
          description: Bad Request
          schema:
            type: object
            properties:
              error:
                type: string
        '401':
          description: Unauthorized
          schema:
            type: object
            properties:
              error:
                type: string
        '403':
          description: Forbidden
          schema:
            type: object
            properties:
              error:
                type: string
        '405':
          description: Method Not allowed
          schema:
            type: object
            properties:
              error:
                type: string
        '409':
          description: Conflict
          schema:
            type: object
            properties:
              error:
                type: string
        '500':
          description: Internal Server Error
          schema:
            type: object
            properties:
              error:
                type: string
  /partyAccount:
    get:
      operationId: listPartyAccount
      summary: List or find PartyAccount objects
      description: This operation list or find PartyAccount entities
      tags:
        - partyAccount
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/PartyAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createPartyAccount
      summary: Creates a PartyAccount
      description: This operation creates a PartyAccount entity.
      tags:
        - partyAccount
      parameters:
        - name: partyAccount
          description: The PartyAccount to be created
          required: true
          schema:
            $ref: '#/definitions/PartyAccount_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/PartyAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /partyAccount/{id}:
    get:
      operationId: retrievePartyAccount
      summary: Retrieves a PartyAccount by ID
      description: This operation retrieves a PartyAccount entity. Attribute selection is enabled for all first level attributes.
      tags:
        - partyAccount
      parameters:
        - name: id
          description: Identifier of the PartyAccount
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/PartyAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchPartyAccount
      summary: Updates partially a PartyAccount
      description: This operation updates partially a PartyAccount entity.
      tags:
        - partyAccount
      parameters:
        - name: id
          description: Identifier of the PartyAccount
          required: true
          type: string
          in: path
        - name: partyAccount
          description: The PartyAccount to be updated
          required: true
          schema:
            $ref: '#/definitions/PartyAccount_Update'
          in: body
      responses:
        '200':
          description: Updated
          schema:
            $ref: '#/definitions/PartyAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deletePartyAccount
      summary: Deletes a PartyAccount
      description: This operation deletes a PartyAccount entity.
      tags:
        - partyAccount
      parameters:
        - name: id
          description: Identifier of the PartyAccount
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billingAccount:
    get:
      operationId: listBillingAccount
      summary: List or find BillingAccount objects
      description: This operation list or find BillingAccount entities
      tags:
        - billingAccount
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/BillingAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createBillingAccount
      summary: Creates a BillingAccount
      description: This operation creates a BillingAccount entity.
      tags:
        - billingAccount
      parameters:
        - name: billingAccount
          description: The BillingAccount to be created
          required: true
          schema:
            $ref: '#/definitions/BillingAccount_Create'
          in: body
          
        - $ref: '#/parameters/transactionId'
        - $ref: '#/parameters/countryCode'
        - $ref: '#/parameters/applicationCode'
        - $ref: '#/parameters/applicationUserName'
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/BillingAccount'
            
          headers:
            transactionId:
              description: Transaction Id should be, an string value 
              type: string
        
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billingAccount/{id}:
    get:
      operationId: retrieveBillingAccount
      summary: Retrieves a BillingAccount by ID
      description: This operation retrieves a BillingAccount entity. Attribute selection is enabled for all first level attributes.
      tags:
        - billingAccount
      parameters:
        - name: id
          description: Identifier of the BillingAccount
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BillingAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchBillingAccount
      summary: Updates partially a BillingAccount
      description: This operation updates partially a BillingAccount entity.
      tags:
        - billingAccount
      parameters:
        - name: id
          description: Identifier of the BillingAccount
          required: true
          type: string
          in: path
          
        - name: transactionId
          description: transactionId
          required: true
          type: string
          in: header  
          
        - name: applicationCode
          description: applicationCode
          required: true
          type: string
          in: header
          
        - name: applicationUserName
          description: applicationUserName
          required: true
          type: string
          in: header
          
        - name: countryCode
          description: countryCode
          required: false
          type: string
          in: header
        - name: billingAccount
          description: The BillingAccount to be updated
          required: true
          schema:
            $ref: '#/definitions/BillingAccount_Update'
          in: body
      responses:
        '200':
          description: Updated
          headers:
            transactionId:
              description: Transaction Id
              type: string
          schema:
            $ref: '#/definitions/BillingAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteBillingAccount
      summary: Deletes a BillingAccount
      description: This operation deletes a BillingAccount entity.
      tags:
        - billingAccount
      parameters:
        - name: id
          description: Identifier of the BillingAccount
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /settlementAccount:
    get:
      operationId: listSettlementAccount
      summary: List or find SettlementAccount objects
      description: This operation list or find SettlementAccount entities
      tags:
        - settlementAccount
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/SettlementAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createSettlementAccount
      summary: Creates a SettlementAccount
      description: This operation creates a SettlementAccount entity.
      tags:
        - settlementAccount
      parameters:
        - name: settlementAccount
          description: The SettlementAccount to be created
          required: true
          schema:
            $ref: '#/definitions/SettlementAccount_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/SettlementAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /settlementAccount/{id}:
    get:
      operationId: retrieveSettlementAccount
      summary: Retrieves a SettlementAccount by ID
      description: This operation retrieves a SettlementAccount entity. Attribute selection is enabled for all first level attributes.
      tags:
        - settlementAccount
      parameters:
        - name: id
          description: Identifier of the SettlementAccount
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/SettlementAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchSettlementAccount
      summary: Updates partially a SettlementAccount
      description: This operation updates partially a SettlementAccount entity.
      tags:
        - settlementAccount
      parameters:
        - name: id
          description: Identifier of the SettlementAccount
          required: true
          type: string
          in: path
        - name: transactionId
          description: transactionId
          required: true
          type: string
          in: header  
          
        - name: applicationCode
          description: applicationCode
          required: true
          type: string
          in: header
          
        - name: applicationUserName
          description: applicationUserName
          required: true
          type: string
          in: header
          
        - name: countryCode
          description: countryCode
          required: false
          type: string
          in: header
        - name: settlementAccount
          description: The SettlementAccount to be updated
          required: true
          schema:
            $ref: '#/definitions/SettlementAccount_Update'
          in: body
      responses:
        '200':
          description: Updated
          headers:
            transactionId:
              description: Transaction Id
              type: string
          schema:
            $ref: '#/definitions/SettlementAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteSettlementAccount
      summary: Deletes a SettlementAccount
      description: This operation deletes a SettlementAccount entity.
      tags:
        - settlementAccount
      parameters:
        - name: id
          description: Identifier of the SettlementAccount
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /financialAccount:
    get:
      operationId: listFinancialAccount
      summary: List or find FinancialAccount objects
      description: This operation list or find FinancialAccount entities
      tags:
        - financialAccount
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/FinancialAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createFinancialAccount
      summary: Creates a FinancialAccount
      description: This operation creates a FinancialAccount entity.
      tags:
        - financialAccount
      parameters:
        - name: financialAccount
          description: The FinancialAccount to be created
          required: true
          schema:
            $ref: '#/definitions/FinancialAccount_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/FinancialAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /financialAccount/{id}:
    get:
      operationId: retrieveFinancialAccount
      summary: Retrieves a FinancialAccount by ID
      description: This operation retrieves a FinancialAccount entity. Attribute selection is enabled for all first level attributes.
      tags:
        - financialAccount
      parameters:
        - name: id
          description: Identifier of the FinancialAccount
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/FinancialAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchFinancialAccount
      summary: Updates partially a FinancialAccount
      description: This operation updates partially a FinancialAccount entity.
      tags:
        - financialAccount
      parameters:
        - name: id
          description: Identifier of the FinancialAccount
          required: true
          type: string
          in: path
        - name: financialAccount
          description: The FinancialAccount to be updated
          required: true
          schema:
            $ref: '#/definitions/FinancialAccount_Update'
          in: body
      responses:
        '200':
          description: Updated
          schema:
            $ref: '#/definitions/FinancialAccount'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteFinancialAccount
      summary: Deletes a FinancialAccount
      description: This operation deletes a FinancialAccount entity.
      tags:
        - financialAccount
      parameters:
        - name: id
          description: Identifier of the FinancialAccount
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billingCycleSpecification:
    get:
      operationId: listBillingCycleSpecification
      summary: List or find BillingCycleSpecification objects
      description: This operation list or find BillingCycleSpecification entities
      tags:
        - billingCycleSpecification
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/BillingCycleSpecification'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createBillingCycleSpecification
      summary: Creates a BillingCycleSpecification
      description: This operation creates a BillingCycleSpecification entity.
      tags:
        - billingCycleSpecification
      parameters:
        - name: billingCycleSpecification
          description: The BillingCycleSpecification to be created
          required: true
          schema:
            $ref: '#/definitions/BillingCycleSpecification_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/BillingCycleSpecification'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billingCycleSpecification/{id}:
    get:
      operationId: retrieveBillingCycleSpecification
      summary: Retrieves a BillingCycleSpecification by ID
      description: This operation retrieves a BillingCycleSpecification entity. Attribute selection is enabled for all first level attributes.
      tags:
        - billingCycleSpecification
      parameters:
        - name: id
          description: Identifier of the BillingCycleSpecification
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BillingCycleSpecification'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchBillingCycleSpecification
      summary: Updates partially a BillingCycleSpecification
      description: This operation updates partially a BillingCycleSpecification entity.
      tags:
        - billingCycleSpecification
      parameters:
        - name: id
          description: Identifier of the BillingCycleSpecification
          required: true
          type: string
          in: path
        - name: billingCycleSpecification
          description: The BillingCycleSpecification to be updated
          required: true
          schema:
            $ref: '#/definitions/BillingCycleSpecification_Update'
          in: body
      responses:
        '200':
          description: Updated
          schema:
            $ref: '#/definitions/BillingCycleSpecification'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteBillingCycleSpecification
      summary: Deletes a BillingCycleSpecification
      description: This operation deletes a BillingCycleSpecification entity.
      tags:
        - billingCycleSpecification
      parameters:
        - name: id
          description: Identifier of the BillingCycleSpecification
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billFormat:
    get:
      operationId: listBillFormat
      summary: List or find BillFormat objects
      description: This operation list or find BillFormat entities
      tags:
        - billFormat
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/BillFormat'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createBillFormat
      summary: Creates a BillFormat
      description: This operation creates a BillFormat entity.
      tags:
        - billFormat
      parameters:
        - name: billFormat
          description: The BillFormat to be created
          required: true
          schema:
            $ref: '#/definitions/BillFormat_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/BillFormat'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billFormat/{id}:
    get:
      operationId: retrieveBillFormat
      summary: Retrieves a BillFormat by ID
      description: This operation retrieves a BillFormat entity. Attribute selection is enabled for all first level attributes.
      tags:
        - billFormat
      parameters:
        - name: id
          description: Identifier of the BillFormat
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BillFormat'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchBillFormat
      summary: Updates partially a BillFormat
      description: This operation updates partially a BillFormat entity.
      tags:
        - billFormat
      parameters:
        - name: id
          description: Identifier of the BillFormat
          required: true
          type: string
          in: path
        - name: billFormat
          description: The BillFormat to be updated
          required: true
          schema:
            $ref: '#/definitions/BillFormat_Update'
          in: body
      responses:
        '200':
          description: Updated
          schema:
            $ref: '#/definitions/BillFormat'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteBillFormat
      summary: Deletes a BillFormat
      description: This operation deletes a BillFormat entity.
      tags:
        - billFormat
      parameters:
        - name: id
          description: Identifier of the BillFormat
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billPresentationMedia:
    get:
      operationId: listBillPresentationMedia
      summary: List or find BillPresentationMedia objects
      description: This operation list or find BillPresentationMedia entities
      tags:
        - billPresentationMedia
      parameters:
        - name: fields
          description: Comma-separated properties to be provided in response
          required: false
          in: query
          type: string
        - name: offset
          description: Requested index for start of resources to be provided in response
          required: false
          in: query
          type: integer
        - name: limit
          description: Requested number of resources to be provided in response
          required: false
          in: query
          type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/BillPresentationMedia'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createBillPresentationMedia
      summary: Creates a BillPresentationMedia
      description: This operation creates a BillPresentationMedia entity.
      tags:
        - billPresentationMedia
      parameters:
        - name: billPresentationMedia
          description: The BillPresentationMedia to be created
          required: true
          schema:
            $ref: '#/definitions/BillPresentationMedia_Create'
          in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/BillPresentationMedia'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /billPresentationMedia/{id}:
    get:
      operationId: retrieveBillPresentationMedia
      summary: Retrieves a BillPresentationMedia by ID
      description: This operation retrieves a BillPresentationMedia entity. Attribute selection is enabled for all first level attributes.
      tags:
        - billPresentationMedia
      parameters:
        - name: id
          description: Identifier of the BillPresentationMedia
          required: true
          type: string
          in: path
        - name: fields
          description: Comma-separated properties to provide in response
          required: false
          type: string
          in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/BillPresentationMedia'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    patch:
      operationId: patchBillPresentationMedia
      summary: Updates partially a BillPresentationMedia
      description: This operation updates partially a BillPresentationMedia entity.
      tags:
        - billPresentationMedia
      parameters:
        - name: id
          description: Identifier of the BillPresentationMedia
          required: true
          type: string
          in: path
        - name: billPresentationMedia
          description: The BillPresentationMedia to be updated
          required: true
          schema:
            $ref: '#/definitions/BillPresentationMedia_Update'
          in: body
      responses:
        '200':
          description: Updated
          schema:
            $ref: '#/definitions/BillPresentationMedia'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    delete:
      operationId: deleteBillPresentationMedia
      summary: Deletes a BillPresentationMedia
      description: This operation deletes a BillPresentationMedia entity.
      tags:
        - billPresentationMedia
      parameters:
        - name: id
          description: Identifier of the BillPresentationMedia
          required: true
          type: string
          in: path
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /hub:
    post:
      operationId: registerListener
      summary: Register a listener
      description: Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
      tags:
        - events subscription
      parameters:
        - name: data
          schema:
            $ref: '#/definitions/EventSubscriptionInput'
          required: true
          in: body
          description: Data containing the callback endpoint to deliver the information
      responses:
        '201':
          description: Subscribed
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /hub/{id}:
    delete:
      operationId: unregisterListener
      summary: Unregister a listener
      description: Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
      tags:
        - events subscription
      parameters:
        - name: id
          type: string
          required: true
          in: path
          description: The id of the registered listener
      responses:
        '204':
          description: Deleted
        '400':
          description: Bad request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method not allowed
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/partyAccountAttributeValueChangeEvent:
    post:
      operationId: listenToPartyAccountAttributeValueChangeEvent
      summary: Client listener for entity PartyAccountAttributeValueChangeEvent
      description: Example of a client listener for receiving the notification PartyAccountAttributeValueChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/PartyAccountAttributeValueChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/partyAccountStateChangeEvent:
    post:
      operationId: listenToPartyAccountStateChangeEvent
      summary: Client listener for entity PartyAccountStateChangeEvent
      description: Example of a client listener for receiving the notification PartyAccountStateChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/PartyAccountStateChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/billingAccountAttributeValueChangeEvent:
    post:
      operationId: listenToBillingAccountAttributeValueChangeEvent
      summary: Client listener for entity BillingAccountAttributeValueChangeEvent
      description: Example of a client listener for receiving the notification BillingAccountAttributeValueChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/BillingAccountAttributeValueChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/billingAccountStateChangeEvent:
    post:
      operationId: listenToBillingAccountStateChangeEvent
      summary: Client listener for entity BillingAccountStateChangeEvent
      description: Example of a client listener for receiving the notification BillingAccountStateChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/BillingAccountStateChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/settlementAccountAttributeValueChangeEvent:
    post:
      operationId: listenToSettlementAccountAttributeValueChangeEvent
      summary: Client listener for entity SettlementAccountAttributeValueChangeEvent
      description: Example of a client listener for receiving the notification SettlementAccountAttributeValueChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/SettlementAccountAttributeValueChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/settlementAccountStateChangeEvent:
    post:
      operationId: listenToSettlementAccountStateChangeEvent
      summary: Client listener for entity SettlementAccountStateChangeEvent
      description: Example of a client listener for receiving the notification SettlementAccountStateChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/SettlementAccountStateChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/financialAccountCreateEvent:
    post:
      operationId: listenToFinancialAccountCreateEvent
      summary: Client listener for entity FinancialAccountCreateEvent
      description: Example of a client listener for receiving the notification FinancialAccountCreateEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/FinancialAccountCreateEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/financialAccountAttributeValueChangeEvent:
    post:
      operationId: listenToFinancialAccountAttributeValueChangeEvent
      summary: Client listener for entity FinancialAccountAttributeValueChangeEvent
      description: Example of a client listener for receiving the notification FinancialAccountAttributeValueChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/FinancialAccountAttributeValueChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/financialAccountStateChangeEvent:
    post:
      operationId: listenToFinancialAccountStateChangeEvent
      summary: Client listener for entity FinancialAccountStateChangeEvent
      description: Example of a client listener for receiving the notification FinancialAccountStateChangeEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/FinancialAccountStateChangeEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /listener/financialAccountDeleteEvent:
    post:
      operationId: listenToFinancialAccountDeleteEvent
      summary: Client listener for entity FinancialAccountDeleteEvent
      description: Example of a client listener for receiving the notification FinancialAccountDeleteEvent
      tags:
        - notification listeners (client side)
      parameters:
        - name: data
          required: true
          in: body
          description: The event data
          schema:
            $ref: '#/definitions/FinancialAccountDeleteEvent'
      responses:
        '201':
          description: Notified
          schema:
            $ref: '#/definitions/EventSubscription'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
securityDefinitions:
  Oauth:
    type: "oauth2"
    tokenUrl: "https://apig-mlbstg1.ooredoo.ps/tmf-api/oauth/token"
    flow: "application"
definitions:
  Account:
    type: object
    description: Generic Account structure used to define commonalities between sub concepts of PartyAccount and Financial Account.
    required:
      - name
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Unique reference of the account
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  AccountBalance:
    type: object
    description: Balances linked to the account
    required:
      - amount
      - balanceType
      - validFor
    properties:
      balanceType:
        type: string
        description: 'Type of the balance : deposit balance, disputed balance, loyalty balance, receivable balance...'
      amount:
        $ref: '#/definitions/Money'
        description: Balance amount
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: Balance validity period
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  AccountRef:
    type: object
    description: Account reference. A account may be a party account or a financial account.
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Reference of the account
      description:
        type: string
        description: Detailed description of the account
      name:
        type: string
        description: Name of the account
      loginname:
        type: string
        description: loginname
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  AccountRelationship:
    type: object
    description: Significant connection between accounts. For instance an aggregating account for a list of shop branches each having its own billing account.
    required:
      - relationshipType
      - validFor
    properties:
      relationshipType:
        type: string
        description: Type of relationship
      account:
        $ref: '#/definitions/AccountRef'
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: Validity period of that relationship
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  AccountTaxExemption:
    type: object
    description: Proof of freedom from taxes imposed by a taxing jurisdiction
    required:
      - issuingJurisdiction
      - validFor
    properties:
      certificateNumber:
        type: string
        description: Identifier of a document that shows proof of exemption from taxes for the taxing jurisdiction
      issuingJurisdiction:
        type: string
        description: Name of the taxing jurisdiction for which taxes are exempt
      reason:
        type: string
        description: Reason of the tax exemption
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: Period for which the exemption is valid
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillFormat:
    type: object
    description: A detailed description of the way in which a bill is presented.
    required:
      - name
    properties:
      id:
        type: string
        description: Unique identifier of the bill format
      href:
        type: string
        description: Reference of the bill format
      description:
        type: string
        description: An explanatory text for this bill format
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillFormat_Create:
    type: object
    description: |-
      A detailed description of the way in which a bill is presented.
      Skipped properties: id,href
    required:
      - name
    properties:
      description:
        type: string
        description: An explanatory text for this bill format
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillFormat_Update:
    type: object
    description: |-
      A detailed description of the way in which a bill is presented.
      Skipped properties: id,href
    required:
      - name
    properties:
      description:
        type: string
        description: An explanatory text for this bill format
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillFormatRef:
    type: object
    description: BillFormat reference. A bill format is a description of the way in which a bill is presented.
    properties:
      id:
        type: string
        description: Unique identifier of the bill format
      href:
        type: string
        description: Reference of the bill format
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  BillFormatRefOrValue:
    type: object
    description: An attachment by value or by reference.
    required:
      - name
      - isRef
    properties:
      id:
        type: string
        description: Unique identifier of the bill format
      href:
        type: string
        description: Reference of the bill format
      description:
        type: string
        description: An explanatory text for this bill format
      isRef:
        default: true
        type: boolean
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
  BillPresentationMedia:
    type: object
    description: A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
    required:
      - name
    properties:
      id:
        type: string
        description: Unique identifier of the bill presentation media
      href:
        type: string
        description: Reference of the bill presentation media
      description:
        type: string
        description: An explanatory text describing this bill presentation media
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillPresentationMedia_Create:
    type: object
    description: |-
      A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
      Skipped properties: id,href
    required:
      - name
    properties:
      description:
        type: string
        description: An explanatory text describing this bill presentation media
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillPresentationMedia_Update:
    type: object
    description: |-
      A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
      Skipped properties: id,href
    required:
      - name
    properties:
      description:
        type: string
        description: An explanatory text describing this bill presentation media
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillPresentationMediaRef:
    type: object
    description: PresentationMedia reference. A mean of communicating a bill, supported by the associated bill format. For example, post mail, email, web page.
    properties:
      id:
        type: string
        description: Unique identifier of the bill presentation media
      href:
        type: string
        description: Reference of the bill presentation media
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  BillPresentationMediaRefOrValue:
    type: object
    description: An attachment by value or by reference.
    required:
      - name
      - isRef
    properties:
      id:
        type: string
        description: Unique identifier of the bill presentation media
      href:
        type: string
        description: Reference of the bill presentation media
      description:
        type: string
        description: An explanatory text describing this bill presentation media
      isRef:
        default: true
        type: boolean
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
  BillStructure:
    type: object
    description: The structure of the bill for party accounts (billing or settlement).
    properties:
      cycleSpecification:
        $ref: '#/definitions/BillingCycleSpecificationRefOrValue'
      format:
        $ref: '#/definitions/BillFormatRefOrValue'
      presentationMedia:
        type: array
        items:
          $ref: '#/definitions/BillPresentationMediaRefOrValue'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingAccount:
    type: object
    description: A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
    required:
      - name
      - relatedParty
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Unique reference of the account
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      firstName:
        type: string
        description: firstName of the account
        
      middleName:
        type: string
        description: middleName of the account
        
      thirdName:
        type: string
        description: thirdName of the account
        
      LastName:
        type: string
        description: LastName of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      
      additionalInformation:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
        description: Describes the characteristic of a Billing account.  
      
      channel:
        type: array
        items:
          $ref: '#/definitions/Channel'
        description: Describes the Channel
        
      IndividualIdentification:
        type: array
        items:
          $ref: '#/definitions/IndividualIdentification'
        description: Describes the Channel
        
      AccountCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
        description: Describes the Channel
        
      tranStatus:
        type: string
        description: tranStatus
        
        
      serviceRequestId:
        type: string
        format: date-time
        description: tranStatus
        
      serviceRequestStatus:
        type: string
        description: serviceRequestStatus
        
      serviceRequestStatusMessage:
        type: string
        description: serviceRequestStatusMessage
        
      operationObjectId:
        type: string
        description: operationObjectId
        
      processInstanceId:
        type: string
        description: processInstanceId
        
        
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingAccount_Create:
    type: object
    description: |-
      A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
      Skipped properties: id,href
    required:
      - name
      - relatedParty
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
        
      firstName:
        type: string
        description: firstName of the account
        
      middleName:
        type: string
        description: middleName of the account
        
      thirdName:
        type: string
        description: thirdName of the account
        
      lastName:
        type: string
        description: LastName of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
          
      
      additionalInformation:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
          
      Channel:
        type: array
        items:
          $ref: '#/definitions/Channel'
      individualIdentification:
        type: array
        items:
          $ref: '#/definitions/IndividualIdentification'
      accountCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
      accountAuthorizedPersonCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'    
      loyaltyAdminCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic' 
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingAccount_Update:
    type: object
    description: |-
      A party account used for billing purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
      Skipped properties: id,href,accountBalance
    required:
      - name
      - relatedParty
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      additionalInformation:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
        description: Describes the characteristic of a Billing account.
      channel:
        type: array
        items:
          $ref: '#/definitions/Channel'
        description: Describes the Channel
        
      individualIdentification:
        type: array
        description: individualIdentification of the related entity. - newField
        items:
          $ref: '#/definitions/IndividualIdentification'
          
      accountCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
        description: Characteristic of the related entity. - newField
        
      accountAuthorizedPersonCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
        description: Characteristic of the related entity. - newField
        
      loyaltyAdminCharacteristic:
        type: array
        items:
          $ref: '#/definitions/Characteristic'
        description: Characteristic of the related entity. - newField
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingCycleSpecification:
    type: object
    description: A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
    required:
      - name
    properties:
      id:
        type: string
        description: Unique identifier of the billing cycle specification
      href:
        type: string
        description: Reference of the billing cycle specification
      billingDateShift:
        type: integer
        description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      billingPeriod:
        type: string
        description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
      chargeDateOffset:
        type: integer
        description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      creditDateOffset:
        type: integer
        description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      description:
        type: string
        description: An explanation regarding this billing cycle specification
      frequency:
        type: string
        description: Frequency of the billing cycle (monthly for instance)
      mailingDateOffset:
        type: integer
        description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      name:
        type: string
        description: A short descriptive name
      paymentDueDateOffset:
        type: integer
        description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period for which the billing specification cycle is valid
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingCycleSpecification_Create:
    type: object
    description: |-
      A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
      Skipped properties: id,href
    required:
      - name
    properties:
      billingDateShift:
        type: integer
        description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      billingPeriod:
        type: string
        description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
      chargeDateOffset:
        type: integer
        description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      creditDateOffset:
        type: integer
        description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      description:
        type: string
        description: An explanation regarding this billing cycle specification
      frequency:
        type: string
        description: Frequency of the billing cycle (monthly for instance)
      mailingDateOffset:
        type: integer
        description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      name:
        type: string
        description: A short descriptive name
      paymentDueDateOffset:
        type: integer
        description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period for which the billing specification cycle is valid
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingCycleSpecification_Update:
    type: object
    description: |-
      A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
      Skipped properties: id,href
    required:
      - name
    properties:
      billingDateShift:
        type: integer
        description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      billingPeriod:
        type: string
        description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
      chargeDateOffset:
        type: integer
        description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      creditDateOffset:
        type: integer
        description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      description:
        type: string
        description: An explanation regarding this billing cycle specification
      frequency:
        type: string
        description: Frequency of the billing cycle (monthly for instance)
      mailingDateOffset:
        type: integer
        description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      name:
        type: string
        description: A short descriptive name
      paymentDueDateOffset:
        type: integer
        description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period for which the billing specification cycle is valid
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  BillingCycleSpecificationRef:
    type: object
    description: BillingCycleSpecification reference. A description of when to initiate a billing cycle and the various sub steps of a billing cycle.
    properties:
      id:
        type: string
        description: Unique identifier of the billing cycle specification
      href:
        type: string
        description: Reference of the billing cycle specification
      dateShift:
        type: integer
        description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      frequency:
        type: string
        description: Frequency of the billing cycle (monthly for instance)
      name:
        type: string
        description: A short descriptive name
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  BillingCycleSpecificationRefOrValue:
    type: object
    description: An attachment by value or by reference.
    required:
      - name
      - isRef
    properties:
      id:
        type: string
        description: Unique identifier of the billing cycle specification
      href:
        type: string
        description: Reference of the billing cycle specification
      billingDateShift:
        type: integer
        description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      billingPeriod:
        type: string
        description: 'A billing time period. It can be recurring, for example: week, month, quarter of year, year .'
      chargeDateOffset:
        type: integer
        description: An offset of a date through which charges previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      creditDateOffset:
        type: integer
        description: An offset of a date through which credits previously received by the billing system will appear on the bill. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      dateShift:
        type: integer
        description: An offset of a billing/settlement date. The offset is expressed as number of days with regard to the start of the billing/settlement period.
      description:
        type: string
        description: An explanation regarding this billing cycle specification
      frequency:
        type: string
        description: Frequency of the billing cycle (monthly for instance)
      isRef:
        default: true
        type: boolean
      mailingDateOffset:
        type: integer
        description: An offset of a customer bill mailing date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      name:
        type: string
        description: A short descriptive name
      paymentDueDateOffset:
        type: integer
        description: An offset of a payment due date. The offset is expressed as number of days with regard to the start of the BillingPeriod.
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period for which the billing specification cycle is valid
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
  Contact:
    type: object
    description: An individual or an organization used as a contact point for a given account and accessed via some contact medium.
    required:
      - contactType
      - validFor
    properties:
      contactName:
        type: string
        description: A displayable name for that contact
      contactType:
        type: string
        description: Type of contact (primary, secondary...)
      partyRoleType:
        type: string
        description: Identifies what kind of party role type is linked to the contact (a account manager...)
      contactMedium:
        type: array
        items:
          $ref: '#/definitions/ContactMedium'
      relatedParty:
        $ref: '#/definitions/RelatedParty'
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: Validity period of that contact
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  ContactMedium:
    type: object
    description: Indicates the contact medium that could be used to contact the party.
    properties:
      mediumType:
        type: string
        description: 'Type of the contact medium, such as: email address, telephone number, postal address'
      preferred:
        type: boolean
        description: If true, indicates that is the preferred contact medium
      characteristic:
        $ref: '#/definitions/MediumCharacteristic'
        description: Any additional characteristic(s) of this contact medium
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The time period that the contact medium is valid for
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
        
  Any: {}
  Characteristic:
    type: object
    description: Describes a given characteristic of an object or entity through a name/value pair.
    required:
      - name
      - value
    properties:
      name:
        type: string
        description: Name of the characteristic
      valueType:
        type: string
        description: Data type of the value of the characteristic
      value:
        $ref: '#/definitions/Any'
        description: The value of the characteristic
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name 
    
    
  EntityRef:
    type: object
    description: Entity reference schema to be use for all entityRef class.
    properties:
      id:
        type: string
        description: Unique identifier of a related entity.
      href:
        type: string
        description: Reference of the related entity.
      name:
        type: string
        description: Name of the related entity.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  FinancialAccount:
    type: object
    description: An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.
    required:
      - name
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Unique reference of the account
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  FinancialAccount_Create:
    type: object
    description: |-
      An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.
      Skipped properties: id,href
    required:
      - name
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  FinancialAccount_Update:
    type: object
    description: |-
      An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. A financial (account receivable account/account payable) aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. It is a specialization of entity Account.
      Skipped properties: id,href,lastModified
    required:
      - name
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      name:
        type: string
        description: Name of the account
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  FinancialAccountRef:
    type: object
    description: AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party.
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Unique reference of the account
      name:
        type: string
        description: Name of the account
      loginName:
        type: string
        description: loginName
      churnRate:
        type: string
        description: churnRate
      newARPU:
        type: string
        description: newARPU
      accountBalance:
        $ref: '#/definitions/AccountBalance'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  MediumCharacteristic:
    type: object
    description: Describes the contact medium characteristics that could be used to contact a party (an individual or an organization)
    properties:
      city:
        type: string
        description: The city
      contactType:
        type: string
        description: 'The type of contact, for example: phone number such as mobile, fixed home, fixed office. postal address such as shipping instalation…'
      country:
        type: string
        description: The country
      emailAddress:
        type: string
        description: Full email address in standard format
      faxNumber:
        type: string
        description: The fax number of the contact
      phoneNumber:
        type: string
        description: The primary phone number of the contact
      postCode:
        type: string
        description: Postcode
      socialNetworkId:
        type: string
        description: Identifier as a member of a social network
      stateOrProvince:
        type: string
        description: State or province
      street1:
        type: string
        description: Describes the street
      street2:
        type: string
        description: Complementary street description
      additionalAddress1:
        type: string
        description: Complementary additionalAddress1 description  
        
      additionalAddress2:
        type: string
        description: Complementary additionalAddress2 description
        
      buildingNumber:
        type: string
        description: building
        
      region:
        type: string
        description: region
        
      apartmentNumber:
        type: string
        description: apartmentNumber
      
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  Money:
    type: object
    description: A base / value business entity used to represent money
    properties:
      unit:
        type: string
        description: Currency (ISO4217 norm uses 3 letters to define the currency)
      value:
        type: number
        format: float
        description: A positive floating point number
  PartyAccount:
    type: object
    description: Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.
    required:
      - name
      - relatedParty
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Unique reference of the account
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  PartyAccount_Create:
    type: object
    description: |-
      Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.
      Skipped properties: id,href
    required:
      - name
      - relatedParty
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  PartyAccount_Update:
    type: object
    description: |-
      Account used for billing or for settlement purposes concerning a given party (an organization or an individual). It is a specialization of entity Account.
      Skipped properties: id,href,accountBalance
    required:
      - name
      - relatedParty
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  PaymentMethodRef:
    type: object
    description: PaymentMethod reference. A payment method defines a specific mean of payment (e.g direct debit).
    properties:
      id:
        type: string
        description: Unique identifier of the payment mean
      href:
        type: string
        description: Reference of the payment mean
      name:
        type: string
        description: Name of the payment mean
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
      - id
  PaymentPlan:
    type: object
    description: Defines a plan for payment (when a party wants to spread his payments)
    properties:
      numberOfPayments:
        type: integer
        description: Number of payments used to spread the global payment
      paymentFrequency:
        type: string
        description: Frequency of the payments, such as monthly and bimonthly
      planType:
        type: string
        description: Type of payment plan
      priority:
        type: integer
        description: Priority of the payment plan
      status:
        type: string
        description: Status of the payment plan (effective, ineffective)
      paymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      totalAmount:
        $ref: '#/definitions/Money'
        description: Amount paid
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: Validity period of the payment plan
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  RelatedParty:
    type: object
    description: Related Entity reference. A related party defines party or party role linked to a specific entity.
    required:
      - '@referredType'
      - id
      - name
    properties:
      id:
        type: string
        description: Unique identifier of a related entity.
      href:
        type: string
        description: Reference of the related entity.
      name:
        type: string
        description: Name of the related entity.
        
      middleName:
        type: string
        description: Name of the related entity.
        
      thirdName:
        type: string
        description: Name of the related entity.
        
      lastName:
        type: string
        description: Name of the related entity.
      role:
        type: string
        description: Role played by the related party
        
      
          
    
      
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
  SettlementAccount:
    type: object
    description: A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
    required:
      - name
      - relatedParty
    properties:
      id:
        type: string
        description: Unique identifier of the account
      href:
        type: string
        description: Unique reference of the account
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  SettlementAccount_Create:
    type: object
    description: |-
      A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
      Skipped properties: id,href
    required:
      - name
      - relatedParty
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountBalance:
        type: array
        items:
          $ref: '#/definitions/AccountBalance'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  SettlementAccount_Update:
    type: object
    description: |-
      A party account used for settlement purposes. It includes a description of the bill structure (frequency, presentation media, format and so on). It is a specialization of entity PartyAccount.
      Skipped properties: id,href,accountBalance
    required:
      - name
      - relatedParty
    properties:
      accountType:
        type: string
        description: 'A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values.'
      description:
        type: string
        description: Detailed description of the party account
      lastModified:
        type: string
        format: date-time
        description: Date of last modification of the account
      name:
        type: string
        description: Name of the account
      paymentStatus:
        type: string
        description: The condition of the account, such as due, paid, in arrears.
      state:
        type: string
        description: 'Contains the lifecycle state such as: Active, Closed, Suspended and so on.'
      accountRelationship:
        type: array
        items:
          $ref: '#/definitions/AccountRelationship'
      billStructure:
        $ref: '#/definitions/BillStructure'
      contact:
        type: array
        items:
          $ref: '#/definitions/Contact'
      creditLimit:
        $ref: '#/definitions/Money'
        description: The maximum amount of money that may be charged on an account
      defaultPaymentMethod:
        $ref: '#/definitions/PaymentMethodRef'
      financialAccount:
        $ref: '#/definitions/FinancialAccountRef'
      paymentPlan:
        type: array
        items:
          $ref: '#/definitions/PaymentPlan'
      relatedParty:
        type: array
        items:
          $ref: '#/definitions/RelatedParty'
        minItems: 1
      taxExemption:
        type: array
        items:
          $ref: '#/definitions/AccountTaxExemption'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
  TimePeriod:
    type: object
    description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
    properties:
      endDateTime:
        type: string
        format: date-time
        description: End of the time period, using IETC-RFC-3339 format
      startDateTime:
        type: string
        format: date-time
        description: Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end
  EventSubscription:
    type: object
    description: Sets the communication endpoint address the service instance must use to deliver notification information
    required:
      - id
      - callback
    properties:
      id:
        type: string
        description: Id of the listener
      callback:
        type: string
        description: The callback being registered.
      query:
        type: string
        description: additional data to be passed
  EventSubscriptionInput:
    type: object
    description: Sets the communication endpoint address the service instance must use to deliver notification information
    required:
      - callback
    properties:
      callback:
        type: string
        description: The callback being registered.
      query:
        type: string
        description: additional data to be passed
  PartyAccountAttributeValueChangeEvent:
    type: object
    description: The notification data structure
    properties:
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      fieldPath:
        type: string
        description: The path identifying the object field concerned by this notification.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/PartyAccountAttributeValueChangeEventPayload'
  PartyAccountAttributeValueChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      partyAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/PartyAccount'
  PartyAccountStateChangeEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/PartyAccountStateChangeEventPayload'
  PartyAccountStateChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      partyAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/PartyAccount'
  BillingAccountAttributeValueChangeEvent:
    type: object
    description: The notification data structure
    properties:
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      fieldPath:
        type: string
        description: The path identifying the object field concerned by this notification.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/BillingAccountAttributeValueChangeEventPayload'
  BillingAccountAttributeValueChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      billingAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/BillingAccount'
  BillingAccountStateChangeEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/BillingAccountStateChangeEventPayload'
  BillingAccountStateChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      billingAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/BillingAccount'
  SettlementAccountAttributeValueChangeEvent:
    type: object
    description: The notification data structure
    properties:
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      fieldPath:
        type: string
        description: The path identifying the object field concerned by this notification.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/SettlementAccountAttributeValueChangeEventPayload'
  SettlementAccountAttributeValueChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      settlementAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/SettlementAccount'
  SettlementAccountStateChangeEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/SettlementAccountStateChangeEventPayload'
  SettlementAccountStateChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      settlementAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/SettlementAccount'
  FinancialAccountCreateEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/FinancialAccountCreateEventPayload'
  FinancialAccountCreateEventPayload:
    type: object
    description: The event data structure
    properties:
      financialAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/FinancialAccount'
  FinancialAccountAttributeValueChangeEvent:
    type: object
    description: The notification data structure
    properties:
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      fieldPath:
        type: string
        description: The path identifying the object field concerned by this notification.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/FinancialAccountAttributeValueChangeEventPayload'
  FinancialAccountAttributeValueChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      financialAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/FinancialAccount'
  FinancialAccountStateChangeEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/FinancialAccountStateChangeEventPayload'
  FinancialAccountStateChangeEventPayload:
    type: object
    description: The event data structure
    properties:
      financialAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/FinancialAccount'
  FinancialAccountDeleteEvent:
    type: object
    description: The notification data structure
    properties:
      id:
        type: string
        description: Identifier of the Process flow
      href:
        type: string
        description: Reference of the ProcessFlow
      eventId:
        type: string
        description: The identifier of the notification.
      eventTime:
        type: string
        format: date-time
        description: Time of the event occurrence.
      eventType:
        type: string
        description: The type of the notification.
      correlationId:
        type: string
        description: The correlation id for this event.
      domain:
        type: string
        description: The domain of the event.
      title:
        type: string
        description: The title of the event.
      description:
        type: string
        description: An explnatory of the event.
      priority:
        type: string
        description: A priority.
      timeOcurred:
        type: string
        format: date-time
        description: The time the event occured.
      payload:
        description: The event payload linked to the involved resource object
        $ref: '#/definitions/FinancialAccountDeleteEventPayload'
  FinancialAccountDeleteEventPayload:
    type: object
    description: The event data structure
    properties:
      financialAccount:
        description: The involved resource data for the event
        $ref: '#/definitions/FinancialAccount'
        
  Channel:
    type: object
    description: Related channel to another entity. May be online web, mobile app, social ,etc.
    required:
      - id
    properties:
      id:
        type: string
        description: Unique identifier of a related entity.
      href:
        type: string
        description: Reference of the related entity.
      name:
        type: string
        description: Name of the channel.
      description:
        type: string
        description: description.
      wscAccess:
        type: string
        description: NewBlockWSCAccess.
    
      role:
        type: string
        description: Role playing by the channel.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
        
  Quantity:
    type: object
    description: An amount in a given unit
    properties:
      amount:
        default: 1
        type: number
        format: float
        description: Numeric value in a given unit
      units:
        type: string
        description: Unit
        
  AttachmentRefOrValue:
    type: object
    description: >-
      An attachment by value or by reference. An attachment complements the
      description of an element, for example through a document, a video, a
      picture.
    properties:
      id:
        type: string
        description: Unique identifier for this particular attachment
      href:
        type: string
        description: URI for this Attachment
      attachmentType:
        type: string
        description: Attachment type such as video, picture
      content:
        type: string
        description: >-
          The actual contents of the attachment object, if embedded, encoded as
          base64
      description:
        type: string
        description: A narrative text describing the content of the attachment
      mimeType:
        type: string
        description: >-
          Attachment mime type such as extension file for video, picture and
          document
      name:
        type: string
        description: The name of the attachment
      url:
        type: string
        description: Uniform Resource Locator, is a web page address (a subset of URI)
      size:
        $ref: '#/definitions/Quantity'
        description: The size of the attachment.
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period of time for which the attachment is valid
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        description: >-
          A URI to a JSON-Schema file that defines additional attributes and
          relationships
        format: uri
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
        
  IndividualIdentification:
    type: object
    description: >-
      Represents our registration of information used as proof of identity by an
      individual (passport, national identity card, drivers license, social
      security number, birth certificate)
   
    properties:
      identificationId:
        type: string
        description: Identifier
      identificationType:
        type: string
        description: >-
          Identification type (passport, national identity card, drivers
          license, social security number, birth certificate)
      issuingAuthority:
        type: string
        description: >-
          Authority which has issued the identifier, such as: social security,
          town hall
      issuingDate:
        type: string
        format: date-time
        description: Date at which the identifier was issued
      attachment:
        $ref: '#/definitions/AttachmentRefOrValue'
      validFor:
        $ref: '#/definitions/TimePeriod'
        description: The period for which the identification information is valid.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        description: >-
          A URI to a JSON-Schema file that defines additional attributes and
          relationships
        format: uri
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name
        
   
  Error:
    description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
    type: object
    required:
      - code
      - reason
    properties:
      code:
        type: string
        description: Application relevant detail, defined in the API or a common list.
      reason:
        type: string
        description: Explanation of the reason for the error which can be shown to a client user.
      message:
        type: string
        description: More details and corrective actions related to the error which can be shown to a client user.
      status:
        type: string
        description: HTTP Error code extension
      referenceError:
        type: string
        format: uri
        description: URI of documentation describing the error.
      techCode:
        type: string
        format: uri
        description: techCode.
      techDetails:
        type: string
        format: uri
        description: techDetails.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class.
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name.