Download OpenAPI specification:Download
EDI validation, translation, and management system.
Submit an EDI interchange for validation and conversion to a back-end application. This operation
accepts a well-formed EDI interchange and (when successfully translated) responds with an
EDI format corresponding to the input (e.g. an X12 997
). The transformed interchange is written to
local server storage (other other queuing system) to be retrieved by or forwarded to a back-end
application for further processing.
EDI payload in either X12 or EDIFACT format
Properly formatted EDI interchange
Submit an XML interchange for validation and conversion to EDI. This operation accepts a well-formed XML interchange and (when successfully translated) responds with an EDI format corresponding to the input. Information about the interchange (transaction control numbers, types of transactions, etc.) is persisted to the Fresno database for tracking and to support acknowledgement confirmation.
XML payload to be converted to EDI
Properly formatted XML interchange
Translate an EDI interchange and persist meta information and validation status in history.
This operation accepts a well-formed EDI interchange and (when successfully translated) responds
with an XML representation of the interchange. The Link
header includes a URI that may be used
for retrieval of validation/status information pertaining to the interchange.
EDI payload in either X12 or EDIFACT format
Properly formatted EDI interchange
{ }
Validate an EDI interchange and persist meta information and validation status in history. This operation accepts a well-formed EDI interchange and responds with either an EDI format corresponding to the input or a JSON format describing the result of validation.
EDI payload in either X12 or EDIFACT format
Properly formatted EDI interchange
interchangeId required | string Interchange identifier |
[- {
- "ackCode": "string",
- "agencyCode": "string",
- "channel": {
- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}, - "controlCount": "string",
- "controlReference": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "industryCode": "string",
- "release": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "uuid": "string",
- "version": "string",
- "createTimestamp": "2019-08-24T14:15:22Z",
- "errors": [
- {
- "componentPosition": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "elementOccurrence": 0,
- "elementPosition": 0,
- "errorCode": "string",
- "loopCode": "string",
- "referenceCode": "string",
- "segmentPosition": 0,
- "segmentTag": "string"
}
], - "receiverId": "string",
- "receiverIdType": "string",
- "senderId": "string",
- "senderIdType": "string",
- "type": "string",
- "controlEntity": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
}
]
id required | string Record identifier |
{- "ackCode": "string",
- "agencyCode": "string",
- "channel": {
- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}, - "controlCount": "string",
- "controlReference": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "industryCode": "string",
- "release": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "uuid": "string",
- "version": "string",
- "createTimestamp": "2019-08-24T14:15:22Z",
- "errors": [
- {
- "componentPosition": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "elementOccurrence": 0,
- "elementPosition": 0,
- "errorCode": "string",
- "loopCode": "string",
- "referenceCode": "string",
- "segmentPosition": 0,
- "segmentTag": "string"
}
], - "receiverId": "string",
- "receiverIdType": "string",
- "senderId": "string",
- "senderIdType": "string",
- "type": "string",
- "controlEntity": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
}
page required | integer <int32> Default: 1 Page number |
[- {
- "ackCode": "string",
- "agencyCode": "string",
- "channel": {
- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}, - "controlCount": "string",
- "controlReference": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "industryCode": "string",
- "release": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "uuid": "string",
- "version": "string",
- "ackRequested": "string",
- "componentSeparator": "string",
- "createTimestamp": "2019-08-24T14:15:22Z",
- "decimalMark": "string",
- "direction": "string",
- "elementSeparator": "string",
- "errors": [
- {
- "componentPosition": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "elementOccurrence": 0,
- "elementPosition": 0,
- "errorCode": "string",
- "loopCode": "string",
- "referenceCode": "string",
- "segmentPosition": 0,
- "segmentTag": "string"
}
], - "interchangeControl": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}, - "messageDigest": "string",
- "receiverId": "string",
- "receiverIdType": "string",
- "releaseCharacter": "string",
- "repetitionSeparator": "string",
- "segmentTerminator": "string",
- "senderId": "string",
- "senderIdType": "string",
- "testIndicator": "string",
- "controlEntity": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}, - "errorCount": 0
}
]
{- "ackCode": "string",
- "agencyCode": "string",
- "channel": {
- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}, - "controlCount": "string",
- "controlReference": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "industryCode": "string",
- "release": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "uuid": "string",
- "version": "string",
- "ackRequested": "string",
- "componentSeparator": "string",
- "createTimestamp": "2019-08-24T14:15:22Z",
- "decimalMark": "string",
- "direction": "string",
- "elementSeparator": "string",
- "errors": [
- {
- "componentPosition": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "elementOccurrence": 0,
- "elementPosition": 0,
- "errorCode": "string",
- "loopCode": "string",
- "referenceCode": "string",
- "segmentPosition": 0,
- "segmentTag": "string"
}
], - "interchangeControl": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}, - "messageDigest": "string",
- "receiverId": "string",
- "receiverIdType": "string",
- "releaseCharacter": "string",
- "repetitionSeparator": "string",
- "segmentTerminator": "string",
- "senderId": "string",
- "senderIdType": "string",
- "testIndicator": "string",
- "controlEntity": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}, - "errorCount": 0
}
dateFrom | string <date-time> (OffsetDateTime) |
dateThru | string <date-time> (OffsetDateTime) |
groupId | string |
interchangeId | string |
[- {
- "ackCode": "string",
- "agencyCode": "string",
- "channel": {
- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}, - "controlCount": "string",
- "controlReference": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "industryCode": "string",
- "release": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "uuid": "string",
- "version": "string",
- "errors": [
- {
- "componentPosition": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "elementOccurrence": 0,
- "elementPosition": 0,
- "errorCode": "string",
- "loopCode": "string",
- "referenceCode": "string",
- "segmentPosition": 0,
- "segmentTag": "string"
}
], - "type": "string",
- "controlEntity": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
}
]
id required | string Record identifier |
{- "ackCode": "string",
- "agencyCode": "string",
- "channel": {
- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}, - "controlCount": "string",
- "controlReference": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "industryCode": "string",
- "release": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "uuid": "string",
- "version": "string",
- "errors": [
- {
- "componentPosition": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "elementOccurrence": 0,
- "elementPosition": 0,
- "errorCode": "string",
- "loopCode": "string",
- "referenceCode": "string",
- "segmentPosition": 0,
- "segmentTag": "string"
}
], - "type": "string",
- "controlEntity": {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
}
title required | string (Readable name for the record) <= 255 characters \S |
{- "title": "string"
}
{- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}
id required | string Record identifier |
title required | string (Readable name for the record) <= 255 characters \S |
{- "title": "string"
}
{- "createdAt": "string",
- "name": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string"
}
interchangeControlId | string Interchange control ID |
[- {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
]
agencyCode | string <= 4 characters Agency code of the standards body that defines the schema of this record |
channelId | string Channel identifier. Required for new records, otherwise read-only |
industryCode | string <= 255 characters Industry identifier (implementation version) of the standard |
lastControlNumber | integer <int64> The previous control number used for outbound data. Defaults to |
release | string <= 255 characters Release (sub-version) of the standard |
title required | string (Readable name for the record) <= 255 characters \S |
version required | string <= 255 characters \S Version of the standard |
interchangeControlId | string Interchange control identifier. Required for new records, otherwise read-only |
localId required | string Used for the sender on output interchanges and the receiver on inbound groups |
localIdType | string Used for the sender on output interchanges and the receiver on inbound groups. Not used for X12 |
remoteId required | string Used for the receiver on output interchanges and the sender on inbound groups |
remoteIdType | string Used for the receiver on output interchanges and the sender on inbound groups. Not used for X12 |
type required | string\S Functional/message group type code |
{- "agencyCode": "stri",
- "channelId": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
id required | string Record identifier |
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
id required | string Record identifier |
agencyCode | string <= 4 characters Agency code of the standards body that defines the schema of this record |
channelId | string Channel identifier. Required for new records, otherwise read-only |
industryCode | string <= 255 characters Industry identifier (implementation version) of the standard |
lastControlNumber | integer <int64> The previous control number used for outbound data. Defaults to |
release | string <= 255 characters Release (sub-version) of the standard |
title required | string (Readable name for the record) <= 255 characters \S |
version required | string <= 255 characters \S Version of the standard |
interchangeControlId | string Interchange control identifier. Required for new records, otherwise read-only |
localId required | string Used for the sender on output interchanges and the receiver on inbound groups |
localIdType | string Used for the sender on output interchanges and the receiver on inbound groups. Not used for X12 |
remoteId required | string Used for the receiver on output interchanges and the sender on inbound groups |
remoteIdType | string Used for the receiver on output interchanges and the sender on inbound groups. Not used for X12 |
type required | string\S Functional/message group type code |
{- "agencyCode": "stri",
- "channelId": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "interchangeControlId": "string",
- "localId": "string",
- "localIdType": "string",
- "remoteId": "string",
- "remoteIdType": "string",
- "type": "string"
}
channelId | string Channel ID |
[- {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}
]
agencyCode | string <= 4 characters Agency code of the standards body that defines the schema of this record |
channelId | string Channel identifier. Required for new records, otherwise read-only |
industryCode | string <= 255 characters Industry identifier (implementation version) of the standard |
lastControlNumber | integer <int64> The previous control number used for outbound data. Defaults to |
release | string <= 255 characters Release (sub-version) of the standard |
title required | string (Readable name for the record) <= 255 characters \S |
version required | string <= 255 characters \S Version of the standard |
componentSeparator | string <= 1 characters Component element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
decimalMark | string <= 1 characters Decimal character to be used for outbound interchanges. Not supported for X12 |
elementSeparator | string <= 1 characters Element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
localId required | string <= 255 characters \S Used for the sender on output interchanges and the receiver on inbound interchanges |
localIdType | string <= 255 characters \S Used for the sender on output interchanges and the receiver on inbound interchanges. Optional for EDIFACT, required for X12 |
releaseCharacter | string <= 1 characters Release character to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
remoteId required | string <= 255 characters \S Used for the receiver on output interchanges and the sender on inbound interchanges |
remoteIdType | string <= 255 characters \S Used for the receiver on output interchanges and the sender on inbound interchanges. Optional for EDIFACT, required for X12 |
repetitionSeparator | string <= 1 characters Repetition separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
segmentTerminator | string <= 1 characters Segment terminator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
standard required | string <= 7 characters \S Enum: "EDIFACT" "X12" EDI standard |
testIndicator required | string <= 1 characters Test indicator to be used for outbound interchanges. Value is dialect specific (EDIFACT/X12). For example, X12 uses |
{- "agencyCode": "stri",
- "channelId": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}
id required | string Interchange control ID |
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}
id required | string Interchange control ID |
agencyCode | string <= 4 characters Agency code of the standards body that defines the schema of this record |
channelId | string Channel identifier. Required for new records, otherwise read-only |
industryCode | string <= 255 characters Industry identifier (implementation version) of the standard |
lastControlNumber | integer <int64> The previous control number used for outbound data. Defaults to |
release | string <= 255 characters Release (sub-version) of the standard |
title required | string (Readable name for the record) <= 255 characters \S |
version required | string <= 255 characters \S Version of the standard |
componentSeparator | string <= 1 characters Component element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
decimalMark | string <= 1 characters Decimal character to be used for outbound interchanges. Not supported for X12 |
elementSeparator | string <= 1 characters Element separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
localId required | string <= 255 characters \S Used for the sender on output interchanges and the receiver on inbound interchanges |
localIdType | string <= 255 characters \S Used for the sender on output interchanges and the receiver on inbound interchanges. Optional for EDIFACT, required for X12 |
releaseCharacter | string <= 1 characters Release character to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
remoteId required | string <= 255 characters \S Used for the receiver on output interchanges and the sender on inbound interchanges |
remoteIdType | string <= 255 characters \S Used for the receiver on output interchanges and the sender on inbound interchanges. Optional for EDIFACT, required for X12 |
repetitionSeparator | string <= 1 characters Repetition separator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
segmentTerminator | string <= 1 characters Segment terminator to be used for outbound interchanges. Default value is dialect specific (EDIFACT/X12) if not specified. |
standard required | string <= 7 characters \S Enum: "EDIFACT" "X12" EDI standard |
testIndicator required | string <= 1 characters Test indicator to be used for outbound interchanges. Value is dialect specific (EDIFACT/X12). For example, X12 uses |
{- "agencyCode": "stri",
- "channelId": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "componentSeparator": "s",
- "decimalMark": "s",
- "elementSeparator": "s",
- "localId": "string",
- "localIdType": "string",
- "releaseCharacter": "s",
- "remoteId": "string",
- "remoteIdType": "string",
- "repetitionSeparator": "s",
- "segmentTerminator": "s",
- "standard": "EDIFACT",
- "testIndicator": "s"
}
groupControlId | string |
interchangeControlId | string |
[- {
- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
]
agencyCode | string <= 4 characters Agency code of the standards body that defines the schema of this record |
channelId | string Channel identifier. Required for new records, otherwise read-only |
industryCode | string <= 255 characters Industry identifier (implementation version) of the standard |
lastControlNumber | integer <int64> The previous control number used for outbound data. Defaults to |
release | string <= 255 characters Release (sub-version) of the standard |
title required | string (Readable name for the record) <= 255 characters \S |
version required | string <= 255 characters \S Version of the standard |
groupControlId | string Group control identifier. Required for new records directly tied to a group control record, not used otherwise |
interchangeControlId | string Interchange control identifier. Required for new records directly tied to an interchange control record, not used otherwise |
type | string |
{- "agencyCode": "stri",
- "channelId": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
id required | string Record identifier |
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
id required | string Record identifier |
agencyCode | string <= 4 characters Agency code of the standards body that defines the schema of this record |
channelId | string Channel identifier. Required for new records, otherwise read-only |
industryCode | string <= 255 characters Industry identifier (implementation version) of the standard |
lastControlNumber | integer <int64> The previous control number used for outbound data. Defaults to |
release | string <= 255 characters Release (sub-version) of the standard |
title required | string (Readable name for the record) <= 255 characters \S |
version required | string <= 255 characters \S Version of the standard |
groupControlId | string Group control identifier. Required for new records directly tied to a group control record, not used otherwise |
interchangeControlId | string Interchange control identifier. Required for new records directly tied to an interchange control record, not used otherwise |
type | string |
{- "agencyCode": "stri",
- "channelId": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
{- "agencyCode": "stri",
- "channelId": "string",
- "createdAt": "string",
- "industryCode": "string",
- "lastControlNumber": 0,
- "release": "string",
- "title": "string",
- "updatedAt": "string",
- "uuid": "string",
- "version": "string",
- "groupControlId": "string",
- "interchangeControlId": "string",
- "type": "string"
}
standard | string\S |
agencyCode | string\S |
version | string\S |
release | string Default: "" |
industryCode | string Default: "" |
transactionCode | string\S |
senderIdType | string Default: "" |
senderId | string Default: "" |
receiverIdType | string Default: "" |
receiverId | string Default: "" |
file | string <binary> |