{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Stedi Core Schemas", "definitions": { "AccessDeniedExceptionResponseContent": { "type": "object", "description": "The server response for authorization failure.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "Artifact": { "type": "object", "properties": { "artifactType": { "$ref": "#/components/schemas/ArtifactType" }, "usage": { "$ref": "#/components/schemas/ArtifactUsage" }, "sizeBytes": { "type": "number", "description": "The size of the artifact in bytes." }, "url": { "type": "string", "description": "A URL to download the artifact." }, "model": { "$ref": "#/components/schemas/ArtifactModel" } }, "required": [ "artifactType", "model", "sizeBytes", "url", "usage" ] }, "ArtifactModel": { "type": "string", "description": "The model of the artifact, which indicates the type of process or operation it represents. For example, an execution artifact represents a file that was processed, a fragment artifact represents a part of a larger transaction, and a fault artifact represents an error that occurred during processing.", "enum": [ "execution", "fragment", "transaction", "fault" ] }, "ArtifactType": { "type": "string", "description": "The format of the artifact.", "enum": [ "text/csv", "application/edifact", "application/filepart", "application/json", "application/pdf", "text/psv", "text/tsv", "application/edi-x12", "application/xml", "application/zip", "image/jpeg", "image/png", "image/tiff", "text/plain", "unknown" ] }, "ArtifactUsage": { "type": "string", "description": "The type of data the artifact contains. For example, an input artifact represents the original data Stedi received before processing, while an output artifact represents the processed data.\n\nFor example, for an inbound 835 ERA from a payer, the input artifact would be the original X12 EDI, and the output artifact would be the JSON representation of the ERA.", "enum": [ "attachment", "input", "metadata", "output" ] }, "BadRequestExceptionResponseContent": { "type": "object", "description": "The server cannot process the request due to an apparent client error.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "BusinessIdentifier": { "type": "object", "properties": { "elementId": { "type": "string", "description": "The identifier of the element containing the business identifier in the EDI specification." }, "element": { "type": "string", "description": "The element where the business identifier was found. For example, `BHT03` for 837 claims." }, "name": { "type": "string", "description": "The friendly name of the business identifier. For example, `Originator Application Transaction Identifier`." }, "value": { "type": "string", "description": "The value of the business identifier." } }, "required": [ "element", "elementId", "name", "value" ] }, "CoreCharacterSet": { "type": "string", "description": "When generating EDI, the character set determines the set of characters allowed in the EDI message. Characters outside of the specified set (after applying any repairs specified in RepairOptions) will result in an error.", "enum": [ "Basic", "Extended", "ExtendedHipaa" ] }, "CoreConnectionType": { "type": "string", "description": "The type of connection used for file delivery.", "enum": [ "BUCKET", "AS2", "STEDI_FTP", "REMOTE_FTP", "STEDI_ACCOUNT_FTP" ] }, "CreateOutboundFragmentRequestContent": { "type": "object", "properties": { "guideId": { "type": "string", "description": "The ID of the Stedi guide for the outbound transaction setting. The guide must be configured to use fragments. You can find this ID on the **Guides** page in the Stedi portal." }, "fragment": { "description": "The fragment to stage for outbound delivery. Without a mapping, the fragment must be < 5MB and the shape must match the Guide JSON format for the specified guide. With a mapping, the fragment must be < 4MB and the shape must match the source schema of the specified mapping." }, "mappingId": { "type": "string", "description": "Specify a mapping id to transform the fragment to Stedi's Guide JSON format." } }, "required": [ "fragment", "guideId" ] }, "CreateOutboundFragmentResponseContent": { "type": "object", "properties": { "fragmentGroupId": { "type": "string", "description": "The fragment group ID where you created and added the fragment." }, "createdAt": { "type": "string", "description": "The time Stedi created the fragment.", "format": "date-time" }, "fragmentId": { "type": "string", "description": "A unique ID for the fragment Stedi created within the fragment group." } }, "required": [ "createdAt", "fragmentGroupId", "fragmentId" ] }, "CreatePartnershipOutboundTransactionRequestContent": { "type": "object", "properties": { "characterSet": { "$ref": "#/components/schemas/CoreCharacterSet" }, "repairOptions": { "$ref": "#/components/schemas/RepairOptions" }, "transaction": { "description": "The data for an EDI transaction. If you are not using a mapping, this transaction data must be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format for the specified outbound transaction setting. If you are using a mapping, this transaction data must be < 4MB and the shape must match the source schema for the specified mapping." }, "filename": { "type": "string", "maxLength": 300, "minLength": 1, "pattern": "^([a-zA-Z0-9.*'()!_-]+)$", "description": "Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using the same ID generated for the `fileExecutionId`." }, "fragmentGroupIds": { "type": "array", "items": { "type": "string" }, "maxItems": 1, "minItems": 1, "description": "Specify the fragment groups to include when creating this transaction. You can only generate EDI with a fragment group once. After you include a fragment group in generation call, Stedi locks the fragment to prevent accidentally generating transactions with duplicate data." }, "mappingId": { "type": "string", "description": "Specify a mapping ID to transform the transaction data to Guide JSON format. You can find the mapping ID on the [Mappings](https://www.stedi.com/app/mappings) page in the Stedi portal." }, "interchangeOverrides": { "$ref": "#/components/schemas/InterchangeOverrides" } }, "required": [ "transaction" ] }, "CreatePartnershipOutboundTransactionResponseContent": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "This property is currently not supported. It is reserved for future use." }, "fileExecutionId": { "type": "string", "description": "An ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for the generated file in the Stedi portal, and you can use it to trace the file's status and delivery." } } }, "CreateTransactionGroupRequestContent": { "type": "object", "properties": { "transaction": { "description": "The data for an EDI transaction. If you are not using a mapping, this transaction data must be < 5MB and the shape should match the [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format for the specified outbound transaction setting. If you are using a mapping, this transaction data must be < 4MB and the shape must match the source schema for the specified mapping. Either `transaction` or `async: true` is required." }, "mappingId": { "type": "string", "description": "Specify a mapping id to transform the transaction to Stedi's Guide JSON format. Can not be used with async: true." }, "groupOverrides": { "$ref": "#/components/schemas/TransactionGroupOverrides" }, "async": { "type": "boolean", "description": "Determines if the transaction should be uploaded asynchronously through a presigned url. Either `transaction` or `async: true` is required. Idempotency-Key header is required when using async: true." } } }, "CreateTransactionGroupResponseContent": { "type": "object", "properties": { "transactionGroupId": { "type": "string", "description": "The transaction group ID where you created and added the transaction." }, "createdAt": { "type": "string", "description": "The time Stedi staged the transaction.", "format": "date-time" }, "transactionId": { "type": "string", "description": "A unique ID for the staged transaction Stedi created within the group." }, "uploadUrl": { "type": "string", "description": "A pre-signed URL to upload the file using a `PUT` request." } }, "required": [ "createdAt", "transactionGroupId", "transactionId" ] }, "DeliveryReport": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "id": { "type": "string", "description": "A unique identifier for the delivery attempt." }, "executionId": { "type": "string", "description": "A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal." }, "partnershipId": { "type": "string", "description": "An identifier for the partnership within the Stedi platform." }, "connectionType": { "$ref": "#/components/schemas/CoreConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "An autogenerated identifier for the connection within the Stedi platform." }, "attempt": { "type": "number", "description": "The attempt number for the delivery." }, "filename": { "type": "string", "description": "The name of the file Stedi attempted to deliver." }, "status": { "$ref": "#/components/schemas/DeliveryReportStatus" }, "message": { "type": "string", "description": "A message providing more information about the delivery attempt. For example `Delivered to sftp://transfer.us.stedi.com/outbound/06bdccdc-4ab9-4add-b1dc-a76a0183f299.x12'." }, "metadata": { "$ref": "#/components/schemas/DeliveryReportMetadata" } }, "required": [ "attempt", "connectionId", "connectionType", "createdAt", "executionId", "filename", "id", "message", "partnershipId", "status" ] }, "DeliveryReportMetadata": { "type": "object", "description": "Metadata about the file delivery.", "properties": { "attempts": { "type": "number", "description": "The total number of delivery attempts for the file." }, "mdn_file": { "$ref": "#/components/schemas/MdnFile" } } }, "DeliveryReportStatus": { "type": "string", "enum": [ "FAILED", "DELIVERED" ] }, "Direction": { "type": "string", "description": "The direction of the transaction. Inbound transactions are those you receive from a payer, provider, or other trading partner. Outbound transactions are those you send to a payer, provider, or other trading partner.", "enum": [ "INBOUND", "OUTBOUND", "UNKNOWN" ] }, "ExceptionCause": { "type": "object", "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } } }, "ExecutionFault": { "type": "object", "description": "A failure to process a given file within stedi.", "properties": { "createdAt": { "type": "string", "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "id": { "type": "string" }, "executionId": { "type": "string", "description": "A unique identifier for the processed file within Stedi." }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string" }, "guideId": { "type": "string", "description": "The unique identifier for the Stedi guide used to process the transactions in the file.\n\nStedi guides are machine-readable specifications that describe how to structure and validate EDI files for each transaction type." }, "receiverProfile": { "$ref": "#/components/schemas/ExecutionPartnershipProfile" }, "senderProfile": { "$ref": "#/components/schemas/ExecutionPartnershipProfile" }, "translateFaultContext": {}, "transactionSetIdentifier": { "type": "string" }, "release": { "type": "string" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" } } }, "required": [ "createdAt", "executionId", "faultCode", "faultMessage", "id" ] }, "ExecutionFaultCode": { "type": "string", "description": "A code specifying the reason for the fault. This code appears in the `code` property of the HTTP error response.", "enum": [ "DELIVERY_FAILURE", "FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS", "FAILED_TO_FIND_GUIDE", "FAILED_TO_FIND_LOCAL_PROFILE", "FAILED_TO_FIND_PARTNER_PROFILE", "FAILED_TO_FIND_PARTNERSHIP", "FAILED_TO_FIND_PROFILES", "FAILED_TO_FIND_RECEIVER_PROFILE", "FAILED_TO_FIND_SENDER_PROFILE", "FAILED_TO_FIND_CONNECTION", "FAILED_TO_GENERATE_CONTROL_NUMBERS", "FAILED_TO_PARSE", "FAILED_TO_PARSE_METADATA", "FAILED_TO_TRANSLATE", "FAILED_TO_ACK", "FAILED_TO_ACK_INTERCHANGE", "FILE_NOT_FOUND", "INVALID_EVENT", "INVALID_CONFIGURATION", "MISMATCHED_PARTNERSHIP_CONNECTION", "MISSING_FUNCTIONAL_GROUP_CONTROL_NUMBER", "MISSING_FUNCTIONAL_GROUP_RELEASE", "MISSING_INTERCHANGE_CONTROL_NUMBER", "MISSING_TRANSACTION_SET_CONTROL_NUMBER", "MISSING_RECEIVER_ID", "MISSING_RECEIVER_QUALIFIER", "MISSING_SENDER_ID", "MISSING_SENDER_QUALIFIER", "MULTIPLE_MATCHING_GUIDES", "MULTIPLE_MATCHING_TRANSACTION_SETTINGS", "MULTIPLE_PARTNERSHIPS", "NO_TRANSLATION_OUTPUT", "NO_TRANSACTION_SETS", "NOT_SUPPORTED", "NO_FUNCTIONAL_GROUPS", "NO_USAGE_INDICATOR_CODE", "PREVIOUSLY_RETRIED", "TRANSLATION_ERROR", "UNKNOWN_ERROR" ] }, "ExecutionPartnershipProfile": { "type": "object", "properties": { "interchangeQualifier": { "$ref": "#/components/schemas/X12InterchangeQualifier" }, "interchangeId": { "type": "string", "maxLength": 15, "minLength": 1, "pattern": "^.*[^ ].*$" }, "profileId": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "A unique identifier for the profile within the Stedi platform." }, "profileType": { "$ref": "#/components/schemas/ProfileType" }, "applicationId": { "type": "string", "maxLength": 15, "minLength": 2 } }, "required": [ "interchangeId", "interchangeQualifier", "profileId", "profileType" ] }, "ExecutionSource": { "type": "object", "description": "The source of the file, including the directory where Stedi received it and the file name.", "properties": { "dirname": { "type": "string", "description": "The directory where Stedi received the file for processing." }, "name": { "type": "string", "description": "The name of the file." } }, "required": [ "dirname", "name" ] }, "ExecutionStatus": { "type": "string", "description": "The status of the execution.\n - You can only retry executions with a `FAILED` or `IGNORED` status.\n - An execution is `COMPLETED` when Stedi has finished processing the file with no errors. If the file is an outbound file, a `COMPLETED` status also means that Stedi successfully delivered it to the configured connection.", "enum": [ "COMPLETED", "PARTIALLY_COMPLETED", "FAILED", "IGNORED", "IN_PROGRESS", "RETRYING", "RETRIED", "STARTED" ] }, "ExecutionSummary": { "type": "object", "description": "The processed executions that match the request criteria. The `items` array is empty if there are no matching executions.", "properties": { "createdAt": { "type": "string", "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "The date and time when the resource was last updated, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "executionId": { "type": "string", "description": "A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal." }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "transactionCount": { "type": "number", "description": "The number of individual transactions included in the file." }, "faultCount": { "type": "number", "description": "The number of errors that occurred during processing. If the file was successfully processed completely, this value is `0`." }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string", "description": "A message providing more information about the fault. Note that if there are multiple faults, Stedi sets the first fault as the code and corresponding message." }, "fileType": { "$ref": "#/components/schemas/FileType" }, "retryable": { "type": "boolean", "description": "If `true`, you can retry the file in the Stedi portal." }, "parentExecutionId": { "type": "string", "description": "The ID of this execution's parent execution, if it is part of a retry chain. When you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution." }, "childExecutionId": { "type": "string", "description": "The ID of this execution's child execution, if it is part of a retry chain. When you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution." }, "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "The unique identifier for the partnership within the Stedi platform.\n\nA partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files." }, "connectionType": { "$ref": "#/components/schemas/CoreConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "An autogenerated identifier for the connection within the Stedi platform." }, "source": { "$ref": "#/components/schemas/ExecutionSource" } }, "required": [ "createdAt", "direction", "executionId", "status", "updatedAt" ] }, "FileType": { "type": "string", "description": "The file format. For example, `EDI/EDIFACT` for an EDIFACT file or `EDI/X12` for an X12 EDI file.", "enum": [ "CSV", "EDI/EDIFACT", "FILEPART", "JSON", "PSV", "JSON/STEDI-GUIDE", "TSV", "UNKNOWN", "EDI/X12", "XML", "ZIP" ] }, "GatewayTimeoutExceptionResponseContent": { "type": "object", "description": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "GenerateEdiRequestContent": { "type": "object", "properties": { "characterSet": { "$ref": "#/components/schemas/CoreCharacterSet" }, "repairOptions": { "$ref": "#/components/schemas/RepairOptions" }, "transactionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionGroup" }, "minItems": 1, "description": "Contains one or more EDI functional groups, each containing the data for one or more EDI transactions. You can override the Application IDs (GS-02 and GS-03) for each group individually. The outbound transaction setting for each group must be configured to use the same connection. If you need to send transactions to different connections, you must call the endpoint multiple times." }, "filename": { "type": "string", "maxLength": 300, "minLength": 1, "pattern": "^([a-zA-Z0-9.*'()!_-]+)$", "description": "Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using an ID." }, "overrides": { "$ref": "#/components/schemas/InterchangeOverrides" }, "interchangeUsageIndicatorOverride": { "$ref": "#/components/schemas/X12UsageIndicator" }, "interchangeAuthorization": { "$ref": "#/components/schemas/X12InterchangeAuthorization" } }, "required": [ "transactionGroups" ] }, "GenerateEdiResponseContent": { "type": "object", "properties": { "edi": { "type": "string", "description": "The EDI Stedi generated from the JSON transaction data." }, "artifactId": { "type": "string", "description": "An ID for the generated EDI file." }, "fileExecutionId": { "type": "string", "description": "A ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for this file execution in the Stedi portal. Internally, Stedi uses this ID to place the file in Stedi's outbound queue." }, "metadata": { "$ref": "#/components/schemas/Metadata" } }, "required": [ "artifactId", "fileExecutionId", "metadata" ] }, "GenerateTransactionGroupEdiRequestContent": { "type": "object", "properties": { "characterSet": { "$ref": "#/components/schemas/CoreCharacterSet" }, "repairOptions": { "$ref": "#/components/schemas/RepairOptions" }, "filename": { "type": "string", "maxLength": 300, "minLength": 1, "pattern": "^([a-zA-Z0-9.*'()!_-]+)$", "description": "Set a custom name for the generated EDI file. Stedi overwrites files with the same name, so we recommend making the filename unique by including a timestamp or other identifier. If you do not specify a filename, Stedi autogenerates a unique name using an ID." }, "overrides": { "$ref": "#/components/schemas/InterchangeOverrides" }, "interchangeAuthorization": { "$ref": "#/components/schemas/X12InterchangeAuthorization" }, "transactionOrdering": { "$ref": "#/components/schemas/TransactionOrdering" } } }, "GenerateTransactionGroupEdiResponseContent": { "type": "object", "properties": { "artifactId": { "type": "string", "description": "An ID for the generated EDI file." }, "fileExecutionId": { "type": "string", "description": "A ID for the process Stedi uses to generate the EDI file. This ID appears on the details page for this file execution in the Stedi portal. Internally, Stedi uses this ID to place the file in Stedi's outbound queue." } }, "required": [ "artifactId", "fileExecutionId" ] }, "GetExecutionInputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionInputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionMetadataDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionMetadataDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionOutputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetExecutionResponseContent": { "type": "object", "properties": { "createdAt": { "type": "string", "description": "The date and time when the resource was created, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "updatedAt": { "type": "string", "description": "The date and time when the resource was last updated, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "executionId": { "type": "string", "description": "A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal." }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "transactionCount": { "type": "number", "description": "The number of individual transactions included in the file." }, "faultCount": { "type": "number", "description": "The number of errors that occurred during processing. If the file was successfully processed completely, this value is `0`." }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "faultMessage": { "type": "string", "description": "A message providing more information about the fault. Note that if there are multiple faults, Stedi sets the first fault as the code and corresponding message." }, "fileType": { "$ref": "#/components/schemas/FileType" }, "retryable": { "type": "boolean", "description": "If `true`, you can retry the file in the Stedi portal." }, "parentExecutionId": { "type": "string", "description": "The ID of this execution's parent execution, if it is part of a retry chain. When you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution." }, "childExecutionId": { "type": "string", "description": "The ID of this execution's child execution, if it is part of a retry chain. When you retry a file, Stedi creates a child execution with a new ID and links it to the original (parent) execution." }, "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "The unique identifier for the partnership within the Stedi platform.\n\nA partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files." }, "connectionType": { "$ref": "#/components/schemas/CoreConnectionType" }, "connectionId": { "type": "string", "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$", "description": "An autogenerated identifier for the connection within the Stedi platform." }, "source": { "$ref": "#/components/schemas/ExecutionSource" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" }, "description": "A list of artifacts related to the transaction. Input artifacts represent the original transaction data Stedi received before processing. Output artifacts represent the processed data.\n\nFor example, for an inbound 835 ERA from a payer, the input artifact would be the original X12 EDI, and the output artifact would be the JSON representation of the ERA." }, "deliveryReports": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryReport" }, "description": "Details about delivery attempts for outbound files./n/nStedi attempts to deliver a file to all configured connections every 6 minutes for up to 3 total attempts. If it cannot deliver the file after the third attempt, it marks the file execution as `FAILED` and emits the file failed event." } }, "required": [ "createdAt", "direction", "executionId", "status", "updatedAt" ] }, "GetTransactionAttachmentDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionAttachmentDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionFragmentOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionFragmentOutputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionFragmentResponseContent": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "A unique identifier for the processed transaction containing this fragment. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal." }, "fileExecutionId": { "type": "string", "description": "A unique identifier for the processed file containing this fragment. This ID is included in the file processed event. You can also retrieve it manually from the file's details page in the Stedi portal." }, "direction": { "$ref": "#/components/schemas/Direction" }, "mode": { "$ref": "#/components/schemas/Mode" }, "processedAt": { "type": "string", "description": "The date and time when Stedi processed the transaction containing the fragment, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "fragmentIndex": { "type": "number", "description": "The identifier for the fragment within a processed transaction." }, "fragments": { "$ref": "#/components/schemas/TransactionFragmentsSummary" }, "transactionUrl": { "type": "string", "description": "The URL to review the transaction within the Stedi portal." }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" }, "description": "A list of artifacts related to the transaction containing the fragment." }, "partnership": { "$ref": "#/components/schemas/Partnership" }, "x12": { "$ref": "#/components/schemas/X12TransactionSummary" } }, "required": [ "artifacts", "direction", "fileExecutionId", "fragmentIndex", "fragments", "mode", "partnership", "processedAt", "transactionId", "transactionUrl" ] }, "GetTransactionInputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionInputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionOutputDocumentResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionOutputDocumentUrlResponseContent": { "type": "object", "properties": { "documentDownloadUrl": { "type": "string", "description": "A URL to download the document. This URL is available for 60 minutes." } } }, "GetTransactionResponseContent": { "type": "object", "properties": { "transactionId": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal." }, "fileExecutionId": { "type": "string", "description": "A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal." }, "status": { "$ref": "#/components/schemas/TransactionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "mode": { "$ref": "#/components/schemas/Mode" }, "processedAt": { "type": "string", "description": "The date and time when Stedi processed the transaction, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" }, "description": "A list of artifacts related to the transaction." }, "partnership": { "$ref": "#/components/schemas/Partnership" }, "x12": { "$ref": "#/components/schemas/X12TransactionSummary" }, "fragments": { "$ref": "#/components/schemas/TransactionFragmentsSummary" }, "translationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationError" }, "description": "Details about errors that prevented Stedi from processing the transaction." }, "businessIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessIdentifier" }, "description": "Any business identifiers extracted from the transaction." } }, "required": [ "artifacts", "direction", "fileExecutionId", "mode", "partnership", "processedAt", "status", "transactionId" ] }, "Index": { "type": "object", "properties": { "line": { "type": "number", "description": "The line number in the document where the problem occurred." }, "column": { "type": "number", "description": "The column number in the document where the problem occurred." } }, "required": [ "column", "line" ] }, "InterchangeMetadata": { "type": "object", "description": "Metadata for a single interchange within the EDI file.", "properties": { "interchangeControlNumber": { "type": "number", "maximum": 999999999, "minimum": 0 }, "functionalGroupControlNumbers": { "type": "array", "items": { "type": "number", "maximum": 999999999, "minimum": 0 }, "minItems": 1, "description": "A list of functional group control numbers within an interchange." } }, "required": [ "functionalGroupControlNumbers", "interchangeControlNumber" ] }, "InterchangeOverrides": { "type": "object", "properties": { "interchangeUsageIndicator": { "$ref": "#/components/schemas/X12UsageIndicator" }, "acknowledgmentRequestedCode": { "$ref": "#/components/schemas/X12AcknowledgmentRequestedCode" }, "interchangeControlVersionNumberCode": { "type": "string", "maxLength": 5, "minLength": 5, "description": "Set [ISA-12](https://www.stedi.com/edi/x12/segment/ISA#ISA-12) to a different value. This code indicates the version of the `ISA` header segments included in the EDI file. By default, Stedi sets `ISA-12` to to be the X12 release number of the guide associated with the transaction setting." }, "delimiters": { "$ref": "#/components/schemas/X12Delimiters" } } }, "ListExecutionFaultsResponseContent": { "type": "object", "description": "Common output structure for list operations with pagination support.", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionFault" } } }, "required": [ "items" ] }, "ListExecutionTransactionsResponseContent": { "type": "object", "description": "Common output structure for list operations with pagination support.", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "ListExecutionsResponseContent": { "type": "object", "description": "Common output structure for list operations with pagination support.", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionSummary" } } }, "required": [ "items" ] }, "ListPollingExecutionsResponseContent": { "type": "object", "description": "Common output structure for list operations with pagination support.", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ExecutionSummary" } } }, "required": [ "items" ] }, "ListPollingTransactionsResponseContent": { "type": "object", "description": "Common output structure for list operations with pagination support.", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "ListTransactionsResponseContent": { "type": "object", "description": "Common output structure for list operations with pagination support.", "properties": { "nextPageToken": { "type": "string", "maxLength": 1024, "minLength": 1, "description": "Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionSummary" } } }, "required": [ "items" ] }, "Mark": { "type": "object", "description": "The location in the document where the problem occurred. May be a single index or a range.", "properties": { "start": { "$ref": "#/components/schemas/Index" }, "end": { "$ref": "#/components/schemas/Index" } }, "required": [ "start" ] }, "MdnFile": { "type": "object", "description": "The location of the Message Disposition Notification (MDN). This is only relevant for AS2 connections.", "properties": { "repository": { "type": "string", "description": "The repository location of the MDN file." }, "pointer": { "type": "string", "description": "The pointer to the specific MDN file." } }, "required": [ "pointer", "repository" ] }, "Metadata": { "type": "object", "description": "Metadata about the generated EDI file.", "properties": { "interchangeMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/InterchangeMetadata" }, "minItems": 1, "description": "A list of interchange metadata for all interchanges in the EDI file." } }, "required": [ "interchangeMetadata" ] }, "Mode": { "type": "string", "description": "Indicates whether the transaction contains test or production data. Stedi determines this from the value in [`ISA15` Usage Indicator Code](https://www.stedi.com/edi/x12/segment/ISA#ISA-15).", "enum": [ "test", "production", "other" ] }, "Partnership": { "type": "object", "description": "Information about the associated partnership.\n\nA partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnership for you automatically when you set up your account.", "properties": { "partnershipId": { "type": "string", "maxLength": 81, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "The unique identifier for the partnership within the Stedi platform.\n\nA partnership describes all aspects of the EDI relationship between two profiles in your Stedi account, such as which transaction sets they will exchange and other important information for processing EDI files. If you're sending or receiving transactions through the Stedi clearinghouse, Stedi configures the necessary partnerships for you automatically when you set up your account." }, "partnershipType": { "$ref": "#/components/schemas/PartnershipType" }, "sender": { "$ref": "#/components/schemas/PartnershipSender" }, "receiver": { "$ref": "#/components/schemas/PartnershipReceiver" } }, "required": [ "partnershipId", "partnershipType", "receiver", "sender" ] }, "PartnershipReceiver": { "type": "object", "description": "The entity that is receiving the transaction.", "properties": { "profileId": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "A unique identifier for the profile within the Stedi platform." } }, "required": [ "profileId" ] }, "PartnershipSender": { "type": "object", "description": "The entity that initiated the transaction.", "properties": { "profileId": { "type": "string", "maxLength": 40, "minLength": 1, "pattern": "^([a-zA-Z0-9._-]+)$", "description": "A unique identifier for the profile within the Stedi platform." } }, "required": [ "profileId" ] }, "PartnershipType": { "type": "string", "description": "The type of partnership, which determines the EDI standard used for exchanging transactions.", "enum": [ "x12", "edifact" ] }, "ProfileType": { "type": "string", "enum": [ "local", "partner" ] }, "RepairOptions": { "type": "object", "description": "Options for repairing EDI data during generation to ensure it meets X12 requirements", "properties": { "trimTrailingSpaces": { "type": "boolean", "description": "Whether to trim trailing spaces from data elements" }, "uppercase": { "type": "boolean", "description": "Whether to convert text to uppercase" }, "replaceConfusable": { "type": "boolean", "description": "Whether to replace characters that are visually similar but technically different" }, "removeDiacritical": { "type": "boolean", "description": "Whether to remove diacritical marks from characters" }, "replaceNonBasicCharacters": { "type": "boolean", "description": "Whether to replace non-basic characters with their basic equivalents" }, "replaceStediCanonicalDelimitersConflicts": { "type": "boolean", "description": "Whether to replace characters that conflict with Stedi canonical delimiters" }, "trimTrailingZeroes": { "type": "boolean", "description": "Whether to trim trailing zeros from numeric data elements" } } }, "ResourceNotFoundExceptionResponseContent": { "type": "object", "description": "The server response when the specified resource cannot be found after an API request passes authentication and authorization.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "ResourceUnderChangeExceptionResponseContent": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "RetryEventResponseContent": { "type": "object", "properties": { "eventId": { "type": "string", "description": "The ID of the newly retried event." } } }, "RetryExecutionSelectionCondition": { "type": "object", "description": "Specify the file executions to retry. Stedi will retry all executions matching the given criteria. For example, you can retry all file executions with a `FAILED` status within a specific date range.\n\nNote that Stedi only retries each `executionId` once. Each retry attempt is stored as a new file execution within Stedi. If you need to retry a file multiple times, you'll need to pass the ID of the latest retry attempt to this endpoint.", "properties": { "executionIds": { "type": "array", "items": { "type": "string" }, "maxItems": 1000, "description": "A list of file execution IDs. These are unique identifiers for the file execution within Stedi. This ID is included in the file processed event, or you can retrieve it manually from the file's details page within the Stedi portal." }, "direction": { "$ref": "#/components/schemas/Direction" }, "faultCode": { "$ref": "#/components/schemas/ExecutionFaultCode" }, "partnershipId": { "type": "string", "description": "Specify executions associated with a specific partnership. This is the `partnershipId` property in the file execution record. You can also find this ID on the [Trading partners](https://www.stedi.com/app/core/partnerships) page under **Partnership identifier**." }, "status": { "$ref": "#/components/schemas/ExecutionStatus" }, "from": { "type": "string", "description": "Specify executions processed after this timestamp, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "to": { "type": "string", "description": "Specify executions processed before this timestamp, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" } } }, "RetryExecutionsRequestContent": { "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/RetryExecutionSelectionCondition" } }, "required": [ "condition" ] }, "ServiceExceptionResponseContent": { "type": "object", "properties": { "message": { "type": "string" }, "exceptionCause": { "$ref": "#/components/schemas/ExceptionCause" } }, "required": [ "message" ] }, "ServiceUnavailableExceptionResponseContent": { "type": "object", "description": "The server cannot handle the request due to technical reasons.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "ThrottlingExceptionResponseContent": { "type": "object", "description": "The server response when usage plan or account-level throttling limits exceeded.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "TransactionFragmentsSummary": { "type": "object", "description": "Details about fragments included in the transaction, if applicable. Fragments break large transactions into smaller parts for easier processing and management.", "properties": { "keyName": { "type": "string", "description": "The JSON schema key name for the segment in the Stedi guide used to split the transaction into fragments. For example, in an 834 Health Care Benefit Enrollment and Maintenance, this would be `member_level_detail_INS_loop`." }, "fragmentCount": { "type": "number", "description": "The total number of fragments in the transaction." }, "batchSize": { "type": "number", "description": "The maximum size of each fragment in kilobytes (KB). Stedi uses this to automatically split large inbound transactions into fragments." } }, "required": [ "batchSize", "fragmentCount", "keyName" ] }, "TransactionGroup": { "type": "object", "description": "A transaction group contains data for one or more EDI transactions in [Guide JSON](https://www.stedi.com/docs/edi-platform/operate/transform-json/guide-json) format.", "properties": { "transactionSettingId": { "type": "string", "maxLength": 50, "pattern": "^([a-zA-Z0-9_-]+)$", "description": "A unique ID outbound transaction setting Stedi should use to determine the correct guide for validation and generation. To find this ID, go to the partnership and use the **Transaction Setting ID** field for the outbound transaction setting." }, "transactions": { "type": "array", "items": {}, "minItems": 1, "description": "This payload contains the transaction data. It must conform to the JSON Schema for the guide associated with each transaction setting (Guide JSON format)." }, "overrides": { "$ref": "#/components/schemas/TransactionGroupOverrides" } }, "required": [ "transactionSettingId", "transactions" ] }, "TransactionGroupOverrides": { "type": "object", "description": "Customize the Application IDs for you or your trading partner.", "properties": { "localApplicationId": { "type": "string", "maxLength": 15, "minLength": 2, "description": "Set the [GS-02](https://www.stedi.com/edi/x12/segment/GS#GS-02) element to a custom value. If not set, Stedi uses the Application ID for the local profile associated with the partnership." }, "partnerApplicationId": { "type": "string", "maxLength": 15, "minLength": 2, "description": "Set the [GS-03](https://www.stedi.com/edi/x12/segment/GS#GS-03) element to a custom value. If not set, Stedi uses the Application ID for the partner profile associated with the partnership." } } }, "TransactionOrdering": { "type": "string", "description": "Specify the order of the transactions in the generated X12 EDI file. By default, Stedi doesn't guarantee any particular order.\n\nSet to `CONTROL_NUMBER` to order transactions within a functional group by their control number, from lowest to highest. In X12 EDI, this is `ST02` (Transaction Set Control Number).", "enum": [ "CONTROL_NUMBER" ] }, "TransactionStatus": { "type": "string", "description": "A status indicating whether Stedi was able to successfully process the transaction.", "enum": [ "failed", "succeeded" ] }, "TransactionSummary": { "type": "object", "description": "The processed transactions that match the request criteria. The `items` array is empty if there are no matching transactions.", "properties": { "transactionId": { "type": "string", "description": "A unique identifier for the processed transaction within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the transaction's details page within the Stedi portal." }, "fileExecutionId": { "type": "string", "description": "A unique identifier for the processed file within Stedi. This ID is included in the transaction processed event. You can also retrieve it manually from the file's details page in the Stedi portal." }, "status": { "$ref": "#/components/schemas/TransactionStatus" }, "direction": { "$ref": "#/components/schemas/Direction" }, "mode": { "$ref": "#/components/schemas/Mode" }, "processedAt": { "type": "string", "description": "The date and time when Stedi processed the transaction, in ISO 8601 format. For example, `2023-08-28T00:00:00Z`.", "format": "date-time" }, "artifacts": { "type": "array", "items": { "$ref": "#/components/schemas/Artifact" }, "description": "A list of artifacts related to the transaction." }, "partnership": { "$ref": "#/components/schemas/Partnership" }, "x12": { "$ref": "#/components/schemas/X12TransactionSummary" }, "fragments": { "$ref": "#/components/schemas/TransactionFragmentsSummary" }, "translationErrors": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationError" }, "description": "Details about errors that prevented Stedi from processing the transaction." }, "businessIdentifiers": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessIdentifier" }, "description": "Any business identifiers extracted from the transaction." } }, "required": [ "artifacts", "direction", "fileExecutionId", "mode", "partnership", "processedAt", "status", "transactionId" ] }, "TranslationError": { "type": "object", "properties": { "context": { "$ref": "#/components/schemas/TranslationErrorContext" }, "mark": { "$ref": "#/components/schemas/Mark" }, "message": { "type": "string", "description": "A message describing the error that occurred during translation." } }, "required": [ "message" ] }, "TranslationErrorContext": { "type": "object", "properties": { "code": { "type": "string", "description": "The error code." }, "schemaPath": { "type": "string", "description": "The name of the JSON property where the error occurred." } } }, "UnauthorizedExceptionResponseContent": { "type": "object", "description": "The server response when the authorizer failed to authenticate the caller.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "UnprocessableEntityExceptionResponseContent": { "type": "object", "description": "The request parameters do not match a previous request with the same idempotency key.", "properties": { "message": { "type": "string" }, "code": { "type": "string" } }, "required": [ "message" ] }, "X12AcknowledgmentRequestedCode": { "type": "string", "description": "Set [ISA-14](https://www.stedi.com/edi/x12/segment/ISA#ISA-14) to a different value. If not set, the default value is `0 (No Interchange Acknowledgment Requested)`.", "enum": [ "0", "1", "2", "3" ] }, "X12AuthorizationInformationQualifier": { "type": "string", "description": "Identifies the type of information in the Authorization Information (`ISA-01`). Default is `00 - No Authorization Information Present`.", "enum": [ "00", "01", "02", "03", "04", "05", "06", "07", "08" ] }, "X12Delimiters": { "type": "object", "properties": { "element": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The data element separator character." }, "composite": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The component element separator character." }, "repetition": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The repetition separator character." }, "segment": { "type": "string", "pattern": "^[\\W|_]{1}$", "description": "The segment terminator character." } }, "required": [ "composite", "element", "repetition", "segment" ] }, "X12InterchangeAuthorization": { "type": "object", "description": "Set values for [ISA header](https://www.stedi.com/edi/x12/segment/ISA) elements (ISA-01 to ISA-04).", "properties": { "authorizationInformationQualifier": { "$ref": "#/components/schemas/X12AuthorizationInformationQualifier" }, "authorizationInformation": { "type": "string", "maxLength": 10, "pattern": "^.*[^ ].*$", "description": "Information used for additional identification or authorization of the interchange sender or the data in the interchange (`ISA-02`). The type of information is set by the `authorizationInformationQualifier`." }, "securityInformationQualifier": { "$ref": "#/components/schemas/X12SecurityInformationQualifier" }, "securityInformation": { "type": "string", "maxLength": 10, "pattern": "^.*[^ ].*$", "description": "The security information referenced by the `securityInformationQualifier` (`ISA-04`). Typically, this is a password." } } }, "X12InterchangeQualifier": { "type": "string", "enum": [ "01", "02", "03", "04", "07", "08", "09", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20", "21", "22", "23", "24", "25", "26", "27", "28", "29", "30", "31", "32", "33", "34", "35", "36", "37", "38", "AM", "NR", "SA", "SN", "ZZ" ] }, "X12SecurityInformationQualifier": { "type": "string", "description": "Identifies the type of information in the Security Information (ISA-03). Default is `00 - No Security Information Present`.", "enum": [ "00", "01" ] }, "X12TransactionMetadata": { "type": "object", "description": "Metadata about the X12 EDI transaction, including information from the interchange, functional group, and transaction headers as well as the sender and receiver IDs.", "properties": { "interchange": { "$ref": "#/components/schemas/X12TransactionMetadataInterchange" }, "functionalGroup": { "$ref": "#/components/schemas/X12TransactionMetadataFunctionalGroup" }, "transaction": { "$ref": "#/components/schemas/X12TransactionMetadataTransaction" }, "sender": { "$ref": "#/components/schemas/X12TransactionMetadataProfile" }, "receiver": { "$ref": "#/components/schemas/X12TransactionMetadataProfile" } }, "required": [ "functionalGroup", "interchange", "receiver", "sender", "transaction" ] }, "X12TransactionMetadataFunctionalGroup": { "type": "object", "description": "Data from the Functional Group Header of the X12 EDI file.", "properties": { "controlNumber": { "type": "number", "maximum": 999999999, "minimum": 0, "description": "The Group Control Number ([`GS06`](https://www.stedi.com/edi/x12/segment/GS#GS-06))." }, "date": { "type": "string", "description": "The date in the Functional Group Header ([`GS04`](https://www.stedi.com/edi/x12/segment/GS#GS-04)), formatted as `YYYY-MM-DD`. For example, `2023-08-28`." }, "functionalIdentifierCode": { "type": "string", "description": "The Functional Identifier Code ([`GS01`](https://www.stedi.com/edi/x12/segment/GS#GS-01)), which indicates the type of transaction. For example, `HC` for an 837 Healthcare Claim." }, "time": { "type": "string", "description": "The Time ([`GS05`](https://www.stedi.com/edi/x12/segment/GS#GS-05)), formatted as `HH:MM:SS`. For example, `21:29:57`." }, "release": { "type": "string", "description": "The Version/Release/Industry Identifier Code ([`GS08`](https://www.stedi.com/edi/x12/segment/GS#GS-08)), which indicates the version of the X12 standard used. For example, `005010X222A1`." } }, "required": [ "controlNumber", "date", "functionalIdentifierCode", "release", "time" ] }, "X12TransactionMetadataInterchange": { "type": "object", "description": "Data from the Interchange Control Header of the X12 EDI file.", "properties": { "acknowledgmentRequestedCode": { "type": "string", "description": "The value of [`ISA14`](https://www.stedi.com/edi/x12/segment/ISA#ISA-14) in the Interchange Control Header, which indicates whether the sender is requesting a [`TA1` Interchange Acknowledgment](https://www.stedi.com/edi/x12/segment/TA1)." }, "controlNumber": { "type": "number", "maximum": 999999999, "minimum": 0, "description": "The control number in the Interchange Control Header." } }, "required": [ "acknowledgmentRequestedCode", "controlNumber" ] }, "X12TransactionMetadataProfile": { "type": "object", "description": "The Application Code and ISA ID for the profile.", "properties": { "applicationCode": { "type": "string", "description": "The Application Code for the profile, which is used to identify the entity in the `GS` header of an EDI file." }, "isa": { "$ref": "#/components/schemas/X12TransactionMetadataProfileISA" } }, "required": [ "applicationCode", "isa" ] }, "X12TransactionMetadataProfileISA": { "type": "object", "description": "The Interchange ID and qualifier.", "properties": { "qualifier": { "type": "string", "description": "The Interchange Sender ID Qualifier, which indicates the type of identifier. For example, `ZZ` for a mutually defined identifier." }, "id": { "type": "string", "description": "The Interchange ID, which is the unique identifier for the entity in the EDI file." } }, "required": [ "id", "qualifier" ] }, "X12TransactionMetadataTransaction": { "type": "object", "description": "Data from the Transaction Set Header of the X12 EDI file.", "properties": { "controlNumber": { "type": "string", "description": "The Transaction Set Control Number ([`ST02`](https://www.stedi.com/edi/x12/segment/ST#ST-02))." }, "transactionSetIdentifier": { "type": "string", "description": "The Transaction Set Identifier Code ([`ST01`](https://www.stedi.com/edi/x12/segment/ST#ST-01)), which indicates the type of transaction. For example, `837` for an 837 Healthcare Claim." } }, "required": [ "controlNumber", "transactionSetIdentifier" ] }, "X12TransactionSetIdentifierCode": { "type": "string", "description": "Any valid 3-digit X12 Transaction Set Identifier Code, as defined in the X12 standard. See: .", "enum": [ "100", "101", "102", "103", "104", "105", "106", "107", "108", "109", "110", "111", "112", "113", "120", "121", "124", "125", "126", "127", "128", "129", "130", "131", "132", "133", "135", "138", "139", "140", "141", "142", "143", "144", "146", "147", "148", "149", "150", "151", "152", "153", "154", "155", "157", "158", "159", "160", "161", "163", "170", "175", "176", "179", "180", "185", "186", "187", "188", "189", "190", "191", "194", "195", "196", "197", "198", "199", "200", "201", "202", "203", "204", "205", "206", "210", "211", "212", "213", "214", "215", "216", "217", "219", "220", "222", "223", "224", "225", "227", "228", "240", "242", "244", "245", "248", "249", "250", "251", "252", "255", "256", "259", "260", "261", "262", "263", "264", "265", "266", "267", "268", "269", "270", "271", "272", "273", "274", "275", "276", "277", "278", "280", "283", "284", "285", "286", "288", "290", "300", "301", "303", "304", "309", "310", "311", "312", "313", "315", "317", "319", "322", "323", "324", "325", "326", "350", "352", "353", "354", "355", "356", "357", "358", "359", "361", "362", "404", "410", "412", "414", "417", "418", "419", "420", "421", "422", "423", "424", "425", "426", "429", "431", "432", "433", "434", "435", "436", "437", "440", "451", "452", "453", "455", "456", "460", "463", "466", "468", "470", "475", "485", "486", "490", "492", "494", "500", "501", "503", "504", "511", "517", "521", "527", "536", "540", "561", "567", "568", "601", "603", "620", "625", "650", "715", "753", "754", "805", "806", "810", "811", "812", "813", "814", "815", "816", "818", "819", "820", "821", "822", "823", "824", "826", "827", "828", "829", "830", "831", "832", "833", "834", "835", "836", "837", "838", "839", "840", "841", "842", "843", "844", "845", "846", "847", "848", "849", "850", "851", "852", "853", "854", "855", "856", "857", "858", "859", "860", "861", "862", "863", "864", "865", "866", "867", "868", "869", "870", "871", "872", "873", "874", "875", "876", "877", "878", "879", "880", "881", "882", "883", "884", "885", "886", "887", "888", "889", "890", "891", "892", "893", "894", "895", "896", "897", "920", "924", "925", "926", "928", "940", "943", "944", "945", "947", "980", "990", "993", "996", "997", "998", "999" ] }, "X12TransactionSetting": { "type": "object", "description": "The IDs for the guide and transaction setting Stedi used to process the transaction.", "properties": { "guideId": { "type": "string", "description": "The unique identifier for the Stedi guide used to process the transaction.\n\nStedi guides are machine-readable specifications for X12 EDI transactions. They describe how to structure and validate EDI files for each transaction type." }, "transactionSettingId": { "type": "string", "description": "The unique identifier for the transaction setting Stedi used to process the transaction.\n\nTransaction settings configure how Stedi processes specific transaction types, such as which Stedi guide to use and other processing options. If you're using the Stedi clearinghouse, Stedi automatically configures the required transaction settings for you when you set up your account." } } }, "X12TransactionSummary": { "type": "object", "description": "Details about the X12 EDI transaction.", "properties": { "metadata": { "$ref": "#/components/schemas/X12TransactionMetadata" }, "transactionSetting": { "$ref": "#/components/schemas/X12TransactionSetting" } }, "required": [ "metadata" ] }, "X12UsageIndicator": { "type": "string", "description": "Set [ISA-15](https://www.stedi.com/edi/x12/segment/ISA#ISA-15) to a different value. If not set, the default value is `P (Production Data)`.", "enum": [ "I", "T", "P" ] } } }