{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/openapi/reference/tag/Carrier-Experience/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/openapi/reference/tag/Carrier-Experience/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.1.0\",\"info\":{\"version\":\"1.0.0\",\"title\":\"NYSHEX External OpenAPI specification\",\"description\":\"This API provides external access to NYSHEX data. It allows users to create, read, and update information regarding bookings, contracts, statements, disputes, and other relevant data. \\n\",\"license\":{\"name\":\"Apache 2.0\",\"url\":\"http://www.apache.org/licenses/LICENSE-2.0.html\"},\"contact\":{\"name\":\"New York Shipping Exchange (NYSHEX)\",\"url\":\"https://nyshex.com/\",\"email\":\"info@NYSHEX.com\"},\"x-release-notes\":\"# Version     Date     Notes\\n# 1.0.0    2023-04-15  Initial draft\\n\"},\"servers\":[{\"url\":\"https://internal.api.staging.nyshex.com\"}],\"security\":[{\"bearerAuth\":[]}],\"paths\":{\"/version\":{\"get\":{\"summary\":\"Current running version of the microservice\",\"description\":\"Returns the current version of the microservice.\",\"operationId\":\"getVersion\",\"tags\":[\"Health\"],\"responses\":{\"200\":{\"description\":\"Service version returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/VersionDto\"}}}}}}},\"/ping.txt\":{\"get\":{\"summary\":\"Ping service\",\"description\":\"Checks for connectivity to the service by sending a ping and receiving a response in return.\",\"operationId\":\"getPing\",\"tags\":[\"Health\"],\"responses\":{\"200\":{\"description\":\"Ping returned\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}}}}}},\"/v1/bookings/save\":{\"post\":{\"summary\":\"Create or update a booking\",\"description\":\"Creates a new booking, or updates an existing booking with the listed parameters.\",\"operationId\":\"saveBooking\",\"tags\":[\"Booking\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalSaveBookingRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Booking was saved\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalSaveBookingResponseDto\"}}}}}}},\"/v1/carrier-experience/contracts/list\":{\"post\":{\"summary\":\"Contract summary list\",\"description\":\"Retrieves the summaries of the specified contract and, if any exist, all child contracts.\",\"operationId\":\"retrieveContractSummaries\",\"tags\":[\"Carrier Experience\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalContractSummaryListRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"List of contracts with performance found\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalContractSummaryListResponseDto\"}}}}}}},\"/v1/contracts/list\":{\"post\":{\"summary\":\"Request contract info by contract number\",\"description\":\"Takes a list of contract numbers and outputs the contract information for each, provided the user is authorized to access the information.\",\"operationId\":\"listContractsByContractNumbers\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessContractRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"List of contracts with found\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListContractsResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/document\":{\"post\":{\"summary\":\"Save a contract document\",\"description\":\"Saves the contract to the contract document archive.\",\"operationId\":\"contractDocumentArchive\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"contract document saved\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalContractDocumentArchiveResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/performance-reports/latest/download\":{\"post\":{\"summary\":\"Retrieve contract performance report url\",\"description\":\"This request sends the contract ID as a parameter, and downloads the most recent report for the contract's performance.\",\"operationId\":\"contractPerformance\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Contract performance report url returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalContractPerformanceReportResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/disputes/{disputeId}/comments\":{\"post\":{\"summary\":\"Create a comment on a dispute\",\"description\":\"This request sends the contract ID and dispute ID parameters, and writes a comment on the listed dispute.\",\"operationId\":\"createDisputeComment\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"disputeId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateDisputeCommentDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Comment saved\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalDisputeCommentResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/disputes/{disputeId}\":{\"post\":{\"summary\":\"Details of a dispute\",\"description\":\"Takes the contract ID and dispute ID as parameters and recalls the full information of the dispute that was raised on the contract.\",\"operationId\":\"viewDisputeDetails\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"disputeId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"dispute details returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalDisputeDetailsDto\"}}}}}}},\"/v1/contracts/{contractId}/disputes/{disputeId}/documents\":{\"post\":{\"summary\":\"Add dispute document\",\"description\":\"Saves a document to the dispute with the given contract ID and dispute ID.\",\"operationId\":\"createDisputeDocument\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"disputeId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateDisputeDocumentListDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Document Saved\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalDisputeDocumentListDto\"}}}}}}},\"/v1/contracts/{contractId}/documents/{documentId}/archive\":{\"post\":{\"summary\":\"Archive dispute document\",\"description\":\"Once a document is no longer required for a dispute, this request is used to archive the document.\",\"operationId\":\"archiveDisputeDocument\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"documentId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\"}}}},\"/v1/contracts/{contractId}/documents/{documentId}/unarchive\":{\"post\":{\"summary\":\"Unarchive dispute document\",\"description\":\"Takes the contract ID and document ID parameters as arguements and moves an archived document out of the archive and into active status.\",\"operationId\":\"unarchiveDisputeDocument\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"documentId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Document unarchived\"}}}},\"/v1/contract-performance/contracts/{contractId}/bookings/{bookingId}/history\":{\"post\":{\"summary\":\"Retrieve contract booking history\",\"description\":\"Takes the contract ID and booking ID as parameters and returns the booking history of the listed contract, if successful. If the request is not successful, it returns an error.\",\"operationId\":\"describeBookingHistory\",\"tags\":[\"Contract Performance\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"bookingId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Booking history found\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBookingHistoryResponseDto\"}}}}}}},\"/v1/contract-performance/contracts/{contractId}/bookings/{bookingId}/details\":{\"post\":{\"summary\":\"Retrieve booking details\",\"description\":\"Lists the full booking details of the contract.\",\"operationId\":\"describeBookingDetails\",\"tags\":[\"Contract Performance\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"bookingId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Booking details returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBookingDetailsResponseDto\"}}}}}}},\"/v1/contract-performance/contracts/{contractId}/bookings\":{\"post\":{\"summary\":\"List bookings by contract ID\",\"description\":\"Returns a list of all bookings connected to the contract ID.\",\"operationId\":\"contractBookingsByContractId\",\"tags\":[\"Contract Performance\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessContractBookingsRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Users full list of bookings by contract returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalContractBookingsResponseDto\"}}}}}}},\"/v1/contract-performance/contracts/{contractId}/locked-in-lanes\":{\"post\":{\"summary\":\"Retrieve locked in lanes page details\",\"description\":\"Retrieves the details for why a contract is locked-in lanes.\",\"operationId\":\"contractLockedInLanes\",\"tags\":[\"Contract Performance\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Locked in lanes details returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalContractLockedInLanesResponseDto\"}}}}}}},\"/v1/contract-performance/contracts/{contractId}/performance\":{\"post\":{\"summary\":\"Performance summary details\",\"description\":\"Returns a summary about the contracts carrier, booking, shipping, and delivery information.\",\"tags\":[\"Contract Performance\"],\"operationId\":\"describePerformance\",\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Performance summary details returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalPerformanceResponseDto\"}}}}}}},\"/v1/equipment/save\":{\"post\":{\"summary\":\"Save equipment\",\"description\":\"Saves the selected equipment as a booking request.\",\"operationId\":\"equipmentRequestDto\",\"tags\":[\"Equipment\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalSaveEquipmentRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Equipment saved\"}}}},\"/v1/disputes/disputes-by-status\":{\"post\":{\"summary\":\"Paginated disputes list\",\"description\":\"Returns a list of all disputes. The list can also be filtered by dispute status using the -s flag.\",\"operationId\":\"listDisputesByStatus\",\"tags\":[\"Disputes\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListDisputesByStatusRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"disputes returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListDisputesByStatusResponseDto\"}}}}}}},\"/v1/disputes/my-disputes-penalties\":{\"post\":{\"summary\":\"Dispute penalties list\",\"description\":\"Retrieves a list of the penalties incurred due to the dispute.\",\"operationId\":\"viewAllDisputePenaltiesByIds\",\"tags\":[\"Disputes\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalDisputePenaltiesListRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"List of penalties returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalDisputePenaltiesListResponseDto\"}}}}}}},\"/v1/disputes\":{\"post\":{\"summary\":\"User disputes list\",\"description\":\"Lists all disputes for the authenticated user.\",\"operationId\":\"viewDisputes\",\"tags\":[\"Disputes\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListDisputesRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"disputes returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListDisputesDto\"}}}}}}},\"/v1/contracts/{contractId}/disputes/create\":{\"post\":{\"summary\":\"Create contract dispute\",\"description\":\"Adds an dispute to the contract ID by passing through the relevant contract ID.\",\"operationId\":\"createDispute\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateDisputeDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"dispute created\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateDisputeResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/statements/{statementId}\":{\"post\":{\"summary\":\"Statement details\",\"description\":\"Returns a list of all details (status, carrier, start date, end date, etc.) of the requested statement.\",\"operationId\":\"describeStatement\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"statementId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the requested statement.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Statement details returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalDescribeStatementResponseDto\"}}}}}}},\"/v1/statements\":{\"post\":{\"summary\":\"Statements list\",\"description\":\"This operation returns a list of statements for the authenticated user\",\"operationId\":\"listStatements\",\"tags\":[\"Statement\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"List of statements returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListStatementsResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/statements/{statementId}/comment\":{\"post\":{\"summary\":\"Create comment on a statement\",\"description\":\"Creates a comment that is attached to the provided statement ID.\",\"operationId\":\"createComment\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"statementId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the requested statement.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateStatementCommentRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Comment created on statement\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateStatementCommentResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/statements/{statementId}/comments\":{\"post\":{\"summary\":\"Statement comments list\",\"description\":\"This request returns a list of all comments on the provided statement ID.\",\"operationId\":\"listStatementComments\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"statementId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the requested statement.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Statement comments returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListStatementCommentResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/statements/{statementId}/attachment\":{\"post\":{\"summary\":\"Create statement attachment\",\"description\":\"Adds one or more attachments to the requested statement.\",\"operationId\":\"createAttachment\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"statementId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the requested statement.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalCreateAttachmentListRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Attachment saved to statement\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListAttachmentsResponseDto\"}}}}}}},\"/v1/contracts/{contractId}/statements/{statementId}/attachments\":{\"post\":{\"summary\":\"Statement attachments list\",\"description\":\"Returns a list of attachments that have been saved to the requested statement.\",\"operationId\":\"listAttachments\",\"tags\":[\"Contract\"],\"parameters\":[{\"name\":\"contractId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the contract.\"}},{\"name\":\"statementId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"description\":\"The ID of the requested statement.\"}},{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Statement attachments returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListAttachmentsResponseDto\"}}}}}}},\"/v1/statements/paginated\":{\"post\":{\"summary\":\"User statements list\",\"description\":\"Returns a list of all user statements in a paginated format.\",\"operationId\":\"listStatementsPaginated\",\"tags\":[\"Statement\"],\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessListStatementsRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Statements returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalListStatementsPaginatedResponseDto\"}}}}}}},\"/v1/statements/penalty/summary\":{\"post\":{\"summary\":\"Overall statements penalty summary\",\"description\":\"Returns a summary of all penalties or compensation assessed on all statements.\",\"tags\":[\"Statement\"],\"operationId\":\"describeStatementsPenaltySummary\",\"parameters\":[{\"name\":\"x-api-key\",\"in\":\"header\",\"required\":true,\"description\":\"The API Key.\",\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"Statement penalty summary returned\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExternalStatementsPenaltySummaryResponseDto\"}}}}}}}},\"components\":{\"schemas\":{\"Instant\":{\"type\":\"object\",\"properties\":{}},\"VersionDto\":{\"type\":\"object\",\"properties\":{\"group\":{\"type\":\"string\"},\"artifact\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"version\":{\"type\":\"string\"},\"time\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"BigDecimal\":{\"type\":\"object\",\"properties\":{}},\"BookingEquipmentDto\":{\"type\":\"object\",\"properties\":{\"containerType\":{\"type\":\"string\"},\"quantity\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalSaveBookingRequestDto\":{\"type\":\"object\",\"properties\":{\"requestId\":{\"type\":\"string\"},\"source\":{\"type\":\"string\"},\"carrierId\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookingNumber\":{\"type\":\"string\"},\"validFrom\":{\"$ref\":\"#/components/schemas/Instant\"},\"notes\":{\"type\":\"string\"},\"status\":{\"type\":\"string\",\"enum\":[\"PENDING\",\"CONFIRMED\",\"CANCELED\"]},\"contractNumber\":{\"type\":\"string\"},\"size\":{\"type\":\"string\"},\"gateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"shippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"teu\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"equipment\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/BookingEquipmentDto\"}},\"placeOfReceipt\":{\"type\":\"string\"},\"portOfLoad\":{\"type\":\"string\"},\"portOfDischarge\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"confirmedAt\":{\"$ref\":\"#/components/schemas/Instant\"},\"confirmedAtIfEarlier\":{\"$ref\":\"#/components/schemas/Instant\"},\"confirmedAtOnCreate\":{\"$ref\":\"#/components/schemas/Instant\"},\"weight\":{\"type\":\"integer\",\"format\":\"int32\"},\"portCut\":{\"$ref\":\"#/components/schemas/Instant\"},\"proformaDeparture\":{\"$ref\":\"#/components/schemas/Instant\"},\"reasonCode\":{\"type\":\"string\"},\"nvoBookingReferences\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"namedAccount\":{\"type\":\"string\"},\"customerReference\":{\"type\":\"string\"},\"adhocData\":{\"type\":\"string\"}}},\"ExternalSaveBookingResponseDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"action\":{\"type\":\"string\",\"enum\":[\"CREATE\",\"UPDATE\",\"NO_UPDATE\"]}}},\"ExternalBusinessRequestDto\":{\"type\":\"object\",\"properties\":{\"contractNumbers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"requestId\":{\"type\":\"string\"}}},\"ExternalContractSummaryListRequestDto\":{\"type\":\"object\",\"properties\":{\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalContractBusinessDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"name\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"logoImageUrl\":{\"type\":\"string\"}}},\"ExternalContractPerformanceSummaryDto\":{\"type\":\"object\",\"properties\":{\"mqc\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"performance\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"shipped\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"split\":{\"type\":\"number\",\"format\":\"double\"},\"threshold\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalContractSummaryItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"shipperId\":{\"type\":\"string\",\"format\":\"uuid\"},\"carrierId\":{\"type\":\"string\",\"format\":\"uuid\"},\"counterparty\":{\"$ref\":\"#/components/schemas/ExternalContractBusinessDto\"},\"contractNumber\":{\"type\":\"string\"},\"contractSubType\":{\"type\":\"string\"},\"shipperReference\":{\"type\":\"string\"},\"effectiveDate\":{\"type\":\"string\",\"format\":\"date\"},\"expirationDate\":{\"type\":\"string\",\"format\":\"date\"},\"isActive\":{\"type\":\"boolean\"},\"contractUrl\":{\"type\":\"string\"},\"performance\":{\"$ref\":\"#/components/schemas/ExternalContractPerformanceSummaryDto\"},\"fakPerformance\":{\"$ref\":\"#/components/schemas/ExternalContractPerformanceSummaryDto\"},\"namedAccountPerformance\":{\"$ref\":\"#/components/schemas/ExternalContractPerformanceSummaryDto\"}}},\"ExternalContractSummaryDto\":{\"type\":\"object\",\"properties\":{\"contractSummary\":{\"$ref\":\"#/components/schemas/ExternalContractSummaryItemDto\"},\"namedAccounts\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalContractSummaryItemDto\"}}}},\"ExternalContractSummaryListResponseDto\":{\"type\":\"object\",\"properties\":{\"contractSummaries\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalContractSummaryDto\"}}}},\"ExternalBusinessContractRequestDto\":{\"type\":\"object\",\"properties\":{\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"},\"page\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalListContractItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"carrierId\":{\"type\":\"string\",\"format\":\"uuid\"},\"shipperId\":{\"type\":\"string\",\"format\":\"uuid\"},\"contractNumber\":{\"type\":\"string\"},\"effective\":{\"type\":\"string\",\"format\":\"date\"},\"expiration\":{\"type\":\"string\",\"format\":\"date\"},\"contractTermsType\":{\"type\":\"string\"},\"shipperName\":{\"type\":\"string\"},\"carrierName\":{\"type\":\"string\"},\"isActive\":{\"type\":\"boolean\"}}},\"ExternalListContractsResponseDto\":{\"type\":\"object\",\"properties\":{\"contracts\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalListContractItemDto\"}},\"page\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalContractDocumentArchiveResponseDto\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"},\"extension\":{\"type\":\"string\"}}},\"ExternalContractPerformanceReportResponseDto\":{\"type\":\"object\",\"properties\":{\"url\":{\"type\":\"string\"}}},\"ExternalBookingHistoryEventDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookingId\":{\"type\":\"string\",\"format\":\"uuid\"},\"created\":{\"$ref\":\"#/components/schemas/Instant\"},\"departure\":{\"$ref\":\"#/components/schemas/Instant\"},\"vessel\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"}}},\"ExternalBookingHistoryResponseDto\":{\"type\":\"object\",\"properties\":{\"events\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalBookingHistoryEventDto\"}}}},\"ExternalEquipmentDetailsDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"equipmentNumber\":{\"type\":\"string\"},\"size\":{\"type\":\"string\"},\"teu\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"gateOut\":{\"$ref\":\"#/components/schemas/Instant\"},\"gateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"shippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"weight\":{\"type\":\"integer\",\"format\":\"int32\"},\"adhocData\":{\"type\":\"string\"}}},\"ExternalBookingDetailsResponseDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookingNumber\":{\"type\":\"string\"},\"nvoBookingReferences\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"contractNumber\":{\"type\":\"string\"},\"carrierId\":{\"type\":\"string\",\"format\":\"uuid\"},\"placeOfReceipt\":{\"type\":\"string\"},\"portOfLoad\":{\"type\":\"string\"},\"portOfDischarge\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"size\":{\"type\":\"string\"},\"teu\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"equipmentTeu\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"equipmentTeuGatedOut\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"equipmentTeuGatedIn\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"teuRequested\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"confirmedAt\":{\"$ref\":\"#/components/schemas/Instant\"},\"gateOut\":{\"$ref\":\"#/components/schemas/Instant\"},\"gateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"initialShippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"shippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"initialVessel\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"initialVoyage\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"serviceCode\":{\"type\":\"string\"},\"weight\":{\"type\":\"integer\",\"format\":\"int32\"},\"portCut\":{\"$ref\":\"#/components/schemas/Instant\"},\"proformaDeparture\":{\"$ref\":\"#/components/schemas/Instant\"},\"namedAccount\":{\"type\":\"string\"},\"adhocData\":{\"type\":\"string\"},\"equipment\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalEquipmentDetailsDto\"}},\"status\":{\"type\":\"string\"},\"customerReference\":{\"type\":\"string\"}}},\"ExternalContractBookingsQueryParams\":{\"type\":\"object\",\"properties\":{\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"sortBy\":{\"type\":\"string\"},\"direction\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"},\"search\":{\"type\":\"string\"}}},\"ExternalBusinessContractBookingsRequestDto\":{\"type\":\"object\",\"properties\":{\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"},\"queryParams\":{\"$ref\":\"#/components/schemas/ExternalContractBookingsQueryParams\"}}},\"ExternalBookingListItemDto\":{\"type\":\"object\",\"properties\":{\"bookingId\":{\"type\":\"string\",\"format\":\"uuid\"},\"requestId\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookingNumber\":{\"type\":\"string\"},\"nvoBookingReferences\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"placeOfReceipt\":{\"type\":\"string\"},\"portOfLoad\":{\"type\":\"string\"},\"portOfDischarge\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"requestedAt\":{\"$ref\":\"#/components/schemas/Instant\"},\"confirmedAt\":{\"$ref\":\"#/components/schemas/Instant\"},\"gateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"bookingGateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"equipmentGateOut\":{\"$ref\":\"#/components/schemas/Instant\"},\"equipmentGateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"shippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"initialShippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"bookingShippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"equipmentShippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"size\":{\"type\":\"string\"},\"teuRequested\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"teu\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"teuConfirmed\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"teuGatedOut\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"teuGatedIn\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"teuShipped\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"status\":{\"type\":\"string\"},\"initialVessel\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"initialVoyage\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"serviceCode\":{\"type\":\"string\"},\"weight\":{\"type\":\"integer\",\"format\":\"int32\"},\"portCut\":{\"$ref\":\"#/components/schemas/Instant\"},\"proformaDeparture\":{\"$ref\":\"#/components/schemas/Instant\"},\"namedAccount\":{\"type\":\"string\"},\"adhocData\":{\"type\":\"string\"},\"equipmentPendingMovement\":{\"type\":\"integer\",\"format\":\"int32\"},\"equipmentOutsideReportingPeriod\":{\"type\":\"integer\",\"format\":\"int32\"},\"equipmentWithinReportingPeriod\":{\"type\":\"integer\",\"format\":\"int32\"},\"customerReference\":{\"type\":\"string\"}}},\"ExternalContractBookingsResponseDto\":{\"type\":\"object\",\"properties\":{\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookings\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalBookingListItemDto\"}},\"currentPage\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalPages\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalItems\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalLockedInLanesItemDto\":{\"type\":\"object\",\"properties\":{\"lastUpdated\":{\"$ref\":\"#/components/schemas/Instant\"},\"data\":{\"type\":\"array\",\"items\":{\"type\":\"array\"}}}},\"ExternalContractLockedInLanesResponseDto\":{\"type\":\"object\",\"properties\":{\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"lockedInLanes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalLockedInLanesItemDto\"}}}},\"ExternalPerformanceListItemDto\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"mqc\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"performance\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalPerformanceResponseDto\":{\"type\":\"object\",\"properties\":{\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"name\":{\"type\":\"string\"},\"contractNumber\":{\"type\":\"string\"},\"carrierId\":{\"type\":\"string\",\"format\":\"uuid\"},\"performance\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalPerformanceListItemDto\"}}}},\"ExternalSaveEquipmentRequestDto\":{\"type\":\"object\",\"properties\":{\"requestId\":{\"type\":\"string\"},\"source\":{\"type\":\"string\"},\"carrierId\":{\"type\":\"string\",\"format\":\"uuid\"},\"equipmentNumber\":{\"type\":\"string\"},\"bookingNumber\":{\"type\":\"string\"},\"containerType\":{\"type\":\"string\"},\"teu\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"weight\":{\"type\":\"integer\",\"format\":\"int32\"},\"adhocData\":{\"type\":\"string\"},\"gateOut\":{\"$ref\":\"#/components/schemas/Instant\"},\"gateIn\":{\"$ref\":\"#/components/schemas/Instant\"},\"gateInIfEarlier\":{\"$ref\":\"#/components/schemas/Instant\"},\"shippedOnBoard\":{\"$ref\":\"#/components/schemas/Instant\"},\"shippedOnBoardIfEarlier\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"ExternalCreateDisputeCommentDto\":{\"type\":\"object\",\"properties\":{\"comment\":{\"type\":\"string\"},\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalDisputeCommentResponseDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"disputeId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submittedByBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submittedByBusinessName\":{\"type\":\"string\"},\"comment\":{\"type\":\"string\"},\"created\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"NyshexMoney\":{\"type\":\"object\",\"properties\":{\"value\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"fractionDigits\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalExceptionPenaltyDto\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"penaltyPerTeu\":{\"$ref\":\"#/components/schemas/NyshexMoney\"},\"carrierTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"shipperTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"penaltyTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalDisputeBusinessDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"name\":{\"type\":\"string\"}}},\"ExternalDisputeDocumentDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"name\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"submittedByBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submittedByBusinessName\":{\"type\":\"string\"},\"created\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"ExternalDisputeDetailsDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"exceptionReference\":{\"type\":\"string\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"contractNumber\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"},\"disputeReason\":{\"type\":\"string\"},\"subReason\":{\"type\":\"string\"},\"eventDate\":{\"type\":\"string\",\"format\":\"date\"},\"submittedByBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submitted\":{\"$ref\":\"#/components/schemas/Instant\"},\"teuCount\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"vessel\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"bookingNumber\":{\"type\":\"string\"},\"placeOfReceipt\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"hidden\":{\"type\":\"boolean\"},\"excused\":{\"type\":\"boolean\"},\"excusedReason\":{\"type\":\"string\"},\"excusedSubReason\":{\"type\":\"string\"},\"penalties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalExceptionPenaltyDto\"}},\"carrierBusiness\":{\"$ref\":\"#/components/schemas/ExternalDisputeBusinessDto\"},\"shipperBusiness\":{\"$ref\":\"#/components/schemas/ExternalDisputeBusinessDto\"},\"documents\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalDisputeDocumentDto\"}},\"comments\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalDisputeCommentResponseDto\"}}}},\"ExternalCreateDisputeDocumentRequestDto\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\"},\"base64EncodedFile\":{\"type\":\"string\"}}},\"ExternalCreateDisputeDocumentListDto\":{\"type\":\"object\",\"properties\":{\"documents\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalCreateDisputeDocumentRequestDto\"}},\"businessInfo\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalDisputeDocumentListDto\":{\"type\":\"object\",\"properties\":{\"documents\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalDisputeDocumentDto\"}}}},\"ExternalFilter\":{\"type\":\"object\",\"properties\":{\"carrierIds\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uuid\"}},\"shipperIds\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uuid\"}},\"status\":{\"type\":\"string\"},\"exceptionReference\":{\"type\":\"string\"},\"contractNumber\":{\"type\":\"string\"},\"bookingNumber\":{\"type\":\"string\"},\"placeOfReceipt\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"hidden\":{\"type\":\"boolean\"},\"contractNumbers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ExternalListDisputesByStatusRequestDto\":{\"type\":\"object\",\"properties\":{\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"},\"status\":{\"type\":\"string\"},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"sortBy\":{\"type\":\"string\"},\"direction\":{\"type\":\"string\"},\"filter\":{\"$ref\":\"#/components/schemas/ExternalFilter\"}}},\"ExternalListDisputesByStatusItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"exceptionReference\":{\"type\":\"string\"},\"eventDate\":{\"type\":\"string\",\"format\":\"date\"},\"status\":{\"type\":\"string\"},\"disputeReason\":{\"type\":\"string\"},\"carrierName\":{\"type\":\"string\"},\"shipperName\":{\"type\":\"string\"},\"responsiblePartyName\":{\"type\":\"string\"},\"contractNumber\":{\"type\":\"string\"},\"teuCount\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"bookingNumber\":{\"type\":\"string\"},\"submitted\":{\"$ref\":\"#/components/schemas/Instant\"},\"placeOfReceipt\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"hidden\":{\"type\":\"boolean\"},\"excused\":{\"type\":\"boolean\"},\"excusedReason\":{\"type\":\"string\"},\"excusedSubReason\":{\"type\":\"string\"},\"penalties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalExceptionPenaltyDto\"}},\"submittedByBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"counterpartyName\":{\"type\":\"string\"},\"subReason\":{\"type\":\"string\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"}}},\"ExternalListDisputesByStatusResponseDto\":{\"type\":\"object\",\"properties\":{\"disputes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalListDisputesByStatusItemDto\"}},\"currentPage\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalPages\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalItems\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalDisputePenaltiesListRequestDto\":{\"type\":\"object\",\"properties\":{\"exceptionIds\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uuid\"}},\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalDisputePenaltiesListItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"responsiblePartyName\":{\"type\":\"string\"},\"responsibleParty\":{\"type\":\"string\"},\"teuCount\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"excused\":{\"type\":\"boolean\"},\"penalties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalExceptionPenaltyDto\"}}}},\"ExternalDisputePenaltiesListResponseDto\":{\"type\":\"object\",\"properties\":{\"disputes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalDisputePenaltiesListItemDto\"}}}},\"ExternalListDisputesRequestDto\":{\"type\":\"object\",\"properties\":{\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"}}},\"ExternalDisputeListItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"exceptionReference\":{\"type\":\"string\"},\"disputeReason\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"penalties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalExceptionPenaltyDto\"}},\"status\":{\"type\":\"string\"},\"teuCount\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"contractNumber\":{\"type\":\"string\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookingNumber\":{\"type\":\"string\"},\"placeOfReceipt\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"submitted\":{\"$ref\":\"#/components/schemas/Instant\"},\"responsibleParty\":{\"type\":\"string\"}}},\"ExternalListDisputesDto\":{\"type\":\"object\",\"properties\":{\"disputes\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalDisputeListItemDto\"}}}},\"ExternalCreateDisputeDto\":{\"type\":\"object\",\"properties\":{\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"reason\":{\"type\":\"string\"},\"subReason\":{\"type\":\"string\"},\"eventDate\":{\"type\":\"string\",\"format\":\"date\"},\"description\":{\"type\":\"string\"},\"teuCount\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"bookingNumber\":{\"type\":\"string\"},\"placeOfReceipt\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"documents\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalCreateDisputeDocumentRequestDto\"}},\"voyage\":{\"type\":\"string\"},\"penalties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalExceptionPenaltyDto\"}},\"businessInfo\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalCreateDisputeResponseDto\":{\"type\":\"object\",\"properties\":{\"disputeId\":{\"type\":\"string\",\"format\":\"uuid\"}}},\"ExternalStatementPenaltyDefaultDto\":{\"type\":\"object\",\"properties\":{\"carrierDefault\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"carrierDefaultTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"shipperDefault\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"shipperDefaultTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"netPenalties\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"totalTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalExceptionCompensationDto\":{\"type\":\"object\",\"properties\":{\"penaltyCompensation\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"penaltyCompensationTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalStatementExceptionDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"exceptionReference\":{\"type\":\"string\"},\"disputeReason\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"vessel\":{\"type\":\"string\"},\"voyage\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"},\"teuCount\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"contractNumber\":{\"type\":\"string\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"bookingNumber\":{\"type\":\"string\"},\"placeOfReceipt\":{\"type\":\"string\"},\"placeOfDelivery\":{\"type\":\"string\"},\"submitted\":{\"$ref\":\"#/components/schemas/Instant\"},\"responsibleParty\":{\"type\":\"string\"},\"exceptionCompensation\":{\"$ref\":\"#/components/schemas/ExternalExceptionCompensationDto\"}}},\"ExternalDescribeStatementResponseDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"reference\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"contractNumber\":{\"type\":\"string\"},\"carrierBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"shipperBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"startDate\":{\"type\":\"string\",\"format\":\"date\"},\"endDate\":{\"type\":\"string\",\"format\":\"date\"},\"additionalInformation\":{\"type\":\"string\"},\"exceptionsIds\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uuid\"}},\"penaltyDefault\":{\"$ref\":\"#/components/schemas/ExternalStatementPenaltyDefaultDto\"},\"exceptions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalStatementExceptionDto\"}},\"dateIssued\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"ExternalListStatementPenaltyDto\":{\"type\":\"object\",\"properties\":{\"penaltyPerTeu\":{\"$ref\":\"#/components/schemas/NyshexMoney\"},\"carrierTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"shipperTeus\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalListStatementItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"reference\":{\"type\":\"string\"},\"contractNumber\":{\"type\":\"string\"},\"contractId\":{\"type\":\"string\",\"format\":\"uuid\"},\"carrierBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"shipperBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"startDate\":{\"type\":\"string\",\"format\":\"date\"},\"endDate\":{\"type\":\"string\",\"format\":\"date\"},\"status\":{\"type\":\"string\"},\"penaltyDefault\":{\"$ref\":\"#/components/schemas/ExternalStatementPenaltyDefaultDto\"},\"penalties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalListStatementPenaltyDto\"}},\"exceptionsIds\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"format\":\"uuid\"}}}},\"ExternalListStatementsResponseDto\":{\"type\":\"object\",\"properties\":{\"statements\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalListStatementItemDto\"}}}},\"ExternalCreateStatementCommentRequestDto\":{\"type\":\"object\",\"properties\":{\"comment\":{\"type\":\"string\"},\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalCreateStatementCommentResponseDto\":{\"type\":\"object\",\"properties\":{\"comment\":{\"type\":\"string\"},\"businessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submittedByBusinessName\":{\"type\":\"string\"},\"created\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"ExternalStatementCommentListItemDto\":{\"type\":\"object\",\"properties\":{\"comment\":{\"type\":\"string\"},\"businessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submittedByBusinessName\":{\"type\":\"string\"},\"created\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"ExternalListStatementCommentResponseDto\":{\"type\":\"object\",\"properties\":{\"comments\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalStatementCommentListItemDto\"}}}},\"ExternalCreateAttachmentDto\":{\"type\":\"object\",\"properties\":{\"fileName\":{\"type\":\"string\"},\"base64EncodedFile\":{\"type\":\"string\"}}},\"ExternalCreateAttachmentListRequestDto\":{\"type\":\"object\",\"properties\":{\"attachments\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalCreateAttachmentDto\"}},\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"}}},\"ExternalListAttachmentsListItemDto\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"format\":\"uuid\"},\"fileName\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"submittedByBusinessId\":{\"type\":\"string\",\"format\":\"uuid\"},\"submittedByBusinessName\":{\"type\":\"string\"},\"created\":{\"$ref\":\"#/components/schemas/Instant\"}}},\"ExternalListAttachmentsResponseDto\":{\"type\":\"object\",\"properties\":{\"attachments\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalListAttachmentsListItemDto\"}}}},\"ExternalFilterDto\":{\"type\":\"object\",\"properties\":{\"status\":{\"type\":\"string\"},\"statementId\":{\"type\":\"string\",\"format\":\"uuid\"},\"contractNumber\":{\"type\":\"string\"},\"startDateFrom\":{\"type\":\"string\",\"format\":\"date\"},\"startDateTo\":{\"type\":\"string\",\"format\":\"date\"},\"endDateFrom\":{\"type\":\"string\",\"format\":\"date\"},\"endDateTo\":{\"type\":\"string\",\"format\":\"date\"},\"reference\":{\"type\":\"string\"},\"counterPartyId\":{\"type\":\"string\",\"format\":\"uuid\"},\"contractNumbers\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"ExternalListStatementsQueryParams\":{\"type\":\"object\",\"properties\":{\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"sortBy\":{\"type\":\"string\"},\"direction\":{\"type\":\"string\"},\"filter\":{\"$ref\":\"#/components/schemas/ExternalFilterDto\"}}},\"ExternalBusinessListStatementsRequestDto\":{\"type\":\"object\",\"properties\":{\"businessRequest\":{\"$ref\":\"#/components/schemas/ExternalBusinessRequestDto\"},\"queryParams\":{\"$ref\":\"#/components/schemas/ExternalListStatementsQueryParams\"}}},\"ExternalListStatementsPaginatedResponseDto\":{\"type\":\"object\",\"properties\":{\"statements\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalListStatementItemDto\"}},\"currentPage\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalPages\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalItems\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"ExternalStatementsPenaltyDto\":{\"type\":\"object\",\"properties\":{\"total\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"decision\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"disputed\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalStatementsPenaltyClosedDto\":{\"type\":\"object\",\"properties\":{\"compensationCollected\":{\"$ref\":\"#/components/schemas/BigDecimal\"},\"penaltyPaid\":{\"$ref\":\"#/components/schemas/BigDecimal\"}}},\"ExternalStatementsPenaltySummaryResponseDto\":{\"type\":\"object\",\"properties\":{\"compensationToBeCollected\":{\"$ref\":\"#/components/schemas/ExternalStatementsPenaltyDto\"},\"penaltyToBePaid\":{\"$ref\":\"#/components/schemas/ExternalStatementsPenaltyDto\"},\"closedStatements\":{\"$ref\":\"#/components/schemas/ExternalStatementsPenaltyClosedDto\"}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"section\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Node.js\"},{\"lang\":\"Python\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/openapi/reference/overview/","redocItemId":"tag/Carrier-Experience","redocHasInfoPage":false,"settings":{"pagination":"section","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Node.js"},{"lang":"Python"}]}},"requestLogin":false,"lastModified":"2023-07-09T17:57:24.000Z"},"seo":{"title":"Carrier Experience"}}},"pageContext":{"id":"30d9e639-62fb-5ee0-959d-dbb56609c363tag/Carrier-Experience/__redocly content/openapi/reference/tag/Carrier-Experience/","seo":{"title":"Carrier Experience","description":"","image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"openapi/reference.page.yaml#tag/Carrier-Experience/","pageBaseUrl":"/openapi/reference","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/openapi/reference/tag/Carrier-Experience/","sidebarName":"training","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"external-services","id":"external-services","title":"external-services","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}