TUI Group Organizations2 API

openapi: 3.2.0
info:
  title: NewSkies-Digital-Api Organizations2 API
  version: 4.8.6.23
  description: Navitaire Digital Api
servers:
- url: https://prod.api.tui/flight/newskies/rest
  description: TUI Prod
- url: https://playground.api.tui/flight/newskies/rest
  description: TUI Playground
security:
- JWT: []
tags:
- name: organizations2
paths:
  /api/nsk/v1/organizations2:
    post:
      tags:
      - organizations2
      summary: Create a new organization.
      description: 'Requires agent permissions.

        The organization code is a generic code for all of the organization types. Each individual type has its own code

        and validation.

        If the organization status is not pending the organization code should follow these validation rules based on type:

        Third Party: 3 to 10 characters in length with alphanumeric values.

        Travel Agency: 7 to 10 characters in length with numeric values.

        Carrier: 2 to 3 characters in length with alphanumeric values.

        If no organization code is provided then one will be generated and returned on the header.


        GraphQL endpoint: organizationAdd'
      operationId: nsk_v1_organizations2_post
      requestBody:
        x-name: createRequest
        description: The request for creating the new organization.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationCreateRequest'
        required: true
        x-position: 1
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v2/organizations2:
    get:
      tags:
      - organizations2
      summary: Searches for organizations.
      description: 'GraphQL endpoint: organizations2v2'
      operationId: nsk_v2_organizations2_get
      parameters:
      - name: OrganizationCode
        in: query
        description: "The organization code.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 10
          minLength: 2
        x-position: 1
      - name: Type
        in: query
        description: "Organization type.\n             \nEnumeration values: 0 = Default, 1 = Master, 2 = Carrier, 3 = TravelAgency, 4 = ThirdParty"
        schema:
          $ref: '#/components/schemas/OrganizationType'
        x-position: 2
      - name: Status
        in: query
        description: "The organization status.\n             \nEnumeration values: 0 = Default, 1 = Active, 2 = Cancelled, 3 = Pending"
        schema:
          $ref: '#/components/schemas/OrganizationStatus'
        x-position: 3
      - name: ParentOrganizationCode
        in: query
        description: "The parent organization code.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 10
          minLength: 2
        x-position: 4
      - name: CompanyName
        in: query
        description: "The organization company name.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 5
      - name: City
        in: query
        description: "The organization company city.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 32
          minLength: 0
        x-position: 6
      - name: PostalCode
        in: query
        description: "The organization company postal code.\n            "
        schema:
          type:
          - string
          - 'null'
          maxLength: 10
          minLength: 0
        x-position: 7
      - name: PagedItemIndex
        in: query
        description: "Used to specify the index for skipping values when paging.\n            "
        schema:
          type:
          - integer
          - 'null'
          format: int64
          maximum: 9.223372036854776e+18
          minimum: 1.0
        x-position: 8
      - name: PageSize
        in: query
        description: "Used to specify the maximum results to return.\n            "
        schema:
          type:
          - integer
          - 'null'
          maximum: 5000.0
          minimum: 1.0
        x-position: 9
      - name: MatchCriteria.OrganizationCode
        in: query
        description: "The type of string search for organization code.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 10
      - name: MatchCriteria.ParentOrganizationCode
        in: query
        description: "The  type of string search for parent organization code.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 11
      - name: MatchCriteria.CompanyName
        in: query
        description: "The  type of string search for organization company name.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 12
      - name: MatchCriteria.City
        in: query
        description: "The  type of string search for organization company city.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 13
      - name: MatchCriteria.PostalCode
        in: query
        description: "The  type of string search for organization company postal code.\n             \nEnumeration values: 0 = StartsWith, 1 = EndsWith, 2 = Contains, 3 = ExactMatch"
        schema:
          $ref: '#/components/schemas/MatchCriteria'
        x-position: 14
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfOrganizationRecord'
  /api/nsk/v1/organizations2/{organizationCode}:
    get:
      tags:
      - organizations2
      summary: Retrieves the organization.
      description: 'GraphQL endpoint: organization2'
      operationId: nsk_v1_organizations2_organizationCode_get
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The identifier of the organization to update.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfOrganizationv2'
    put:
      tags:
      - organizations2
      summary: Updates an organization.
      description: 'Requires agent permissions.

        The organization code is a generic code for all of the organization types. Each individual type has its own code

        and validation.

        If the organization status is not pending the organization code should follow these validation rules based on type:

        Third Party: 3 to 10 characters in length with alphanumeric values.

        Travel Agency: 7 to 10 characters in length with numeric values.

        Carrier: 2 to 3 characters in length with alphanumeric values.


        GraphQL endpoint: organizationSet'
      operationId: nsk_v1_organizations2_organizationCode_put
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The identifier for the organization to be updated.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The request for the update.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationEditRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    patch:
      tags:
      - organizations2
      summary: Updates an organization.
      description: 'Requires agent permissions.

        The organization code is a generic code for all of the organization types. Each individual type has its own code

        and validation.

        If the organization status is not pending the organization code should follow these validation rules based on type:

        Third Party: 3 to 10 characters in length with alphanumeric values.

        Travel Agency: 7 to 10 characters in length with numeric values.

        Carrier: 2 to 3 characters in length with alphanumeric values.


        GraphQL endpoint: organizationModify'
      operationId: nsk_v1_organizations2_organizationCode_patch
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The identifier of the organization to update.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: createRequest
        description: The request containing the updates for the organization.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeltaMapperOfOrganizationEditRequest'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/organizations2/{organizationCode}/account:
    get:
      tags:
      - organizations2
      summary: Retrieves the organization account and collections based on the organization code.
      description: 'GraphQL endpoint: organizations2Account'
      operationId: nsk_v1_organizations2_organizationCode_account_get
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      responses:
        '404':
          description: The item was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfOrganizationAccount'
    post:
      tags:
      - organizations2
      summary: Creates an organization account based on the organization code.
      description: 'GraphQL endpoint: organizations2AccountAdd'
      operationId: nsk_v1_organizations2_organizationCode_account_post
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The create organization account request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrganizationAccountRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/organizations2/{organizationCode}/account/childAccountTransactions:
    post:
      tags:
      - organizations2
      summary: Adjust the available amount of a child account.
      description: 'The known list of parent-child relations are as follows:

        - Dependent accounts are not supported.

        - A parent''s account of type credit may have children of type supplemental or credit.

        - A parent''s account of type prepaid may have children of type prepaid.

        - No other combination of parent-child relations are supported.


        GraphQL endpoint: childAccountTransactionsAdd'
      operationId: nsk_v1_organizations2_organizationCode_account_childAccountTransactions_post
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The account reference number for the child organization.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The child account transaction request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChildAccountTransactionsRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    put:
      tags:
      - organizations2
      summary: Adjust the credit limit of a child account.
      description: 'The known list of parent-child relations are as follows:

        - Dependent accounts are not supported.

        - A parent''s account of type credit may have children of type supplemental or credit.

        - A parent''s account of type prepaid may have children of type prepaid.

        - No other combination of parent-child relations are supported.


        GraphQL endpoint: childAccountTransactionsSet'
      operationId: nsk_v1_organizations2_organizationCode_account_childAccountTransactions_put
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The account reference number for the child organization.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The child account transaction request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChildAccountTransactionsRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/organizations2/{organizationCode}/account/status:
    put:
      tags:
      - organizations2
      summary: Updates the organization account status.
      description: 'GraphQL endpoint: organizations2AccountStatusSet'
      operationId: nsk_v1_organizations2_organizationCode_account_status_put
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      - name: status
        in: query
        description: "The allowed account status. \nEnumeration values: 0 = Open, 1 = Closed, 2 = AgencyInactive, 3 = Unknown"
        schema:
          $ref: '#/components/schemas/AccountStatus'
        x-position: 2
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '500':
          description: A server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v1/organizations2/{organizationCode}/account/transactions:
    get:
      tags:
      - organizations2
      summary: 'Retrieves the organization account transactions based on the organization code

        and data in the request.'
      description: 'GraphQL endpoint: organizations2Transactions'
      operationId: nsk_v1_organizations2_organizationCode_account_transactions_get
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      - name: StartTime
        in: query
        description: "The starting date and time of the date range to search in.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 2
      - name: EndTime
        in: query
        description: "The end date and time of the date range to search in.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 3
      - name: SortByNewest
        in: query
        description: "Optional filter to sort results by newest.\n            "
        schema:
          type: boolean
        x-position: 4
      - name: PageSize
        in: query
        description: "Used to specify the number of records to return.\n            "
        schema:
          type:
          - integer
          - 'null'
          maximum: 5000.0
          minimum: 10.0
        x-position: 5
      - name: PageIndex
        in: query
        description: "Represents the index of the requested paged item.\n            "
        schema:
          type:
          - integer
          - 'null'
          format: int64
        x-position: 6
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfTransaction'
              examples:
                Retrieve Transactions Response:
                  description: Example response for retrieving transactions.
                  value:
                    data:
                    - accountTransactionCode: null
                      recordLocator: null
                      accountReference: null
                      transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ
                      amount: -2.42
                      createdDate: '2026-07-09T05:55:16.3583433Z'
                      currencyCode: USD
                      foreignAmount: -15.0
                      note: 'Funds Used: PNR123'
                      foreignCurrencyCode: CNY
                      type: 0
                      paymentId: 365423
                      accountCollectionKey: MSex
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Empty Start Date:
                  description: Example response when start date field is empty.
                  value:
                    errors:
                    - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b
                      code: TransactionSearchRequestv2.StartDate:RequiredAttribute
                      message: TransactionSearchRequestv2.StartDate:RequiredAttribute
                      type: Validation
                      details:
                        validation: RequiredAttribute
                        model: TransactionSearchRequestv2
                        member: StartDate
                      rawMessage: The TransactionSearchRequestv2 field is required.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                End Date Before Start Date:
                  description: Example response when end date is before start date.
                  value:
                    errors:
                    - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87
                      code: nsk:Validation:EndDateBeforeStartDate
                      message: nsk:Validation:EndDateBeforeStartDate
                      type: Validation
                      details: null
                      rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
      deprecated: true
    post:
      tags:
      - organizations2
      summary: 'Creates account transactions based on data in the request and the

        organization code.'
      description: 'GraphQL endpoint: organizations2TransactionsAdd'
      operationId: nsk_v1_organizations2_organizationCode_account_transactions_post
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The transaction request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationTransactionRequest'
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
  /api/nsk/v2/organizations2/{organizationCode}/account/transactions:
    get:
      tags:
      - organizations2
      summary: Retrieves the organization account transactions based on the organization code and data in the request.
      description: 'GraphQL endpoint: organizations2Transactionsv2'
      operationId: nsk_v2_organizations2_organizationCode_account_transactions_get
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      - name: StartDate
        in: query
        description: "The starting date and time of the date range to search in.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 2
      - name: EndDate
        in: query
        description: "The end date and time of the date range to search in.\n            "
        schema:
          type:
          - string
          - 'null'
          format: date-time
        x-position: 3
      - name: SortByNewest
        in: query
        description: "Optional filter to sort results by newest.\n            "
        schema:
          type: boolean
        x-position: 4
      - name: PageSize
        in: query
        description: "Used to specify the number of records to return.\n            "
        schema:
          type:
          - integer
          - 'null'
          maximum: 5000.0
          minimum: 10.0
        x-position: 5
      - name: LastPageKey
        in: query
        description: "The last page key where to start paged query.\n            "
        schema:
          type:
          - string
          - 'null'
        x-position: 6
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfPagedTransactionResponse'
              examples:
                Retrieve Transactions Successful:
                  description: Example response for a successful retrieval of transactions.
                  value:
                    data:
                      totalCount: 11085
                      lastPageKey: MTAw
                      transactions:
                      - accountTransactionCode: null
                        recordLocator: null
                        accountReference: null
                        transactionKey: MSExITEwMjA4OCJsJNQxATUzMyEhUURRNUZ
                        amount: -2.42
                        createdDate: '2026-07-09T05:55:16.388568Z'
                        currencyCode: USD
                        foreignAmount: -15.0
                        note: 'Funds Used: PNR123'
                        foreignCurrencyCode: CNY
                        type: 0
                        paymentId: 365423
                        accountCollectionKey: MSex
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Empty Start Date:
                  description: Example response when start date field is empty.
                  value:
                    errors:
                    - id: 154b85c0-1119-42c2-895c-1aa09ec3a85b
                      code: TransactionSearchRequestv2.StartDate:RequiredAttribute
                      message: TransactionSearchRequestv2.StartDate:RequiredAttribute
                      type: Validation
                      details:
                        validation: RequiredAttribute
                        model: TransactionSearchRequestv2
                        member: StartDate
                      rawMessage: The TransactionSearchRequestv2 field is required.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                End Date Before Start Date:
                  description: Example response when end date is before start date.
                  value:
                    errors:
                    - id: 4e33c648-abec-fa59-0877-5e0bfee7ea87
                      code: nsk:Validation:EndDateBeforeStartDate
                      message: nsk:Validation:EndDateBeforeStartDate
                      type: Validation
                      details: null
                      rawMessage: The requested end date of 1/1/2011 occurs before the requested start date of 1/1/2012.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
        '404':
          description: End of paged results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                End of paged results:
                  description: 404 no content can be returned when there is no data or all data is filtered out such as when there is no more paged results.
                  value:
                    data: null
  /api/nsk/v1/organizations2/{organizationCode}/allotments/contracts:
    get:
      tags:
      - organizations2
      summary: Retrieves all allotment contracts for the specified organization.
      description: 'GraphQL endpoint: allotmentContracts'
      operationId: nsk_v1_organizations2_organizationCode_allotments_contracts_get
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK. Request completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentContractResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
    post:
      tags:
      - organizations2
      summary: Creates the specified allotment contract.
      description: 'GraphQL endpoint: allotmentContractAdd'
      operationId: nsk_v1_organizations2_organizationCode_allotments_contracts_post
      parameters:
      - name: organizationCode
        in: path
        required: true
        description: The organization code.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: request
        description: The allotment contract to create.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AllotmentContractRequest'
            examples:
              Allotment contract request:
                description: Updates the current user's password with the new provided one.
                value:
                  contractCode: ABC
                  description: Travel agency contract
                  status: 1
                  discontinueDate: '2026-07-09T05:55:16.1780894Z'
                  contractProperties:
                  - contractPropertyCode: ABC
                    value: Test
        required: true
        x-position: 2
      responses:
        '201':
          description: The item was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
        '400':
          description: There was a problem with the request and it could not be completed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IJsonResponse'
              examples:
                Error response for no request.:
                  description: Only returns raw message in debug mode.
                  value:
                    errors:
                    - id: null
                      code: core:Validation:RequiredArgument
                      message: null
                      type: Error
                      details: null
                      rawMessage: The request is missing a required argument expected in the request.
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.
                    data: null
                Error response for when that status is default (0).:
                  description: Only returns raw message in debug mode.
                  value:
                    errors:
                    - id: null
                      code: nsk-server:AllotmentContractStatusInvalid
                      message: null
                      type: Error
                      details: null
                      rawMessage: '''Default'' is not a valid status for a Contract.'
                      exception: null
                      debugMode: The API is currently running in debug mode. In production the 'rawMessage' and 'exception' nodes will not be returned. These are for troubleshooting development issues only.


# --- truncated at 32 KB (192 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tui-group/refs/heads/main/openapi/tui-group-organizations2-api-openapi.yml