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. data: null /api/nsk/v1/organizations2/{organizationCode}/allotments/contracts/{contractCode}: put: tags: - organizations2 summary: Updates the specified allotment contract. description: 'GraphQL endpoint: allotmentContractSet' operationId: nsk_v1_organizations2_organizationCode_allotments_contracts_contractCode_put parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 2 requestBody: x-name: request description: The allotment contract to create. content: application/json: schema: $ref: '#/components/schemas/AllotmentContractUpdateRequest' 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.1807784Z' contractProperties: - contractPropertyCode: ABC value: Test required: true x-position: 3 responses: '200': description: OK. Request completed 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. data: null /api/nsk/v1/organizations2/{organizationCode}/commissionRates: post: tags: - organizations2 summary: Create a commission rate. description: 'GraphQL endpoint: organizationCommissionRateAdd' operationId: nsk_v1_organizations2_organizationCode_commissionRates_post parameters: - name: organizationCode in: path required: true description: The organization group code to create a commission rate for. schema: type: string x-position: 1 requestBody: x-name: request description: The organization commission rate request. content: application/json: schema: $ref: '#/components/schemas/OrganizationCommissionRate' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/commissionRates/{commissionRateCode}: get: tags: - organizations2 summary: Get a commission rate. description: Get a commission rate. operationId: nsk_v1_organizations2_organizationCode_commissionRates_commissionRateCode_get parameters: - name: organizationCode in: path required: true description: The organization group code to retrieve commission rates for. schema: type: string x-position: 1 - name: commissionRateCode in: path required: true description: The commission rate code to retrieve. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationCommissionRate' delete: tags: - organizations2 summary: Delete a commission rate. description: 'GraphQL endpoint: organizationCommissionRateDelete' operationId: nsk_v1_organizations2_organizationCode_commissionRates_commissionRateCode_delete parameters: - name: organizationCode in: path required: true description: The organization group code to delete commission rates for. schema: type: string x-position: 1 - name: commissionRateCode in: path required: true description: The commission rate code to delete. schema: type: string x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/company/phoneNumbers: post: tags: - organizations2 summary: Create a company phone number. description: 'GraphQL endpoint: organizationCompanyPhoneAdd' operationId: nsk_v1_organizations2_organizationCode_company_phoneNumbers_post parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the phone number. schema: type: string x-position: 1 requestBody: x-name: request description: The data to update. content: application/json: schema: $ref: '#/components/schemas/PhoneNumber' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/company/phoneNumbers/{phoneNumberType}: put: tags: - organizations2 summary: Updates a company phone number. description: 'GraphQL endpoint: organizationCompanyPhoneSet' operationId: nsk_v1_organizations2_organizationCode_company_phoneNumbers_phoneNumberType_put parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the phone number. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type of the phone number to update. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 requestBody: x-name: request description: The data to update. content: application/json: schema: $ref: '#/components/schemas/PhoneNumberBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - organizations2 summary: Deletes a company phone number. description: 'GraphQL endpoint: organizationCompanyPhoneDelete' operationId: nsk_v1_organizations2_organizationCode_company_phoneNumbers_phoneNumberType_delete parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the phone number. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The phone number type of the phone number to delete. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/contact/phoneNumbers: post: tags: - organizations2 summary: Create a contact phone number. description: 'GraphQL endpoint: organizationContactPhoneAdd' operationId: nsk_v1_organizations2_organizationCode_contact_phoneNumbers_post parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the contact. schema: type: string x-position: 1 requestBody: x-name: request description: The request for the update. content: application/json: schema: $ref: '#/components/schemas/PhoneNumber' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/contact/phoneNumbers/{phoneNumberType}: put: tags: - organizations2 summary: Updates a contact phone number. description: 'GraphQL endpoint: organizationContactPhoneSet' operationId: nsk_v1_organizations2_organizationCode_contact_phoneNumbers_phoneNumberType_put parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the contact. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The type of the phone number being updated. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 requestBody: x-name: request description: The request for updating the phone number. content: application/json: schema: $ref: '#/components/schemas/PhoneNumberBase' required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - organizations2 summary: Deletes a contact phone number. description: 'GraphQL endpoint: organizationContactPhoneDelete' operationId: nsk_v1_organizations2_organizationCode_contact_phoneNumbers_phoneNumberType_delete parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the contact. schema: type: string x-position: 1 - name: phoneNumberType in: path required: true description: "The type of the phone number being deleted. \nEnumeration values: 0 = Other, 1 = Home, 2 = Work, 3 = Mobile, 4 = Fax" schema: $ref: '#/components/schemas/PhoneNumberType' x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/externalAccounts: post: tags: - organizations2 summary: Create an external account. description: 'GraphQL endpoint: organizationExternalAccountAdd' operationId: nsk_v1_organizations2_organizationCode_externalAccounts_post parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the account. schema: type: string x-position: 1 requestBody: x-name: request description: The request containing the information for the account. content: application/json: schema: $ref: '#/components/schemas/OrganizationExternalAccountRequest' required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/externalAccounts/{externalAccountKey}: get: tags: - organizations2 summary: Get an external account. description: Get an external account. operationId: nsk_v1_organizations2_organizationCode_externalAccounts_externalAccountKey_get parameters: - name: organizationCode in: path required: true description: The organization code for the organization that owns the account. schema: type: string x-position: 1 - name: externalAccountKey in: path required: true description: The particular external account desired. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfOrganizationExternalAccountv2' delete: tags: - organizations2 summary: Delete an external account. description: 'GraphQL endpoint: organizationExternalAccountDelete' operationId: nsk_v1_organizations2_organizationCode_externalAccounts_externalAccountKey_delete parameters: - name: organizationCode in: path required: true description: The organization that owns the account to delete. schema: type: string x-position: 1 - name: externalAccountKey in: path required: true description: The particular account to delete. schema: type: string x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/processSchedules: get: tags: - organizations2 summary: Returns a list of Process Schedules for the organization. description: 'GraphQL endpoint: organizationProcessScheduleGetAll' operationId: nsk_v1_organizations2_organizationCode_processSchedules_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/IJsonResponseOfIListOfOrganizationProcessSchedule' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/{organizationCode}/processSchedules/{processScheduleId}: post: tags: - organizations2 summary: Adds a process schedule to the organization. description: 'GraphQL endpoint: organizationProcessScheduleAdd' operationId: nsk_v1_organizations2_organizationCode_processSchedules_processScheduleId_post parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: processScheduleId in: path required: true description: The ID of the process schedule. schema: type: integer format: int64 x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' delete: tags: - organizations2 summary: Deletes a process schedule from the organization. description: 'GraphQL endpoint: organizationProcessScheduleDelete' operationId: nsk_v1_organizations2_organizationCode_processSchedules_processScheduleId_delete parameters: - name: organizationCode in: path required: true description: The organization code. schema: type: string x-position: 1 - name: processScheduleId in: path required: true description: The ID of the process schedule. schema: type: integer format: int64 x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' /api/nsk/v1/organizations2/allotments: get: tags: - organizations2 summary: Retrieves all allotments for the specified leg. description: 'GraphQL endpoint: allotments' operationId: nsk_v1_organizations2_allotments_get parameters: - name: legKey in: query description: The leg key. schema: type: - string - 'null' x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentResponse' examples: Allotment response: description: Returns an allotment response value: allotmentBasisCode: NEGO1 authorizedUnits: 10 allotted: 10 nest: 1 classOfService: NEGO type: 4 rank: 0 seatsSold: 5 latestAdvanceReservation: 0 status: 1 legNestKey: MQ-- legClassKey: Mjk1MTAwNCExIU5FR08- legKey: null marketInformation: null '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/allotments/{allotmentBasisCode}: get: tags: - organizations2 summary: Retrieves a single allotment for the specified leg using the given allotment basis code. description: 'The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments. GraphQL endpoint: allotment' operationId: nsk_v1_organizations2_allotments_allotmentBasisCode_get parameters: - name: legKey in: query description: The leg key. schema: type: - string - 'null' x-position: 1 - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentResponse' examples: Allotment response: description: Returns an allotment response value: allotmentBasisCode: NEGO1 authorizedUnits: 10 allotted: 10 nest: 1 classOfService: NEGO type: 4 rank: 0 seatsSold: 5 latestAdvanceReservation: 0 status: 1 legNestKey: MQ-- legClassKey: Mjk1MTAwNCExIU5FR08- legKey: null marketInformation: null '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/allotments/{contractCode}/bases: get: tags: - organizations2 summary: Retrieves all allotment bases for the specified contract. description: 'GraphQL endpoint: allotmentBases' operationId: nsk_v1_organizations2_allotments_contractCode_bases_get parameters: - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 1 - name: PageSize in: query description: "The Page Size, Default 1000\n " schema: type: - integer - 'null' maximum: 5000.0 minimum: 10.0 x-position: 2 - name: LastPageKey in: query description: "The LastPageKey, where to start paged query.\n " schema: type: - string - 'null' x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfRetrieveAllotmentBasisResponse' examples: Get all Allotment Bases: description: Returns a list of all allotment bases associated with an allotment contract value: lastPageKey: null allotmentBasisResponses: - allotmentBasisCode: AAA contractCode: DEF description: The description status: 1 allotmentType: 1 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 - allotmentBasisCode: BBB contractCode: DEF description: The description status: 2 allotmentType: 0 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: NV ruleNumber: ' The rule number' fareBasisCode: Fare1 '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 basis. description: 'GraphQL endpoint: allotmentBasisAdd' operationId: nsk_v1_organizations2_allotments_contractCode_bases_post parameters: - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 1 requestBody: x-name: request description: The allotment basis to create. content: application/json: schema: $ref: '#/components/schemas/AllotmentBasisRequest' examples: Allotment Basis Request: description: Creates a new allotment basis value: allotmentBasisCode: ABC description: The description status: 1 allotmentType: 0 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 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/allotments/{contractCode}/bases/{allotmentBasisCode}: put: tags: - organizations2 summary: Updates the specified allotment basis. description: 'GraphQL endpoint: allotmentBasisSet' operationId: nsk_v1_organizations2_allotments_contractCode_bases_allotmentBasisCode_put parameters: - name: contractCode in: path required: true description: The contract code. schema: type: string x-position: 1 - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 2 requestBody: x-name: request description: The allotment basis to update. content: application/json: schema: $ref: '#/components/schemas/AllotmentBasisUpdateRequest' examples: Allotment Basis Request: description: Updates an allotment basis value: description: The description status: 1 allotmentType: 0 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 required: true x-position: 3 responses: '200': description: OK. Request completed 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/allotments/bases/{allotmentBasisCode}: get: tags: - organizations2 summary: Retrieves the specified allotment basis. description: 'GraphQL endpoint: allotmentBasis' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code to search for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentBasisResponse' examples: Get Allotment Basis: description: Returns a specific allotment basis value: allotmentMarketFares: - allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.157905Z' discontinueDate: '2026-07-16T05:55:16.1579052Z' allotmentBasisCode: ABC contractCode: DEF description: The description status: 1 allotmentType: 1 classNest: 0 classRank: 0 latestAdvanceReservation: 0 ruleTariff: The rule tariff carrierCode: AA ruleNumber: ' The rule number' fareBasisCode: Fare1 '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/allotments/bases/{allotmentBasisCode}/marketFares: get: tags: - organizations2 summary: Gets all market fares for the given allotment basis. description: 'GraphQL endpoint: allotmentBasisMarketFares' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2056803Z' discontinueDate: '2026-07-16T05:55:16.2056804Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' post: tags: - organizations2 summary: Creates the specified allotment basis market fare. description: 'GraphQL endpoint: allotmentBasisMarketFareAdd' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_post parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 requestBody: x-name: request description: The allotment market fare request. content: application/json: schema: $ref: '#/components/schemas/AllotmentMarketFareRequest' examples: Allotment market fare request full data: description: Create/update request with full customization. value: stationCode: DEN travelStationCode: SLC directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2099662Z' discontinueDate: '2026-07-16T05:55:16.2099795Z' Allotment market fare request minimum required data: description: Create/update request with minimum required data. Directionality and DiscontinueDate have hard default values. Currency code will default to the default currency code of your environment. value: stationCode: DEN travelStationCode: SLC directionality: null price: 10.0 currencyCode: null releaseDate: '2026-07-09T05:55:16.2099926Z' discontinueDate: null required: true x-position: 2 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2111129Z' discontinueDate: '2026-07-16T05:55:16.211113Z' '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 the provided stations are the same.: description: '' value: errors: - id: null code: nsk:Allotments:SameStationCodeAndTravelStationCode message: The value for station code 'SLC' and travel station code 'SLC' cannot be the same. type: Validation details: null rawMessage: null 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 the provided station codes are not in alphabetical order.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationOrder message: The station codes provided 'SLC-DEN' need to be in alphabetical order. Please use DEN-SLC. type: Validation details: null rawMessage: null 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 a provided station code does not exist or is inactive.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationCode message: The station code provided 'SLC' is either invalid or not active. type: Validation details: null rawMessage: null 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 a release or discontinue date is set in the past.: description: '' value: errors: - id: null code: nsk:Allotments:DateSetBeforeToday message: The provided date '7/2/2026 5:55:16 AM' cannot be set earlier than today. type: Validation details: null rawMessage: null 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 the provided discontinue date is before the release date.: description: '' value: errors: - id: null code: nsk:Allotments:DiscontinueDateBeforeReleaseDate message: The discontinue date '7/8/2026 5:55:16 AM' cannot be before the release date '7/9/2026 5:55:16 AM' type: Validation details: null rawMessage: null 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 the provided price is less than zero.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidPrice message: The price provided '-10.0' is invalid. Price must be a positive decimal value. type: Validation details: null rawMessage: null 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 the provided allotment basis code could not be found or is invalid.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidAllotmentBasisCode message: The provided allotment basis code 'ABC' does not exist. type: Validation details: null rawMessage: null 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 /api/nsk/v1/organizations2/allotments/bases/{allotmentBasisCode}/marketFares/{allotmentMarketFareKey}: get: tags: - organizations2 summary: Gets the specified market fare for the given allotment basis. description: 'GraphQL endpoint: allotmentBasisMarketFare' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_allotmentMarketFareKey_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 - name: allotmentMarketFareKey in: path required: true description: The allotment market fare key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2071958Z' discontinueDate: '2026-07-16T05:55:16.2071959Z' '400': description: There was a problem with the request and it could not be completed. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' put: tags: - organizations2 summary: Updates the specified allotment basis market fare. description: 'GraphQL endpoint: allotmentBasisMarketFareSet' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_allotmentMarketFareKey_put parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 - name: allotmentMarketFareKey in: path required: true description: The target allotment market fare key. schema: type: string x-position: 2 requestBody: x-name: request description: The allotment market fare update request. content: application/json: schema: $ref: '#/components/schemas/AllotmentMarketFareRequest' examples: Allotment market fare request full data: description: Create/update request with full customization. value: stationCode: DEN travelStationCode: SLC directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2138735Z' discontinueDate: '2026-07-16T05:55:16.2138737Z' Allotment market fare request minimum required data: description: Create/update request with minimum required data. Directionality and DiscontinueDate have hard default values. Currency code will default to the default currency code of your environment. value: stationCode: DEN travelStationCode: SLC directionality: null price: 10.0 currencyCode: null releaseDate: '2026-07-09T05:55:16.2138745Z' discontinueDate: null required: true x-position: 3 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentMarketFareResponse' examples: Allotment market fare response: description: Create/update response. value: allotmentMarketFareKey: ABC123 allotmentBasisCode: ABC stationCode: DEN travelStationCode: SLC fareSequence: 0 directionality: 3 price: 10.0 currencyCode: USD releaseDate: '2026-07-09T05:55:16.2139324Z' discontinueDate: '2026-07-16T05:55:16.2139324Z' '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 the provided stations are the same.: description: '' value: errors: - id: null code: nsk:Allotments:SameStationCodeAndTravelStationCode message: The value for station code 'SLC' and travel station code 'SLC' cannot be the same. type: Validation details: null rawMessage: null 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 the provided station codes are not in alphabetical order.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationOrder message: The station codes provided 'SLC-DEN' need to be in alphabetical order. Please use DEN-SLC. type: Validation details: null rawMessage: null 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 a provided station code does not exist or is inactive.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidStationCode message: The station code provided 'SLC' is either invalid or not active. type: Validation details: null rawMessage: null 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 a release or discontinue date is set in the past.: description: '' value: errors: - id: null code: nsk:Allotments:DateSetBeforeToday message: The provided date '7/2/2026 5:55:16 AM' cannot be set earlier than today. type: Validation details: null rawMessage: null 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 the provided discontinue date is before the release date.: description: '' value: errors: - id: null code: nsk:Allotments:DiscontinueDateBeforeReleaseDate message: The discontinue date '7/8/2026 5:55:16 AM' cannot be before the release date '7/9/2026 5:55:16 AM' type: Validation details: null rawMessage: null 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 the provided price is less than zero.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidPrice message: The price provided '-10.0' is invalid. Price must be a positive decimal value. type: Validation details: null rawMessage: null 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 the provided allotment basis code could not be found or is invalid.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidAllotmentBasisCode message: The provided allotment basis code 'ABC' does not exist. type: Validation details: null rawMessage: null 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 delete: tags: - organizations2 summary: Deletes the specified allotment basis market fare. description: 'GraphQL endpoint: allotmentBasisMarketFareDelete' operationId: nsk_v1_organizations2_allotments_bases_allotmentBasisCode_marketFares_allotmentMarketFareKey_delete parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 - name: allotmentMarketFareKey in: path required: true description: The target allotment market fare key. schema: type: string x-position: 2 responses: '200': description: OK. Request completed 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 when the provided allotment market fare key could not be deleted.: description: '' value: errors: - id: null code: nsk:Exceptions:DeleteFailed message: Attempted delete of object 'allotmentMarketFareKey' with key 'AllotmentBasisResponse' has failed. Please verify this object exists. type: Validation details: null rawMessage: null 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 the provided allotment basis code could not be found or is invalid.: description: '' value: errors: - id: null code: nsk:Allotments:InvalidAllotmentBasisCode message: The provided allotment basis code 'ABC' does not exist. type: Validation details: null rawMessage: null 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 the provided allotment market fare key is invalid.: description: '' value: errors: - id: null code: nsk:Exceptions:InvalidKey message: The identifier 'allotmentMarketFareKey' with value 'ABC123' is invalid. type: Validation details: null rawMessage: null 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 /api/nsk/v1/organizations2/allotments/byAllotmentBasisCode/{allotmentBasisCode}: get: tags: - organizations2 summary: Retrieves all allotments for the specified allotment basis code. description: 'GraphQL endpoint: allotmentsByBasisCode' operationId: nsk_v1_organizations2_allotments_byAllotmentBasisCode_allotmentBasisCode_get parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfAllotmentResponse' examples: Allotment response: description: Returns an allotment response value: allotmentBasisCode: NEGO1 authorizedUnits: 10 allotted: 10 nest: 1 classOfService: NEGO type: 4 rank: 0 seatsSold: 5 latestAdvanceReservation: 0 status: 1 legNestKey: MQ-- legClassKey: Mjk1MTAwNCExIU5FR08- legKey: null marketInformation: null '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/allotments/contracts/{contractCode}: get: tags: - organizations2 summary: Retrieves the specified allotment contract. description: 'GraphQL endpoint: allotmentContract' operationId: nsk_v1_organizations2_allotments_contracts_contractCode_get parameters: - name: contractCode in: path required: true description: The contract code to search for. schema: type: string x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentContractResponse' examples: Allotment contract response: description: Returns an allotment contract response value: contractCode: ABC description: Travel agency contract status: 1 organizationCode: '123456' discontinueDate: '2026-07-09T05:55:16.17388Z' contractProperties: - contractPropertyCode: ABC value: Test '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/contracts/basis/{allotmentBasisCode}/allotments/legs/{legKey}: post: tags: - organizations2 summary: Creates an allotment for the specified leg. description: 'Due to system limitations, if this endpoint is used the inventory cache will need to be refreshed NegoAlloment and ProrataAllotment are the only allotment class types available. These values align with the ClassType enum. The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments. GraphQL endpoint: allotmentAdd' operationId: nsk_v1_organizations2_contracts_basis_allotmentBasisCode_allotments_legs_legKey_post parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code schema: type: string x-position: 1 - name: legKey in: path required: true description: The leg key schema: type: string x-position: 2 requestBody: x-name: request description: The allotment request. content: application/json: schema: $ref: '#/components/schemas/AllotmentRequest' examples: Allotment Request: description: Creates a new allotment value: authorizedUnits: 10 allotted: 10 nest: 1 classType: 4 rank: 1 latestAdvanceReservation: 0 status: 1 required: true x-position: 3 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfAllotmentCreatedResponse' examples: Allotment Created Response: description: Creates a new allotment basis value: allotmentBasisCode: ABC legKey: LTg1ODQxODAzMDM2OTI4Mjc3NjEhQUEhMTIzNCEhU0xDIUJPUyExMw-- legNestKey: MTIzNDU2Nzg5ITE- legClassKey: MTIzNDU2Nzg5ITEhQQ-- '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: Updates an allotment for the specified leg. description: 'Due to system limitations, if this endpoint is used the inventory cache will need to be refreshed. NegoAllotment and ProrataAllotment are the only allotment class types available. These values align with the ClassType enum. The allotment basis code should be substituted with allotment class code in Fare Manager Plus environments. GraphQL endpoint: allotmentSet' operationId: nsk_v1_organizations2_contracts_basis_allotmentBasisCode_allotments_legs_legKey_put parameters: - name: allotmentBasisCode in: path required: true description: The allotment basis code schema: type: string x-position: 1 - name: legKey in: path required: true description: The leg key schema: type: string x-position: 2 requestBody: x-name: request description: The allotment request. content: application/json: schema: $ref: '#/components/schemas/AllotmentRequest' examples: Allotment Request: description: Creates a new allotment value: authorizedUnits: 10 allotted: 10 nest: 1 classType: 4 rank: 1 latestAdvanceReservation: 0 status: 1 required: true x-position: 3 responses: '200': description: OK. Request completed 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/processSchedule/{processScheduleId}: get: tags: - organizations2 summary: Returns a single Process Schedule object. description: 'GraphQL endpoint: processScheduleGet' operationId: nsk_v1_organizations2_processSchedule_processScheduleId_get parameters: - name: processScheduleId in: path required: true description: The ID of the process schedule to retrieve. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedule' examples: Successfully returned process schedule: description: Example response for successful retrieval of a process schedule. DaysOfWeek represents a single day, which is fixed in the v2 version of this endpoint. None=0, Monday=1, Tuesday=2, through Sunday=7. value: processScheduleId: 123 name: Process Schedule A beginDate: '2026-07-09T05:55:16.2770685+00:00' frequencyType: 0 daysOfWeek: 1 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedule' deprecated: true /api/nsk/v2/organizations2/processSchedule/{processScheduleId}: get: tags: - organizations2 summary: Returns a single Process Schedule object. description: 'GraphQL endpoint: processScheduleGetv2' operationId: nsk_v2_organizations2_processSchedule_processScheduleId_get parameters: - name: processScheduleId in: path required: true description: The ID of the process schedule to retrieve. schema: type: integer format: int64 x-position: 1 responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedulev2' examples: Successfully returned process schedule: description: Example response for successful retrieval of a process schedule. DaysOfWeek is a list in which None=0, Monday=1, Tuesday=2, through Sunday=7. value: processScheduleId: 123 name: Process Schedule A beginDate: '2026-07-09T05:55:16.3018561+00:00' frequencyType: 0 daysOfWeek: - 1 - 3 - 5 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false '404': description: The item was not found. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfProcessSchedulev2' /api/nsk/v1/organizations2/processSchedules: get: tags: - organizations2 summary: Returns a list of active process schedules. description: 'GraphQL endpoint: processScheduleGetAll' operationId: nsk_v1_organizations2_processSchedules_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProcessSchedule' examples: Successfully returned list of all process schedules: description: Example response for successful retrieval of all process schedules. DaysOfWeek represents a single day, which is fixed in the v2 version of this endpoint. None=0, Monday=1, Tuesday=2, through Sunday=7. value: - processScheduleId: 123 name: Process Schedule - Runs every other Monday beginDate: '2026-07-09T05:55:16.2730672+00:00' frequencyType: 0 daysOfWeek: 1 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 124 name: Process Schedule - Runs every third Tuesday beginDate: '2026-07-09T05:55:16.2731542+00:00' frequencyType: 1 daysOfWeek: 2 frequency: 3 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 125 name: Process Schedule - Runs the second Saturday of each month beginDate: '2026-07-09T05:55:16.2731546+00:00' frequencyType: 2 daysOfWeek: 6 frequency: 1 monthDay: 0 monthWeek: 2 inActive: false - processScheduleId: 126 name: Process Schedule - Runs every day beginDate: '2026-07-09T05:55:16.2731548+00:00' frequencyType: 0 daysOfWeek: 0 frequency: 1 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 127 name: Process Schedule - Runs every third day beginDate: '2026-07-09T05:55:16.273155+00:00' frequencyType: 0 daysOfWeek: 0 frequency: 3 monthDay: 0 monthWeek: 0 inActive: false deprecated: true /api/nsk/v2/organizations2/processSchedules: get: tags: - organizations2 summary: Returns a list of active process schedules. description: 'GraphQL endpoint: processScheduleGetAllv2' operationId: nsk_v2_organizations2_processSchedules_get responses: '200': description: OK. Request completed successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponseOfIListOfProcessSchedulev2' examples: Successfully returned list of all process schedules: description: Example response for successful retrieval of all process schedules. DaysOfWeek is a list in which None=0, Monday=1, Tuesday=2, through Sunday=7. value: - processScheduleId: 123 name: Process Schedule - Runs every Mon Wed Fri beginDate: '2026-07-09T05:55:16.2984575+00:00' frequencyType: 0 daysOfWeek: - 1 - 3 - 5 frequency: 1 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 124 name: Process Schedule - Runs every third Tuesday beginDate: '2026-07-09T05:55:16.2985787+00:00' frequencyType: 1 daysOfWeek: - 2 frequency: 3 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 125 name: Process Schedule - Runs the second Saturday of each month beginDate: '2026-07-09T05:55:16.2985793+00:00' frequencyType: 2 daysOfWeek: - 6 frequency: 1 monthDay: 0 monthWeek: 2 inActive: false - processScheduleId: 126 name: Process Schedule - Runs every day beginDate: '2026-07-09T05:55:16.2985818+00:00' frequencyType: 0 daysOfWeek: - 0 frequency: 1 monthDay: 0 monthWeek: 0 inActive: false - processScheduleId: 127 name: Process Schedule - Runs every other day beginDate: '2026-07-09T05:55:16.2985821+00:00' frequencyType: 0 daysOfWeek: - 0 frequency: 2 monthDay: 0 monthWeek: 0 inActive: false /api/nsk/v1/organizations2/register: post: tags: - organizations2 summary: Requests to register a new organization. description: 'Note: This is only a request. An agent will need to approve the action. GraphQL endpoint: organization2RegisterAdd' operationId: nsk_v1_organizations2_register_post requestBody: x-name: registerRequest description: The request for registering a new organization. content: application/json: schema: $ref: '#/components/schemas/OrganizationRegisterRequest' required: true x-position: 1 responses: '201': description: The item was created successfully. content: application/json: schema: $ref: '#/components/schemas/IJsonResponse' components: schemas: OrganizationTransactionRequest: type: object description: "The organization account transaction request.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n " maxLength: 3 minLength: 0 note: type: - string - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 type: description: "The transaction types for an organization account.\n " $ref: '#/components/schemas/AllowedTransactionTypes' PagedTransactionResponse: type: object description: "The paged transaction response.\n " additionalProperties: false properties: totalCount: type: integer description: "The total count of transactions.\n " format: int32 lastPageKey: type: - string - 'null' description: "The last page key.\n " transactions: type: - array - 'null' description: "The collection of transactions.\n " items: $ref: '#/components/schemas/Transaction' OrganizationEditRequest: type: object description: "The base data on the organization.\n " additionalProperties: false properties: organizationCode: type: - string - 'null' description: "The organization code.\n " maxLength: 10 minLength: 2 type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " $ref: '#/components/schemas/OrganizationConfigurationv2' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: - string - 'null' description: "The parent organization code.\n " maxLength: 10 minLength: 2 statementNote: type: - string - 'null' description: "The statement note.\n " maxLength: 128 minLength: 0 lastStatementDate: type: - string - 'null' description: "The last statement date.\n " format: date-time company: description: "The company details.\n " $ref: '#/components/schemas/CompanyEditDetails' contact: description: "The contact details.\n " $ref: '#/components/schemas/ContactEditDetails' IJsonResponseOfProcessSchedulev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ProcessSchedulev2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' OrganizationStatus: type: integer description: "Organization status.\n \n\n0 = Default\n1 = Active\n2 = Cancelled\n3 = Pending" x-enumNames: - Default - Active - Cancelled - Pending enum: - 0 - 1 - 2 - 3 ContactDetails: type: object description: "The contact details for an organization.\n " additionalProperties: false properties: name: description: "The contact name.\n " $ref: '#/components/schemas/Name' phoneNumbers: type: - array - 'null' description: "The available contact phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' AllotmentBasisRequest: type: object description: "The allotment basis request model\n " additionalProperties: false required: - allotmentBasisCode - status - allotmentType properties: allotmentBasisCode: type: string description: "The allotment basis code.\n " minLength: 1 description: type: - string - 'null' description: "The description.\n " status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: - string - 'null' description: "The rule tariff.\n " carrierCode: type: - string - 'null' description: "The carrier code.\n " ruleNumber: type: - string - 'null' description: "The rule number.\n " fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " IJsonResponseOfIListOfAllotmentMarketFareResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/AllotmentMarketFareResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' OrganizationProcessSchedule: type: object description: "The OrganizationCode defines a link between an Organization and a ProcessSchedule.\n " additionalProperties: false properties: processScheduleID: type: integer description: "The ProcessScheduleID of the Process Schedule of an organization.\n " format: int64 AccountCollectionBase: type: object description: "The account collection base model.\n " additionalProperties: false properties: accountCollectionKey: type: - string - 'null' description: "The unique account collection key.\n " available: type: number description: "The available amount.\n " format: decimal amount: type: number description: "The total amount.\n " format: decimal createdDate: type: - string - 'null' description: "The creation date.\n " format: date-time IJsonResponseOfOrganizationv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/Organizationv2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AllotmentContractProperty: type: object description: "The allotment contract property.\n " additionalProperties: false properties: contractPropertyCode: type: - string - 'null' description: "The contract property code.\n " value: type: - string - 'null' description: "The allotment value.\n " AllotmentResponse: type: object description: "The allotment response model.\n " additionalProperties: false properties: allotmentBasisCode: type: - string - 'null' description: "The allotment basis code.\n " authorizedUnits: type: integer description: "The number of class authorized units.\n " allotted: type: integer description: "The number of classes allotted.\n " nest: type: integer description: "The class nest.\n " classOfService: type: - string - 'null' description: "The class of service.\n " type: description: "The class of service type.\n " $ref: '#/components/schemas/ClassOfServiceType' rank: type: integer description: "The class rank.\n " seatsSold: type: integer description: "The number of class seats sold.\n " latestAdvanceReservation: type: integer description: "The latest advance reservation.\n " status: description: "The class status.\n " $ref: '#/components/schemas/ClassStatus' legNestKey: type: - string - 'null' description: "The leg nest key. Useful for inventory operations.\n " legClassKey: type: - string - 'null' description: "The leg class key. Useful for inventory operations.\n " legKey: type: - string - 'null' description: "The leg key.\n " marketInformation: description: "The market information of the allotment.\n " $ref: '#/components/schemas/MarketInformation' CompanyEditDetails: type: object description: "The organization company details of an organization.\n " additionalProperties: false required: - name properties: name: type: string description: "The organization name.\n " minLength: 1 address: description: "The address of the organization.\n " $ref: '#/components/schemas/Address' url: type: - string - 'null' description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 emailAddress: type: - string - 'null' description: "The email address.\n " format: email internalNote: type: - string - 'null' description: "Internal note.\n " maxLength: 256 minLength: 0 externalNote: type: - string - 'null' description: "External note.\n " maxLength: 256 minLength: 0 IJsonResponseOfAllotmentCreatedResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AllotmentCreatedResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' MonthWeek: type: integer description: "MonthWeek Enumeration. Based on ones for SQL server scheduler, not all included.\n \n\n0 = None\n1 = First\n2 = Second\n3 = Third\n4 = Fourth\n5 = Last" x-enumNames: - None - First - Second - Third - Fourth - Last enum: - 0 - 1 - 2 - 3 - 4 - 5 DayOfWeek: type: integer description: "Defines the day of the week with none as an option.\n \n\n0 = None\n1 = Monday\n2 = Tuesday\n3 = Wednesday\n4 = Thursday\n5 = Friday\n6 = Saturday\n7 = Sunday" x-enumNames: - None - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 TransportationIdentifier: type: object description: "Represents the transportation identifier model data.\n " additionalProperties: false required: - identifier - carrierCode properties: identifier: type: string description: "The unique transportation identifier.\n " maxLength: 4 minLength: 0 carrierCode: type: string description: "The carrier code.\n " maxLength: 3 minLength: 2 opSuffix: type: - string - 'null' description: "The op suffix.\nPlease note that this should be a char and not a string.\n " maxLength: 1 IJsonResponseOfOrganizationAccount: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/OrganizationAccount' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AllowedTransactionTypes: type: integer description: "The dotREZ specific transaction types.\n \n\n0 = Default\n1 = Payment\n2 = Adjustment\n3 = Supplementary" x-enumNames: - Default - Payment - Adjustment - Supplementary enum: - 0 - 1 - 2 - 3 ExternalDistributionOption: type: integer description: "Describes the external distribution option.\n \n\n0 = NoDistribution\n1 = UseOrganizationEmailOnly\n2 = UseMessageEmailOnly\n3 = UseMessageEmail" x-enumNames: - NoDistribution - UseOrganizationEmailOnly - UseMessageEmailOnly - UseMessageEmail enum: - 0 - 1 - 2 - 3 OrganizationConfigurationv2: type: object description: "The configuration details of an organization.\n " additionalProperties: false properties: cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 1 commissionable: type: boolean description: "Commissionable.\n " recalculateCommission: type: boolean description: "Recalculate commission.\n " recallCommission: type: boolean description: "Recall commission.\n " nettedTotal: type: boolean description: "Netted total.\n " gdsEmailItinerary: description: "Gds email itinerary.\n " $ref: '#/components/schemas/ExternalDistributionOption' sourceIsInternal: type: boolean description: "Organization source is internal. Otherwise its external.\n " sourceIsDeleted: type: boolean description: "Organization source is deleted. Otherwise its active.\n " traceQueueCode: type: - string - 'null' description: "The trace queue code.\n " maxLength: 6 minLength: 0 referralType: description: "Referral type.\n " $ref: '#/components/schemas/ReferralType' DeltaMapperOfOrganizationEditRequest: type: object description: "Map delta changes of a specific type T to another object.\n " additionalProperties: false properties: organizationCode: type: - string - 'null' description: "The organization code.\n " maxLength: 10 minLength: 2 type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " properties: cultureCode: type: - string - 'null' description: "The culture code.\n " maxLength: 17 minLength: 0 currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 1 commissionable: type: boolean description: "Commissionable.\n " recalculateCommission: type: boolean description: "Recalculate commission.\n " recallCommission: type: boolean description: "Recall commission.\n " nettedTotal: type: boolean description: "Netted total.\n " gdsEmailItinerary: description: "Gds email itinerary.\n " $ref: '#/components/schemas/ExternalDistributionOption' sourceIsInternal: type: boolean description: "Organization source is internal. Otherwise its external.\n " sourceIsDeleted: type: boolean description: "Organization source is deleted. Otherwise its active.\n " traceQueueCode: type: - string - 'null' description: "The trace queue code.\n " maxLength: 6 minLength: 0 referralType: description: "Referral type.\n " $ref: '#/components/schemas/ReferralType' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: - string - 'null' description: "The parent organization code.\n " maxLength: 10 minLength: 2 statementNote: type: - string - 'null' description: "The statement note.\n " maxLength: 128 minLength: 0 lastStatementDate: type: - string - 'null' description: "The last statement date.\n " format: date-time company: description: "The company details.\n " properties: name: type: string description: "The organization name.\n " minLength: 1 address: description: "The address of the organization.\n " properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 url: type: - string - 'null' description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 emailAddress: type: - string - 'null' description: "The email address.\n " format: email internalNote: type: - string - 'null' description: "Internal note.\n " maxLength: 256 minLength: 0 externalNote: type: - string - 'null' description: "External note.\n " maxLength: 256 minLength: 0 contact: description: "The contact details.\n " properties: name: description: "The contact name.\n " properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 AllotmentMarketFareRequest: type: object description: "The allotment market fare update request model.\n " additionalProperties: false required: - stationCode - travelStationCode - price properties: stationCode: type: string description: "The station code.\nMust come alphabetically before the travel station code.\n " maxLength: 3 minLength: 0 travelStationCode: type: string description: "The travel station code.\n " maxLength: 3 minLength: 0 directionality: description: "The directionality of the fare.\nIf not provided this will default to both ways.\n " $ref: '#/components/schemas/Directionality' price: type: number description: "The price.\n " format: decimal currencyCode: type: - string - 'null' description: "The currency code.\nIf not provided this will default to your configured default currency code.\n " maxLength: 3 minLength: 0 releaseDate: type: - string - 'null' description: "The release date.\nIf not provided this will default to today.\n " format: date-time discontinueDate: type: - string - 'null' description: "The discontinue date.\nIf not provided this will default to never discontinue.\n " format: date-time AccountType: type: integer description: "The account type enumeration.\n \n\n0 = Credit\n1 = Prepaid\n2 = Supplementary\n3 = Dependent\n4 = Unknown" x-enumNames: - Credit - Prepaid - Supplementary - Dependent - Unknown enum: - 0 - 1 - 2 - 3 - 4 OrganizationRecord: type: object description: "The data on the user related agent's organization.\n " additionalProperties: false required: - organizationCode properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' company: description: "The company details.\n " $ref: '#/components/schemas/CompanyDetailsRecord' contact: description: "The contact details.\n " $ref: '#/components/schemas/ContactDetails' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: - string - 'null' description: "The parent organization code.\n " maxLength: 10 minLength: 2 PhoneNumberBase: type: object description: "Defines a common phone number base.\n " additionalProperties: false required: - number properties: number: type: string description: "The phone number without any formatting characters.\n " maxLength: 20 minLength: 0 IJsonResponseOfPagedTransactionResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/PagedTransactionResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfProcessSchedule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/ProcessSchedule' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PhoneNumberType: type: integer description: "Defines the types of phone numbers. Note: New Skies does not support Mobile for booking contacts.\n \n\n0 = Other\n1 = Home\n2 = Work\n3 = Mobile\n4 = Fax" x-enumNames: - Other - Home - Work - Mobile - Fax enum: - 0 - 1 - 2 - 3 - 4 ReferralType: type: integer description: "Referral type.\n \n\n0 = Default\n1 = Allowed\n2 = AllowedWithUrlMatch\n3 = NotAllowed" x-enumNames: - Default - Allowed - AllowedWithUrlMatch - NotAllowed enum: - 0 - 1 - 2 - 3 AllotmentClassType: type: integer description: "The class of service type enumeration.\n \n\n4 = NegoAllotment\n5 = ProrataAllotment" x-enumNames: - NegoAllotment - ProrataAllotment enum: - 4 - 5 OrganizationExternalAccountRequest: type: object description: "The data for an organizations external account.\n " additionalProperties: false properties: name: type: - string - 'null' description: "The name of the external account.\n " maxLength: 256 minLength: 0 description: type: - string - 'null' description: "The description.\n " maxLength: 128 minLength: 0 routingNumber: type: - string - 'null' description: "The routing number.\n " maxLength: 32 minLength: 0 accountNumber: type: - string - 'null' description: "The account number.\n " maxLength: 34 minLength: 0 bankIdentifierCode: type: - string - 'null' description: "The band identifier code (BIC).\n " maxLength: 16 minLength: 0 internationalBankAccountNumber: type: - string - 'null' description: "The international bank account number or IBAN.\n " maxLength: 64 minLength: 0 notes: type: - string - 'null' description: "The notes.\n " maxLength: 128 minLength: 0 Message: type: object description: "Defines a unique informational message.\n " additionalProperties: false properties: code: type: - string - 'null' description: "The unique message code.\n " type: type: - string - 'null' description: "The message type.\n " value: type: - string - 'null' description: "The message's value.\n " status: description: "The message's status.\n " $ref: '#/components/schemas/MessageStatus' details: type: - object - 'null' description: "Dynamic detailed information about the message.\n " additionalProperties: type: string IJsonResponseOfAllotmentContractResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AllotmentContractResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' MarketInformation: type: object description: "Model information about the market arrival and destination details.\n " additionalProperties: false required: - destination - origin - departureDate - identifier properties: destination: type: string description: "Gets or sets the leg arrival station.\n " maxLength: 3 minLength: 0 origin: type: string description: "Gets or sets the leg departure station.\n " maxLength: 3 minLength: 0 departureDate: type: string description: "The departure date.\n " format: date-time minLength: 1 identifier: description: "Gets or sets the leg arrival station.\n " $ref: '#/components/schemas/TransportationIdentifier' Transaction: type: object description: "The transaction model.\n " additionalProperties: false required: - amount - currencyCode properties: amount: type: number description: "The credit account transaction amount.\n " format: decimal currencyCode: type: string description: "The credit account transaction currency code.\n " maxLength: 3 minLength: 0 note: type: - string - 'null' description: "The credit account transaction note.\n " maxLength: 128 minLength: 0 accountTransactionCode: type: - string - 'null' description: "The system-generated code for the transaction.\n " recordLocator: type: - string - 'null' description: "The record locator from the refunded booking payment. This property is redundant and the same information can be\nfound on the AccountReference property.\n " deprecated: true x-deprecatedMessage: 4.4.4 - Please use Account Reference instead. accountReference: type: - string - 'null' description: "The account reference. This property may contain a record locator, account number, string value, or may be null\ndepending on the transaction type.\n " transactionKey: type: - string - 'null' description: "The unique transaction key.\n " createdDate: type: - string - 'null' description: "The created date associated with the transaction.\n " format: date-time foreignAmount: type: number description: "The transaction foreign amount.\n " format: decimal foreignCurrencyCode: type: - string - 'null' description: "The transaction foreign currency code.\n " maxLength: 3 minLength: 0 type: description: "The transaction type.\n " $ref: '#/components/schemas/TransactionType' paymentId: type: integer description: "The payment ID of the transaction. This will only be non zero on refunded booking payments. A zero signifies that\nno payment ID is found.\n " format: int64 accountCollectionKey: type: - string - 'null' description: "The account collection key associated with the transaction.\n " RetrieveAllotmentBasisResponse: type: object description: "The retrieve allotment basis response model\n " additionalProperties: false properties: lastPageKey: type: - string - 'null' description: "The LastPageKey, where to start paged query.\n " allotmentBasisResponses: type: - array - 'null' description: "The list of allotment bases.\n " items: $ref: '#/components/schemas/AllotmentBasisResponseBase' IJsonResponseOfProcessSchedule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/ProcessSchedule' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' ChildAccountTransactionsRequest: type: object description: "The organization account transaction request.\n " additionalProperties: false required: - amount properties: amount: type: number description: "The amount to adjust on the account.\n " format: decimal AllotmentCreatedResponse: type: object description: "Model representing a created allotment.\n " additionalProperties: false properties: allotmentBasisCode: type: - string - 'null' description: "The allotment basis code.\n " legKey: type: - string - 'null' description: "The leg key.\n " legNestKey: type: - string - 'null' description: "The leg nest key. Useful for inventory operations.\n " legClassKey: type: - string - 'null' description: "The leg class key. Useful for inventory operations.\n " IJsonResponse: type: object description: "Defines the JSON response contract for a not content type response.\n " additionalProperties: false properties: data: description: "The payload data, this will always be null for errors responses and no content responses.\n " errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AllotmentBasisUpdateRequest: type: object description: "The allotment basis update request model\n " additionalProperties: false properties: description: type: - string - 'null' description: "The description.\n " status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: - string - 'null' description: "The rule tariff.\n " carrierCode: type: - string - 'null' description: "The carrier code.\n " ruleNumber: type: - string - 'null' description: "The rule number.\n " fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " OrganizationAccount: type: object description: "The organization account model.\n " additionalProperties: false properties: accountKey: type: - string - 'null' description: "The account key.\n " totalAvailable: type: number description: "The summed total of all currently available credit amounts for the account.\n " format: decimal owner: description: "The account owner type.\n " $ref: '#/components/schemas/AccountOwnerType' type: description: "The account type.\n " $ref: '#/components/schemas/AccountType' status: description: "The account status.\n " $ref: '#/components/schemas/AccountStatus' totalAmount: type: number description: "The total amount.\n " format: decimal foreignAvailable: type: number description: "The foreign currency available.\n " format: decimal foreignCurrencyCode: type: - string - 'null' description: "The foreign currency code.\n " accountNumber: type: - string - 'null' description: "The account number associated to the customer or organization.\n " expiredCreditAmount: type: number description: "The amount of credit that was unused and already expired.\n " format: decimal expiredCreditCurrencyCode: type: - string - 'null' description: "The currency code of the expired credit amount.\n " currencyCode: type: - string - 'null' description: "The currency code.\n " maxLength: 3 minLength: 0 collection: description: "The organization account collection.\n " $ref: '#/components/schemas/AccountCollectionBase' AllotmentContractUpdateRequest: type: object description: "The allotment contract update request model\n " additionalProperties: false properties: description: type: - string - 'null' description: "The description\n " status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' discontinueDate: type: - string - 'null' description: "The discontinue date\n " format: date-time IJsonResponseOfRetrieveAllotmentBasisResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/RetrieveAllotmentBasisResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' MatchCriteria: type: integer description: "Defines the matching criteria for strings.\n \n\n0 = StartsWith\n1 = EndsWith\n2 = Contains\n3 = ExactMatch" x-enumNames: - StartsWith - EndsWith - Contains - ExactMatch enum: - 0 - 1 - 2 - 3 CompanyDetails: type: object description: "The organization company details of an organization.\n " additionalProperties: false properties: name: type: - string - 'null' description: "The organization name.\n " address: description: "The address of the organization.\n " $ref: '#/components/schemas/Address' url: type: - string - 'null' description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 emailAddress: type: - string - 'null' description: "The email address.\n " format: email internalNote: type: - string - 'null' description: "Internal note.\n " maxLength: 256 minLength: 0 externalNote: type: - string - 'null' description: "External note.\n " maxLength: 256 minLength: 0 phoneNumbers: type: - array - 'null' description: "The available phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' Exception: type: object additionalProperties: false properties: Message: type: string InnerException: $ref: '#/components/schemas/Exception' Source: type: - string - 'null' StackTrace: type: - string - 'null' IJsonResponseOfIListOfAllotmentResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/AllotmentResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' PhoneNumber: type: object description: "Defines a common phone number.\n " additionalProperties: false required: - number - type properties: number: type: string description: "The phone number without any formatting characters.\n " maxLength: 20 minLength: 0 type: description: "The phone number type.\n " $ref: '#/components/schemas/PhoneNumberType' AllotmentContractStatus: type: integer description: "The allotment contract status enumeration.\n \n\n0 = Default\n1 = Active\n2 = Closed" x-enumNames: - Default - Active - Closed enum: - 0 - 1 - 2 IJsonResponseOfIListOfProcessSchedulev2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/ProcessSchedulev2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfAllotmentBasisResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AllotmentBasisResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfIListOfOrganizationRecord: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/OrganizationRecord' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Name: type: object description: "Defines a common name.\n " additionalProperties: false properties: first: type: - string - 'null' description: "The given first name.\n " maxLength: 32 minLength: 0 middle: type: - string - 'null' description: "The given middle name.\n " maxLength: 32 minLength: 0 last: type: - string - 'null' description: "The given last name.\n " maxLength: 32 minLength: 0 title: type: - string - 'null' description: "The title.\n " maxLength: 6 minLength: 0 suffix: type: - string - 'null' description: "The suffix.\n " maxLength: 6 minLength: 0 AllowedAccountTypes: type: integer description: "The allowed account type enumeration. These are a subset of the AccountTypes enumeartion\nand represent the currently supported account types for an account creation.\n \n\n0 = Credit\n1 = Prepaid\n2 = Supplementary" x-enumNames: - Credit - Prepaid - Supplementary enum: - 0 - 1 - 2 Address: type: object description: "Defines a common address.\n " additionalProperties: false properties: lineOne: type: - string - 'null' description: "The address line one.\n " maxLength: 128 minLength: 0 lineTwo: type: - string - 'null' description: "The address line two.\n " maxLength: 128 minLength: 0 lineThree: type: - string - 'null' description: "The address line 3.\n " maxLength: 128 minLength: 0 countryCode: type: - string - 'null' description: "The country code.\n " maxLength: 2 minLength: 0 provinceState: type: - string - 'null' description: "The province state.\n " maxLength: 3 minLength: 0 city: type: - string - 'null' description: "The city.\n " maxLength: 32 minLength: 0 postalCode: type: - string - 'null' description: "The postal code.\n " maxLength: 10 minLength: 0 AllotmentBasisStatus: type: integer description: "The allotment basis status enumeration.\n \n\n0 = Default\n1 = Active\n2 = Closed" x-enumNames: - Default - Active - Closed enum: - 0 - 1 - 2 AllotmentMarketFareResponse: type: object description: "The allotment market fare response model\n " additionalProperties: false properties: allotmentMarketFareKey: type: - string - 'null' description: "The allotment market fare key.\n " allotmentBasisCode: type: - string - 'null' description: "The allotment basis code.\n " stationCode: type: - string - 'null' description: "The station code.\n " travelStationCode: type: - string - 'null' description: "The travel station code.\n " fareSequence: type: integer description: "The fare sequence.\n " directionality: description: "The directionality.\n " $ref: '#/components/schemas/Directionality' price: type: number description: "The price.\n " format: decimal currencyCode: type: - string - 'null' description: "The currency code.\n " releaseDate: type: string description: "The release date.\n " format: date-time discontinueDate: type: string description: "The discontinue date.\n " format: date-time AccountStatus: type: integer description: "The account status enumeration.\n \n\n0 = Open\n1 = Closed\n2 = AgencyInactive\n3 = Unknown" x-enumNames: - Open - Closed - AgencyInactive - Unknown enum: - 0 - 1 - 2 - 3 IJsonResponseOfIListOfAllotmentContractResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/AllotmentContractResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfAllotmentResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AllotmentResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' OrganizationType: type: integer description: "Organization type.\n \n\n0 = Default\n1 = Master\n2 = Carrier\n3 = TravelAgency\n4 = ThirdParty" x-enumNames: - Default - Master - Carrier - TravelAgency - ThirdParty enum: - 0 - 1 - 2 - 3 - 4 AllotmentContractRequest: type: object description: "The allotment contract request model\n " additionalProperties: false required: - contractCode - status properties: contractCode: type: string description: "The Contract Code.\n " minLength: 1 description: type: - string - 'null' description: "The description\n " status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' discontinueDate: type: - string - 'null' description: "The discontinue date\n " format: date-time contractProperties: type: - array - 'null' description: "The contract properties\n " items: $ref: '#/components/schemas/AllotmentContractProperty' ProcessSchedulev2: type: object description: "The data for an organizations Process Schedule, v2.\nProcess Schedule is a reporting tool that is used to generate agency commission statements.\nIt’s a batch process that runs daily to see when the reports should be generated and\ndetermine when a statement is generated and sent to an organization.\n " additionalProperties: false properties: processScheduleId: type: integer description: "The ProcessScheduleID of ProcessSchedulev2.\n " format: int64 name: type: - string - 'null' description: "The Name of ProcessSchedule.\n " beginDate: type: string description: "The BeginDate of ProcessSchedule.\n " format: date-time frequencyType: description: "The FrequencyType of ProcessSchedule.\n " $ref: '#/components/schemas/FrequencyType' daysOfWeek: type: - array - 'null' description: "The DaysOfWeek List of ProcessSchedule.\n " items: $ref: '#/components/schemas/DayOfWeek' frequency: type: integer description: "The Frequency of ProcessSchedule.\n " monthDay: type: integer description: "The MonthDay of ProcessSchedule.\n " monthWeek: description: "The MonthWeek of ProcessSchedule.\n " $ref: '#/components/schemas/MonthWeek' inActive: type: boolean description: "The InActive of ProcessSchedule.\n " TransactionType: type: integer description: "The dotREZ specific transaction types. This includes some system specific values that\nare not allowed during a transaction creation.\n \n\n0 = Default\n1 = Payment\n2 = Adjustment\n3 = Supplementary\n4 = Transfer\n5 = Spoilage\n6 = StatementDateAndBalance\n7 = PayableCommission\n8 = Commission\n9 = ChildCommissionTransfer\n10 = ParentCommissionTransfer" x-enumNames: - Default - Payment - Adjustment - Supplementary - Transfer - Spoilage - StatementDateAndBalance - PayableCommission - Commission - ChildCommissionTransfer - ParentCommissionTransfer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 IJsonResponseOfIListOfOrganizationProcessSchedule: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/OrganizationProcessSchedule' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AccountOwnerType: type: integer description: "The account owner type enumeration.\n \n\n0 = Organization\n1 = Personnal\n2 = Booking\n3 = Unknown" x-enumNames: - Organization - Personnal - Booking - Unknown enum: - 0 - 1 - 2 - 3 AllotmentRequest: type: object description: "The allotment request model.\n " additionalProperties: false properties: authorizedUnits: type: integer description: "The number of class authorized units.\n " allotted: type: integer description: "The number of classes allotted.\n " nest: type: integer description: "The class nest.\n " classType: description: "The allotment class type.\n " $ref: '#/components/schemas/AllotmentClassType' rank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The latest advance reservation.\n " status: description: "The class status.\n " $ref: '#/components/schemas/ClassStatus' ClassStatus: type: integer description: "Indicates whether a leg class may be used or not.\n \n\n1 = Active\n2 = InActive\n3 = AvsOpen\n4 = AvsOnRequest\n5 = AvsClosed" x-enumNames: - Active - InActive - AvsOpen - AvsOnRequest - AvsClosed enum: - 1 - 2 - 3 - 4 - 5 AllotmentBasisResponseBase: type: object description: "The allotment basis response base model\n " additionalProperties: false properties: allotmentBasisCode: type: - string - 'null' description: "The allotment basis code.\n " contractCode: type: - string - 'null' description: "The contract code.\n " description: type: - string - 'null' description: "The description.\n " status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: - string - 'null' description: "The rule tariff.\n " carrierCode: type: - string - 'null' description: "The carrier code.\n " ruleNumber: type: - string - 'null' description: "The rule number.\n " fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " MessageStatus: type: integer description: "Defines the message status.\n \n\n0 = General\n1 = Warning\n2 = Critical" x-enumNames: - General - Warning - Critical enum: - 0 - 1 - 2 OrganizationExternalAccountv2: type: object description: "The data for an organizations external account.\n " additionalProperties: false properties: name: type: - string - 'null' description: "The name of the external account.\n " maxLength: 256 minLength: 0 description: type: - string - 'null' description: "The description.\n " maxLength: 128 minLength: 0 routingNumber: type: - string - 'null' description: "The routing number.\n " maxLength: 32 minLength: 0 accountNumber: type: - string - 'null' description: "The account number.\n " maxLength: 34 minLength: 0 bankIdentifierCode: type: - string - 'null' description: "The band identifier code (BIC).\n " maxLength: 16 minLength: 0 internationalBankAccountNumber: type: - string - 'null' description: "The international bank account number or IBAN.\n " maxLength: 64 minLength: 0 notes: type: - string - 'null' description: "The notes.\n " maxLength: 128 minLength: 0 externalAccountKey: type: - string - 'null' description: "The unique key for the external account.\n " IJsonResponseOfIListOfTransaction: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: type: - array - 'null' description: "The payload data.\n " items: $ref: '#/components/schemas/Transaction' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' IJsonResponseOfOrganizationExternalAccountv2: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/OrganizationExternalAccountv2' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' ProcessSchedule: type: object description: "The data for an organizations Process Schedule.\nProcess Schedule is a reporting tool that is used to generate agency commission statements.\nIt’s a batch process that runs daily to see when the reports should be generated and\ndetermine when a statement is generated and sent to an organization.\n " deprecated: true x-deprecatedMessage: 4.4.4 - Please use ProcessSchedulev2. additionalProperties: false properties: processScheduleId: type: integer description: "The ProcessScheduleID of ProcessSchedule.\n " format: int64 name: type: - string - 'null' description: "The Name of ProcessSchedule.\n " beginDate: type: string description: "The BeginDate of ProcessSchedule.\n " format: date-time frequencyType: description: "The FrequencyType of ProcessSchedule.\n " $ref: '#/components/schemas/FrequencyType' daysOfWeek: description: "The DaysOfWeek of ProcessSchedule.\n " $ref: '#/components/schemas/DayOfWeek' frequency: type: integer description: "The Frequency of ProcessSchedule.\n " monthDay: type: integer description: "The MonthDay of ProcessSchedule.\n " monthWeek: description: "The MonthWeek of ProcessSchedule.\n " $ref: '#/components/schemas/MonthWeek' inActive: type: boolean description: "The InActive of ProcessSchedule.\n " AllotmentContractResponse: type: object description: "The allotment contract response model\n " additionalProperties: false properties: contractCode: type: - string - 'null' description: "The Contract Code\n " description: type: - string - 'null' description: "The description\n " status: description: "The contract status\n " $ref: '#/components/schemas/AllotmentContractStatus' organizationCode: type: - string - 'null' description: "The organization code\n " discontinueDate: type: - string - 'null' description: "The discontinue date\n " format: date-time contractProperties: type: - array - 'null' description: "The contract properties\n " items: $ref: '#/components/schemas/AllotmentContractProperty' AllotmentType: type: integer description: "Specifies the allotment type.\n \n\n0 = Fixed\n1 = Prorata" x-enumNames: - Fixed - Prorata enum: - 0 - 1 IJsonResponseOfAllotmentMarketFareResponse: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/AllotmentMarketFareResponse' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' AllotmentBasisResponse: type: object description: "The allotment basis response model\n " additionalProperties: false properties: allotmentBasisCode: type: - string - 'null' description: "The allotment basis code.\n " contractCode: type: - string - 'null' description: "The contract code.\n " description: type: - string - 'null' description: "The description.\n " status: description: "The allotment basis status.\n " $ref: '#/components/schemas/AllotmentBasisStatus' allotmentType: description: "The allotment type.\n " $ref: '#/components/schemas/AllotmentType' classNest: type: integer description: "The class nest.\n " classRank: type: integer description: "The class rank.\n " latestAdvanceReservation: type: integer description: "The Latest Advance Reservation.\n " ruleTariff: type: - string - 'null' description: "The rule tariff.\n " carrierCode: type: - string - 'null' description: "The carrier code.\n " ruleNumber: type: - string - 'null' description: "The rule number.\n " fareBasisCode: type: - string - 'null' description: "The fare basis code.\n " allotmentMarketFares: type: - array - 'null' description: "The allotment market fares associated with the allotment basis.\n " items: $ref: '#/components/schemas/AllotmentMarketFareResponse' ErrorResponse: type: object description: "Defines a unique error response.\n " additionalProperties: false properties: exception: description: "The original exception that was thrown and all the exception details.\n " $ref: '#/components/schemas/Exception' rawMessage: type: - string - 'null' description: "The original raw message set (non-localized).\n " code: type: - string - 'null' description: "The unique error code. The primary value used to match against a unique message localized for the end user in the\nchosen language.\n " message: type: - string - 'null' description: "The error message. Deprecated: Please use the Code instead.\n " type: type: - string - 'null' description: "The error type showing severity. Values: Critical, Error, Validation, Information.\n " number: type: - integer - 'null' description: "A unique identifier in numeric form. This is required for Splunk logging. If none is provided a number will be\ngenerated based on code and type.\n " format: int32 maximum: 99999.0 minimum: 0.0 details: type: - object - 'null' description: "Dynamic detailed information about the error.\n " additionalProperties: type: string ActivityId: type: - string - 'null' description: "The activity ID unique to the request. Useful for debugging purposes to uniquely look up what happened for this\nspecific request.\n " ClassOfServiceType: type: integer description: "The class of service type enumeration.\n \n\n0 = Default\n1 = Normal\n2 = Discrete\n3 = NonNested\n4 = NegoAllotment\n5 = ProrataAllotment\n6 = OperatingBlockspace\n7 = MarketingBlockspace" x-enumNames: - Default - Normal - Discrete - NonNested - NegoAllotment - ProrataAllotment - OperatingBlockspace - MarketingBlockspace enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 IJsonResponseOfOrganizationCommissionRate: type: object description: "Defines the JSON response contract.\n " additionalProperties: false properties: data: description: "The payload data.\n " $ref: '#/components/schemas/OrganizationCommissionRate' errors: type: - array - 'null' description: "The collection of errors being thrown.\n " items: $ref: '#/components/schemas/ErrorResponse' messages: type: - array - 'null' description: "The collection of informational messages.\n " items: $ref: '#/components/schemas/Message' Directionality: type: integer description: "Enum representing direction of an object.\n \n\n0 = None\n1 = To\n2 = From\n3 = Between" x-enumNames: - None - To - From - Between enum: - 0 - 1 - 2 - 3 OrganizationRegisterRequest: type: object description: "The data on the organization register request.\n " additionalProperties: false required: - organizationCode properties: organizationCode: type: string description: "The organization code.\n " maxLength: 10 minLength: 2 company: description: "The company details.\n " $ref: '#/components/schemas/CompanyDetails' contact: description: "The contact details.\n " $ref: '#/components/schemas/ContactDetails' externalAccounts: type: - array - 'null' description: "External accounts.\n " items: $ref: '#/components/schemas/OrganizationExternalAccountRequest' currencyCode: type: - string - 'null' description: "The organization's currency code.\n " cultureCode: type: - string - 'null' description: "The organization's culture code.\n " FrequencyType: type: integer description: "FrequencyType Enumeration. Based on ones for SQL server scheduler, not all included.\n \n\n0 = Daily\n1 = Weekly\n2 = Monthly" x-enumNames: - Daily - Weekly - Monthly enum: - 0 - 1 - 2 CreateOrganizationAccountRequest: type: object description: "The create organization account request model.\n " additionalProperties: false properties: currencyCode: type: - string - 'null' description: "The account currency code.\n " maxLength: 3 minLength: 0 totalAmount: type: number description: "The total amount of the account.\n " format: decimal type: description: "The allowed account types for account creation.\n " $ref: '#/components/schemas/AllowedAccountTypes' note: type: - string - 'null' description: "The optional note to associate with the account creation.\n " OrganizationCreateRequest: type: object description: "The data on the organization.\n " additionalProperties: false properties: organizationCode: type: - string - 'null' description: "The organization code.\n " maxLength: 10 minLength: 2 type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " $ref: '#/components/schemas/OrganizationConfigurationv2' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: - string - 'null' description: "The parent organization code.\n " maxLength: 10 minLength: 2 statementNote: type: - string - 'null' description: "The statement note.\n " maxLength: 128 minLength: 0 lastStatementDate: type: - string - 'null' description: "The last statement date.\n " format: date-time sendNotification: type: boolean description: "Send agency activation notification.\n " externalAccounts: type: - array - 'null' description: "External accounts.\n " items: $ref: '#/components/schemas/OrganizationExternalAccountRequest' commissionRates: type: - array - 'null' description: "Commission rates.\n " items: $ref: '#/components/schemas/OrganizationCommissionRate' company: description: "The company details.\n " $ref: '#/components/schemas/CompanyDetails' contact: description: "The contact details.\n " $ref: '#/components/schemas/ContactDetails' organizationProcessSchedules: type: - array - 'null' description: "Process Schedules.\n " items: $ref: '#/components/schemas/OrganizationProcessSchedule' CompanyDetailsRecord: type: object description: "The organization company details record results.\n " additionalProperties: false required: - name properties: name: type: string description: "The organization name.\n " minLength: 1 address: description: "The address of the organization.\n " $ref: '#/components/schemas/Address' url: type: - string - 'null' description: "The website url of the organization.\n " maxLength: 2048 minLength: 0 emailAddress: type: - string - 'null' description: "The email address.\n " format: email phoneNumbers: type: - array - 'null' description: "The available phone numbers.\n " items: $ref: '#/components/schemas/PhoneNumber' OrganizationCommissionRate: type: object description: "The commission rate details of an organization.\n " additionalProperties: false properties: commissionRateCode: type: - string - 'null' description: "Commission rate code.\n " maxLength: 8 minLength: 0 directRate: type: number description: "The direct rate.\n " format: decimal gdsRate: type: number description: "The Gds rate.\n " format: decimal webRate: type: number description: "The web rate.\n " format: decimal apiRate: type: number description: "The Api rate.\n " format: decimal addOnRate: type: number description: "The add on rate.\n " format: decimal Organizationv2: type: object description: "The base data on the organization.\n " additionalProperties: false properties: organizationCode: type: - string - 'null' description: "The organization code.\n " maxLength: 10 minLength: 2 type: description: "Organization type.\n " $ref: '#/components/schemas/OrganizationType' configuration: description: "Advanced configuration values.\n " $ref: '#/components/schemas/OrganizationConfigurationv2' status: description: "The organization status.\n " $ref: '#/components/schemas/OrganizationStatus' parentOrganizationCode: type: - string - 'null' description: "The parent organization code.\n " maxLength: 10 minLength: 2 statementNote: type: - string - 'null' description: "The statement note.\n " maxLength: 128 minLength: 0 lastStatementDate: type: - string - 'null' description: "The last statement date.\n " format: date-time externalAccounts: type: - array - 'null' description: "External accounts.\n " items: $ref: '#/components/schemas/OrganizationExternalAccountv2' commissionRates: type: - array - 'null' description: "Commission rates.\n " items: $ref: '#/components/schemas/OrganizationCommissionRate' company: description: "The company details.\n " $ref: '#/components/schemas/CompanyDetails' contact: description: "The contact details.\n " $ref: '#/components/schemas/ContactDetails' organizationProcessSchedules: type: - array - 'null' description: "Process Schedules.\n " items: $ref: '#/components/schemas/OrganizationProcessSchedule' ContactEditDetails: type: object description: "The contact details for an organization.\n " additionalProperties: false properties: name: description: "The contact name.\n " $ref: '#/components/schemas/Name' securitySchemes: JWT: type: http description: Paste your JWT token from the token endpoint. scheme: bearer bearerFormat: jwt x-generator: NSwag v14.6.3.0 (NJsonSchema v11.5.2.0 (Newtonsoft.Json v13.0.0.0))