¶ Syncrofy GraphQL
¶ API Endpoints
bff-next.stage.syncrofy.com¶ Queries
¶
DeletePartnerProtocol
¶
DeleteSystemProtocol
¶
DownloadEventSummary
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
|
headers - [String]
|
¶ Example
¶ Query
query DownloadEventSummary(
$SearchRequest: SearchRequestInput,
$headers: [String]
) {
DownloadEventSummary(
SearchRequest: $SearchRequest,
headers: $headers
)
}
¶ Variables
{
"SearchRequest": SearchRequestInput,
"headers": ["abc123"]
}
¶ Response
{"data": {"DownloadEventSummary": "abc123"}}
¶
ExportPartnerContacts
¶
ExportPartnersBulkData
¶
ExportSystemBulkData
¶
ExportSystemContacts
¶
FindAdvanceShipNoticeById
¶ Response
Returns an AdvanceShipNoticeDocument
¶ Example
¶ Query
query FindAdvanceShipNoticeById($id: String) {
FindAdvanceShipNoticeById(id: $id) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
actualShipDate
addressFields {
...AddressFragment
}
allShipmentInfo
appAdviceTransferStatus
asnPurposeCode
billOfLadingNumber
billToAddress {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyingParty {
...AddressFragment
}
canDownloadOriginalFile
carrierReferenceNumber
categoryFacet
childrenTypes
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currentScheduleDelivery
currentScheduleShip
customFields
dataFormat
dataFormatVersion
deliveryAppointment
deliveryRequested
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
errorsCollection
estimatedDelivery
eventType
expectedShipDate
expiration
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasApplicationAdvice
hasErrors
hasExceptions
hasInvoice
hasPurchaseOrder
hasRemittanceAdvice
hierarchyStructure
id
identifierType
inboundIdentifierHash
incorrectLineItemsStructure
indexName
internalVendorNumber
invoiceDates
invoiceNumber
invoiceNumbers
isDeleted
isaBegin
isaControlNumber
isaEnd
laDocumentVersion
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
packIds
partnerHash
partyToReceiveInvoice {
...AddressFragment
}
paymentDates
poDate
poDates
poNumber
poNumberCount
poNumbers
poShipTo {
...AddressFragment
}
primary
primaryContent
primaryIdentifier
promisedForDelivery
purchaseOrderPoDate
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceIds
referenceInfo {
...RefSegmentFragment
}
reprocessOn
reprocessedOn
requestedShipDate
rootNode {
...TreeNodeFragment
}
routing
scacCode
scacCodes
scheduledDeliveryAppointment
sellingParty {
...AddressFragment
}
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipFrom {
...AddressFragment
}
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
shipmentIdNumber
shipmentNumber
shipped
shippingContainerIds
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supportedDateFields
tareIds
testIndicator
textInfo {
...TextSegmentFragment
}
thirdPartyCorrelation {
...DocumentCorrelationPointFragment
}
timeline
timestamp
timezoneOffset
totalNumUnitsShipped
totalQuantityOrdered
trackingNumber
transactionBegin
transactionEnd
transactionRefNum
tsControlNumber
tsIDCode
type
unknownFields
vendorIdNumberMap
vendorNumberMap
vendorOrderNumberMap
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"FindAdvanceShipNoticeById": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"actualShipDate": "2007-12-03",
"addressFields": [Address],
"allShipmentInfo": ["xyz789"],
"appAdviceTransferStatus": "xyz789",
"asnPurposeCode": "xyz789",
"billOfLadingNumber": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": false,
"carrierReferenceNumber": "abc123",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"childrenTypes": ["abc123"],
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"deliveryAppointment": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "xyz789",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedShipDate": "2007-12-03",
"expiration": "2007-12-03",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hasInvoice": true,
"hasPurchaseOrder": false,
"hasRemittanceAdvice": false,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"incorrectLineItemsStructure": false,
"indexName": "abc123",
"internalVendorNumber": "abc123",
"invoiceDates": ["2007-12-03"],
"invoiceNumber": "abc123",
"invoiceNumbers": ["abc123"],
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laDocumentVersion": "abc123",
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"packIds": ["abc123"],
"partnerHash": "abc123",
"partyToReceiveInvoice": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "abc123",
"poNumberCount": 123,
"poNumbers": ["xyz789"],
"poShipTo": Address,
"primary": true,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"promisedForDelivery": "2007-12-03",
"purchaseOrderPoDate": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceIds": ["abc123"],
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"rootNode": TreeNode,
"routing": "abc123",
"scacCode": "xyz789",
"scacCodes": ["abc123"],
"scheduledDeliveryAppointment": "2007-12-03",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentIdNumber": "abc123",
"shipmentNumber": "xyz789",
"shipped": "2007-12-03",
"shippingContainerIds": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"tareIds": ["xyz789"],
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalNumUnitsShipped": 987.65,
"totalQuantityOrdered": 987.65,
"trackingNumber": "xyz789",
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vendorIdNumberMap": Map_String_StringScalar,
"vendorNumberMap": Map_String_StringScalar,
"vendorOrderNumberMap": Map_String_StringScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
FindAllContactsByPartnerID
¶ Response
Returns [PartnerContactRecord]
¶ Example
¶ Query
query FindAllContactsByPartnerID($partnerID: String) {
FindAllContactsByPartnerID(partnerID: $partnerID) {
accessGrantedOn
accessRevokedOn
address {
...AddressFragment
}
companyID
contactType
createdOn
email
emailLower
environment
firstName
firstNameLower
fullName
fullNameLower
id
lastModified
lastModifiedBy {
...UserInfoFragment
}
lastName
lastNameLower
notes
office
officeLower
partnerID
phoneNumbers {
...PhoneRecordFragment
}
status {
...PartnerConnectionStatusFragment
}
title
titleLower
}
}
¶ Variables
{"partnerID": "abc123"}
¶ Response
{
"data": {
"FindAllContactsByPartnerID": [
{
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "xyz789",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "xyz789",
"emailLower": "abc123",
"environment": "abc123",
"firstName": "xyz789",
"firstNameLower": "xyz789",
"fullName": "abc123",
"fullNameLower": "abc123",
"id": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "xyz789",
"lastNameLower": "xyz789",
"notes": "abc123",
"office": "xyz789",
"officeLower": "abc123",
"partnerID": "abc123",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "abc123",
"titleLower": "xyz789"
}
]
}
}
¶
FindComments
¶ Response
Returns a Results_Comments
¶ Example
¶ Query
query FindComments(
$page: Int,
$searchTerm: String,
$size: Int,
$sortBy: String,
$sortOrder: String,
$sourceObjectId: String,
$sourceType: SourceType
) {
FindComments(
page: $page,
searchTerm: $searchTerm,
size: $size,
sortBy: $sortBy,
sortOrder: $sortOrder,
sourceObjectId: $sourceObjectId,
sourceType: $sourceType
) {
aggregations
items {
...CommentsFragment
}
totalItems
}
}
¶ Variables
{
"page": 0,
"searchTerm": "abc123",
"size": 20,
"sortBy": "createdAt",
"sortOrder": "desc",
"sourceObjectId": "xyz789",
"sourceType": "BUSINESS_DOCUMENT"
}
¶ Response
{
"data": {
"FindComments": {
"aggregations": Map_String_ObjectScalar,
"items": [Comments],
"totalItems": {}
}
}
}
¶
FindCompanyById
¶ Example
¶ Query
query FindCompanyById($id: String) {
FindCompanyById(id: $id) {
BPartners {
...CompanyFragment
}
adminGroup_id
avatarID
companyContact {
...CompanyContactFragment
}
complianceLicense
contactRecords {
...ContactRecordFragment
}
dataManagerCompanyID
defaultGroup_id
description
domains
groups
hasProcessedTa1
id
industryCode
local
locations
managedCompanyIds
members
name
openSignupDisabled
parentCompany {
...CompanyFragment
}
passwordRequirements {
...PasswordRequirementsFragment
}
pendingDomainRequests {
...DomainRequestFragment
}
preferences {
...CompanyPreferencesFragment
}
uniqueFilenames
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"FindCompanyById": {
"BPartners": [Company],
"adminGroup_id": "abc123",
"avatarID": "xyz789",
"companyContact": CompanyContact,
"complianceLicense": "INVITED_SUPPLIER",
"contactRecords": [ContactRecord],
"dataManagerCompanyID": "xyz789",
"defaultGroup_id": "xyz789",
"description": "xyz789",
"domains": ["abc123"],
"groups": ["xyz789"],
"hasProcessedTa1": true,
"id": "xyz789",
"industryCode": "abc123",
"local": true,
"locations": ["abc123"],
"managedCompanyIds": ["xyz789"],
"members": ["abc123"],
"name": "abc123",
"openSignupDisabled": true,
"parentCompany": Company,
"passwordRequirements": PasswordRequirements,
"pendingDomainRequests": [DomainRequest],
"preferences": CompanyPreferences,
"uniqueFilenames": true
}
}
}
¶
FindCompanyDomains
¶ Response
Returns a CompanyDomains
¶
FindCompanyPreferences
¶ Response
Returns a CompanyPreferences
¶ Example
¶ Query
query FindCompanyPreferences {
FindCompanyPreferences {
autoLogout
defaultFilterCurrency
lineItemsStoredOnCloud
primaryProductIdentifier
showTechnicalDatasets
}
}
¶ Response
{
"data": {
"FindCompanyPreferences": {
"autoLogout": true,
"defaultFilterCurrency": "abc123",
"lineItemsStoredOnCloud": true,
"primaryProductIdentifier": "abc123",
"showTechnicalDatasets": true
}
}
}
¶
FindContactRecordByID
¶ Response
Returns a PartnerContactRecord
¶ Example
¶ Query
query FindContactRecordByID(
$contactID: String,
$partnerID: String
) {
FindContactRecordByID(
contactID: $contactID,
partnerID: $partnerID
) {
accessGrantedOn
accessRevokedOn
address {
...AddressFragment
}
companyID
contactType
createdOn
email
emailLower
environment
firstName
firstNameLower
fullName
fullNameLower
id
lastModified
lastModifiedBy {
...UserInfoFragment
}
lastName
lastNameLower
notes
office
officeLower
partnerID
phoneNumbers {
...PhoneRecordFragment
}
status {
...PartnerConnectionStatusFragment
}
title
titleLower
}
}
¶ Variables
{
"contactID": "abc123",
"partnerID": "abc123"
}
¶ Response
{
"data": {
"FindContactRecordByID": {
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "xyz789",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "abc123",
"emailLower": "xyz789",
"environment": "abc123",
"firstName": "xyz789",
"firstNameLower": "xyz789",
"fullName": "abc123",
"fullNameLower": "xyz789",
"id": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "abc123",
"lastNameLower": "xyz789",
"notes": "xyz789",
"office": "xyz789",
"officeLower": "xyz789",
"partnerID": "xyz789",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "abc123",
"titleLower": "xyz789"
}
}
}
¶
FindContactRecordsByPartnerID
¶ Response
Returns a Results_PartnerContactRecord
¶ Example
¶ Query
query FindContactRecordsByPartnerID(
$contactTypeExclusions: [ContactType],
$page: Int,
$partnerID: String,
$q: String,
$size: Int,
$sortBy: String,
$sortOrder: String,
$status: [String]
) {
FindContactRecordsByPartnerID(
contactTypeExclusions: $contactTypeExclusions,
page: $page,
partnerID: $partnerID,
q: $q,
size: $size,
sortBy: $sortBy,
sortOrder: $sortOrder,
status: $status
) {
aggregations
items {
...PartnerContactRecordFragment
}
totalItems
}
}
¶ Variables
{
"contactTypeExclusions": ["business"],
"page": 0,
"partnerID": "xyz789",
"q": "abc123",
"size": 100,
"sortBy": "lastNameLower",
"sortOrder": "asc",
"status": ["abc123"]
}
¶ Response
{
"data": {
"FindContactRecordsByPartnerID": {
"aggregations": Map_String_ObjectScalar,
"items": [PartnerContactRecord],
"totalItems": {}
}
}
}
¶
FindContactRecordsBySystemID
¶ Response
Returns a Results_PartnerContactRecord
¶ Example
¶ Query
query FindContactRecordsBySystemID(
$contactTypeExclusions: [ContactType],
$page: Int,
$q: String,
$size: Int,
$sortBy: String,
$sortOrder: String,
$status: [String],
$systemId: String
) {
FindContactRecordsBySystemID(
contactTypeExclusions: $contactTypeExclusions,
page: $page,
q: $q,
size: $size,
sortBy: $sortBy,
sortOrder: $sortOrder,
status: $status,
systemId: $systemId
) {
aggregations
items {
...PartnerContactRecordFragment
}
totalItems
}
}
¶ Variables
{
"contactTypeExclusions": ["business"],
"page": 0,
"q": "xyz789",
"size": 100,
"sortBy": "lastNameLower",
"sortOrder": "asc",
"status": ["xyz789"],
"systemId": "abc123"
}
¶ Response
{
"data": {
"FindContactRecordsBySystemID": {
"aggregations": Map_String_ObjectScalar,
"items": [PartnerContactRecord],
"totalItems": {}
}
}
}
¶
FindDataRetentionPolicy
¶ Response
Returns [DataRetentionPolicy]
¶ Example
¶ Query
query FindDataRetentionPolicy {
FindDataRetentionPolicy {
MINIMUM_VALUE
companyID
enabled
environment
id
lastModifiedBy {
...UserDetailsFragment
}
lastModifiedByID
lastUpdated
type
units
value
}
}
¶ Response
{
"data": {
"FindDataRetentionPolicy": [
{
"MINIMUM_VALUE": 123,
"companyID": "xyz789",
"enabled": false,
"environment": "abc123",
"id": "xyz789",
"lastModifiedBy": UserDetails,
"lastModifiedByID": "abc123",
"lastUpdated": "2007-12-03",
"type": "BUSINESS_DOCUMENT",
"units": "CUSTOM",
"value": 123
}
]
}
}
¶
FindFunctionalAcknowledgmentById
¶ Response
Returns a FunctionalAcknowledgmentDocument
¶ Example
¶ Query
query FindFunctionalAcknowledgmentById($id: String) {
FindFunctionalAcknowledgmentById(id: $id) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
acknowledgedEntityIds
acknowledgedType
acknowledgementCode
acknowledgementDetail {
...TransactionHeaderSegmentFragment
}
acknowledges
acknowledgmentErrorCode
addressFields {
...AddressFragment
}
akFuncIDCode
appAdviceTransferStatus
billToAddress {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
canDownloadOriginalFile
categoryFacet
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationPoints {
...ErrorCorrelationPointFragment
}
correlationReferenceId
customFields
dataFormat
dataFormatVersion
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
errorsCollection
eventType
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasApplicationAdvice
hasErrors
hasExceptions
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numTransactionsAccepted
numTransactionsIncluded
numTransactionsReceived
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
primary
primaryContent
primaryIdentifier
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
reprocessOn
reprocessedOn
rootNode {
...TreeNodeFragment
}
routing
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipToAddress {
...AddressFragment
}
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supportedDateFields
testIndicator
textInfo {
...TextSegmentFragment
}
timeline
timestamp
timezoneOffset
transactionBegin
transactionEnd
transactionRefNum
tsControlNumber
tsIDCode
type
unknownFields
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{"id": "abc123"}
¶ Response
{
"data": {
"FindFunctionalAcknowledgmentById": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"acknowledgedEntityIds": ["xyz789"],
"acknowledgedType": ["xyz789"],
"acknowledgementCode": "xyz789",
"acknowledgementDetail": [TransactionHeaderSegment],
"acknowledges": "xyz789",
"acknowledgmentErrorCode": "abc123",
"addressFields": [Address],
"akFuncIDCode": "abc123",
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationPoints": [ErrorCorrelationPoint],
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 987,
"numTransactionsAccepted": 987,
"numTransactionsIncluded": 987,
"numTransactionsReceived": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
FindInvoiceById
¶ Response
Returns an InvoiceDocument
¶ Example
¶ Query
query FindInvoiceById($id: String) {
FindInvoiceById(id: $id) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
addressFields {
...AddressFragment
}
allowChrgIndicator
appAdviceTransferStatus
billFromParty {
...AddressFragment
}
billOfLadingNumber
billToAddress {
...AddressFragment
}
billToParty {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyingParty {
...AddressFragment
}
calculatedSACTotalAmount
calculatedTotalAmount
canDownloadOriginalFile
categoryFacet
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currency
currentScheduleDelivery
currentScheduleShip
customFields
dataFormat
dataFormatVersion
deliveredOn
deliveryRequested
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
estimatedDelivery
eventType
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasAdvanceShipNotice
hasApplicationAdvice
hasErrors
hasExceptions
hasPurchaseOrder
hasRemittanceAdvice
headerSAC {
...SACFragment
}
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
internalVendorNumber
invoiceDate
invoiceNumber
invoiced
invoicedTo {
...ContactRepresentationFragment
}
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
lineItems {
...LineItemFragment
}
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
partyToReceiveCommercialInvoiceRemittance {
...AddressFragment
}
paymentDates
poDate
poDates
poNumber
poNumberCount
poNumbers
primary
primaryContent
primaryIdentifier
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
remitTo {
...AddressFragment
}
reprocessOn
reprocessedOn
requestedShipDate
routing
sellingParty {
...AddressFragment
}
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
serviceCode
serviceCodeList
sharedToCompanies
shipFrom {
...AddressFragment
}
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
shipmentDates
shipmentNumberCount
shipmentNumbers
shipped
soldOn
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supportedDateFields
taxInfo {
...TaxInfoFragment
}
taxMonetaryAmount
taxPercentage
taxTypeCode
termsSaleTypeCode
testIndicator
textInfo {
...TextSegmentFragment
}
thirdPartyCorrelation {
...DocumentCorrelationPointFragment
}
timeline
timestamp
timezoneOffset
totalAmount
totalQuantity
transactionBegin
transactionEnd
transactionRefNum
transactionTypeCode
tsControlNumber
tsIDCode
type
units
unitsOfMeasure
unknownFields
vendor {
...AddressFragment
}
vendorIdNumber
vendorNumber
vendorOrderNumber
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"FindInvoiceById": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"allowChrgIndicator": "xyz789",
"appAdviceTransferStatus": "xyz789",
"billFromParty": Address,
"billOfLadingNumber": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"calculatedSACTotalAmount": 987.65,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "abc123",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"deliveredOn": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": false,
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hasPurchaseOrder": true,
"hasRemittanceAdvice": true,
"headerSAC": [SAC],
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"internalVendorNumber": "xyz789",
"invoiceDate": "2007-12-03",
"invoiceNumber": "abc123",
"invoiced": "2007-12-03",
"invoicedTo": ContactRepresentation,
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"partyToReceiveCommercialInvoiceRemittance": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["xyz789"],
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "abc123",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"serviceCode": "xyz789",
"serviceCodeList": ["abc123"],
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 123,
"shipmentNumbers": ["abc123"],
"shipped": "2007-12-03",
"soldOn": "2007-12-03",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"taxInfo": [TaxInfo],
"taxMonetaryAmount": 123.45,
"taxPercentage": 987.65,
"taxTypeCode": "xyz789",
"termsSaleTypeCode": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 123.45,
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"transactionTypeCode": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "abc123",
"units": "abc123",
"unitsOfMeasure": ["abc123"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "abc123",
"vendorNumber": "xyz789",
"vendorOrderNumber": "xyz789",
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
FindPartnerById
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
query FindPartnerById(
$count: Int,
$offset: Int,
$partnerID: String
) {
FindPartnerById(
count: $count,
offset: $offset,
partnerID: $partnerID
) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{
"count": 30,
"offset": 0,
"partnerID": "abc123"
}
¶ Response
{
"data": {
"FindPartnerById": {
"address": Address,
"companyID": "xyz789",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "xyz789",
"id": "abc123",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "xyz789",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 987
}
}
}
¶
FindPartnerProtocols
¶ Response
Returns a Results_PartnerProtocol
¶ Example
¶ Query
query FindPartnerProtocols($partnerID: String) {
FindPartnerProtocols(partnerID: $partnerID) {
aggregations
items {
...PartnerProtocolFragment
}
totalItems
}
}
¶ Variables
{"partnerID": "abc123"}
¶ Response
{
"data": {
"FindPartnerProtocols": {
"aggregations": Map_String_ObjectScalar,
"items": [PartnerProtocol],
"totalItems": {}
}
}
}
¶
FindPartners
¶ Response
Returns a Results_BusinessPartner
¶ Example
¶ Query
query FindPartners(
$direction: String,
$excludedPartners: [String],
$page: Int,
$searchTerm: String,
$size: Int,
$sortBy: String
) {
FindPartners(
direction: $direction,
excludedPartners: $excludedPartners,
page: $page,
searchTerm: $searchTerm,
size: $size,
sortBy: $sortBy
) {
aggregations
items {
...BusinessPartnerFragment
}
totalItems
}
}
¶ Variables
{
"direction": "asc",
"excludedPartners": ["abc123"],
"page": 0,
"searchTerm": "",
"size": 30,
"sortBy": "nameLowercase"
}
¶ Response
{
"data": {
"FindPartners": {
"aggregations": Map_String_ObjectScalar,
"items": [BusinessPartner],
"totalItems": {}
}
}
}
¶
FindPurchaseOrderAcknowledgmentById
¶ Response
Returns a PurchaseOrderAcknowledgmentDocument
¶ Example
¶ Query
query FindPurchaseOrderAcknowledgmentById($id: String) {
FindPurchaseOrderAcknowledgmentById(id: $id) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
ackType
addressFields {
...AddressFragment
}
appAdviceTransferStatus
billToAddress {
...AddressFragment
}
billToParty {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyingParty {
...AddressFragment
}
calculatedTotalAmount
canDownloadOriginalFile
cancelAfterDate
cancelIfNotShippedByDate
categoryFacet
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currency
currentScheduleDelivery
customFields
dataFormat
dataFormatVersion
deferredPaymentDate
deliveryRequested
deliveryRequestedDate
doNotDeliverAfterDate
doNotDeliverBeforeDate
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
eventType
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasApplicationAdvice
hasErrors
hasExceptions
hasPOChange
hasPurchaseOrder
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
lineItems {
...LineItemFragment
}
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
poDate
poDates
poNumber
poNumberCount
poNumbers
poType
primary
primaryContent
primaryIdentifier
providedTotalAmount
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
releaseDate
reprocessOn
reprocessedOn
requestedForDeliveryDatePriorTo
requestedForDeliveryDateWeekOf
requestedForShipmentDateWeekOf
requestedShipDate
routing
salesReqCode
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipFrom {
...AddressFragment
}
shipMethodPayment
shipNoLaterDate
shipNotBeforeDate
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supplierOrManufacturer {
...AddressFragment
}
supportedDateFields
testIndicator
textInfo {
...TextSegmentFragment
}
timeline
timestamp
timezoneOffset
totalAmount
totalQuantity
transactionBegin
transactionEnd
transactionRefNum
tsControlNumber
tsIDCode
tsPurposeCode
type
unknownFields
vendor {
...AddressFragment
}
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{"id": "abc123"}
¶ Response
{
"data": {
"FindPurchaseOrderAcknowledgmentById": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "xyz789",
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": false,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hasPOChange": true,
"hasPurchaseOrder": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["xyz789"],
"poType": "xyz789",
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"providedTotalAmount": 123.45,
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "abc123",
"salesReqCode": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 123.45,
"totalQuantity": 123.45,
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
FindPurchaseOrderById
¶ Response
Returns a PurchaseOrderDocument
¶ Example
¶ Query
query FindPurchaseOrderById($id: String) {
FindPurchaseOrderById(id: $id) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
ackType
ackTypes
addressFields {
...AddressFragment
}
albertsonsDepartmentNumber
alphaCodes
appAdviceTransferStatus
arrivedAtCustomsDates
arrivedAtTerminalLocationsDates
arrivedDates
availableForDeliveryDates
billOfLadingNumbers
billOfLadingReleasedDates
billToAddress {
...AddressFragment
}
billToParty {
...AddressFragment
}
bodID
bodIDVersion
bookingConfirmedDates
bookingNumbers
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyerIdentification
buyingParty {
...AddressFragment
}
calculatedSACTotalAmount
calculatedTotalAmount
canDownloadOriginalFile
cancelAfterDate
cancelIfNotShippedByDate
cargoReceivedAtContractualPlaceOfReceiptDates
carrierAndCustomsReleaseDates
carrierReleaseDates
categoryFacet
commenters {
...UserInfoFragment
}
companyID
completedUnloadingAtDeliveryLocationDates
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currency
customFields
customsReleasedDates
dataFormat
dataFormatVersion
deferredPaymentDate
deliveryAppointmentDates
deliveryRequested
deliveryRequestedDate
departedPickupLocationDates
departmentNumberText
doNotDeliverAfter
doNotDeliverAfterDate
doNotDeliverBefore
doNotDeliverBeforeDate
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
emptyEquipmentDispatchedDates
entityID
environment
equipmentNumberN9Segments
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
estimatedDeliveryDates
estimatedToArriveDates
estimatedToDepartTerminalLocationDates
eventType
expectedReply
expectedShipDate
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasAdvanceShipNotice
hasApplicationAdvice
hasCreditDebitAdjustment
hasErrors
hasExceptions
hasInvoice
hasPOChange
hasPurchaseOrderAcknowledgment
hasPurchaseOrderChange
hasRemittanceAdvice
hasReturnMerchandiseAuthorization
hasStatusDetail
hasWarehouseShippingAdvice
hasWarehouseShippingOrder
hasWarehouseStockTransferShipmentAdvice
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
internalVendorNumber
invoiceDates
invoiceNumberCount
invoiceNumbers
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
lineItems {
...LineItemFragment
}
loadedOn
loadedOnRailDates
loadedOnTruckDates
loadedOnVesselDates
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
oceanShipmentStatusCodes
oceanShipmentStatuses
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
paymentDates
poAndAsnVendorNumbersMatch
poDate
poNumber
poType
pocDates
primary
primaryContent
primaryIdentifier
providedTotalAmount
purposeCodes
railDepartureFromOriginIntermodalRampsDates
receivedAtOriginDates
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
releaseDate
reprocessOn
reprocessedOn
requestedForDeliveryDatePriorTo
requestedForDeliveryDateWeekOf
requestedForShipmentDateWeekOf
requestedPickup
requestedShipDate
returnedToCarriersTerminalDates
returnedToShipperDates
routing
sacItems {
...SACFragment
}
salesReqCode
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipFrom {
...AddressFragment
}
shipMethodPayment
shipNoLaterDate
shipNotBeforeDate
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
shipToCompany {
...CompanyFragment
}
shipmentCancelledDates
shipmentDates
shipmentNumberCount
shipmentNumbers
shippingMethod
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supplierOrManufacturer {
...AddressFragment
}
supportedDateFields
testIndicator
textInfo {
...TextSegmentFragment
}
textMessages
timeline
timestamp
timezoneOffset
totalAmount
totalQuantity
transactionBegin
transactionEnd
transactionRefNum
transactionTypeCode
tsControlNumber
tsIDCode
tsPurposeCode
tsPurposeCodes
type
units
unitsOfMeasure
unknownFields
vendor {
...AddressFragment
}
vendorIdNumber
vendorIdNumberAsn
vendorNumber
vendorNumbers
vendorOrderNumber
vendorOrderNumberAsn
watchers
webOrderNumber
weight
weightUOM
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"FindPurchaseOrderById": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "xyz789",
"ackTypes": ["abc123"],
"addressFields": [Address],
"albertsonsDepartmentNumber": "abc123",
"alphaCodes": ["abc123"],
"appAdviceTransferStatus": "abc123",
"arrivedAtCustomsDates": [
"2007-12-03"
],
"arrivedAtTerminalLocationsDates": [
"2007-12-03"
],
"arrivedDates": ["2007-12-03"],
"availableForDeliveryDates": [
"2007-12-03"
],
"billOfLadingNumbers": ["abc123"],
"billOfLadingReleasedDates": [
"2007-12-03"
],
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"bookingConfirmedDates": [
"2007-12-03"
],
"bookingNumbers": ["xyz789"],
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyerIdentification": "xyz789",
"buyingParty": Address,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": true,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"cargoReceivedAtContractualPlaceOfReceiptDates": [
"2007-12-03"
],
"carrierAndCustomsReleaseDates": [
"2007-12-03"
],
"carrierReleaseDates": ["2007-12-03"],
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"completedUnloadingAtDeliveryLocationDates": [
"2007-12-03"
],
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "xyz789",
"customFields": Map_String_StringScalar,
"customsReleasedDates": [
"2007-12-03"
],
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"deferredPaymentDate": "2007-12-03",
"deliveryAppointmentDates": [
"2007-12-03"
],
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"departedPickupLocationDates": [
"2007-12-03"
],
"departmentNumberText": "abc123",
"doNotDeliverAfter": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBefore": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "xyz789",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"emptyEquipmentDispatchedDates": [
"2007-12-03"
],
"entityID": "abc123",
"environment": "abc123",
"equipmentNumberN9Segments": [
"xyz789"
],
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDeliveryDates": [
"2007-12-03"
],
"estimatedToArriveDates": [
"2007-12-03"
],
"estimatedToDepartTerminalLocationDates": [
"2007-12-03"
],
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedReply": "2007-12-03",
"expectedShipDate": "2007-12-03",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": false,
"hasApplicationAdvice": true,
"hasCreditDebitAdjustment": false,
"hasErrors": false,
"hasExceptions": true,
"hasInvoice": true,
"hasPOChange": false,
"hasPurchaseOrderAcknowledgment": true,
"hasPurchaseOrderChange": true,
"hasRemittanceAdvice": false,
"hasReturnMerchandiseAuthorization": true,
"hasStatusDetail": true,
"hasWarehouseShippingAdvice": true,
"hasWarehouseShippingOrder": true,
"hasWarehouseStockTransferShipmentAdvice": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumberCount": 123,
"invoiceNumbers": ["abc123"],
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"loadedOnRailDates": ["2007-12-03"],
"loadedOnTruckDates": ["2007-12-03"],
"loadedOnVesselDates": ["2007-12-03"],
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 987,
"oceanShipmentStatusCodes": [
"abc123"
],
"oceanShipmentStatuses": ["abc123"],
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"paymentDates": ["2007-12-03"],
"poAndAsnVendorNumbersMatch": false,
"poDate": "2007-12-03",
"poNumber": "xyz789",
"poType": "xyz789",
"pocDates": ["2007-12-03"],
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"providedTotalAmount": 987.65,
"purposeCodes": ["xyz789"],
"railDepartureFromOriginIntermodalRampsDates": [
"2007-12-03"
],
"receivedAtOriginDates": [
"2007-12-03"
],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedPickup": "2007-12-03",
"requestedShipDate": "2007-12-03",
"returnedToCarriersTerminalDates": [
"2007-12-03"
],
"returnedToShipperDates": [
"2007-12-03"
],
"routing": "abc123",
"sacItems": [SAC],
"salesReqCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipMethodPayment": "xyz789",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"shipToCompany": Company,
"shipmentCancelledDates": [
"2007-12-03"
],
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["abc123"],
"shippingMethod": "xyz789",
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"textMessages": ["xyz789"],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 123.45,
"totalQuantity": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"transactionTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"tsPurposeCodes": ["xyz789"],
"type": "abc123",
"units": "xyz789",
"unitsOfMeasure": ["abc123"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "xyz789",
"vendorIdNumberAsn": "abc123",
"vendorNumber": "xyz789",
"vendorNumbers": ["xyz789"],
"vendorOrderNumber": "abc123",
"vendorOrderNumberAsn": "abc123",
"watchers": ["xyz789"],
"webOrderNumber": "xyz789",
"weight": 987.65,
"weightUOM": "xyz789",
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
FindSystems
¶ Response
Returns a Results_BusinessPartner
¶ Example
¶ Query
query FindSystems(
$direction: String,
$excludedPartners: [String],
$page: Int,
$searchTerm: String,
$size: Int,
$sortBy: String
) {
FindSystems(
direction: $direction,
excludedPartners: $excludedPartners,
page: $page,
searchTerm: $searchTerm,
size: $size,
sortBy: $sortBy
) {
aggregations
items {
...BusinessPartnerFragment
}
totalItems
}
}
¶ Variables
{
"direction": "asc",
"excludedPartners": ["xyz789"],
"page": 0,
"searchTerm": "",
"size": 30,
"sortBy": "nameLowercase"
}
¶ Response
{
"data": {
"FindSystems": {
"aggregations": Map_String_ObjectScalar,
"items": [BusinessPartner],
"totalItems": {}
}
}
}
¶
GeneratePrivateKey
¶
PartnersInfo
¶
SystemsInfo
¶
all_documents
¶ Response
Returns a Results_BaseBusinessDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query all_documents($SearchRequest: SearchRequestInput) {
all_documents(SearchRequest: $SearchRequest) {
aggregations
items {
...BaseBusinessDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"all_documents": {
"aggregations": Map_String_ObjectScalar,
"items": [BaseBusinessDocument],
"totalItems": {}
}
}
}
¶
all_map_templates
¶ Response
Returns [RepositoryFile]
¶ Example
¶ Query
query all_map_templates {
all_map_templates {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Response
{
"data": {
"all_map_templates": [
{
"comments": "xyz789",
"companyID": "abc123",
"content": "abc123",
"defaultVersion": "xyz789",
"directions": "xyz789",
"docType": "abc123",
"documentType": "abc123",
"enable": false,
"environment": "xyz789",
"fileType": "xyz789",
"id": "xyz789",
"indexName": "abc123",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "abc123",
"partner": "xyz789",
"readOnly": true,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["abc123"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
]
}
}
¶
all_map_versions
¶ Response
Returns an Results_XSLTMapVersion
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query all_map_versions($SearchRequest: SearchRequestInput) {
all_map_versions(SearchRequest: $SearchRequest) {
aggregations
items {
...XSLTMapVersionFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"all_map_versions": {
"aggregations": Map_String_ObjectScalar,
"items": [XSLTMapVersion],
"totalItems": {}
}
}
}
¶
all_maps
¶ Response
Returns a Results_RepositoryFile
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query all_maps($SearchRequest: SearchRequestInput) {
all_maps(SearchRequest: $SearchRequest) {
aggregations
items {
...RepositoryFileFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"all_maps": {
"aggregations": Map_String_ObjectScalar,
"items": [RepositoryFile],
"totalItems": {}
}
}
}
¶
companySubOrgs
¶ Example
¶ Query
query companySubOrgs($companyID: String) {
companySubOrgs(companyID: $companyID) {
children {
...SubOrgDTOFragment
}
companyID
id
identifiers {
...CompanyBusinessIdentifierFragment
}
name
parentID
removeable
}
}
¶ Variables
{"companyID": "xyz789"}
¶ Response
{
"data": {
"companySubOrgs": {
"children": [SubOrgDTO],
"companyID": "abc123",
"id": "xyz789",
"identifiers": [CompanyBusinessIdentifier],
"name": "xyz789",
"parentID": "xyz789",
"removeable": false
}
}
}
¶
company_env_list
¶ Response
Returns a Map_String_CompanyGroupScalar
¶
dashboard_by_id
¶ Response
Returns a DashboardConfig
¶ Example
¶ Query
query dashboard_by_id($dashboardId: String) {
dashboard_by_id(dashboardId: $dashboardId) {
companyID
createdOn
environment
favorite
galleryReferenceID
galleryType
hasEdited
id
lastUpdated
layout {
...LayoutConfigFragment
}
name
owner {
...UserDetailsFragment
}
sharedWith {
...UserDetailsFragment
}
sharedWithIDs
updatedBy {
...UserDetailsFragment
}
userID
widgets {
...WidgetConfigFragment
}
}
}
¶ Variables
{"dashboardId": "xyz789"}
¶ Response
{
"data": {
"dashboard_by_id": {
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"favorite": false,
"galleryReferenceID": "xyz789",
"galleryType": "DASHBOARD",
"hasEdited": false,
"id": "abc123",
"lastUpdated": "2007-12-03",
"layout": LayoutConfig,
"name": "xyz789",
"owner": UserDetails,
"sharedWith": [UserDetails],
"sharedWithIDs": ["xyz789"],
"updatedBy": UserDetails,
"userID": "abc123",
"widgets": [WidgetConfig]
}
}
}
¶
docs_advance_ship_notice
¶ Response
Returns a Results_AdvanceShipNoticeDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_advance_ship_notice($SearchRequest: SearchRequestInput) {
docs_advance_ship_notice(SearchRequest: $SearchRequest) {
aggregations
items {
...AdvanceShipNoticeDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_advance_ship_notice": {
"aggregations": Map_String_ObjectScalar,
"items": [AdvanceShipNoticeDocument],
"totalItems": {}
}
}
}
¶
docs_application_advice_824
¶ Response
Returns a Results_ApplicationAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_application_advice_824($SearchRequest: SearchRequestInput) {
docs_application_advice_824(SearchRequest: $SearchRequest) {
aggregations
items {
...ApplicationAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_application_advice_824": {
"aggregations": Map_String_ObjectScalar,
"items": [ApplicationAdviceDocument],
"totalItems": {}
}
}
}
¶
docs_credit_debit_adjustment
¶ Response
Returns a Results_CreditDebitAdjustmentDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_credit_debit_adjustment($SearchRequest: SearchRequestInput) {
docs_credit_debit_adjustment(SearchRequest: $SearchRequest) {
aggregations
items {
...CreditDebitAdjustmentDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_credit_debit_adjustment": {
"aggregations": Map_String_ObjectScalar,
"items": [CreditDebitAdjustmentDocument],
"totalItems": {}
}
}
}
¶
docs_delivery_return_ack_adj
¶ Response
Returns a Results_DeliveryReturnAckAdjDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_delivery_return_ack_adj($SearchRequest: SearchRequestInput) {
docs_delivery_return_ack_adj(SearchRequest: $SearchRequest) {
aggregations
items {
...DeliveryReturnAckAdjDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_delivery_return_ack_adj": {
"aggregations": Map_String_ObjectScalar,
"items": [DeliveryReturnAckAdjDocument],
"totalItems": {}
}
}
}
¶
docs_delivery_return_base_record
¶ Response
Returns a Results_DeliveryReturnBaseRecordDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_delivery_return_base_record($SearchRequest: SearchRequestInput) {
docs_delivery_return_base_record(SearchRequest: $SearchRequest) {
aggregations
items {
...DeliveryReturnBaseRecordDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_delivery_return_base_record": {
"aggregations": Map_String_ObjectScalar,
"items": [DeliveryReturnBaseRecordDocument],
"totalItems": {}
}
}
}
¶
docs_functional_acknowledgement_997
¶ Response
Returns a Results_FunctionalAcknowledgmentDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_functional_acknowledgement_997($SearchRequest: SearchRequestInput) {
docs_functional_acknowledgement_997(SearchRequest: $SearchRequest) {
aggregations
items {
...FunctionalAcknowledgmentDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_functional_acknowledgement_997": {
"aggregations": Map_String_ObjectScalar,
"items": [FunctionalAcknowledgmentDocument],
"totalItems": {}
}
}
}
¶
docs_grocery_products_invoice
¶ Response
Returns a Results_GroceryProductsInvoiceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_grocery_products_invoice($SearchRequest: SearchRequestInput) {
docs_grocery_products_invoice(SearchRequest: $SearchRequest) {
aggregations
items {
...GroceryProductsInvoiceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_grocery_products_invoice": {
"aggregations": Map_String_ObjectScalar,
"items": [GroceryProductsInvoiceDocument],
"totalItems": {}
}
}
}
¶
docs_grocery_products_purchase_order
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_grocery_products_purchase_order($SearchRequest: SearchRequestInput) {
docs_grocery_products_purchase_order(SearchRequest: $SearchRequest) {
aggregations
items {
...GroceryProductsPurchaseOrderDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_grocery_products_purchase_order": {
"aggregations": Map_String_ObjectScalar,
"items": [GroceryProductsPurchaseOrderDocument],
"totalItems": {}
}
}
}
¶
docs_inventory_inquiry_advice
¶ Response
Returns a Results_InventoryInquiryAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_inventory_inquiry_advice($SearchRequest: SearchRequestInput) {
docs_inventory_inquiry_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...InventoryInquiryAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_inventory_inquiry_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [InventoryInquiryAdviceDocument],
"totalItems": {}
}
}
}
¶
docs_invoice
¶ Response
Returns a Results_InvoiceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_invoice($SearchRequest: SearchRequestInput) {
docs_invoice(SearchRequest: $SearchRequest) {
aggregations
items {
...InvoiceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_invoice": {
"aggregations": Map_String_ObjectScalar,
"items": [InvoiceDocument],
"totalItems": {}
}
}
}
¶
docs_item_maintenance
¶ Response
Returns a Results_ItemMaintenanceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_item_maintenance($SearchRequest: SearchRequestInput) {
docs_item_maintenance(SearchRequest: $SearchRequest) {
aggregations
items {
...ItemMaintenanceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_item_maintenance": {
"aggregations": Map_String_ObjectScalar,
"items": [ItemMaintenanceDocument],
"totalItems": {}
}
}
}
¶
docs_lockbox
¶ Response
Returns a Results_LockboxDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_lockbox($SearchRequest: SearchRequestInput) {
docs_lockbox(SearchRequest: $SearchRequest) {
aggregations
items {
...LockboxDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_lockbox": {
"aggregations": Map_String_ObjectScalar,
"items": [LockboxDocument],
"totalItems": {}
}
}
}
¶
docs_motor_carrier_bill_loading
¶ Response
Returns a Results_MotorCarrierBillOfLadingDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_motor_carrier_bill_loading($SearchRequest: SearchRequestInput) {
docs_motor_carrier_bill_loading(SearchRequest: $SearchRequest) {
aggregations
items {
...MotorCarrierBillOfLadingDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_motor_carrier_bill_loading": {
"aggregations": Map_String_ObjectScalar,
"items": [MotorCarrierBillOfLadingDocument],
"totalItems": {}
}
}
}
¶
docs_motor_carrier_freight_details_invoice
¶ Response
Returns a Results_MotorCarrierFreightDetailsAndInvoiceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_motor_carrier_freight_details_invoice($SearchRequest: SearchRequestInput) {
docs_motor_carrier_freight_details_invoice(SearchRequest: $SearchRequest) {
aggregations
items {
...MotorCarrierFreightDetailsAndInvoiceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_motor_carrier_freight_details_invoice": {
"aggregations": Map_String_ObjectScalar,
"items": [
MotorCarrierFreightDetailsAndInvoiceDocument
],
"totalItems": {}
}
}
}
¶
docs_motor_carrier_load_tender
¶ Response
Returns a Results_MotorCarrierLoadTenderDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_motor_carrier_load_tender($SearchRequest: SearchRequestInput) {
docs_motor_carrier_load_tender(SearchRequest: $SearchRequest) {
aggregations
items {
...MotorCarrierLoadTenderDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_motor_carrier_load_tender": {
"aggregations": Map_String_ObjectScalar,
"items": [MotorCarrierLoadTenderDocument],
"totalItems": {}
}
}
}
¶
docs_order_status_report
¶ Response
Returns a Results_OrderStatusReportDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_order_status_report($SearchRequest: SearchRequestInput) {
docs_order_status_report(SearchRequest: $SearchRequest) {
aggregations
items {
...OrderStatusReportDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_order_status_report": {
"aggregations": Map_String_ObjectScalar,
"items": [OrderStatusReportDocument],
"totalItems": {}
}
}
}
¶
docs_organizational_relationship
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_organizational_relationship($SearchRequest: SearchRequestInput) {
docs_organizational_relationship(SearchRequest: $SearchRequest) {
aggregations
items {
...OrganizationalRelationshipsDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_organizational_relationship": {
"aggregations": Map_String_ObjectScalar,
"items": [OrganizationalRelationshipsDocument],
"totalItems": {}
}
}
}
¶
docs_planning_schedule
¶ Response
Returns a Results_PlanningScheduleDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_planning_schedule($SearchRequest: SearchRequestInput) {
docs_planning_schedule(SearchRequest: $SearchRequest) {
aggregations
items {
...PlanningScheduleDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_planning_schedule": {
"aggregations": Map_String_ObjectScalar,
"items": [PlanningScheduleDocument],
"totalItems": {}
}
}
}
¶
docs_price_authorization_ack
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_price_authorization_ack($SearchRequest: SearchRequestInput) {
docs_price_authorization_ack(SearchRequest: $SearchRequest) {
aggregations
items {
...PriceAuthorizationAcknowledgmentDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_price_authorization_ack": {
"aggregations": Map_String_ObjectScalar,
"items": [PriceAuthorizationAcknowledgmentDocument],
"totalItems": {}
}
}
}
¶
docs_price_catalog
¶ Response
Returns a Results_PriceSalesCatalogDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_price_catalog($SearchRequest: SearchRequestInput) {
docs_price_catalog(SearchRequest: $SearchRequest) {
aggregations
items {
...PriceSalesCatalogDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_price_catalog": {
"aggregations": Map_String_ObjectScalar,
"items": [PriceSalesCatalogDocument],
"totalItems": {}
}
}
}
¶
docs_price_information
¶ Response
Returns a Results_PriceInformationDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_price_information($SearchRequest: SearchRequestInput) {
docs_price_information(SearchRequest: $SearchRequest) {
aggregations
items {
...PriceInformationDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_price_information": {
"aggregations": Map_String_ObjectScalar,
"items": [PriceInformationDocument],
"totalItems": {}
}
}
}
¶
docs_product_activity
¶ Response
Returns a Results_ProductActivityDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_product_activity($SearchRequest: SearchRequestInput) {
docs_product_activity(SearchRequest: $SearchRequest) {
aggregations
items {
...ProductActivityDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_product_activity": {
"aggregations": Map_String_ObjectScalar,
"items": [ProductActivityDocument],
"totalItems": {}
}
}
}
¶
docs_product_transfer_account_adj_response
¶ Response
Returns a Results_ProductTransferAccountAdjustmentResponseDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_product_transfer_account_adj_response($SearchRequest: SearchRequestInput) {
docs_product_transfer_account_adj_response(SearchRequest: $SearchRequest) {
aggregations
items {
...ProductTransferAccountAdjustmentResponseDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_product_transfer_account_adj_response": {
"aggregations": Map_String_ObjectScalar,
"items": [
ProductTransferAccountAdjustmentResponseDocument
],
"totalItems": {}
}
}
}
¶
docs_product_transfer_account_adjustment
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_product_transfer_account_adjustment($SearchRequest: SearchRequestInput) {
docs_product_transfer_account_adjustment(SearchRequest: $SearchRequest) {
aggregations
items {
...ProductTransferAccountAdjustmentDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_product_transfer_account_adjustment": {
"aggregations": Map_String_ObjectScalar,
"items": [ProductTransferAccountAdjustmentDocument],
"totalItems": {}
}
}
}
¶
docs_product_transfer_resale_report
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_product_transfer_resale_report($SearchRequest: SearchRequestInput) {
docs_product_transfer_resale_report(SearchRequest: $SearchRequest) {
aggregations
items {
...ProductTransferAndResaleReportDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_product_transfer_resale_report": {
"aggregations": Map_String_ObjectScalar,
"items": [ProductTransferAndResaleReportDocument],
"totalItems": {}
}
}
}
¶
docs_promotion_announcement
¶ Response
Returns a Results_PromotionAnnouncementDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_promotion_announcement($SearchRequest: SearchRequestInput) {
docs_promotion_announcement(SearchRequest: $SearchRequest) {
aggregations
items {
...PromotionAnnouncementDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_promotion_announcement": {
"aggregations": Map_String_ObjectScalar,
"items": [PromotionAnnouncementDocument],
"totalItems": {}
}
}
}
¶
docs_purchase_order_acknowledgement
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_purchase_order_acknowledgement($SearchRequest: SearchRequestInput) {
docs_purchase_order_acknowledgement(SearchRequest: $SearchRequest) {
aggregations
items {
...PurchaseOrderAcknowledgmentDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_purchase_order_acknowledgement": {
"aggregations": Map_String_ObjectScalar,
"items": [PurchaseOrderAcknowledgmentDocument],
"totalItems": {}
}
}
}
¶
docs_purchase_order_change
¶ Response
Returns a Results_PurchaseOrderChangeDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_purchase_order_change($SearchRequest: SearchRequestInput) {
docs_purchase_order_change(SearchRequest: $SearchRequest) {
aggregations
items {
...PurchaseOrderChangeDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_purchase_order_change": {
"aggregations": Map_String_ObjectScalar,
"items": [PurchaseOrderChangeDocument],
"totalItems": {}
}
}
}
¶
docs_rail_carrier_invoice
¶ Response
Returns a Results_RailCarrierInvoiceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_rail_carrier_invoice($SearchRequest: SearchRequestInput) {
docs_rail_carrier_invoice(SearchRequest: $SearchRequest) {
aggregations
items {
...RailCarrierInvoiceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_rail_carrier_invoice": {
"aggregations": Map_String_ObjectScalar,
"items": [RailCarrierInvoiceDocument],
"totalItems": {}
}
}
}
¶
docs_rail_carrier_shipment
¶ Response
Returns a Results_RailCarrierShipmentDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_rail_carrier_shipment($SearchRequest: SearchRequestInput) {
docs_rail_carrier_shipment(SearchRequest: $SearchRequest) {
aggregations
items {
...RailCarrierShipmentDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_rail_carrier_shipment": {
"aggregations": Map_String_ObjectScalar,
"items": [RailCarrierShipmentDocument],
"totalItems": {}
}
}
}
¶
docs_rail_carrier_waybill
¶ Response
Returns a Results_RailCarrierWaybillDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_rail_carrier_waybill($SearchRequest: SearchRequestInput) {
docs_rail_carrier_waybill(SearchRequest: $SearchRequest) {
aggregations
items {
...RailCarrierWaybillDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_rail_carrier_waybill": {
"aggregations": Map_String_ObjectScalar,
"items": [RailCarrierWaybillDocument],
"totalItems": {}
}
}
}
¶
docs_receiving_advice
¶ Response
Returns a Results_ReceivingAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_receiving_advice($SearchRequest: SearchRequestInput) {
docs_receiving_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...ReceivingAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_receiving_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [ReceivingAdviceDocument],
"totalItems": {}
}
}
}
¶
docs_remittance_advice
¶ Response
Returns a Results_RemittanceAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_remittance_advice($SearchRequest: SearchRequestInput) {
docs_remittance_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...RemittanceAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_remittance_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [RemittanceAdviceDocument],
"totalItems": {}
}
}
}
¶
docs_report_of_test_results
¶ Response
Returns a Results_ReportOfTestResultsDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_report_of_test_results($SearchRequest: SearchRequestInput) {
docs_report_of_test_results(SearchRequest: $SearchRequest) {
aggregations
items {
...ReportOfTestResultsDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_report_of_test_results": {
"aggregations": Map_String_ObjectScalar,
"items": [ReportOfTestResultsDocument],
"totalItems": {}
}
}
}
¶
docs_request_for_routing_instructions
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_request_for_routing_instructions($SearchRequest: SearchRequestInput) {
docs_request_for_routing_instructions(SearchRequest: $SearchRequest) {
aggregations
items {
...RequestForRoutingInstructionsDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_request_for_routing_instructions": {
"aggregations": Map_String_ObjectScalar,
"items": [RequestForRoutingInstructionsDocument],
"totalItems": {}
}
}
}
¶
docs_response_to_load_tender
¶ Response
Returns a Results_ResponseToLoadTenderDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_response_to_load_tender($SearchRequest: SearchRequestInput) {
docs_response_to_load_tender(SearchRequest: $SearchRequest) {
aggregations
items {
...ResponseToLoadTenderDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_response_to_load_tender": {
"aggregations": Map_String_ObjectScalar,
"items": [ResponseToLoadTenderDocument],
"totalItems": {}
}
}
}
¶
docs_return_merchandise_authorization
¶ Response
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_return_merchandise_authorization($SearchRequest: SearchRequestInput) {
docs_return_merchandise_authorization(SearchRequest: $SearchRequest) {
aggregations
items {
...ReturnMerchandiseAuthorizationDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_return_merchandise_authorization": {
"aggregations": Map_String_ObjectScalar,
"items": [ReturnMerchandiseAuthorizationDocument],
"totalItems": {}
}
}
}
¶
docs_routing_instructions
¶ Response
Returns a Results_RoutingInstructionsDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_routing_instructions($SearchRequest: SearchRequestInput) {
docs_routing_instructions(SearchRequest: $SearchRequest) {
aggregations
items {
...RoutingInstructionsDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_routing_instructions": {
"aggregations": Map_String_ObjectScalar,
"items": [RoutingInstructionsDocument],
"totalItems": {}
}
}
}
¶
docs_shipment_billing_notice
¶ Response
Returns a Results_ShipmentBillingNoticeDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_shipment_billing_notice($SearchRequest: SearchRequestInput) {
docs_shipment_billing_notice(SearchRequest: $SearchRequest) {
aggregations
items {
...ShipmentBillingNoticeDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_shipment_billing_notice": {
"aggregations": Map_String_ObjectScalar,
"items": [ShipmentBillingNoticeDocument],
"totalItems": {}
}
}
}
¶
docs_shipping_schedule
¶ Response
Returns a Results_ShippingScheduleDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_shipping_schedule($SearchRequest: SearchRequestInput) {
docs_shipping_schedule(SearchRequest: $SearchRequest) {
aggregations
items {
...ShippingScheduleDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_shipping_schedule": {
"aggregations": Map_String_ObjectScalar,
"items": [ShippingScheduleDocument],
"totalItems": {}
}
}
}
¶
docs_status_details
¶ Response
Returns a Results_StatusDetailsDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_status_details($SearchRequest: SearchRequestInput) {
docs_status_details(SearchRequest: $SearchRequest) {
aggregations
items {
...StatusDetailsDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_status_details": {
"aggregations": Map_String_ObjectScalar,
"items": [StatusDetailsDocument],
"totalItems": {}
}
}
}
¶
docs_text_message
¶ Response
Returns a Results_TextMessageDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_text_message($SearchRequest: SearchRequestInput) {
docs_text_message(SearchRequest: $SearchRequest) {
aggregations
items {
...TextMessageDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_text_message": {
"aggregations": Map_String_ObjectScalar,
"items": [TextMessageDocument],
"totalItems": {}
}
}
}
¶
docs_transportation_carrier_shipment_status_message
¶ Response
Returns a Results_TransportationCarrierShipmentStatusMessageDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_transportation_carrier_shipment_status_message($SearchRequest: SearchRequestInput) {
docs_transportation_carrier_shipment_status_message(SearchRequest: $SearchRequest) {
aggregations
items {
...TransportationCarrierShipmentStatusMessageDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_transportation_carrier_shipment_status_message": {
"aggregations": Map_String_ObjectScalar,
"items": [
TransportationCarrierShipmentStatusMessageDocument
],
"totalItems": {}
}
}
}
¶
docs_warehouse_inventory_adj_advice
¶ Response
Returns a Results_WarehouseInventoryAdjustmentAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_warehouse_inventory_adj_advice($SearchRequest: SearchRequestInput) {
docs_warehouse_inventory_adj_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...WarehouseInventoryAdjustmentAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_warehouse_inventory_adj_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [
WarehouseInventoryAdjustmentAdviceDocument
],
"totalItems": {}
}
}
}
¶
docs_warehouse_shipping_advice
¶ Response
Returns a Results_WarehouseShippingAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_warehouse_shipping_advice($SearchRequest: SearchRequestInput) {
docs_warehouse_shipping_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...WarehouseShippingAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_warehouse_shipping_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseShippingAdviceDocument],
"totalItems": {}
}
}
}
¶
docs_warehouse_shipping_order
¶ Response
Returns a Results_WarehouseShippingOrderDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_warehouse_shipping_order($SearchRequest: SearchRequestInput) {
docs_warehouse_shipping_order(SearchRequest: $SearchRequest) {
aggregations
items {
...WarehouseShippingOrderDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_warehouse_shipping_order": {
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseShippingOrderDocument],
"totalItems": {}
}
}
}
¶
docs_warehouse_stock_transfer_receipt_advice
¶ Response
Returns a Results_WarehouseStockTransferReceiptAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_warehouse_stock_transfer_receipt_advice($SearchRequest: SearchRequestInput) {
docs_warehouse_stock_transfer_receipt_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...WarehouseStockTransferReceiptAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_warehouse_stock_transfer_receipt_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [
WarehouseStockTransferReceiptAdviceDocument
],
"totalItems": {}
}
}
}
¶
docs_warehouse_stock_transfer_shipment_advice
¶ Response
Returns a Results_WarehouseStockTransferShipmentAdviceDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query docs_warehouse_stock_transfer_shipment_advice($SearchRequest: SearchRequestInput) {
docs_warehouse_stock_transfer_shipment_advice(SearchRequest: $SearchRequest) {
aggregations
items {
...WarehouseStockTransferShipmentAdviceDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"docs_warehouse_stock_transfer_shipment_advice": {
"aggregations": Map_String_ObjectScalar,
"items": [
WarehouseStockTransferShipmentAdviceDocument
],
"totalItems": {}
}
}
}
¶
domain_groups
¶ Response
Returns a Results_Group
¶ Example
¶ Query
query domain_groups($domain: String) {
domain_groups(domain: $domain) {
aggregations
items {
...GroupFragment
}
totalItems
}
}
¶ Variables
{"domain": "xyz789"}
¶ Response
{
"data": {
"domain_groups": {
"aggregations": Map_String_ObjectScalar,
"items": [Group],
"totalItems": {}
}
}
}
¶
downloadFromS3_map
¶
environment_members
¶ Response
Returns a Results_UserDetails
¶ Example
¶ Query
query environment_members(
$count: Int,
$environmentId: String,
$offset: Int
) {
environment_members(
count: $count,
environmentId: $environmentId,
offset: $offset
) {
aggregations
items {
...UserDetailsFragment
}
totalItems
}
}
¶ Variables
{
"count": 10,
"environmentId": "xyz789",
"offset": 0
}
¶ Response
{
"data": {
"environment_members": {
"aggregations": Map_String_ObjectScalar,
"items": [UserDetails],
"totalItems": {}
}
}
}
¶
environments_list
¶ Response
Returns a Results_Environment
¶
event_summaries
¶ Response
Returns a Results_EventSummary
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query event_summaries($SearchRequest: SearchRequestInput) {
event_summaries(SearchRequest: $SearchRequest) {
aggregations
items {
...EventSummaryFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"event_summaries": {
"aggregations": Map_String_ObjectScalar,
"items": [EventSummary],
"totalItems": {}
}
}
}
¶
event_summary
¶ Response
Returns an EventSummary
¶ Example
¶ Query
query event_summary($id: String) {
event_summary(id: $id) {
arrivedFileKey
companyID
consumerErrorMessage
consumerFileSize
consumerFilename
consumerID
consumerMailboxPath
consumerName
consumerOperation
consumerPartner {
...BusinessPartnerFragment
}
consumerPathFilename
consumerProtocol
consumerRemoteHost
consumerRemoteIP
consumerStatus
consumerSteps {
...ProcessingStepFragment
}
consumerTimestamp
delieryErrorMessage
deliveryStatus
deliveryTimestamp
environment
eventSourceName
eventSourceType
eventSourceURL
id
indexName
lastUpdated
overallStatus
parties {
...BusinessPartnerFragment
}
partiesIDs
processSteps {
...ProcessingStepFragment
}
processingErrorMessage
processingStatus
processingTimestamp
producerCode
producerDocumentId
producerErrorMessage
producerFileSize
producerFilename
producerID
producerMailboxPath
producerMessageId
producerName
producerOperation
producerPartner {
...BusinessPartnerFragment
}
producerPathFilename
producerProtocol
producerRemoteHost
producerRemoteIP
producerStatus
producerSteps {
...ProcessingStepFragment
}
producerTimestamp
producerUserId
routing
routingTemplateName
timestamp
}
}
¶ Variables
{"id": "abc123"}
¶ Response
{
"data": {
"event_summary": {
"arrivedFileKey": "abc123",
"companyID": "xyz789",
"consumerErrorMessage": "abc123",
"consumerFileSize": {},
"consumerFilename": "abc123",
"consumerID": "xyz789",
"consumerMailboxPath": "xyz789",
"consumerName": "abc123",
"consumerOperation": "abc123",
"consumerPartner": BusinessPartner,
"consumerPathFilename": "xyz789",
"consumerProtocol": "abc123",
"consumerRemoteHost": "xyz789",
"consumerRemoteIP": "xyz789",
"consumerStatus": "Failed",
"consumerSteps": [ProcessingStep],
"consumerTimestamp": "2007-12-03",
"delieryErrorMessage": "xyz789",
"deliveryStatus": "Failed",
"deliveryTimestamp": "2007-12-03",
"environment": "abc123",
"eventSourceName": "xyz789",
"eventSourceType": "abc123",
"eventSourceURL": "xyz789",
"id": "xyz789",
"indexName": "xyz789",
"lastUpdated": "2007-12-03",
"overallStatus": "Failed",
"parties": [BusinessPartner],
"partiesIDs": "xyz789",
"processSteps": [ProcessingStep],
"processingErrorMessage": "abc123",
"processingStatus": "Failed",
"processingTimestamp": "2007-12-03",
"producerCode": "xyz789",
"producerDocumentId": "xyz789",
"producerErrorMessage": "abc123",
"producerFileSize": {},
"producerFilename": "abc123",
"producerID": "abc123",
"producerMailboxPath": "xyz789",
"producerMessageId": "xyz789",
"producerName": "xyz789",
"producerOperation": "xyz789",
"producerPartner": BusinessPartner,
"producerPathFilename": "abc123",
"producerProtocol": "abc123",
"producerRemoteHost": "xyz789",
"producerRemoteIP": "xyz789",
"producerStatus": "Failed",
"producerSteps": [ProcessingStep],
"producerTimestamp": "2007-12-03",
"producerUserId": "abc123",
"routing": "xyz789",
"routingTemplateName": "xyz789",
"timestamp": "2007-12-03"
}
}
}
¶
file
¶ Response
Returns a FileMetadata
¶ Example
¶ Query
query file($Id: String) {
file(Id: $Id) {
canDownloadOriginalFile
commenters {
...UserInfoFragment
}
companyID
conversation {
...ConversationFragment
}
conversation_id
environment
fileType
id
indexName
name
originalFileID
path
replayedOn
reprocessOn
reprocessedOn
routing
senderID
size
status
timestamp
type
watchers
}
}
¶ Variables
{"Id": "xyz789"}
¶ Response
{
"data": {
"file": {
"canDownloadOriginalFile": true,
"commenters": [UserInfo],
"companyID": "abc123",
"conversation": Conversation,
"conversation_id": "abc123",
"environment": "abc123",
"fileType": "Axalta",
"id": "xyz789",
"indexName": "xyz789",
"name": "abc123",
"originalFileID": "xyz789",
"path": "abc123",
"replayedOn": ["2007-12-03"],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"senderID": "xyz789",
"size": {},
"status": "FAILED_PROCESSING",
"timestamp": "2007-12-03",
"type": "xyz789",
"watchers": ["xyz789"]
}
}
}
¶
files
¶ Response
Returns a Results_FileMetadata
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query files($SearchRequest: SearchRequestInput) {
files(SearchRequest: $SearchRequest) {
aggregations
items {
...FileMetadataFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"files": {
"aggregations": Map_String_ObjectScalar,
"items": [FileMetadata],
"totalItems": {}
}
}
}
¶
findFeatureById
¶ Example
¶ Query
query findFeatureById($id: String) {
findFeatureById(id: $id) {
companyAccess
createdOn
description
global
id
lastUpdated
name
userAccess
}
}
¶ Variables
{"id": "abc123"}
¶ Response
{
"data": {
"findFeatureById": {
"companyAccess": ["abc123"],
"createdOn": "2007-12-03",
"description": "xyz789",
"global": false,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"name": "xyz789",
"userAccess": ["xyz789"]
}
}
}
¶
gallery_item_by_id
¶ Response
Returns a GalleryItem
¶ Example
¶ Query
query gallery_item_by_id($galleryId: String) {
gallery_item_by_id(galleryId: $galleryId) {
companyID
config {
...DashboardConfigFragment
}
createdOn
description
id
published
screenshotID
title
type
}
}
¶ Variables
{"galleryId": "xyz789"}
¶ Response
{
"data": {
"gallery_item_by_id": {
"companyID": "abc123",
"config": DashboardConfig,
"createdOn": "2007-12-03",
"description": "abc123",
"id": "xyz789",
"published": true,
"screenshotID": "abc123",
"title": "abc123",
"type": "DASHBOARD"
}
}
}
¶
gallery_items
¶ Response
Returns a Results_GalleryItem
¶ Arguments
| Name | Description |
|---|---|
count - Int
|
Default = 10 |
offset - Int
|
Default = 0 |
searchTerm - String
|
Default = "" |
type - GalleryItemType
|
¶ Example
¶ Query
query gallery_items(
$count: Int,
$offset: Int,
$searchTerm: String,
$type: GalleryItemType
) {
gallery_items(
count: $count,
offset: $offset,
searchTerm: $searchTerm,
type: $type
) {
aggregations
items {
...GalleryItemFragment
}
totalItems
}
}
¶ Variables
{"count": 10, "offset": 0, "searchTerm": "", "type": "DASHBOARD"}
¶ Response
{
"data": {
"gallery_items": {
"aggregations": Map_String_ObjectScalar,
"items": [GalleryItem],
"totalItems": {}
}
}
}
¶
group_details
¶ Example
¶ Query
query group_details($groupId: String) {
group_details(groupId: $groupId) {
avatarID
companyID
environment
hasHiddenMembers
id
members {
...UserDetailsFragment
}
name
permissionList
permissions
}
}
¶ Variables
{"groupId": "abc123"}
¶ Response
{
"data": {
"group_details": {
"avatarID": "abc123",
"companyID": "abc123",
"environment": "xyz789",
"hasHiddenMembers": true,
"id": "abc123",
"members": [UserDetails],
"name": "abc123",
"permissionList": ["abc123"],
"permissions": Map_String_ObjectScalar
}
}
}
¶
list_companies
¶ Example
¶ Query
query list_companies {
list_companies {
BPartners {
...CompanyFragment
}
adminGroup_id
avatarID
companyContact {
...CompanyContactFragment
}
complianceLicense
contactRecords {
...ContactRecordFragment
}
dataManagerCompanyID
defaultGroup_id
description
domains
groups
hasProcessedTa1
id
industryCode
local
locations
managedCompanyIds
members
name
openSignupDisabled
parentCompany {
...CompanyFragment
}
passwordRequirements {
...PasswordRequirementsFragment
}
pendingDomainRequests {
...DomainRequestFragment
}
preferences {
...CompanyPreferencesFragment
}
uniqueFilenames
}
}
¶ Response
{
"data": {
"list_companies": [
{
"BPartners": [Company],
"adminGroup_id": "abc123",
"avatarID": "abc123",
"companyContact": CompanyContact,
"complianceLicense": "INVITED_SUPPLIER",
"contactRecords": [ContactRecord],
"dataManagerCompanyID": "xyz789",
"defaultGroup_id": "abc123",
"description": "abc123",
"domains": ["abc123"],
"groups": ["xyz789"],
"hasProcessedTa1": true,
"id": "xyz789",
"industryCode": "abc123",
"local": false,
"locations": ["abc123"],
"managedCompanyIds": ["xyz789"],
"members": ["abc123"],
"name": "abc123",
"openSignupDisabled": true,
"parentCompany": Company,
"passwordRequirements": PasswordRequirements,
"pendingDomainRequests": [DomainRequest],
"preferences": CompanyPreferences,
"uniqueFilenames": true
}
]
}
}
¶
list_dashboard
¶ Response
Returns a Results_DashboardConfig
¶
list_features
¶ Example
¶ Query
query list_features {
list_features {
companyAccess
createdOn
description
global
id
lastUpdated
name
userAccess
}
}
¶ Response
{
"data": {
"list_features": [
{
"companyAccess": ["abc123"],
"createdOn": "2007-12-03",
"description": "xyz789",
"global": false,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"name": "xyz789",
"userAccess": ["xyz789"]
}
]
}
}
¶
list_tokens
¶ Response
Returns a Results_Token
¶
logged_in_user
¶ Response
Returns a UserDetails
¶ Example
¶ Query
query logged_in_user {
logged_in_user {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Response
{
"data": {
"logged_in_user": {
"avatarID": "xyz789",
"bio": "xyz789",
"companyID": "abc123",
"createdOn": "2007-12-03",
"department": "abc123",
"disabled": true,
"email": "xyz789",
"emailVerified": false,
"environment": "abc123",
"firstName": "xyz789",
"groups": [Group],
"id": "xyz789",
"invited": true,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["abc123"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
mapVersion_by_Id
¶ Response
Returns an XSLTMapVersion
¶ Example
¶ Query
query mapVersion_by_Id($mapVersionById: String) {
mapVersion_by_Id(mapVersionById: $mapVersionById) {
comments
companyID
content
docType
editedBy
editedDate
environment
fileType
id
indexName
name
parentId
routing
size
timestamp
}
}
¶ Variables
{"mapVersionById": "xyz789"}
¶ Response
{
"data": {
"mapVersion_by_Id": {
"comments": "abc123",
"companyID": "xyz789",
"content": "abc123",
"docType": "xyz789",
"editedBy": "xyz789",
"editedDate": "2007-12-03",
"environment": "xyz789",
"fileType": "abc123",
"id": "abc123",
"indexName": "xyz789",
"name": "xyz789",
"parentId": "abc123",
"routing": "xyz789",
"size": {},
"timestamp": "2007-12-03"
}
}
}
¶
map_by_Id
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
query map_by_Id($repositoryFileId: String) {
map_by_Id(repositoryFileId: $repositoryFileId) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{"repositoryFileId": "abc123"}
¶ Response
{
"data": {
"map_by_Id": {
"comments": "xyz789",
"companyID": "abc123",
"content": "xyz789",
"defaultVersion": "xyz789",
"directions": "abc123",
"docType": "xyz789",
"documentType": "abc123",
"enable": true,
"environment": "abc123",
"fileType": "xyz789",
"id": "xyz789",
"indexName": "xyz789",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "xyz789",
"partner": "xyz789",
"readOnly": true,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["abc123"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
}
}
¶
map_by_versionId
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
query map_by_versionId($mapVersionId: String) {
map_by_versionId(mapVersionId: $mapVersionId) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{"mapVersionId": "abc123"}
¶ Response
{
"data": {
"map_by_versionId": {
"comments": "abc123",
"companyID": "xyz789",
"content": "xyz789",
"defaultVersion": "abc123",
"directions": "xyz789",
"docType": "abc123",
"documentType": "xyz789",
"enable": false,
"environment": "xyz789",
"fileType": "abc123",
"id": "abc123",
"indexName": "abc123",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "xyz789",
"partner": "abc123",
"readOnly": true,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["xyz789"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
}
}
¶
mft_exception
¶ Response
Returns an Results_BaseMFTException
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query mft_exception($SearchRequest: SearchRequestInput) {
mft_exception(SearchRequest: $SearchRequest) {
aggregations
items {
...BaseMFTExceptionFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"mft_exception": {
"aggregations": Map_String_ObjectScalar,
"items": [BaseMFTException],
"totalItems": {}
}
}
}
¶
partner_group
¶ Response
Returns a Results_Group
¶ Example
¶ Query
query partner_group($partnerId: String) {
partner_group(partnerId: $partnerId) {
aggregations
items {
...GroupFragment
}
totalItems
}
}
¶ Variables
{"partnerId": "xyz789"}
¶ Response
{
"data": {
"partner_group": {
"aggregations": Map_String_ObjectScalar,
"items": [Group],
"totalItems": {}
}
}
}
¶
purchase_orders
¶ Response
Returns a Results_PurchaseOrderDocument
¶ Arguments
| Name | Description |
|---|---|
SearchRequest - SearchRequestInput
|
¶ Example
¶ Query
query purchase_orders($SearchRequest: SearchRequestInput) {
purchase_orders(SearchRequest: $SearchRequest) {
aggregations
items {
...PurchaseOrderDocumentFragment
}
totalItems
}
}
¶ Variables
{"SearchRequest": SearchRequestInput}
¶ Response
{
"data": {
"purchase_orders": {
"aggregations": Map_String_ObjectScalar,
"items": [PurchaseOrderDocument],
"totalItems": {}
}
}
}
¶
readFromS3_map
¶
read_counter
¶ Example
¶ Query
query read_counter($id: String) {
read_counter(id: $id) {
companyID
counter
description
environment
id
timestamp
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"read_counter": {
"companyID": "abc123",
"counter": {},
"description": "abc123",
"environment": "abc123",
"id": "xyz789",
"timestamp": "2007-12-03"
}
}
}
¶
read_counters
¶
read_file_processing_pipeline
¶ Response
Returns a ProcessingPipeline
¶ Example
¶ Query
query read_file_processing_pipeline($id: String) {
read_file_processing_pipeline(id: $id) {
companyID
createdBy {
...UserDetailsFragment
}
environment
filePathRegexp
id
lastUpdate
name
partner {
...BusinessPartnerFragment
}
stepsData
timestamp
}
}
¶ Variables
{"id": "abc123"}
¶ Response
{
"data": {
"read_file_processing_pipeline": {
"companyID": "xyz789",
"createdBy": UserDetails,
"environment": "xyz789",
"filePathRegexp": "abc123",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"name": "xyz789",
"partner": BusinessPartner,
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03"
}
}
}
¶
read_file_processing_pipelines
¶ Response
Returns [ProcessingPipeline]
¶ Example
¶ Query
query read_file_processing_pipelines {
read_file_processing_pipelines {
companyID
createdBy {
...UserDetailsFragment
}
environment
filePathRegexp
id
lastUpdate
name
partner {
...BusinessPartnerFragment
}
stepsData
timestamp
}
}
¶ Response
{
"data": {
"read_file_processing_pipelines": [
{
"companyID": "abc123",
"createdBy": UserDetails,
"environment": "xyz789",
"filePathRegexp": "abc123",
"id": "abc123",
"lastUpdate": "2007-12-03",
"name": "abc123",
"partner": BusinessPartner,
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03"
}
]
}
}
¶
read_late_mft_event_rule
¶ Response
Returns an LateMFTEventRule
¶ Example
¶ Query
query read_late_mft_event_rule($id: String) {
read_late_mft_event_rule(id: $id) {
active
companyID
consumerPartner {
...BusinessPartnerFragment
}
createdBy {
...UserDetailsFragment
}
cronExpression
environment
exceptionEntityType
filePattern
id
ignoreOlderThanDelta
producerPartner {
...BusinessPartnerFragment
}
timestamp
type
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"read_late_mft_event_rule": {
"active": false,
"companyID": "xyz789",
"consumerPartner": BusinessPartner,
"createdBy": UserDetails,
"cronExpression": "xyz789",
"environment": "abc123",
"exceptionEntityType": "DOCUMENT",
"filePattern": "abc123",
"id": "xyz789",
"ignoreOlderThanDelta": {},
"producerPartner": BusinessPartner,
"timestamp": "2007-12-03",
"type": "LATE_MFT_EVENT"
}
}
}
¶
read_late_mft_event_rules
¶ Response
Returns [LateMFTEventRule]
¶ Example
¶ Query
query read_late_mft_event_rules {
read_late_mft_event_rules {
active
companyID
consumerPartner {
...BusinessPartnerFragment
}
createdBy {
...UserDetailsFragment
}
cronExpression
environment
exceptionEntityType
filePattern
id
ignoreOlderThanDelta
producerPartner {
...BusinessPartnerFragment
}
timestamp
type
}
}
¶ Response
{
"data": {
"read_late_mft_event_rules": [
{
"active": true,
"companyID": "xyz789",
"consumerPartner": BusinessPartner,
"createdBy": UserDetails,
"cronExpression": "abc123",
"environment": "abc123",
"exceptionEntityType": "DOCUMENT",
"filePattern": "abc123",
"id": "xyz789",
"ignoreOlderThanDelta": {},
"producerPartner": BusinessPartner,
"timestamp": "2007-12-03",
"type": "LATE_MFT_EVENT"
}
]
}
}
¶
read_outbound_sftp_configuration
¶ Response
Returns an OutboundSFTPConfiguration
¶ Example
¶ Query
query read_outbound_sftp_configuration($id: String) {
read_outbound_sftp_configuration(id: $id) {
businessPartnerID
companyID
connectionTimeout
createdBy {
...UserDetailsFragment
}
destinationFolder
environment
host
id
knownHosts
name
passwordHash
port
privateKey
retryCount
strictHostKeyChecking
timestamp
type
username
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"read_outbound_sftp_configuration": {
"businessPartnerID": "abc123",
"companyID": "abc123",
"connectionTimeout": 987,
"createdBy": UserDetails,
"destinationFolder": "abc123",
"environment": "xyz789",
"host": "abc123",
"id": "abc123",
"knownHosts": "xyz789",
"name": "abc123",
"passwordHash": "abc123",
"port": 987,
"privateKey": "abc123",
"retryCount": 987,
"strictHostKeyChecking": false,
"timestamp": "2007-12-03",
"type": "KEY",
"username": "abc123"
}
}
}
¶
read_outbound_sftp_configurations
¶ Response
Returns [OutboundSFTPConfiguration]
¶ Example
¶ Query
query read_outbound_sftp_configurations {
read_outbound_sftp_configurations {
businessPartnerID
companyID
connectionTimeout
createdBy {
...UserDetailsFragment
}
destinationFolder
environment
host
id
knownHosts
name
passwordHash
port
privateKey
retryCount
strictHostKeyChecking
timestamp
type
username
}
}
¶ Response
{
"data": {
"read_outbound_sftp_configurations": [
{
"businessPartnerID": "xyz789",
"companyID": "xyz789",
"connectionTimeout": 123,
"createdBy": UserDetails,
"destinationFolder": "abc123",
"environment": "xyz789",
"host": "xyz789",
"id": "abc123",
"knownHosts": "xyz789",
"name": "xyz789",
"passwordHash": "abc123",
"port": 123,
"privateKey": "xyz789",
"retryCount": 123,
"strictHostKeyChecking": true,
"timestamp": "2007-12-03",
"type": "KEY",
"username": "xyz789"
}
]
}
}
¶
read_processing_state
¶ Response
Returns a ProcessingState
¶ Example
¶ Query
query read_processing_state($id: String) {
read_processing_state(id: $id) {
companyID
environment
eventSummaryId
id
steps
timestamp
}
}
¶ Variables
{"id": "abc123"}
¶ Response
{
"data": {
"read_processing_state": {
"companyID": "abc123",
"environment": "xyz789",
"eventSummaryId": "xyz789",
"id": "xyz789",
"steps": Map_PipelineStepKey_ProcessingStepStateScalar,
"timestamp": "2007-12-03"
}
}
}
¶
read_processing_states
¶ Response
Returns [ProcessingState]
¶ Example
¶ Query
query read_processing_states {
read_processing_states {
companyID
environment
eventSummaryId
id
steps
timestamp
}
}
¶ Response
{
"data": {
"read_processing_states": [
{
"companyID": "abc123",
"environment": "abc123",
"eventSummaryId": "xyz789",
"id": "xyz789",
"steps": Map_PipelineStepKey_ProcessingStepStateScalar,
"timestamp": "2007-12-03"
}
]
}
}
¶
read_transaction_processing_pipeline
¶ Response
Returns a TransactionProcessingPipeline
¶ Example
¶ Query
query read_transaction_processing_pipeline($id: String) {
read_transaction_processing_pipeline(id: $id) {
companyID
createdBy {
...UserDetailsFragment
}
environment
id
lastUpdate
receiverID
receiverIDQualifier
receiverIDValue
stepsData
timestamp
type
}
}
¶ Variables
{"id": "xyz789"}
¶ Response
{
"data": {
"read_transaction_processing_pipeline": {
"companyID": "abc123",
"createdBy": UserDetails,
"environment": "abc123",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03",
"type": "xyz789"
}
}
}
¶
read_transaction_processing_pipelines
¶ Response
Returns [TransactionProcessingPipeline]
¶ Example
¶ Query
query read_transaction_processing_pipelines {
read_transaction_processing_pipelines {
companyID
createdBy {
...UserDetailsFragment
}
environment
id
lastUpdate
receiverID
receiverIDQualifier
receiverIDValue
stepsData
timestamp
type
}
}
¶ Response
{
"data": {
"read_transaction_processing_pipelines": [
{
"companyID": "abc123",
"createdBy": UserDetails,
"environment": "xyz789",
"id": "abc123",
"lastUpdate": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03",
"type": "abc123"
}
]
}
}
¶
sftp_config
¶ Response
Returns a Map_String_ObjectScalar
¶
timeline
¶ Example
¶ Query
query timeline(
$count: Int,
$sortBy: String,
$sortOrder: String,
$timelineId: String
) {
timeline(
count: $count,
sortBy: $sortBy,
sortOrder: $sortOrder,
timelineId: $timelineId
) {
bodID
businessPartner {
...PartyInformationFragment
}
companyInfo {
...CompanyInfoFragment
}
company_id
compositeKey
conversation {
...ConversationFragment
}
endTime
environment
exceededMaximumAmountOfItems
flowDirection
hasExceptions
id
items
lastCommentedOn
lastUpdated
partnerInfo {
...CompanyInfoFragment
}
sharedToCompanies
sharedToCompanyItems {
...CompanyFragment
}
startTime
subOrgId
timelineItems {
...TimelineItemFragment
}
timelineVersion
title
}
}
¶ Variables
{
"count": 100,
"sortBy": "loadedOn",
"sortOrder": "DESC",
"timelineId": "xyz789"
}
¶ Response
{
"data": {
"timeline": {
"bodID": "abc123",
"businessPartner": PartyInformation,
"companyInfo": CompanyInfo,
"company_id": "xyz789",
"compositeKey": "xyz789",
"conversation": Conversation,
"endTime": "2007-12-03",
"environment": "xyz789",
"exceededMaximumAmountOfItems": true,
"flowDirection": "inbound",
"hasExceptions": true,
"id": "abc123",
"items": ["abc123"],
"lastCommentedOn": "2007-12-03",
"lastUpdated": "2007-12-03",
"partnerInfo": CompanyInfo,
"sharedToCompanies": ["xyz789"],
"sharedToCompanyItems": [Company],
"startTime": "2007-12-03",
"subOrgId": "xyz789",
"timelineItems": [TimelineItem],
"timelineVersion": 123,
"title": "xyz789"
}
}
}
¶
update_company
¶ Arguments
| Name | Description |
|---|---|
company - CompanyInput
|
¶ Example
¶ Query
query update_company($company: CompanyInput) {
update_company(company: $company) {
BPartners {
...CompanyFragment
}
adminGroup_id
avatarID
companyContact {
...CompanyContactFragment
}
complianceLicense
contactRecords {
...ContactRecordFragment
}
dataManagerCompanyID
defaultGroup_id
description
domains
groups
hasProcessedTa1
id
industryCode
local
locations
managedCompanyIds
members
name
openSignupDisabled
parentCompany {
...CompanyFragment
}
passwordRequirements {
...PasswordRequirementsFragment
}
pendingDomainRequests {
...DomainRequestFragment
}
preferences {
...CompanyPreferencesFragment
}
uniqueFilenames
}
}
¶ Variables
{"company": CompanyInput}
¶ Response
{
"data": {
"update_company": {
"BPartners": [Company],
"adminGroup_id": "xyz789",
"avatarID": "abc123",
"companyContact": CompanyContact,
"complianceLicense": "INVITED_SUPPLIER",
"contactRecords": [ContactRecord],
"dataManagerCompanyID": "abc123",
"defaultGroup_id": "abc123",
"description": "abc123",
"domains": ["abc123"],
"groups": ["abc123"],
"hasProcessedTa1": true,
"id": "abc123",
"industryCode": "abc123",
"local": true,
"locations": ["xyz789"],
"managedCompanyIds": ["xyz789"],
"members": ["xyz789"],
"name": "abc123",
"openSignupDisabled": true,
"parentCompany": Company,
"passwordRequirements": PasswordRequirements,
"pendingDomainRequests": [DomainRequest],
"preferences": CompanyPreferences,
"uniqueFilenames": false
}
}
}
¶
user_details
¶ Response
Returns a UserDetails
¶ Example
¶ Query
query user_details($userId: String) {
user_details(userId: $userId) {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Variables
{"userId": "abc123"}
¶ Response
{
"data": {
"user_details": {
"avatarID": "abc123",
"bio": "abc123",
"companyID": "abc123",
"createdOn": "2007-12-03",
"department": "abc123",
"disabled": false,
"email": "abc123",
"emailVerified": false,
"environment": "xyz789",
"firstName": "xyz789",
"groups": [Group],
"id": "abc123",
"invited": true,
"jobTitle": "abc123",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["abc123"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
user_groups
¶ Description
List of groups under current user company/environment
¶ Response
Returns a Results_Group
¶ Example
¶ Query
query user_groups(
$count: Int,
$groupId: String,
$offset: Int,
$searchTerm: String
) {
user_groups(
count: $count,
groupId: $groupId,
offset: $offset,
searchTerm: $searchTerm
) {
aggregations
items {
...GroupFragment
}
totalItems
}
}
¶ Variables
{
"count": 10,
"groupId": "xyz789",
"offset": 0,
"searchTerm": ""
}
¶ Response
{
"data": {
"user_groups": {
"aggregations": Map_String_ObjectScalar,
"items": [Group],
"totalItems": {}
}
}
}
¶
users
¶ Response
Returns a Results_UserDetails
¶ Arguments
| Name | Description |
|---|---|
count - Int
|
Default = 10 |
excludedGroupId - String
|
To exclude users of the group |
invited - Boolean
|
Default = false |
offset - Int
|
Default = 0 |
partnerId - String
|
Filter users, member of the partner group |
searchTerm - String
|
Default = "" |
sortBy - String
|
Default = "lastName" |
sortOrder - String
|
Default = "ASC" |
¶ Example
¶ Query
query users(
$count: Int,
$excludedGroupId: String,
$invited: Boolean,
$offset: Int,
$partnerId: String,
$searchTerm: String,
$sortBy: String,
$sortOrder: String
) {
users(
count: $count,
excludedGroupId: $excludedGroupId,
invited: $invited,
offset: $offset,
partnerId: $partnerId,
searchTerm: $searchTerm,
sortBy: $sortBy,
sortOrder: $sortOrder
) {
aggregations
items {
...UserDetailsFragment
}
totalItems
}
}
¶ Variables
{
"count": 10,
"excludedGroupId": "abc123",
"invited": false,
"offset": 0,
"partnerId": "xyz789",
"searchTerm": "",
"sortBy": "lastName",
"sortOrder": "ASC"
}
¶ Response
{
"data": {
"users": {
"aggregations": Map_String_ObjectScalar,
"items": [UserDetails],
"totalItems": {}
}
}
}
¶
view_replay_sftp_config
¶ Response
Returns a ReplaySftpConfiguration
¶ Example
¶ Query
query view_replay_sftp_config {
view_replay_sftp_config {
companyID
distPath
environment
host
id
knownHosts
password
port
timestamp
userName
}
}
¶ Response
{
"data": {
"view_replay_sftp_config": {
"companyID": "abc123",
"distPath": "abc123",
"environment": "abc123",
"host": "abc123",
"id": "abc123",
"knownHosts": "xyz789",
"password": "abc123",
"port": 987,
"timestamp": "2007-12-03",
"userName": "xyz789"
}
}
}
¶
view_replay_sftp_config_by_id
¶ Response
Returns a ReplaySftpConfiguration
¶ Example
¶ Query
query view_replay_sftp_config_by_id($configId: String) {
view_replay_sftp_config_by_id(configId: $configId) {
companyID
distPath
environment
host
id
knownHosts
password
port
timestamp
userName
}
}
¶ Variables
{"configId": "xyz789"}
¶ Response
{
"data": {
"view_replay_sftp_config_by_id": {
"companyID": "abc123",
"distPath": "abc123",
"environment": "abc123",
"host": "abc123",
"id": "xyz789",
"knownHosts": "xyz789",
"password": "abc123",
"port": 123,
"timestamp": "2007-12-03",
"userName": "abc123"
}
}
}
¶ Mutations
¶
AddComment
¶ Arguments
| Name | Description |
|---|---|
comment - String
|
|
sourceObjectId - String
|
|
sourceType - SourceType
|
¶ Example
¶ Query
mutation AddComment(
$comment: String,
$sourceObjectId: String,
$sourceType: SourceType
) {
AddComment(
comment: $comment,
sourceObjectId: $sourceObjectId,
sourceType: $sourceType
) {
comment
companyID
createdAt
createdBy {
...UserDetailsFragment
}
environment
id
sourceObjectId
sourceType
}
}
¶ Variables
{
"comment": "abc123",
"sourceObjectId": "xyz789",
"sourceType": "BUSINESS_DOCUMENT"
}
¶ Response
{
"data": {
"AddComment": {
"comment": "abc123",
"companyID": "abc123",
"createdAt": "2007-12-03",
"createdBy": UserDetails,
"environment": "xyz789",
"id": "xyz789",
"sourceObjectId": "xyz789",
"sourceType": "BUSINESS_DOCUMENT"
}
}
}
¶
AddPartner
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation AddPartner($partnerName: String) {
AddPartner(partnerName: $partnerName) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{"partnerName": "abc123"}
¶ Response
{
"data": {
"AddPartner": {
"address": Address,
"companyID": "abc123",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "abc123",
"id": "abc123",
"identifierRefs": ["abc123"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "abc123",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 987,
"type": "EDIPartner",
"version": 123
}
}
}
¶
AddPartnerContact
¶ Response
Returns a PartnerContactRecord
¶ Arguments
| Name | Description |
|---|---|
contactDto - PartnerContactDTOInput
|
|
partnerID - String
|
¶ Example
¶ Query
mutation AddPartnerContact(
$contactDto: PartnerContactDTOInput,
$partnerID: String
) {
AddPartnerContact(
contactDto: $contactDto,
partnerID: $partnerID
) {
accessGrantedOn
accessRevokedOn
address {
...AddressFragment
}
companyID
contactType
createdOn
email
emailLower
environment
firstName
firstNameLower
fullName
fullNameLower
id
lastModified
lastModifiedBy {
...UserInfoFragment
}
lastName
lastNameLower
notes
office
officeLower
partnerID
phoneNumbers {
...PhoneRecordFragment
}
status {
...PartnerConnectionStatusFragment
}
title
titleLower
}
}
¶ Variables
{
"contactDto": PartnerContactDTOInput,
"partnerID": "xyz789"
}
¶ Response
{
"data": {
"AddPartnerContact": {
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "abc123",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "xyz789",
"emailLower": "abc123",
"environment": "xyz789",
"firstName": "xyz789",
"firstNameLower": "xyz789",
"fullName": "abc123",
"fullNameLower": "abc123",
"id": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "abc123",
"lastNameLower": "abc123",
"notes": "xyz789",
"office": "xyz789",
"officeLower": "xyz789",
"partnerID": "xyz789",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "abc123",
"titleLower": "xyz789"
}
}
}
¶
AddSystem
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation AddSystem($systemName: String) {
AddSystem(systemName: $systemName) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{"systemName": "abc123"}
¶ Response
{
"data": {
"AddSystem": {
"address": Address,
"companyID": "abc123",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["abc123"],
"environment": "abc123",
"id": "xyz789",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "abc123",
"name": "abc123",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 987,
"type": "EDIPartner",
"version": 123
}
}
}
¶
AddSystemContact
¶ Response
Returns a PartnerContactRecord
¶ Arguments
| Name | Description |
|---|---|
contactDto - PartnerContactDTOInput
|
|
systemId - String
|
¶ Example
¶ Query
mutation AddSystemContact(
$contactDto: PartnerContactDTOInput,
$systemId: String
) {
AddSystemContact(
contactDto: $contactDto,
systemId: $systemId
) {
accessGrantedOn
accessRevokedOn
address {
...AddressFragment
}
companyID
contactType
createdOn
email
emailLower
environment
firstName
firstNameLower
fullName
fullNameLower
id
lastModified
lastModifiedBy {
...UserInfoFragment
}
lastName
lastNameLower
notes
office
officeLower
partnerID
phoneNumbers {
...PhoneRecordFragment
}
status {
...PartnerConnectionStatusFragment
}
title
titleLower
}
}
¶ Variables
{
"contactDto": PartnerContactDTOInput,
"systemId": "xyz789"
}
¶ Response
{
"data": {
"AddSystemContact": {
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "xyz789",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "xyz789",
"emailLower": "abc123",
"environment": "xyz789",
"firstName": "abc123",
"firstNameLower": "xyz789",
"fullName": "xyz789",
"fullNameLower": "abc123",
"id": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "xyz789",
"lastNameLower": "xyz789",
"notes": "abc123",
"office": "abc123",
"officeLower": "abc123",
"partnerID": "xyz789",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "xyz789",
"titleLower": "xyz789"
}
}
}
¶
CreateDataRetentionPolicy
¶ Response
Returns a DataRetentionPolicy
¶ Arguments
| Name | Description |
|---|---|
dto - DataRetentionPolicyDTOInput
|
¶ Example
¶ Query
mutation CreateDataRetentionPolicy($dto: DataRetentionPolicyDTOInput) {
CreateDataRetentionPolicy(dto: $dto) {
MINIMUM_VALUE
companyID
enabled
environment
id
lastModifiedBy {
...UserDetailsFragment
}
lastModifiedByID
lastUpdated
type
units
value
}
}
¶ Variables
{"dto": DataRetentionPolicyDTOInput}
¶ Response
{
"data": {
"CreateDataRetentionPolicy": {
"MINIMUM_VALUE": 123,
"companyID": "xyz789",
"enabled": true,
"environment": "abc123",
"id": "abc123",
"lastModifiedBy": UserDetails,
"lastModifiedByID": "xyz789",
"lastUpdated": "2007-12-03",
"type": "BUSINESS_DOCUMENT",
"units": "CUSTOM",
"value": 123
}
}
}
¶
CreateSubOrg
¶ Example
¶ Query
mutation CreateSubOrg(
$newSubOrgName: String,
$parentOrgId: String
) {
CreateSubOrg(
newSubOrgName: $newSubOrgName,
parentOrgId: $parentOrgId
) {
companyID
id
name
parentID
removeable
}
}
¶ Variables
{
"newSubOrgName": "xyz789",
"parentOrgId": "abc123"
}
¶ Response
{
"data": {
"CreateSubOrg": {
"companyID": "abc123",
"id": "xyz789",
"name": "abc123",
"parentID": "xyz789",
"removeable": false
}
}
}
¶
DeleteComment
¶
DeletePartner
¶
DeletePartnerContact
¶
DeleteSubOrg
¶
MergePartners
¶
PartnerToSystem
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation PartnerToSystem($partnerId: String) {
PartnerToSystem(partnerId: $partnerId) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{"partnerId": "xyz789"}
¶ Response
{
"data": {
"PartnerToSystem": {
"address": Address,
"companyID": "abc123",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["abc123"],
"environment": "abc123",
"id": "xyz789",
"identifierRefs": ["abc123"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "abc123",
"name": "abc123",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 123
}
}
}
¶
RequestCompanyDomain
¶ Response
Returns a CompanyDomains
¶ Example
¶ Query
mutation RequestCompanyDomain($email: String) {
RequestCompanyDomain(email: $email) {
pendingDomains {
...DomainRequestFragment
}
validatedDomains
}
}
¶ Variables
{"email": "abc123"}
¶ Response
{
"data": {
"RequestCompanyDomain": {
"pendingDomains": [DomainRequest],
"validatedDomains": ["xyz789"]
}
}
}
¶
SystemToPartner
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation SystemToPartner($systemId: String) {
SystemToPartner(systemId: $systemId) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{"systemId": "xyz789"}
¶ Response
{
"data": {
"SystemToPartner": {
"address": Address,
"companyID": "abc123",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "xyz789",
"id": "abc123",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "abc123",
"nameLowercase": "abc123",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 987
}
}
}
¶
UpdateDataRetentionPolicy
¶ Response
Returns a DataRetentionPolicy
¶ Arguments
| Name | Description |
|---|---|
policyDTO - DataRetentionPolicyDTOInput
|
|
policyId - String
|
¶ Example
¶ Query
mutation UpdateDataRetentionPolicy(
$policyDTO: DataRetentionPolicyDTOInput,
$policyId: String
) {
UpdateDataRetentionPolicy(
policyDTO: $policyDTO,
policyId: $policyId
) {
MINIMUM_VALUE
companyID
enabled
environment
id
lastModifiedBy {
...UserDetailsFragment
}
lastModifiedByID
lastUpdated
type
units
value
}
}
¶ Variables
{
"policyDTO": DataRetentionPolicyDTOInput,
"policyId": "abc123"
}
¶ Response
{
"data": {
"UpdateDataRetentionPolicy": {
"MINIMUM_VALUE": 123,
"companyID": "abc123",
"enabled": false,
"environment": "abc123",
"id": "abc123",
"lastModifiedBy": UserDetails,
"lastModifiedByID": "abc123",
"lastUpdated": "2007-12-03",
"type": "BUSINESS_DOCUMENT",
"units": "CUSTOM",
"value": 123
}
}
}
¶
UpdatePartnerContact
¶ Response
Returns a PartnerContactRecord
¶ Arguments
| Name | Description |
|---|---|
contact - PartnerContactDTOInput
|
|
contactID - String
|
|
partnerID - String
|
¶ Example
¶ Query
mutation UpdatePartnerContact(
$contact: PartnerContactDTOInput,
$contactID: String,
$partnerID: String
) {
UpdatePartnerContact(
contact: $contact,
contactID: $contactID,
partnerID: $partnerID
) {
accessGrantedOn
accessRevokedOn
address {
...AddressFragment
}
companyID
contactType
createdOn
email
emailLower
environment
firstName
firstNameLower
fullName
fullNameLower
id
lastModified
lastModifiedBy {
...UserInfoFragment
}
lastName
lastNameLower
notes
office
officeLower
partnerID
phoneNumbers {
...PhoneRecordFragment
}
status {
...PartnerConnectionStatusFragment
}
title
titleLower
}
}
¶ Variables
{
"contact": PartnerContactDTOInput,
"contactID": "abc123",
"partnerID": "xyz789"
}
¶ Response
{
"data": {
"UpdatePartnerContact": {
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "abc123",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "abc123",
"emailLower": "xyz789",
"environment": "abc123",
"firstName": "xyz789",
"firstNameLower": "xyz789",
"fullName": "abc123",
"fullNameLower": "xyz789",
"id": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "xyz789",
"lastNameLower": "abc123",
"notes": "abc123",
"office": "xyz789",
"officeLower": "abc123",
"partnerID": "abc123",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "xyz789",
"titleLower": "abc123"
}
}
}
¶
UpdatePartnerDomain
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation UpdatePartnerDomain(
$domains: [String],
$partnerID: String
) {
UpdatePartnerDomain(
domains: $domains,
partnerID: $partnerID
) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{
"domains": ["xyz789"],
"partnerID": "abc123"
}
¶ Response
{
"data": {
"UpdatePartnerDomain": {
"address": Address,
"companyID": "xyz789",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "xyz789",
"id": "xyz789",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "xyz789",
"nameLowercase": "abc123",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 123
}
}
}
¶
UpdatePartnerName
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation UpdatePartnerName(
$partnerID: String,
$partnerName: String
) {
UpdatePartnerName(
partnerID: $partnerID,
partnerName: $partnerName
) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{
"partnerID": "xyz789",
"partnerName": "abc123"
}
¶ Response
{
"data": {
"UpdatePartnerName": {
"address": Address,
"companyID": "xyz789",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "xyz789",
"id": "abc123",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "abc123",
"name": "abc123",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 123
}
}
}
¶
UpdatePartnerProtocol
¶ Response
Returns a PartnerProtocol
¶ Arguments
| Name | Description |
|---|---|
protocol - PartnerProtocolInput
|
|
protocolID - String
|
¶ Example
¶ Query
mutation UpdatePartnerProtocol(
$protocol: PartnerProtocolInput,
$protocolID: String
) {
UpdatePartnerProtocol(
protocol: $protocol,
protocolID: $protocolID
) {
authenticationMethod
companyID
direction
directory
environment
hosts
id
lastModified
name
notes
partnerID
port
protocol
user
}
}
¶ Variables
{
"protocol": PartnerProtocolInput,
"protocolID": "abc123"
}
¶ Response
{
"data": {
"UpdatePartnerProtocol": {
"authenticationMethod": "abc123",
"companyID": "abc123",
"direction": "Inbound",
"directory": "xyz789",
"environment": "xyz789",
"hosts": ["xyz789"],
"id": "xyz789",
"lastModified": "2007-12-03",
"name": "xyz789",
"notes": "xyz789",
"partnerID": "abc123",
"port": "abc123",
"protocol": "API",
"user": "abc123"
}
}
}
¶
UpdatePartnerType
¶ Description
Update partner type to EDIPartner/MFTPartner
¶ Response
Returns a BusinessPartner
¶ Arguments
| Name | Description |
|---|---|
newType - PartnerType
|
|
partnerID - String
|
¶ Example
¶ Query
mutation UpdatePartnerType(
$newType: PartnerType,
$partnerID: String
) {
UpdatePartnerType(
newType: $newType,
partnerID: $partnerID
) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{
"newType": "EDIPartner",
"partnerID": "abc123"
}
¶ Response
{
"data": {
"UpdatePartnerType": {
"address": Address,
"companyID": "abc123",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["abc123"],
"environment": "abc123",
"id": "abc123",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "abc123",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 987,
"type": "EDIPartner",
"version": 987
}
}
}
¶
UpdateSubOrg
¶ Arguments
| Name | Description |
|---|---|
SubOrg - SubOrgDTOInput
|
|
subOrgId - String
|
¶ Example
¶ Query
mutation UpdateSubOrg(
$SubOrg: SubOrgDTOInput,
$subOrgId: String
) {
UpdateSubOrg(
SubOrg: $SubOrg,
subOrgId: $subOrgId
) {
children {
...SubOrgDTOFragment
}
companyID
id
identifiers {
...CompanyBusinessIdentifierFragment
}
name
parentID
removeable
}
}
¶ Variables
{
"SubOrg": SubOrgDTOInput,
"subOrgId": "xyz789"
}
¶ Response
{
"data": {
"UpdateSubOrg": {
"children": [SubOrgDTO],
"companyID": "xyz789",
"id": "abc123",
"identifiers": [CompanyBusinessIdentifier],
"name": "xyz789",
"parentID": "xyz789",
"removeable": true
}
}
}
¶
UpdateSystemContact
¶ Response
Returns a PartnerContactRecord
¶ Arguments
| Name | Description |
|---|---|
contact - PartnerContactDTOInput
|
|
contactID - String
|
|
systemId - String
|
¶ Example
¶ Query
mutation UpdateSystemContact(
$contact: PartnerContactDTOInput,
$contactID: String,
$systemId: String
) {
UpdateSystemContact(
contact: $contact,
contactID: $contactID,
systemId: $systemId
) {
accessGrantedOn
accessRevokedOn
address {
...AddressFragment
}
companyID
contactType
createdOn
email
emailLower
environment
firstName
firstNameLower
fullName
fullNameLower
id
lastModified
lastModifiedBy {
...UserInfoFragment
}
lastName
lastNameLower
notes
office
officeLower
partnerID
phoneNumbers {
...PhoneRecordFragment
}
status {
...PartnerConnectionStatusFragment
}
title
titleLower
}
}
¶ Variables
{
"contact": PartnerContactDTOInput,
"contactID": "abc123",
"systemId": "xyz789"
}
¶ Response
{
"data": {
"UpdateSystemContact": {
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "abc123",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "abc123",
"emailLower": "xyz789",
"environment": "abc123",
"firstName": "xyz789",
"firstNameLower": "xyz789",
"fullName": "xyz789",
"fullNameLower": "abc123",
"id": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "xyz789",
"lastNameLower": "abc123",
"notes": "abc123",
"office": "abc123",
"officeLower": "abc123",
"partnerID": "xyz789",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "abc123",
"titleLower": "abc123"
}
}
}
¶
UpdateSystemDomain
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation UpdateSystemDomain(
$domains: [String],
$systemId: String
) {
UpdateSystemDomain(
domains: $domains,
systemId: $systemId
) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{
"domains": ["xyz789"],
"systemId": "abc123"
}
¶ Response
{
"data": {
"UpdateSystemDomain": {
"address": Address,
"companyID": "xyz789",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["abc123"],
"environment": "xyz789",
"id": "xyz789",
"identifierRefs": ["abc123"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "xyz789",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 987
}
}
}
¶
UpdateSystemName
¶ Response
Returns a BusinessPartner
¶ Example
¶ Query
mutation UpdateSystemName(
$systemId: String,
$systemName: String
) {
UpdateSystemName(
systemId: $systemId,
systemName: $systemName
) {
address {
...AddressFragment
}
companyID
contactInfo {
...PartnerContactRecordFragment
}
createdOn
domains
environment
id
identifierRefs
lastUpdate
locations {
...PartnerLocationFragment
}
mergedToPartner
name
nameLowercase
protocols {
...PartnerProtocolFragment
}
role
settings {
...BusinessPartnerSettingsFragment
}
totalNumIdentifiers
type
version
}
}
¶ Variables
{
"systemId": "xyz789",
"systemName": "xyz789"
}
¶ Response
{
"data": {
"UpdateSystemName": {
"address": Address,
"companyID": "xyz789",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "abc123",
"id": "xyz789",
"identifierRefs": ["abc123"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "abc123",
"name": "abc123",
"nameLowercase": "abc123",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 987
}
}
}
¶
UpdateSystemProtocol
¶ Response
Returns a PartnerProtocol
¶ Arguments
| Name | Description |
|---|---|
protocol - PartnerProtocolInput
|
|
protocolID - String
|
¶ Example
¶ Query
mutation UpdateSystemProtocol(
$protocol: PartnerProtocolInput,
$protocolID: String
) {
UpdateSystemProtocol(
protocol: $protocol,
protocolID: $protocolID
) {
authenticationMethod
companyID
direction
directory
environment
hosts
id
lastModified
name
notes
partnerID
port
protocol
user
}
}
¶ Variables
{
"protocol": PartnerProtocolInput,
"protocolID": "xyz789"
}
¶ Response
{
"data": {
"UpdateSystemProtocol": {
"authenticationMethod": "xyz789",
"companyID": "xyz789",
"direction": "Inbound",
"directory": "abc123",
"environment": "abc123",
"hosts": ["xyz789"],
"id": "abc123",
"lastModified": "2007-12-03",
"name": "xyz789",
"notes": "xyz789",
"partnerID": "abc123",
"port": "abc123",
"protocol": "API",
"user": "xyz789"
}
}
}
¶
addPartnerProtocol
¶ Response
Returns a PartnerProtocol
¶ Arguments
| Name | Description |
|---|---|
partnerID - String
|
|
protocol - PartnerProtocolInput
|
¶ Example
¶ Query
mutation addPartnerProtocol(
$partnerID: String,
$protocol: PartnerProtocolInput
) {
addPartnerProtocol(
partnerID: $partnerID,
protocol: $protocol
) {
authenticationMethod
companyID
direction
directory
environment
hosts
id
lastModified
name
notes
partnerID
port
protocol
user
}
}
¶ Variables
{
"partnerID": "abc123",
"protocol": PartnerProtocolInput
}
¶ Response
{
"data": {
"addPartnerProtocol": {
"authenticationMethod": "xyz789",
"companyID": "xyz789",
"direction": "Inbound",
"directory": "abc123",
"environment": "abc123",
"hosts": ["abc123"],
"id": "xyz789",
"lastModified": "2007-12-03",
"name": "abc123",
"notes": "xyz789",
"partnerID": "abc123",
"port": "abc123",
"protocol": "API",
"user": "xyz789"
}
}
}
¶
addSystemProtocol
¶ Response
Returns a PartnerProtocol
¶ Arguments
| Name | Description |
|---|---|
protocol - PartnerProtocolInput
|
|
systemId - String
|
¶ Example
¶ Query
mutation addSystemProtocol(
$protocol: PartnerProtocolInput,
$systemId: String
) {
addSystemProtocol(
protocol: $protocol,
systemId: $systemId
) {
authenticationMethod
companyID
direction
directory
environment
hosts
id
lastModified
name
notes
partnerID
port
protocol
user
}
}
¶ Variables
{
"protocol": PartnerProtocolInput,
"systemId": "abc123"
}
¶ Response
{
"data": {
"addSystemProtocol": {
"authenticationMethod": "xyz789",
"companyID": "xyz789",
"direction": "Inbound",
"directory": "abc123",
"environment": "abc123",
"hosts": ["xyz789"],
"id": "xyz789",
"lastModified": "2007-12-03",
"name": "abc123",
"notes": "xyz789",
"partnerID": "abc123",
"port": "xyz789",
"protocol": "API",
"user": "abc123"
}
}
}
¶
add_user_to_groups
¶ Description
Add a user to the given subgroups of the current company & environment
¶ Response
Returns a UserDetails
¶ Example
¶ Query
mutation add_user_to_groups(
$groupIds: [String],
$userId: String
) {
add_user_to_groups(
groupIds: $groupIds,
userId: $userId
) {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Variables
{
"groupIds": ["xyz789"],
"userId": "abc123"
}
¶ Response
{
"data": {
"add_user_to_groups": {
"avatarID": "abc123",
"bio": "abc123",
"companyID": "abc123",
"createdOn": "2007-12-03",
"department": "xyz789",
"disabled": false,
"email": "xyz789",
"emailVerified": true,
"environment": "xyz789",
"firstName": "xyz789",
"groups": [Group],
"id": "xyz789",
"invited": false,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["xyz789"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
add_users_to_group
¶ Example
¶ Query
mutation add_users_to_group(
$groupId: String,
$userIds: [String]
) {
add_users_to_group(
groupId: $groupId,
userIds: $userIds
) {
avatarID
companyID
environment
hasHiddenMembers
id
members {
...UserDetailsFragment
}
name
permissionList
permissions
}
}
¶ Variables
{
"groupId": "abc123",
"userIds": ["abc123"]
}
¶ Response
{
"data": {
"add_users_to_group": {
"avatarID": "xyz789",
"companyID": "xyz789",
"environment": "abc123",
"hasHiddenMembers": true,
"id": "abc123",
"members": [UserDetails],
"name": "xyz789",
"permissionList": ["abc123"],
"permissions": Map_String_ObjectScalar
}
}
}
¶
copy_dashboard
¶ Response
Returns a DashboardConfig
¶ Example
¶ Query
mutation copy_dashboard(
$dashboardId: String,
$newName: String
) {
copy_dashboard(
dashboardId: $dashboardId,
newName: $newName
) {
companyID
createdOn
environment
favorite
galleryReferenceID
galleryType
hasEdited
id
lastUpdated
layout {
...LayoutConfigFragment
}
name
owner {
...UserDetailsFragment
}
sharedWith {
...UserDetailsFragment
}
sharedWithIDs
updatedBy {
...UserDetailsFragment
}
userID
widgets {
...WidgetConfigFragment
}
}
}
¶ Variables
{
"dashboardId": "abc123",
"newName": "xyz789"
}
¶ Response
{
"data": {
"copy_dashboard": {
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "abc123",
"favorite": true,
"galleryReferenceID": "xyz789",
"galleryType": "DASHBOARD",
"hasEdited": false,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"layout": LayoutConfig,
"name": "abc123",
"owner": UserDetails,
"sharedWith": [UserDetails],
"sharedWithIDs": ["xyz789"],
"updatedBy": UserDetails,
"userID": "abc123",
"widgets": [WidgetConfig]
}
}
}
¶
copy_map
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation copy_map(
$newMapName: String,
$repositoryFileId: String
) {
copy_map(
newMapName: $newMapName,
repositoryFileId: $repositoryFileId
) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{
"newMapName": "abc123",
"repositoryFileId": "xyz789"
}
¶ Response
{
"data": {
"copy_map": {
"comments": "xyz789",
"companyID": "abc123",
"content": "abc123",
"defaultVersion": "abc123",
"directions": "abc123",
"docType": "abc123",
"documentType": "xyz789",
"enable": true,
"environment": "abc123",
"fileType": "abc123",
"id": "xyz789",
"indexName": "xyz789",
"inputFormat": "xyz789",
"name": "abc123",
"outputFormat": "xyz789",
"partner": "abc123",
"readOnly": false,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["xyz789"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
}
}
¶
create_company
¶ Arguments
| Name | Description |
|---|---|
company - CompanyInput
|
¶ Example
¶ Query
mutation create_company($company: CompanyInput) {
create_company(company: $company) {
BPartners {
...CompanyFragment
}
adminGroup_id
avatarID
companyContact {
...CompanyContactFragment
}
complianceLicense
contactRecords {
...ContactRecordFragment
}
dataManagerCompanyID
defaultGroup_id
description
domains
groups
hasProcessedTa1
id
industryCode
local
locations
managedCompanyIds
members
name
openSignupDisabled
parentCompany {
...CompanyFragment
}
passwordRequirements {
...PasswordRequirementsFragment
}
pendingDomainRequests {
...DomainRequestFragment
}
preferences {
...CompanyPreferencesFragment
}
uniqueFilenames
}
}
¶ Variables
{"company": CompanyInput}
¶ Response
{
"data": {
"create_company": {
"BPartners": [Company],
"adminGroup_id": "xyz789",
"avatarID": "abc123",
"companyContact": CompanyContact,
"complianceLicense": "INVITED_SUPPLIER",
"contactRecords": [ContactRecord],
"dataManagerCompanyID": "abc123",
"defaultGroup_id": "xyz789",
"description": "abc123",
"domains": ["xyz789"],
"groups": ["xyz789"],
"hasProcessedTa1": false,
"id": "xyz789",
"industryCode": "xyz789",
"local": false,
"locations": ["xyz789"],
"managedCompanyIds": ["xyz789"],
"members": ["xyz789"],
"name": "abc123",
"openSignupDisabled": false,
"parentCompany": Company,
"passwordRequirements": PasswordRequirements,
"pendingDomainRequests": [DomainRequest],
"preferences": CompanyPreferences,
"uniqueFilenames": false
}
}
}
¶
create_counter
¶ Arguments
| Name | Description |
|---|---|
counter - CounterInput
|
¶ Example
¶ Query
mutation create_counter($counter: CounterInput) {
create_counter(counter: $counter) {
companyID
counter
description
environment
id
timestamp
}
}
¶ Variables
{"counter": CounterInput}
¶ Response
{
"data": {
"create_counter": {
"companyID": "abc123",
"counter": {},
"description": "xyz789",
"environment": "abc123",
"id": "xyz789",
"timestamp": "2007-12-03"
}
}
}
¶
create_dashboard
¶ Response
Returns a DashboardConfig
¶ Arguments
| Name | Description |
|---|---|
config - DashboardConfigInput
|
¶ Example
¶ Query
mutation create_dashboard($config: DashboardConfigInput) {
create_dashboard(config: $config) {
companyID
createdOn
environment
favorite
galleryReferenceID
galleryType
hasEdited
id
lastUpdated
layout {
...LayoutConfigFragment
}
name
owner {
...UserDetailsFragment
}
sharedWith {
...UserDetailsFragment
}
sharedWithIDs
updatedBy {
...UserDetailsFragment
}
userID
widgets {
...WidgetConfigFragment
}
}
}
¶ Variables
{"config": DashboardConfigInput}
¶ Response
{
"data": {
"create_dashboard": {
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"favorite": true,
"galleryReferenceID": "abc123",
"galleryType": "DASHBOARD",
"hasEdited": true,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"layout": LayoutConfig,
"name": "abc123",
"owner": UserDetails,
"sharedWith": [UserDetails],
"sharedWithIDs": ["xyz789"],
"updatedBy": UserDetails,
"userID": "abc123",
"widgets": [WidgetConfig]
}
}
}
¶
create_environment
¶ Response
Returns an Environment
¶ Example
¶ Query
mutation create_environment(
$description: String,
$environmentName: String
) {
create_environment(
description: $description,
environmentName: $environmentName
) {
active
code
description
id
name
}
}
¶ Variables
{
"description": "abc123",
"environmentName": "xyz789"
}
¶ Response
{
"data": {
"create_environment": {
"active": true,
"code": "abc123",
"description": "abc123",
"id": "abc123",
"name": "abc123"
}
}
}
¶
create_feature
¶ Arguments
| Name | Description |
|---|---|
feature - FeatureInput
|
¶ Example
¶ Query
mutation create_feature($feature: FeatureInput) {
create_feature(feature: $feature) {
companyAccess
createdOn
description
global
id
lastUpdated
name
userAccess
}
}
¶ Variables
{"feature": FeatureInput}
¶ Response
{
"data": {
"create_feature": {
"companyAccess": ["xyz789"],
"createdOn": "2007-12-03",
"description": "abc123",
"global": true,
"id": "abc123",
"lastUpdated": "2007-12-03",
"name": "abc123",
"userAccess": ["abc123"]
}
}
}
¶
create_file_processing_pipeline
¶ Response
Returns a ProcessingPipeline
¶ Arguments
| Name | Description |
|---|---|
fileProcessingPipeline - ProcessingPipelineInput
|
¶ Example
¶ Query
mutation create_file_processing_pipeline($fileProcessingPipeline: ProcessingPipelineInput) {
create_file_processing_pipeline(fileProcessingPipeline: $fileProcessingPipeline) {
companyID
createdBy {
...UserDetailsFragment
}
environment
filePathRegexp
id
lastUpdate
name
partner {
...BusinessPartnerFragment
}
stepsData
timestamp
}
}
¶ Variables
{"fileProcessingPipeline": ProcessingPipelineInput}
¶ Response
{
"data": {
"create_file_processing_pipeline": {
"companyID": "xyz789",
"createdBy": UserDetails,
"environment": "abc123",
"filePathRegexp": "abc123",
"id": "abc123",
"lastUpdate": "2007-12-03",
"name": "abc123",
"partner": BusinessPartner,
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03"
}
}
}
¶
create_group
¶ Arguments
| Name | Description |
|---|---|
group - GroupInput
|
¶ Example
¶ Query
mutation create_group($group: GroupInput) {
create_group(group: $group) {
avatarID
companyID
environment
hasHiddenMembers
id
members {
...UserDetailsFragment
}
name
permissionList
permissions
}
}
¶ Variables
{"group": GroupInput}
¶ Response
{
"data": {
"create_group": {
"avatarID": "abc123",
"companyID": "abc123",
"environment": "abc123",
"hasHiddenMembers": false,
"id": "abc123",
"members": [UserDetails],
"name": "abc123",
"permissionList": ["abc123"],
"permissions": Map_String_ObjectScalar
}
}
}
¶
create_late_mft_event_rule
¶ Response
Returns an LateMFTEventRule
¶ Arguments
| Name | Description |
|---|---|
rule - LateMFTEventRuleRequestInput
|
¶ Example
¶ Query
mutation create_late_mft_event_rule($rule: LateMFTEventRuleRequestInput) {
create_late_mft_event_rule(rule: $rule) {
active
companyID
consumerPartner {
...BusinessPartnerFragment
}
createdBy {
...UserDetailsFragment
}
cronExpression
environment
exceptionEntityType
filePattern
id
ignoreOlderThanDelta
producerPartner {
...BusinessPartnerFragment
}
timestamp
type
}
}
¶ Variables
{"rule": LateMFTEventRuleRequestInput}
¶ Response
{
"data": {
"create_late_mft_event_rule": {
"active": false,
"companyID": "xyz789",
"consumerPartner": BusinessPartner,
"createdBy": UserDetails,
"cronExpression": "xyz789",
"environment": "xyz789",
"exceptionEntityType": "DOCUMENT",
"filePattern": "abc123",
"id": "abc123",
"ignoreOlderThanDelta": {},
"producerPartner": BusinessPartner,
"timestamp": "2007-12-03",
"type": "LATE_MFT_EVENT"
}
}
}
¶
create_map_by_template
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation create_map_by_template(
$newMapName: String,
$templateId: String
) {
create_map_by_template(
newMapName: $newMapName,
templateId: $templateId
) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{
"newMapName": "abc123",
"templateId": "xyz789"
}
¶ Response
{
"data": {
"create_map_by_template": {
"comments": "xyz789",
"companyID": "xyz789",
"content": "xyz789",
"defaultVersion": "xyz789",
"directions": "xyz789",
"docType": "xyz789",
"documentType": "abc123",
"enable": true,
"environment": "abc123",
"fileType": "abc123",
"id": "xyz789",
"indexName": "xyz789",
"inputFormat": "abc123",
"name": "abc123",
"outputFormat": "abc123",
"partner": "xyz789",
"readOnly": true,
"routing": "xyz789",
"size": {},
"standards": "xyz789",
"tags": ["abc123"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["abc123"]
}
}
}
¶
create_map_template
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation create_map_template($repositoryFileId: String) {
create_map_template(repositoryFileId: $repositoryFileId) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{"repositoryFileId": "xyz789"}
¶ Response
{
"data": {
"create_map_template": {
"comments": "xyz789",
"companyID": "abc123",
"content": "abc123",
"defaultVersion": "xyz789",
"directions": "xyz789",
"docType": "abc123",
"documentType": "abc123",
"enable": true,
"environment": "xyz789",
"fileType": "xyz789",
"id": "xyz789",
"indexName": "xyz789",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "xyz789",
"partner": "abc123",
"readOnly": true,
"routing": "xyz789",
"size": {},
"standards": "xyz789",
"tags": ["xyz789"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["abc123"]
}
}
}
¶
create_outbound_sftp_configuration
¶ Response
Returns an OutboundSFTPConfiguration
¶ Arguments
| Name | Description |
|---|---|
outboundSFTPConfiguration - OutboundSFTPConfigurationInput
|
¶ Example
¶ Query
mutation create_outbound_sftp_configuration($outboundSFTPConfiguration: OutboundSFTPConfigurationInput) {
create_outbound_sftp_configuration(outboundSFTPConfiguration: $outboundSFTPConfiguration) {
businessPartnerID
companyID
connectionTimeout
createdBy {
...UserDetailsFragment
}
destinationFolder
environment
host
id
knownHosts
name
passwordHash
port
privateKey
retryCount
strictHostKeyChecking
timestamp
type
username
}
}
¶ Variables
{
"outboundSFTPConfiguration": OutboundSFTPConfigurationInput
}
¶ Response
{
"data": {
"create_outbound_sftp_configuration": {
"businessPartnerID": "abc123",
"companyID": "xyz789",
"connectionTimeout": 123,
"createdBy": UserDetails,
"destinationFolder": "abc123",
"environment": "xyz789",
"host": "abc123",
"id": "xyz789",
"knownHosts": "abc123",
"name": "abc123",
"passwordHash": "abc123",
"port": 987,
"privateKey": "abc123",
"retryCount": 123,
"strictHostKeyChecking": true,
"timestamp": "2007-12-03",
"type": "KEY",
"username": "abc123"
}
}
}
¶
create_replay_sftp_config
¶ Response
Returns a ReplaySftpConfiguration
¶ Arguments
| Name | Description |
|---|---|
configInput - ReplaySftpConfigurationInput
|
¶ Example
¶ Query
mutation create_replay_sftp_config($configInput: ReplaySftpConfigurationInput) {
create_replay_sftp_config(configInput: $configInput) {
companyID
distPath
environment
host
id
knownHosts
password
port
timestamp
userName
}
}
¶ Variables
{"configInput": ReplaySftpConfigurationInput}
¶ Response
{
"data": {
"create_replay_sftp_config": {
"companyID": "abc123",
"distPath": "abc123",
"environment": "xyz789",
"host": "abc123",
"id": "xyz789",
"knownHosts": "abc123",
"password": "abc123",
"port": 123,
"timestamp": "2007-12-03",
"userName": "abc123"
}
}
}
¶
create_transaction_processing_pipeline
¶ Response
Returns a TransactionProcessingPipeline
¶ Arguments
| Name | Description |
|---|---|
transactionProcessingPipeline - TransactionProcessingPipelineInput
|
¶ Example
¶ Query
mutation create_transaction_processing_pipeline($transactionProcessingPipeline: TransactionProcessingPipelineInput) {
create_transaction_processing_pipeline(transactionProcessingPipeline: $transactionProcessingPipeline) {
companyID
createdBy {
...UserDetailsFragment
}
environment
id
lastUpdate
receiverID
receiverIDQualifier
receiverIDValue
stepsData
timestamp
type
}
}
¶ Variables
{
"transactionProcessingPipeline": TransactionProcessingPipelineInput
}
¶ Response
{
"data": {
"create_transaction_processing_pipeline": {
"companyID": "abc123",
"createdBy": UserDetails,
"environment": "abc123",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03",
"type": "xyz789"
}
}
}
¶
delete_counter
¶
delete_dashboard
¶
delete_feature
¶
delete_file_processing_pipeline
¶
delete_group
¶
delete_late_mft_event_rule
¶
delete_map
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation delete_map($repositoryFileId: String) {
delete_map(repositoryFileId: $repositoryFileId) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{"repositoryFileId": "abc123"}
¶ Response
{
"data": {
"delete_map": {
"comments": "xyz789",
"companyID": "xyz789",
"content": "xyz789",
"defaultVersion": "abc123",
"directions": "abc123",
"docType": "xyz789",
"documentType": "abc123",
"enable": false,
"environment": "abc123",
"fileType": "xyz789",
"id": "xyz789",
"indexName": "xyz789",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "xyz789",
"partner": "xyz789",
"readOnly": false,
"routing": "abc123",
"size": {},
"standards": "abc123",
"tags": ["abc123"],
"template": false,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["abc123"]
}
}
}
¶
delete_map_version
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation delete_map_version($mapVersionId: String) {
delete_map_version(mapVersionId: $mapVersionId) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{"mapVersionId": "abc123"}
¶ Response
{
"data": {
"delete_map_version": {
"comments": "xyz789",
"companyID": "abc123",
"content": "abc123",
"defaultVersion": "abc123",
"directions": "xyz789",
"docType": "xyz789",
"documentType": "xyz789",
"enable": false,
"environment": "xyz789",
"fileType": "xyz789",
"id": "abc123",
"indexName": "abc123",
"inputFormat": "xyz789",
"name": "xyz789",
"outputFormat": "abc123",
"partner": "abc123",
"readOnly": false,
"routing": "xyz789",
"size": {},
"standards": "xyz789",
"tags": ["xyz789"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["abc123"]
}
}
}
¶
delete_mft_exceptions
¶
delete_outbound_sftp_configuration
¶
delete_replay_sftp_config
¶
delete_transaction_processing_pipeline
¶
edit_map
¶ Response
Returns a RepositoryFile
¶ Arguments
| Name | Description |
|---|---|
repositoryFileData - RepositoryFileMetadataInput
|
|
repositoryFileId - String
|
¶ Example
¶ Query
mutation edit_map(
$repositoryFileData: RepositoryFileMetadataInput,
$repositoryFileId: String
) {
edit_map(
repositoryFileData: $repositoryFileData,
repositoryFileId: $repositoryFileId
) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{
"repositoryFileData": RepositoryFileMetadataInput,
"repositoryFileId": "xyz789"
}
¶ Response
{
"data": {
"edit_map": {
"comments": "abc123",
"companyID": "xyz789",
"content": "xyz789",
"defaultVersion": "abc123",
"directions": "xyz789",
"docType": "abc123",
"documentType": "abc123",
"enable": true,
"environment": "abc123",
"fileType": "abc123",
"id": "xyz789",
"indexName": "xyz789",
"inputFormat": "xyz789",
"name": "abc123",
"outputFormat": "abc123",
"partner": "abc123",
"readOnly": true,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["abc123"],
"template": false,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["abc123"]
}
}
}
¶
enable_map
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation enable_map(
$enable: Boolean,
$repositoryFileId: String
) {
enable_map(
enable: $enable,
repositoryFileId: $repositoryFileId
) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{
"enable": true,
"repositoryFileId": "abc123"
}
¶ Response
{
"data": {
"enable_map": {
"comments": "abc123",
"companyID": "xyz789",
"content": "abc123",
"defaultVersion": "abc123",
"directions": "xyz789",
"docType": "xyz789",
"documentType": "abc123",
"enable": false,
"environment": "abc123",
"fileType": "abc123",
"id": "abc123",
"indexName": "xyz789",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "abc123",
"partner": "xyz789",
"readOnly": false,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["abc123"],
"template": true,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
}
}
¶
generate_token
¶
import_from_gallery
¶ Response
Returns a DashboardConfig
¶ Example
¶ Query
mutation import_from_gallery($galleryId: String) {
import_from_gallery(galleryId: $galleryId) {
companyID
createdOn
environment
favorite
galleryReferenceID
galleryType
hasEdited
id
lastUpdated
layout {
...LayoutConfigFragment
}
name
owner {
...UserDetailsFragment
}
sharedWith {
...UserDetailsFragment
}
sharedWithIDs
updatedBy {
...UserDetailsFragment
}
userID
widgets {
...WidgetConfigFragment
}
}
}
¶ Variables
{"galleryId": "xyz789"}
¶ Response
{
"data": {
"import_from_gallery": {
"companyID": "xyz789",
"createdOn": "2007-12-03",
"environment": "abc123",
"favorite": false,
"galleryReferenceID": "abc123",
"galleryType": "DASHBOARD",
"hasEdited": true,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"layout": LayoutConfig,
"name": "abc123",
"owner": UserDetails,
"sharedWith": [UserDetails],
"sharedWithIDs": ["abc123"],
"updatedBy": UserDetails,
"userID": "abc123",
"widgets": [WidgetConfig]
}
}
}
¶
inviteGroupUser
¶ Response
Returns a UserDetails
¶ Arguments
| Name | Description |
|---|---|
groupId - String
|
Invite user to this group |
password - String
|
Temporary password |
user - UserDetailsInput
|
User to be invited |
¶ Example
¶ Query
mutation inviteGroupUser(
$groupId: String,
$password: String,
$user: UserDetailsInput
) {
inviteGroupUser(
groupId: $groupId,
password: $password,
user: $user
) {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Variables
{
"groupId": "abc123",
"password": "abc123",
"user": UserDetailsInput
}
¶ Response
{
"data": {
"inviteGroupUser": {
"avatarID": "xyz789",
"bio": "xyz789",
"companyID": "xyz789",
"createdOn": "2007-12-03",
"department": "abc123",
"disabled": false,
"email": "abc123",
"emailVerified": false,
"environment": "xyz789",
"firstName": "abc123",
"groups": [Group],
"id": "abc123",
"invited": true,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "abc123",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["xyz789"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
invitePartnerUser
¶ Response
Returns a UserDetails
¶ Arguments
| Name | Description |
|---|---|
partnerId - String
|
Invite user to the partner group |
password - String
|
Temporary password |
user - UserDetailsInput
|
User to be invited |
¶ Example
¶ Query
mutation invitePartnerUser(
$partnerId: String,
$password: String,
$user: UserDetailsInput
) {
invitePartnerUser(
partnerId: $partnerId,
password: $password,
user: $user
) {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Variables
{
"partnerId": "abc123",
"password": "xyz789",
"user": UserDetailsInput
}
¶ Response
{
"data": {
"invitePartnerUser": {
"avatarID": "abc123",
"bio": "xyz789",
"companyID": "xyz789",
"createdOn": "2007-12-03",
"department": "abc123",
"disabled": true,
"email": "xyz789",
"emailVerified": true,
"environment": "xyz789",
"firstName": "abc123",
"groups": [Group],
"id": "abc123",
"invited": true,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["xyz789"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
inviteUser
¶ Description
Invite a user. Provide only either groupId or partnerId. if both are provided, only groupId will be considered. If user invited to a non-existing partner group(by partnerId), a new partner group with name: 'Partner Group ' will be created.
¶ Response
Returns a UserDetails
¶ Arguments
| Name | Description |
|---|---|
externalUserInvite - Boolean!
|
If a user invited to partner/system |
groupId - String
|
Invite user to this group |
partnerId - String
|
Invite user to the partner group |
password - String
|
Temporary password |
temporaryPassword - Boolean!
|
Only if you want to set a temp password for the invited user |
user - UserDetailsInput
|
User to be invited |
¶ Example
¶ Query
mutation inviteUser(
$externalUserInvite: Boolean!,
$groupId: String,
$partnerId: String,
$password: String,
$temporaryPassword: Boolean!,
$user: UserDetailsInput
) {
inviteUser(
externalUserInvite: $externalUserInvite,
groupId: $groupId,
partnerId: $partnerId,
password: $password,
temporaryPassword: $temporaryPassword,
user: $user
) {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Variables
{
"externalUserInvite": true,
"groupId": "xyz789",
"partnerId": "abc123",
"password": "abc123",
"temporaryPassword": false,
"user": UserDetailsInput
}
¶ Response
{
"data": {
"inviteUser": {
"avatarID": "abc123",
"bio": "xyz789",
"companyID": "abc123",
"createdOn": "2007-12-03",
"department": "xyz789",
"disabled": false,
"email": "abc123",
"emailVerified": true,
"environment": "xyz789",
"firstName": "xyz789",
"groups": [Group],
"id": "abc123",
"invited": true,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["xyz789"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
remove_user_from_company_env
¶ Description
Remove n user from all the sub-groups of current company & environment
¶
remove_user_from_group
¶ Description
Remove a user from the given sub-group of the current company & environment
¶ Example
¶ Query
mutation remove_user_from_group(
$groupId: String,
$userId: String
) {
remove_user_from_group(
groupId: $groupId,
userId: $userId
) {
avatarID
companyID
environment
hasHiddenMembers
id
members {
...UserDetailsFragment
}
name
permissionList
permissions
}
}
¶ Variables
{
"groupId": "abc123",
"userId": "abc123"
}
¶ Response
{
"data": {
"remove_user_from_group": {
"avatarID": "abc123",
"companyID": "abc123",
"environment": "xyz789",
"hasHiddenMembers": false,
"id": "xyz789",
"members": [UserDetails],
"name": "abc123",
"permissionList": ["abc123"],
"permissions": Map_String_ObjectScalar
}
}
}
¶
revoke_token
¶
rollback_map
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation rollback_map($mapVersionId: String) {
rollback_map(mapVersionId: $mapVersionId) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{"mapVersionId": "abc123"}
¶ Response
{
"data": {
"rollback_map": {
"comments": "xyz789",
"companyID": "xyz789",
"content": "abc123",
"defaultVersion": "abc123",
"directions": "abc123",
"docType": "abc123",
"documentType": "xyz789",
"enable": true,
"environment": "abc123",
"fileType": "abc123",
"id": "abc123",
"indexName": "abc123",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "xyz789",
"partner": "abc123",
"readOnly": true,
"routing": "abc123",
"size": {},
"standards": "abc123",
"tags": ["abc123"],
"template": false,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
}
}
¶
submit_advance_ship_notice
¶ Response
Returns an AdvanceShipNoticeDocument
¶ Arguments
| Name | Description |
|---|---|
AdvanceShipNoticeDocument - AdvanceShipNoticeDocumentInput
|
|
LineItems - TreeNodeInput
|
¶ Example
¶ Query
mutation submit_advance_ship_notice(
$AdvanceShipNoticeDocument: AdvanceShipNoticeDocumentInput,
$LineItems: TreeNodeInput
) {
submit_advance_ship_notice(
AdvanceShipNoticeDocument: $AdvanceShipNoticeDocument,
LineItems: $LineItems
) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
actualShipDate
addressFields {
...AddressFragment
}
allShipmentInfo
appAdviceTransferStatus
asnPurposeCode
billOfLadingNumber
billToAddress {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyingParty {
...AddressFragment
}
canDownloadOriginalFile
carrierReferenceNumber
categoryFacet
childrenTypes
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currentScheduleDelivery
currentScheduleShip
customFields
dataFormat
dataFormatVersion
deliveryAppointment
deliveryRequested
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
errorsCollection
estimatedDelivery
eventType
expectedShipDate
expiration
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasApplicationAdvice
hasErrors
hasExceptions
hasInvoice
hasPurchaseOrder
hasRemittanceAdvice
hierarchyStructure
id
identifierType
inboundIdentifierHash
incorrectLineItemsStructure
indexName
internalVendorNumber
invoiceDates
invoiceNumber
invoiceNumbers
isDeleted
isaBegin
isaControlNumber
isaEnd
laDocumentVersion
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
packIds
partnerHash
partyToReceiveInvoice {
...AddressFragment
}
paymentDates
poDate
poDates
poNumber
poNumberCount
poNumbers
poShipTo {
...AddressFragment
}
primary
primaryContent
primaryIdentifier
promisedForDelivery
purchaseOrderPoDate
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceIds
referenceInfo {
...RefSegmentFragment
}
reprocessOn
reprocessedOn
requestedShipDate
rootNode {
...TreeNodeFragment
}
routing
scacCode
scacCodes
scheduledDeliveryAppointment
sellingParty {
...AddressFragment
}
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipFrom {
...AddressFragment
}
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
shipmentIdNumber
shipmentNumber
shipped
shippingContainerIds
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supportedDateFields
tareIds
testIndicator
textInfo {
...TextSegmentFragment
}
thirdPartyCorrelation {
...DocumentCorrelationPointFragment
}
timeline
timestamp
timezoneOffset
totalNumUnitsShipped
totalQuantityOrdered
trackingNumber
transactionBegin
transactionEnd
transactionRefNum
tsControlNumber
tsIDCode
type
unknownFields
vendorIdNumberMap
vendorNumberMap
vendorOrderNumberMap
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{
"AdvanceShipNoticeDocument": AdvanceShipNoticeDocumentInput,
"LineItems": TreeNodeInput
}
¶ Response
{
"data": {
"submit_advance_ship_notice": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"actualShipDate": "2007-12-03",
"addressFields": [Address],
"allShipmentInfo": ["xyz789"],
"appAdviceTransferStatus": "abc123",
"asnPurposeCode": "xyz789",
"billOfLadingNumber": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": true,
"carrierReferenceNumber": "xyz789",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"childrenTypes": ["xyz789"],
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"deliveryAppointment": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedShipDate": "2007-12-03",
"expiration": "2007-12-03",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hasInvoice": true,
"hasPurchaseOrder": true,
"hasRemittanceAdvice": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"incorrectLineItemsStructure": false,
"indexName": "abc123",
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumber": "abc123",
"invoiceNumbers": ["xyz789"],
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laDocumentVersion": "xyz789",
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"packIds": ["abc123"],
"partnerHash": "xyz789",
"partyToReceiveInvoice": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["abc123"],
"poShipTo": Address,
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"promisedForDelivery": "2007-12-03",
"purchaseOrderPoDate": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceIds": ["xyz789"],
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"rootNode": TreeNode,
"routing": "abc123",
"scacCode": "xyz789",
"scacCodes": ["abc123"],
"scheduledDeliveryAppointment": "2007-12-03",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentIdNumber": "abc123",
"shipmentNumber": "abc123",
"shipped": "2007-12-03",
"shippingContainerIds": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"supportedDateFields": Map_SupportedDate_DateScalar,
"tareIds": ["abc123"],
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalNumUnitsShipped": 987.65,
"totalQuantityOrdered": 987.65,
"trackingNumber": "xyz789",
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vendorIdNumberMap": Map_String_StringScalar,
"vendorNumberMap": Map_String_StringScalar,
"vendorOrderNumberMap": Map_String_StringScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
submit_functional_acknowledgment
¶ Response
Returns a FunctionalAcknowledgmentDocument
¶ Arguments
| Name | Description |
|---|---|
FunctionalAcknowledgmentDocument - FunctionalAcknowledgmentDocumentInput
|
|
LineItems - TreeNodeInput
|
¶ Example
¶ Query
mutation submit_functional_acknowledgment(
$FunctionalAcknowledgmentDocument: FunctionalAcknowledgmentDocumentInput,
$LineItems: TreeNodeInput
) {
submit_functional_acknowledgment(
FunctionalAcknowledgmentDocument: $FunctionalAcknowledgmentDocument,
LineItems: $LineItems
) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
acknowledgedEntityIds
acknowledgedType
acknowledgementCode
acknowledgementDetail {
...TransactionHeaderSegmentFragment
}
acknowledges
acknowledgmentErrorCode
addressFields {
...AddressFragment
}
akFuncIDCode
appAdviceTransferStatus
billToAddress {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
canDownloadOriginalFile
categoryFacet
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationPoints {
...ErrorCorrelationPointFragment
}
correlationReferenceId
customFields
dataFormat
dataFormatVersion
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
errorsCollection
eventType
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasApplicationAdvice
hasErrors
hasExceptions
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numTransactionsAccepted
numTransactionsIncluded
numTransactionsReceived
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
primary
primaryContent
primaryIdentifier
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
reprocessOn
reprocessedOn
rootNode {
...TreeNodeFragment
}
routing
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipToAddress {
...AddressFragment
}
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supportedDateFields
testIndicator
textInfo {
...TextSegmentFragment
}
timeline
timestamp
timezoneOffset
transactionBegin
transactionEnd
transactionRefNum
tsControlNumber
tsIDCode
type
unknownFields
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{
"FunctionalAcknowledgmentDocument": FunctionalAcknowledgmentDocumentInput,
"LineItems": TreeNodeInput
}
¶ Response
{
"data": {
"submit_functional_acknowledgment": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"acknowledgedEntityIds": ["abc123"],
"acknowledgedType": ["xyz789"],
"acknowledgementCode": "xyz789",
"acknowledgementDetail": [TransactionHeaderSegment],
"acknowledges": "abc123",
"acknowledgmentErrorCode": "abc123",
"addressFields": [Address],
"akFuncIDCode": "abc123",
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationPoints": [ErrorCorrelationPoint],
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 987,
"numTransactionsAccepted": 987,
"numTransactionsIncluded": 123,
"numTransactionsReceived": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
submit_invoice
¶ Response
Returns an InvoiceDocument
¶ Arguments
| Name | Description |
|---|---|
InvoiceDocument - InvoiceDocumentInput
|
|
LineItems - [LineItemInput]
|
¶ Example
¶ Query
mutation submit_invoice(
$InvoiceDocument: InvoiceDocumentInput,
$LineItems: [LineItemInput]
) {
submit_invoice(
InvoiceDocument: $InvoiceDocument,
LineItems: $LineItems
) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
addressFields {
...AddressFragment
}
allowChrgIndicator
appAdviceTransferStatus
billFromParty {
...AddressFragment
}
billOfLadingNumber
billToAddress {
...AddressFragment
}
billToParty {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyingParty {
...AddressFragment
}
calculatedSACTotalAmount
calculatedTotalAmount
canDownloadOriginalFile
categoryFacet
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currency
currentScheduleDelivery
currentScheduleShip
customFields
dataFormat
dataFormatVersion
deliveredOn
deliveryRequested
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
estimatedDelivery
eventType
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasAdvanceShipNotice
hasApplicationAdvice
hasErrors
hasExceptions
hasPurchaseOrder
hasRemittanceAdvice
headerSAC {
...SACFragment
}
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
internalVendorNumber
invoiceDate
invoiceNumber
invoiced
invoicedTo {
...ContactRepresentationFragment
}
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
lineItems {
...LineItemFragment
}
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
partyToReceiveCommercialInvoiceRemittance {
...AddressFragment
}
paymentDates
poDate
poDates
poNumber
poNumberCount
poNumbers
primary
primaryContent
primaryIdentifier
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
remitTo {
...AddressFragment
}
reprocessOn
reprocessedOn
requestedShipDate
routing
sellingParty {
...AddressFragment
}
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
serviceCode
serviceCodeList
sharedToCompanies
shipFrom {
...AddressFragment
}
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
shipmentDates
shipmentNumberCount
shipmentNumbers
shipped
soldOn
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supportedDateFields
taxInfo {
...TaxInfoFragment
}
taxMonetaryAmount
taxPercentage
taxTypeCode
termsSaleTypeCode
testIndicator
textInfo {
...TextSegmentFragment
}
thirdPartyCorrelation {
...DocumentCorrelationPointFragment
}
timeline
timestamp
timezoneOffset
totalAmount
totalQuantity
transactionBegin
transactionEnd
transactionRefNum
transactionTypeCode
tsControlNumber
tsIDCode
type
units
unitsOfMeasure
unknownFields
vendor {
...AddressFragment
}
vendorIdNumber
vendorNumber
vendorOrderNumber
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{
"InvoiceDocument": InvoiceDocumentInput,
"LineItems": [LineItemInput]
}
¶ Response
{
"data": {
"submit_invoice": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"allowChrgIndicator": "xyz789",
"appAdviceTransferStatus": "abc123",
"billFromParty": Address,
"billOfLadingNumber": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 123.45,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"currency": "abc123",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deliveredOn": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "xyz789",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hasPurchaseOrder": false,
"hasRemittanceAdvice": false,
"headerSAC": [SAC],
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"internalVendorNumber": "abc123",
"invoiceDate": "2007-12-03",
"invoiceNumber": "xyz789",
"invoiced": "2007-12-03",
"invoicedTo": ContactRepresentation,
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"partyToReceiveCommercialInvoiceRemittance": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["xyz789"],
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "abc123",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"serviceCode": "xyz789",
"serviceCodeList": ["abc123"],
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["xyz789"],
"shipped": "2007-12-03",
"soldOn": "2007-12-03",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supportedDateFields": Map_SupportedDate_DateScalar,
"taxInfo": [TaxInfo],
"taxMonetaryAmount": 123.45,
"taxPercentage": 123.45,
"taxTypeCode": "xyz789",
"termsSaleTypeCode": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 123.45,
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"transactionTypeCode": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "abc123",
"units": "xyz789",
"unitsOfMeasure": ["xyz789"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "xyz789",
"vendorNumber": "xyz789",
"vendorOrderNumber": "xyz789",
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
submit_purchase_order
¶ Response
Returns a PurchaseOrderDocument
¶ Arguments
| Name | Description |
|---|---|
LineItems - [LineItemInput]
|
|
PurchaseOrderDocument - PurchaseOrderDocumentInput
|
¶ Example
¶ Query
mutation submit_purchase_order(
$LineItems: [LineItemInput],
$PurchaseOrderDocument: PurchaseOrderDocumentInput
) {
submit_purchase_order(
LineItems: $LineItems,
PurchaseOrderDocument: $PurchaseOrderDocument
) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
ackType
ackTypes
addressFields {
...AddressFragment
}
albertsonsDepartmentNumber
alphaCodes
appAdviceTransferStatus
arrivedAtCustomsDates
arrivedAtTerminalLocationsDates
arrivedDates
availableForDeliveryDates
billOfLadingNumbers
billOfLadingReleasedDates
billToAddress {
...AddressFragment
}
billToParty {
...AddressFragment
}
bodID
bodIDVersion
bookingConfirmedDates
bookingNumbers
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyerIdentification
buyingParty {
...AddressFragment
}
calculatedSACTotalAmount
calculatedTotalAmount
canDownloadOriginalFile
cancelAfterDate
cancelIfNotShippedByDate
cargoReceivedAtContractualPlaceOfReceiptDates
carrierAndCustomsReleaseDates
carrierReleaseDates
categoryFacet
commenters {
...UserInfoFragment
}
companyID
completedUnloadingAtDeliveryLocationDates
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currency
customFields
customsReleasedDates
dataFormat
dataFormatVersion
deferredPaymentDate
deliveryAppointmentDates
deliveryRequested
deliveryRequestedDate
departedPickupLocationDates
departmentNumberText
doNotDeliverAfter
doNotDeliverAfterDate
doNotDeliverBefore
doNotDeliverBeforeDate
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
emptyEquipmentDispatchedDates
entityID
environment
equipmentNumberN9Segments
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
estimatedDeliveryDates
estimatedToArriveDates
estimatedToDepartTerminalLocationDates
eventType
expectedReply
expectedShipDate
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasAdvanceShipNotice
hasApplicationAdvice
hasCreditDebitAdjustment
hasErrors
hasExceptions
hasInvoice
hasPOChange
hasPurchaseOrderAcknowledgment
hasPurchaseOrderChange
hasRemittanceAdvice
hasReturnMerchandiseAuthorization
hasStatusDetail
hasWarehouseShippingAdvice
hasWarehouseShippingOrder
hasWarehouseStockTransferShipmentAdvice
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
internalVendorNumber
invoiceDates
invoiceNumberCount
invoiceNumbers
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
lineItems {
...LineItemFragment
}
loadedOn
loadedOnRailDates
loadedOnTruckDates
loadedOnVesselDates
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
oceanShipmentStatusCodes
oceanShipmentStatuses
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
paymentDates
poAndAsnVendorNumbersMatch
poDate
poNumber
poType
pocDates
primary
primaryContent
primaryIdentifier
providedTotalAmount
purposeCodes
railDepartureFromOriginIntermodalRampsDates
receivedAtOriginDates
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
releaseDate
reprocessOn
reprocessedOn
requestedForDeliveryDatePriorTo
requestedForDeliveryDateWeekOf
requestedForShipmentDateWeekOf
requestedPickup
requestedShipDate
returnedToCarriersTerminalDates
returnedToShipperDates
routing
sacItems {
...SACFragment
}
salesReqCode
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipFrom {
...AddressFragment
}
shipMethodPayment
shipNoLaterDate
shipNotBeforeDate
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
shipToCompany {
...CompanyFragment
}
shipmentCancelledDates
shipmentDates
shipmentNumberCount
shipmentNumbers
shippingMethod
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supplierOrManufacturer {
...AddressFragment
}
supportedDateFields
testIndicator
textInfo {
...TextSegmentFragment
}
textMessages
timeline
timestamp
timezoneOffset
totalAmount
totalQuantity
transactionBegin
transactionEnd
transactionRefNum
transactionTypeCode
tsControlNumber
tsIDCode
tsPurposeCode
tsPurposeCodes
type
units
unitsOfMeasure
unknownFields
vendor {
...AddressFragment
}
vendorIdNumber
vendorIdNumberAsn
vendorNumber
vendorNumbers
vendorOrderNumber
vendorOrderNumberAsn
watchers
webOrderNumber
weight
weightUOM
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{
"LineItems": [LineItemInput],
"PurchaseOrderDocument": PurchaseOrderDocumentInput
}
¶ Response
{
"data": {
"submit_purchase_order": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "xyz789",
"ackTypes": ["xyz789"],
"addressFields": [Address],
"albertsonsDepartmentNumber": "abc123",
"alphaCodes": ["xyz789"],
"appAdviceTransferStatus": "xyz789",
"arrivedAtCustomsDates": [
"2007-12-03"
],
"arrivedAtTerminalLocationsDates": [
"2007-12-03"
],
"arrivedDates": ["2007-12-03"],
"availableForDeliveryDates": [
"2007-12-03"
],
"billOfLadingNumbers": ["abc123"],
"billOfLadingReleasedDates": [
"2007-12-03"
],
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"bookingConfirmedDates": [
"2007-12-03"
],
"bookingNumbers": ["xyz789"],
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyerIdentification": "xyz789",
"buyingParty": Address,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": true,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"cargoReceivedAtContractualPlaceOfReceiptDates": [
"2007-12-03"
],
"carrierAndCustomsReleaseDates": [
"2007-12-03"
],
"carrierReleaseDates": ["2007-12-03"],
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"completedUnloadingAtDeliveryLocationDates": [
"2007-12-03"
],
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "xyz789",
"customFields": Map_String_StringScalar,
"customsReleasedDates": [
"2007-12-03"
],
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryAppointmentDates": [
"2007-12-03"
],
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"departedPickupLocationDates": [
"2007-12-03"
],
"departmentNumberText": "xyz789",
"doNotDeliverAfter": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBefore": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"emptyEquipmentDispatchedDates": [
"2007-12-03"
],
"entityID": "abc123",
"environment": "abc123",
"equipmentNumberN9Segments": [
"xyz789"
],
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDeliveryDates": [
"2007-12-03"
],
"estimatedToArriveDates": [
"2007-12-03"
],
"estimatedToDepartTerminalLocationDates": [
"2007-12-03"
],
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedReply": "2007-12-03",
"expectedShipDate": "2007-12-03",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": false,
"hasApplicationAdvice": true,
"hasCreditDebitAdjustment": true,
"hasErrors": false,
"hasExceptions": true,
"hasInvoice": true,
"hasPOChange": true,
"hasPurchaseOrderAcknowledgment": false,
"hasPurchaseOrderChange": true,
"hasRemittanceAdvice": true,
"hasReturnMerchandiseAuthorization": false,
"hasStatusDetail": true,
"hasWarehouseShippingAdvice": false,
"hasWarehouseShippingOrder": true,
"hasWarehouseStockTransferShipmentAdvice": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"internalVendorNumber": "abc123",
"invoiceDates": ["2007-12-03"],
"invoiceNumberCount": 987,
"invoiceNumbers": ["xyz789"],
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"loadedOnRailDates": ["2007-12-03"],
"loadedOnTruckDates": ["2007-12-03"],
"loadedOnVesselDates": ["2007-12-03"],
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 987,
"oceanShipmentStatusCodes": [
"abc123"
],
"oceanShipmentStatuses": ["abc123"],
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"paymentDates": ["2007-12-03"],
"poAndAsnVendorNumbersMatch": true,
"poDate": "2007-12-03",
"poNumber": "xyz789",
"poType": "abc123",
"pocDates": ["2007-12-03"],
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"providedTotalAmount": 987.65,
"purposeCodes": ["xyz789"],
"railDepartureFromOriginIntermodalRampsDates": [
"2007-12-03"
],
"receivedAtOriginDates": [
"2007-12-03"
],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedPickup": "2007-12-03",
"requestedShipDate": "2007-12-03",
"returnedToCarriersTerminalDates": [
"2007-12-03"
],
"returnedToShipperDates": [
"2007-12-03"
],
"routing": "abc123",
"sacItems": [SAC],
"salesReqCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"shipToCompany": Company,
"shipmentCancelledDates": [
"2007-12-03"
],
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["abc123"],
"shippingMethod": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"textMessages": ["abc123"],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 123.45,
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"transactionTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"tsPurposeCodes": ["xyz789"],
"type": "xyz789",
"units": "xyz789",
"unitsOfMeasure": ["xyz789"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "xyz789",
"vendorIdNumberAsn": "xyz789",
"vendorNumber": "xyz789",
"vendorNumbers": ["abc123"],
"vendorOrderNumber": "abc123",
"vendorOrderNumberAsn": "xyz789",
"watchers": ["abc123"],
"webOrderNumber": "abc123",
"weight": 123.45,
"weightUOM": "abc123",
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
submit_purchase_order_acknowledgment
¶ Response
Returns a PurchaseOrderAcknowledgmentDocument
¶ Arguments
| Name | Description |
|---|---|
LineItems - [LineItemInput]
|
|
PurchaseOrderAcknowledgmentDocument - PurchaseOrderAcknowledgmentDocumentInput
|
¶ Example
¶ Query
mutation submit_purchase_order_acknowledgment(
$LineItems: [LineItemInput],
$PurchaseOrderAcknowledgmentDocument: PurchaseOrderAcknowledgmentDocumentInput
) {
submit_purchase_order_acknowledgment(
LineItems: $LineItems,
PurchaseOrderAcknowledgmentDocument: $PurchaseOrderAcknowledgmentDocument
) {
SLAFields
acceptanceStatus {
...AcceptanceStatusFragment
}
ackType
addressFields {
...AddressFragment
}
appAdviceTransferStatus
billToAddress {
...AddressFragment
}
billToParty {
...AddressFragment
}
bodID
bodIDVersion
businessPartner {
...PartyInformationFragment
}
businessPartnerIdentifiers {
...IdPairFragment
}
businessPartnerStrictIdEnabled
buyingParty {
...AddressFragment
}
calculatedTotalAmount
canDownloadOriginalFile
cancelAfterDate
cancelIfNotShippedByDate
categoryFacet
commenters {
...UserInfoFragment
}
companyID
compositeKeys {
...CompositeKeyFragment
}
contactRepresentations {
...ContactRepresentationFragment
}
containerID
conversation {
...ConversationFragment
}
conversationList {
...ConversationListFragment
}
conversation_id
correlatedByPoints {
...LifeCycleCorrelationPointFragment
}
correlatesOnPoints {
...LifeCycleCorrelationPointFragment
}
correlationReferenceId
currency
currentScheduleDelivery
customFields
dataFormat
dataFormatVersion
deferredPaymentDate
deliveryRequested
deliveryRequestedDate
doNotDeliverAfterDate
doNotDeliverBeforeDate
docType
documentCorrelationPoints {
...DocumentCorrelationPointFragment
}
dtmDates {
...DTMDateFragment
}
entityID
environment
errorCodes
errorCorrelationPoints {
...ErrorCorrelationPointFragment
}
eventType
filename
filteringMetadata
flowDirection
functionalAcknowledgmentCode
functionalAcknowledgmentErrorCode
functionallyAcknowledged
functionallyAcknowledgedBy
functionallyAcknowledgedByDocType
functionallyAcknowledgedOn
gsFuncIDCode
gsReceiverID
gsSenderID
gsTimestamp
hasApplicationAdvice
hasErrors
hasExceptions
hasPOChange
hasPurchaseOrder
hierarchyStructure
id
identifierType
inboundIdentifierHash
indexName
isDeleted
isaBegin
isaControlNumber
isaEnd
laVersion
lastCommentedOn
lifeCycleAudit {
...LifeCycleAuditFragment
}
lifeCycleUUIDs
lineItems {
...LineItemFragment
}
loadedOn
manuallyAcknowledged
manuallyAcknowledgedBy
name
numOfErrors
numberOfItems
originalDocumentID
originalTransactionID
outboundIdentifierHash
partnerHash
poDate
poDates
poNumber
poNumberCount
poNumbers
poType
primary
primaryContent
primaryIdentifier
providedTotalAmount
receiverID
receiverIDQualifier
receiverIDValue
receiverIdentifierHash
receiverIdentifierMap
referenceInfo {
...RefSegmentFragment
}
releaseDate
reprocessOn
reprocessedOn
requestedForDeliveryDatePriorTo
requestedForDeliveryDateWeekOf
requestedForShipmentDateWeekOf
requestedShipDate
routing
salesReqCode
sendFrom {
...PartyInformationFragment
}
sendTo {
...PartyInformationFragment
}
senderID
senderIDQualifier
senderIDValue
senderIdentifierHash
senderIdentifierMap
sharedToCompanies
shipFrom {
...AddressFragment
}
shipMethodPayment
shipNoLaterDate
shipNotBeforeDate
shipTo {
...AddressFragment
}
shipToAddress {
...AddressFragment
}
strictIdInboundIdentifierHash
strictIdOutboundIdentifierHash
subOrgID
subOrgName
subOrgStrictIdEnabled
supplierOrManufacturer {
...AddressFragment
}
supportedDateFields
testIndicator
textInfo {
...TextSegmentFragment
}
timeline
timestamp
timezoneOffset
totalAmount
totalQuantity
transactionBegin
transactionEnd
transactionRefNum
tsControlNumber
tsIDCode
tsPurposeCode
type
unknownFields
vendor {
...AddressFragment
}
watchers
wildcardReceiverIdentifierHash
wildcardSenderIdentifierHash
xmlCorrelationExists
xmlCorrelationFileID
xmlCorrelationPoints {
...XmlCorrelationPointFragment
}
}
}
¶ Variables
{
"LineItems": [LineItemInput],
"PurchaseOrderAcknowledgmentDocument": PurchaseOrderAcknowledgmentDocumentInput
}
¶ Response
{
"data": {
"submit_purchase_order_acknowledgment": {
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "abc123",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"calculatedTotalAmount": 123.45,
"canDownloadOriginalFile": true,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"deferredPaymentDate": "2007-12-03",
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [
DocumentCorrelationPoint
],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": true,
"hasPOChange": true,
"hasPurchaseOrder": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "abc123",
"poNumberCount": 987,
"poNumbers": ["abc123"],
"poType": "xyz789",
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"providedTotalAmount": 987.65,
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "xyz789",
"salesReqCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 123.45,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"tsPurposeCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
}
}
¶
switch_company_environment
¶ Example
¶ Query
mutation switch_company_environment(
$companyID: String,
$environmentID: String
) {
switch_company_environment(
companyID: $companyID,
environmentID: $environmentID
)
}
¶ Variables
{
"companyID": "abc123",
"environmentID": "abc123"
}
¶ Response
{"data": {"switch_company_environment": true}}
¶
toggleReadOnly_map
¶ Response
Returns a RepositoryFile
¶ Example
¶ Query
mutation toggleReadOnly_map(
$readOnly: Boolean,
$repositoryFileId: String
) {
toggleReadOnly_map(
readOnly: $readOnly,
repositoryFileId: $repositoryFileId
) {
comments
companyID
content
defaultVersion
directions
docType
documentType
enable
environment
fileType
id
indexName
inputFormat
name
outputFormat
partner
readOnly
routing
size
standards
tags
template
timestamp
xsltMapVersionIds
}
}
¶ Variables
{
"readOnly": true,
"repositoryFileId": "xyz789"
}
¶ Response
{
"data": {
"toggleReadOnly_map": {
"comments": "abc123",
"companyID": "xyz789",
"content": "xyz789",
"defaultVersion": "xyz789",
"directions": "abc123",
"docType": "abc123",
"documentType": "abc123",
"enable": true,
"environment": "abc123",
"fileType": "xyz789",
"id": "xyz789",
"indexName": "abc123",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "abc123",
"partner": "xyz789",
"readOnly": true,
"routing": "xyz789",
"size": {},
"standards": "xyz789",
"tags": ["xyz789"],
"template": false,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["abc123"]
}
}
}
¶
update_dashboard
¶ Response
Returns a DashboardConfig
¶ Arguments
| Name | Description |
|---|---|
dashboardId - String
|
|
dashboardUpdate - DashboardConfigInput
|
¶ Example
¶ Query
mutation update_dashboard(
$dashboardId: String,
$dashboardUpdate: DashboardConfigInput
) {
update_dashboard(
dashboardId: $dashboardId,
dashboardUpdate: $dashboardUpdate
) {
companyID
createdOn
environment
favorite
galleryReferenceID
galleryType
hasEdited
id
lastUpdated
layout {
...LayoutConfigFragment
}
name
owner {
...UserDetailsFragment
}
sharedWith {
...UserDetailsFragment
}
sharedWithIDs
updatedBy {
...UserDetailsFragment
}
userID
widgets {
...WidgetConfigFragment
}
}
}
¶ Variables
{
"dashboardId": "xyz789",
"dashboardUpdate": DashboardConfigInput
}
¶ Response
{
"data": {
"update_dashboard": {
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "abc123",
"favorite": false,
"galleryReferenceID": "xyz789",
"galleryType": "DASHBOARD",
"hasEdited": true,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"layout": LayoutConfig,
"name": "abc123",
"owner": UserDetails,
"sharedWith": [UserDetails],
"sharedWithIDs": ["xyz789"],
"updatedBy": UserDetails,
"userID": "abc123",
"widgets": [WidgetConfig]
}
}
}
¶
update_environment
¶ Response
Returns an Environment
¶ Arguments
| Name | Description |
|---|---|
environment - EnvironmentInput
|
¶ Example
¶ Query
mutation update_environment($environment: EnvironmentInput) {
update_environment(environment: $environment) {
active
code
description
id
name
}
}
¶ Variables
{"environment": EnvironmentInput}
¶ Response
{
"data": {
"update_environment": {
"active": true,
"code": "xyz789",
"description": "abc123",
"id": "xyz789",
"name": "abc123"
}
}
}
¶
update_file_processing_pipeline
¶ Response
Returns a ProcessingPipeline
¶ Arguments
| Name | Description |
|---|---|
id - String
|
|
processingPipeline - ProcessingPipelineInput
|
¶ Example
¶ Query
mutation update_file_processing_pipeline(
$id: String,
$processingPipeline: ProcessingPipelineInput
) {
update_file_processing_pipeline(
id: $id,
processingPipeline: $processingPipeline
) {
companyID
createdBy {
...UserDetailsFragment
}
environment
filePathRegexp
id
lastUpdate
name
partner {
...BusinessPartnerFragment
}
stepsData
timestamp
}
}
¶ Variables
{
"id": "abc123",
"processingPipeline": ProcessingPipelineInput
}
¶ Response
{
"data": {
"update_file_processing_pipeline": {
"companyID": "xyz789",
"createdBy": UserDetails,
"environment": "xyz789",
"filePathRegexp": "xyz789",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"name": "abc123",
"partner": BusinessPartner,
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03"
}
}
}
¶
update_group
¶ Arguments
| Name | Description |
|---|---|
group - GroupInput
|
|
groupId - String
|
¶ Example
¶ Query
mutation update_group(
$group: GroupInput,
$groupId: String
) {
update_group(
group: $group,
groupId: $groupId
) {
avatarID
companyID
environment
hasHiddenMembers
id
members {
...UserDetailsFragment
}
name
permissionList
permissions
}
}
¶ Variables
{
"group": GroupInput,
"groupId": "abc123"
}
¶ Response
{
"data": {
"update_group": {
"avatarID": "abc123",
"companyID": "xyz789",
"environment": "abc123",
"hasHiddenMembers": false,
"id": "xyz789",
"members": [UserDetails],
"name": "abc123",
"permissionList": ["abc123"],
"permissions": Map_String_ObjectScalar
}
}
}
¶
update_group_permissions
¶ Description
Override existing permissions with a new set of permissions
¶ Response
Returns a Results_String
¶ Arguments
| Name | Description |
|---|---|
groupId - String
|
|
permissions - Map_String_ObjectScalar
|
¶ Example
¶ Query
mutation update_group_permissions(
$groupId: String,
$permissions: Map_String_ObjectScalar
) {
update_group_permissions(
groupId: $groupId,
permissions: $permissions
) {
aggregations
items
totalItems
}
}
¶ Variables
{
"groupId": "xyz789",
"permissions": Map_String_ObjectScalar
}
¶ Response
{
"data": {
"update_group_permissions": {
"aggregations": Map_String_ObjectScalar,
"items": ["xyz789"],
"totalItems": {}
}
}
}
¶
update_late_mft_event_rule
¶ Response
Returns an LateMFTEventRule
¶ Arguments
| Name | Description |
|---|---|
id - String
|
|
rule - LateMFTEventRuleRequestInput
|
¶ Example
¶ Query
mutation update_late_mft_event_rule(
$id: String,
$rule: LateMFTEventRuleRequestInput
) {
update_late_mft_event_rule(
id: $id,
rule: $rule
) {
active
companyID
consumerPartner {
...BusinessPartnerFragment
}
createdBy {
...UserDetailsFragment
}
cronExpression
environment
exceptionEntityType
filePattern
id
ignoreOlderThanDelta
producerPartner {
...BusinessPartnerFragment
}
timestamp
type
}
}
¶ Variables
{
"id": "xyz789",
"rule": LateMFTEventRuleRequestInput
}
¶ Response
{
"data": {
"update_late_mft_event_rule": {
"active": true,
"companyID": "abc123",
"consumerPartner": BusinessPartner,
"createdBy": UserDetails,
"cronExpression": "abc123",
"environment": "xyz789",
"exceptionEntityType": "DOCUMENT",
"filePattern": "xyz789",
"id": "xyz789",
"ignoreOlderThanDelta": {},
"producerPartner": BusinessPartner,
"timestamp": "2007-12-03",
"type": "LATE_MFT_EVENT"
}
}
}
¶
update_mft_exceptions
¶ Response
Returns [BaseMFTException]
¶ Arguments
| Name | Description |
|---|---|
UpdateRequest - [BaseMFTExceptionInput]
|
|
resolved - Boolean!
|
¶ Example
¶ Query
mutation update_mft_exceptions(
$UpdateRequest: [BaseMFTExceptionInput],
$resolved: Boolean!
) {
update_mft_exceptions(
UpdateRequest: $UpdateRequest,
resolved: $resolved
) {
assignedTo {
...UserDetailsFragment
}
companyID
details {
...ExceptionDetailsFragment
}
environment
exceptionEntityType
exceptionType
id
indexName
notes
parties {
...BusinessPartnerFragment
}
resolvedBy {
...UserDetailsFragment
}
resolvedOn
routing
status
timestamp
}
}
¶ Variables
{
"UpdateRequest": [BaseMFTExceptionInput],
"resolved": false
}
¶ Response
{
"data": {
"update_mft_exceptions": [
{
"assignedTo": UserDetails,
"companyID": "xyz789",
"details": ExceptionDetails,
"environment": "abc123",
"exceptionEntityType": "DOCUMENT",
"exceptionType": "LATE_MFT_EVENT_SUMMARY",
"id": "xyz789",
"indexName": "abc123",
"notes": "xyz789",
"parties": [BusinessPartner],
"resolvedBy": UserDetails,
"resolvedOn": "2007-12-03",
"routing": "xyz789",
"status": "ARCHIVED",
"timestamp": "2007-12-03"
}
]
}
}
¶
update_outbound_sftp_configuration
¶ Response
Returns an OutboundSFTPConfiguration
¶ Arguments
| Name | Description |
|---|---|
id - String
|
|
outboundSFTPConfiguration - OutboundSFTPConfigurationInput
|
¶ Example
¶ Query
mutation update_outbound_sftp_configuration(
$id: String,
$outboundSFTPConfiguration: OutboundSFTPConfigurationInput
) {
update_outbound_sftp_configuration(
id: $id,
outboundSFTPConfiguration: $outboundSFTPConfiguration
) {
businessPartnerID
companyID
connectionTimeout
createdBy {
...UserDetailsFragment
}
destinationFolder
environment
host
id
knownHosts
name
passwordHash
port
privateKey
retryCount
strictHostKeyChecking
timestamp
type
username
}
}
¶ Variables
{
"id": "abc123",
"outboundSFTPConfiguration": OutboundSFTPConfigurationInput
}
¶ Response
{
"data": {
"update_outbound_sftp_configuration": {
"businessPartnerID": "abc123",
"companyID": "abc123",
"connectionTimeout": 123,
"createdBy": UserDetails,
"destinationFolder": "xyz789",
"environment": "abc123",
"host": "abc123",
"id": "xyz789",
"knownHosts": "xyz789",
"name": "xyz789",
"passwordHash": "xyz789",
"port": 987,
"privateKey": "xyz789",
"retryCount": 987,
"strictHostKeyChecking": false,
"timestamp": "2007-12-03",
"type": "KEY",
"username": "xyz789"
}
}
}
¶
update_replay_sftp_config
¶ Response
Returns a ReplaySftpConfiguration
¶ Arguments
| Name | Description |
|---|---|
configUpdate - ReplaySftpConfigurationInput
|
|
id - String
|
¶ Example
¶ Query
mutation update_replay_sftp_config(
$configUpdate: ReplaySftpConfigurationInput,
$id: String
) {
update_replay_sftp_config(
configUpdate: $configUpdate,
id: $id
) {
companyID
distPath
environment
host
id
knownHosts
password
port
timestamp
userName
}
}
¶ Variables
{
"configUpdate": ReplaySftpConfigurationInput,
"id": "xyz789"
}
¶ Response
{
"data": {
"update_replay_sftp_config": {
"companyID": "xyz789",
"distPath": "xyz789",
"environment": "abc123",
"host": "abc123",
"id": "abc123",
"knownHosts": "xyz789",
"password": "xyz789",
"port": 123,
"timestamp": "2007-12-03",
"userName": "xyz789"
}
}
}
¶
update_transaction_processing_pipeline
¶ Response
Returns a TransactionProcessingPipeline
¶ Arguments
| Name | Description |
|---|---|
id - String
|
|
transactionProcessingPipeline - TransactionProcessingPipelineInput
|
¶ Example
¶ Query
mutation update_transaction_processing_pipeline(
$id: String,
$transactionProcessingPipeline: TransactionProcessingPipelineInput
) {
update_transaction_processing_pipeline(
id: $id,
transactionProcessingPipeline: $transactionProcessingPipeline
) {
companyID
createdBy {
...UserDetailsFragment
}
environment
id
lastUpdate
receiverID
receiverIDQualifier
receiverIDValue
stepsData
timestamp
type
}
}
¶ Variables
{
"id": "abc123",
"transactionProcessingPipeline": TransactionProcessingPipelineInput
}
¶ Response
{
"data": {
"update_transaction_processing_pipeline": {
"companyID": "abc123",
"createdBy": UserDetails,
"environment": "xyz789",
"id": "abc123",
"lastUpdate": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03",
"type": "abc123"
}
}
}
¶
update_user
¶ Example
¶ Query
mutation update_user(
$disable: Boolean,
$revokeInvite: Boolean,
$userId: String
) {
update_user(
disable: $disable,
revokeInvite: $revokeInvite,
userId: $userId
)
}
¶ Variables
{
"disable": false,
"revokeInvite": true,
"userId": "abc123"
}
¶ Response
{"data": {"update_user": "abc123"}}
¶
update_user_profile
¶ Response
Returns a UserDetails
¶ Arguments
| Name | Description |
|---|---|
updateDetails - UserDetailsInput
|
|
userId - String
|
¶ Example
¶ Query
mutation update_user_profile(
$updateDetails: UserDetailsInput,
$userId: String
) {
update_user_profile(
updateDetails: $updateDetails,
userId: $userId
) {
avatarID
bio
companyID
createdOn
department
disabled
email
emailVerified
environment
firstName
groups {
...GroupFragment
}
id
invited
jobTitle
lastActivity
lastName
permissionMap
permissions
userContact {
...UserContactFragment
}
userPreferences {
...UserPreferencesFragment
}
}
}
¶ Variables
{
"updateDetails": UserDetailsInput,
"userId": "xyz789"
}
¶ Response
{
"data": {
"update_user_profile": {
"avatarID": "xyz789",
"bio": "abc123",
"companyID": "xyz789",
"createdOn": "2007-12-03",
"department": "xyz789",
"disabled": false,
"email": "abc123",
"emailVerified": true,
"environment": "abc123",
"firstName": "xyz789",
"groups": [Group],
"id": "xyz789",
"invited": false,
"jobTitle": "abc123",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["xyz789"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
}
}
¶
verify_client_scopes
¶ Description
Verify the defined permissions in each client_scope
¶ Types
¶ AcceptanceStatus
¶ AcceptanceStatusInput
¶ Address
¶ Fields
| Field Name | Description |
|---|---|
addressType - String
|
|
city - String
|
|
city2 - String
|
|
contactRepresentation - ContactRepresentation
|
|
coordinate - Coordinate
|
|
country - String
|
|
faxNumber - String
|
|
houseNumber - String
|
|
isoLanguageKey - String
|
|
jurisdiction - String
|
|
languageKey - String
|
|
line1 - String
|
|
line2 - String
|
|
locationCode - String
|
|
locationQualifier - String
|
|
name - String
|
|
name2 - String
|
|
name3 - String
|
|
partner - String
|
|
partnerNumber - String
|
|
postalCode - String
|
|
purchasingOrganization - String
|
|
referenceInfo - [RefSegment]
|
|
state - String
|
|
telephone - String
|
|
userName - String
|
|
vendorNumber - String
|
¶ Example
{
"addressType": "xyz789",
"city": "xyz789",
"city2": "abc123",
"contactRepresentation": ContactRepresentation,
"coordinate": Coordinate,
"country": "xyz789",
"faxNumber": "abc123",
"houseNumber": "xyz789",
"isoLanguageKey": "xyz789",
"jurisdiction": "xyz789",
"languageKey": "abc123",
"line1": "abc123",
"line2": "xyz789",
"locationCode": "abc123",
"locationQualifier": "xyz789",
"name": "xyz789",
"name2": "abc123",
"name3": "abc123",
"partner": "xyz789",
"partnerNumber": "xyz789",
"postalCode": "abc123",
"purchasingOrganization": "xyz789",
"referenceInfo": [RefSegment],
"state": "abc123",
"telephone": "abc123",
"userName": "xyz789",
"vendorNumber": "xyz789"
}
¶ AddressInput
¶ Fields
| Input Field | Description |
|---|---|
addressType - String
|
|
city - String
|
|
city2 - String
|
|
contactRepresentation - ContactRepresentationInput
|
|
coordinate - CoordinateInput
|
|
country - String
|
|
faxNumber - String
|
|
houseNumber - String
|
|
isoLanguageKey - String
|
|
jurisdiction - String
|
|
languageKey - String
|
|
line1 - String
|
|
line2 - String
|
|
locationCode - String
|
|
locationQualifier - String
|
|
name - String
|
|
name2 - String
|
|
name3 - String
|
|
partner - String
|
|
partnerNumber - String
|
|
postalCode - String
|
|
purchasingOrganization - String
|
|
referenceInfo - [RefSegmentInput]
|
|
state - String
|
|
telephone - String
|
|
userName - String
|
|
vendorNumber - String
|
¶ Example
{
"addressType": "abc123",
"city": "xyz789",
"city2": "xyz789",
"contactRepresentation": ContactRepresentationInput,
"coordinate": CoordinateInput,
"country": "abc123",
"faxNumber": "xyz789",
"houseNumber": "xyz789",
"isoLanguageKey": "abc123",
"jurisdiction": "abc123",
"languageKey": "abc123",
"line1": "xyz789",
"line2": "xyz789",
"locationCode": "xyz789",
"locationQualifier": "abc123",
"name": "xyz789",
"name2": "abc123",
"name3": "abc123",
"partner": "abc123",
"partnerNumber": "xyz789",
"postalCode": "xyz789",
"purchasingOrganization": "abc123",
"referenceInfo": [RefSegmentInput],
"state": "xyz789",
"telephone": "xyz789",
"userName": "xyz789",
"vendorNumber": "abc123"
}
¶ Adjustment
¶ Example
{
"monetaryAmount": "abc123",
"reasonCode": "abc123",
"referenceDate": "2007-12-03",
"referenceDateQualifier": "abc123",
"referenceIdentification": "xyz789",
"referenceIdentificationQualifier": "xyz789",
"referenceNumber": "abc123",
"referenceType": "xyz789"
}
¶ AdvanceShipNoticeDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
actualShipDate - Date
|
|
addressFields - [Address]
|
|
allShipmentInfo - [String]
|
|
appAdviceTransferStatus - String
|
|
asnPurposeCode - String
|
|
billOfLadingNumber - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
carrierReferenceNumber - String
|
|
categoryFacet - CategoryFacet
|
|
childrenTypes - [String]
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currentScheduleDelivery - Date
|
|
currentScheduleShip - Date
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deliveryAppointment - Date
|
|
deliveryRequested - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
estimatedDelivery - Date
|
|
eventType - LifeCycleEventType
|
|
expectedShipDate - Date
|
|
expiration - Date
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasInvoice - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
incorrectLineItemsStructure - Boolean
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
invoiceDates - [Date]
|
|
invoiceNumber - String
|
|
invoiceNumbers - [String]
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laDocumentVersion - String
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
packIds - [String]
|
|
partnerHash - String
|
|
partyToReceiveInvoice - Address
|
|
paymentDates - [Date]
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
poShipTo - Address
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
promisedForDelivery - Date
|
|
purchaseOrderPoDate - Date
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceIds - [String]
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedShipDate - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
scacCode - String
|
|
scacCodes - [String]
|
|
scheduledDeliveryAppointment - Date
|
|
sellingParty - Address
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipmentIdNumber - String
|
|
shipmentNumber - String
|
|
shipped - Date
|
|
shippingContainerIds - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
tareIds - [String]
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
thirdPartyCorrelation - DocumentCorrelationPoint
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalNumUnitsShipped - Float
|
|
totalQuantityOrdered - Float
|
|
trackingNumber - String
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendorIdNumberMap - Map_String_StringScalar
|
|
vendorNumberMap - Map_String_StringScalar
|
|
vendorOrderNumberMap - Map_String_StringScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"actualShipDate": "2007-12-03",
"addressFields": [Address],
"allShipmentInfo": ["abc123"],
"appAdviceTransferStatus": "xyz789",
"asnPurposeCode": "xyz789",
"billOfLadingNumber": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"canDownloadOriginalFile": true,
"carrierReferenceNumber": "abc123",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"childrenTypes": ["abc123"],
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"deliveryAppointment": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedShipDate": "2007-12-03",
"expiration": "2007-12-03",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hasInvoice": false,
"hasPurchaseOrder": true,
"hasRemittanceAdvice": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"incorrectLineItemsStructure": false,
"indexName": "xyz789",
"internalVendorNumber": "abc123",
"invoiceDates": ["2007-12-03"],
"invoiceNumber": "abc123",
"invoiceNumbers": ["abc123"],
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laDocumentVersion": "abc123",
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"packIds": ["xyz789"],
"partnerHash": "xyz789",
"partyToReceiveInvoice": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 987,
"poNumbers": ["xyz789"],
"poShipTo": Address,
"primary": true,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"promisedForDelivery": "2007-12-03",
"purchaseOrderPoDate": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceIds": ["abc123"],
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"scacCode": "xyz789",
"scacCodes": ["xyz789"],
"scheduledDeliveryAppointment": "2007-12-03",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentIdNumber": "abc123",
"shipmentNumber": "xyz789",
"shipped": "2007-12-03",
"shippingContainerIds": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"supportedDateFields": Map_SupportedDate_DateScalar,
"tareIds": ["xyz789"],
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalNumUnitsShipped": 123.45,
"totalQuantityOrdered": 123.45,
"trackingNumber": "xyz789",
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendorIdNumberMap": Map_String_StringScalar,
"vendorNumberMap": Map_String_StringScalar,
"vendorOrderNumberMap": Map_String_StringScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ AdvanceShipNoticeDocumentInput
¶ Fields
| Input Field | Description |
|---|---|
acceptanceStatus - AcceptanceStatusInput
|
|
actualShipDate - Date
|
|
addressFields - [AddressInput]
|
|
allShipmentInfo - [String]
|
|
appAdviceTransferStatus - String
|
|
asnPurposeCode - String
|
|
billOfLadingNumber - String
|
|
billToAddress - AddressInput
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformationInput
|
|
businessPartnerIdentifiers - [IdPairInput]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - AddressInput
|
|
canDownloadOriginalFile - Boolean
|
|
carrierReferenceNumber - String
|
|
childrenTypes - [String]
|
|
commenters - [UserInfoInput]
|
|
companyID - String
|
|
contactRepresentations - [ContactRepresentationInput]
|
|
containerID - String
|
|
conversation_id - String
|
|
currentScheduleDelivery - Date
|
|
currentScheduleShip - Date
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deliveryAppointment - Date
|
|
deliveryRequested - Date
|
|
docType - String
|
|
dtmDates - [DTMDateInput]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
estimatedDelivery - Date
|
|
expectedShipDate - Date
|
|
expiration - Date
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasInvoice - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
incorrectLineItemsStructure - Boolean
|
|
internalVendorNumber - String
|
|
invoiceDates - [Date]
|
|
invoiceNumber - String
|
|
invoiceNumbers - [String]
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laDocumentVersion - String
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
packIds - [String]
|
|
partnerHash - String
|
|
partyToReceiveInvoice - AddressInput
|
|
paymentDates - [Date]
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
poShipTo - AddressInput
|
|
promisedForDelivery - Date
|
|
purchaseOrderPoDate - Date
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceIds - [String]
|
|
referenceInfo - [RefSegmentInput]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedShipDate - Date
|
|
scacCode - String
|
|
scacCodes - [String]
|
|
scheduledDeliveryAppointment - Date
|
|
sellingParty - AddressInput
|
|
sendFrom - PartyInformationInput
|
|
sendTo - PartyInformationInput
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
shipFrom - AddressInput
|
|
shipTo - AddressInput
|
|
shipToAddress - AddressInput
|
|
shipmentIdNumber - String
|
|
shipmentNumber - String
|
|
shipped - Date
|
|
shippingContainerIds - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
tareIds - [String]
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegmentInput]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalNumUnitsShipped - Float
|
|
totalQuantityOrdered - Float
|
|
trackingNumber - String
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
vendorIdNumberMap - Map_String_StringScalar
|
|
vendorNumberMap - Map_String_StringScalar
|
|
vendorOrderNumberMap - Map_String_StringScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatusInput,
"actualShipDate": "2007-12-03",
"addressFields": [AddressInput],
"allShipmentInfo": ["xyz789"],
"appAdviceTransferStatus": "xyz789",
"asnPurposeCode": "xyz789",
"billOfLadingNumber": "xyz789",
"billToAddress": AddressInput,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformationInput,
"businessPartnerIdentifiers": [IdPairInput],
"businessPartnerStrictIdEnabled": false,
"buyingParty": AddressInput,
"canDownloadOriginalFile": false,
"carrierReferenceNumber": "xyz789",
"childrenTypes": ["xyz789"],
"commenters": [UserInfoInput],
"companyID": "abc123",
"contactRepresentations": [ContactRepresentationInput],
"containerID": "xyz789",
"conversation_id": "abc123",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deliveryAppointment": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "xyz789",
"dtmDates": [DTMDateInput],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"estimatedDelivery": "2007-12-03",
"expectedShipDate": "2007-12-03",
"expiration": "2007-12-03",
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hasInvoice": true,
"hasPurchaseOrder": true,
"hasRemittanceAdvice": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"incorrectLineItemsStructure": false,
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumber": "abc123",
"invoiceNumbers": ["xyz789"],
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laDocumentVersion": "xyz789",
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"packIds": ["xyz789"],
"partnerHash": "abc123",
"partyToReceiveInvoice": AddressInput,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["abc123"],
"poShipTo": AddressInput,
"promisedForDelivery": "2007-12-03",
"purchaseOrderPoDate": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceIds": ["xyz789"],
"referenceInfo": [RefSegmentInput],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"scacCode": "xyz789",
"scacCodes": ["xyz789"],
"scheduledDeliveryAppointment": "2007-12-03",
"sellingParty": AddressInput,
"sendFrom": PartyInformationInput,
"sendTo": PartyInformationInput,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"shipFrom": AddressInput,
"shipTo": AddressInput,
"shipToAddress": AddressInput,
"shipmentIdNumber": "xyz789",
"shipmentNumber": "xyz789",
"shipped": "2007-12-03",
"shippingContainerIds": "abc123",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"tareIds": ["abc123"],
"testIndicator": "INFORMATION",
"textInfo": [TextSegmentInput],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalNumUnitsShipped": 123.45,
"totalQuantityOrdered": 987.65,
"trackingNumber": "abc123",
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"vendorIdNumberMap": Map_String_StringScalar,
"vendorNumberMap": Map_String_StringScalar,
"vendorOrderNumberMap": Map_String_StringScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"]
}
¶ AggregationTypeDisambiguator
¶ Aggregation_ObjectInput
¶ Fields
| Input Field | Description |
|---|---|
aggregations - [Aggregation_ObjectInput]
|
|
calendarInterval - CalendarInterval
|
|
field - String
|
|
format - String
|
|
name - String
|
|
parameters - ObjectScalar
|
|
type - AggregationTypeDisambiguator
|
Input type discriminator |
¶ Example
{
"aggregations": [Aggregation_ObjectInput],
"calendarInterval": "Day",
"field": "abc123",
"format": "xyz789",
"name": "abc123",
"parameters": ObjectScalar,
"type": "AVG"
}
¶ ApplicationAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
OTI01value - String
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
affectedDocuments - [OTIReference]
|
|
appAdviceTransferStatus - String
|
|
applicationAdviceDate - Date
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedDocIds - [String]
|
|
correlationPoints - [ErrorCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodeUUID - [ErrorCode]
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
n1Segments - [N1Segment]
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
purposeCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceIdFriendlyName - [String]
|
|
referenceIdList - [String]
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsIdCodeList - [String]
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"OTI01value": "abc123",
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"affectedDocuments": [OTIReference],
"appAdviceTransferStatus": "xyz789",
"applicationAdviceDate": "2007-12-03",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedDocIds": ["abc123"],
"correlationPoints": [ErrorCorrelationPoint],
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodeUUID": [ErrorCode],
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"n1Segments": [N1Segment],
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"purposeCode": "abc123",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "xyz789",
"referenceIdFriendlyName": ["abc123"],
"referenceIdList": ["xyz789"],
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"tsIdCodeList": ["xyz789"],
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ Base64String
¶ BaseBusinessDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ BaseMFTException
¶ Fields
| Field Name | Description |
|---|---|
assignedTo - UserDetails
|
|
companyID - String
|
|
details - ExceptionDetails
|
|
environment - String
|
|
exceptionEntityType - ExceptionEntityType
|
|
exceptionType - ExceptionType
|
|
id - String
|
|
indexName - String
|
|
notes - String
|
|
parties - [BusinessPartner]
|
|
resolvedBy - UserDetails
|
|
resolvedOn - Date
|
|
routing - String
|
|
status - ExceptionStatus
|
|
timestamp - Date
|
¶ Example
{
"assignedTo": UserDetails,
"companyID": "abc123",
"details": ExceptionDetails,
"environment": "abc123",
"exceptionEntityType": "DOCUMENT",
"exceptionType": "LATE_MFT_EVENT_SUMMARY",
"id": "abc123",
"indexName": "abc123",
"notes": "abc123",
"parties": [BusinessPartner],
"resolvedBy": UserDetails,
"resolvedOn": "2007-12-03",
"routing": "abc123",
"status": "ARCHIVED",
"timestamp": "2007-12-03"
}
¶ BaseMFTExceptionInput
¶ Fields
| Input Field | Description |
|---|---|
assignedTo - UserDetailsInput
|
|
companyID - String
|
|
details - ExceptionDetailsInput
|
|
environment - String
|
|
exceptionEntityType - ExceptionEntityType
|
|
exceptionType - ExceptionType
|
|
id - String
|
|
notes - String
|
|
parties - [BusinessPartnerInput]
|
|
resolvedBy - UserDetailsInput
|
|
resolvedOn - Date
|
|
status - ExceptionStatus
|
|
timestamp - Date
|
¶ Example
{
"assignedTo": UserDetailsInput,
"companyID": "abc123",
"details": ExceptionDetailsInput,
"environment": "abc123",
"exceptionEntityType": "DOCUMENT",
"exceptionType": "LATE_MFT_EVENT_SUMMARY",
"id": "abc123",
"notes": "abc123",
"parties": [BusinessPartnerInput],
"resolvedBy": UserDetailsInput,
"resolvedOn": "2007-12-03",
"status": "ARCHIVED",
"timestamp": "2007-12-03"
}
¶ Boolean
¶ Description
The Boolean scalar type represents true or false.
¶ BusinessIdentifier
¶ Example
{
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"id": "xyz789",
"lastUpdatedOn": "2007-12-03",
"partnerID": "xyz789",
"type": "abc123"
}
¶ BusinessIdentifierInput
¶ Example
{
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "abc123",
"id": "xyz789",
"lastUpdatedOn": "2007-12-03",
"partnerID": "xyz789",
"type": "xyz789"
}
¶ BusinessIdentifierType
¶ BusinessPartner
¶ Fields
| Field Name | Description |
|---|---|
address - Address
|
|
companyID - String
|
|
contactInfo - [PartnerContactRecord]
|
|
createdOn - Date
|
|
domains - [String]
|
|
environment - String
|
|
id - String
|
|
identifierRefs - [String]
|
|
lastUpdate - Date
|
|
locations - [PartnerLocation]
|
|
mergedToPartner - String
|
|
name - String
|
|
nameLowercase - String
|
|
protocols - [PartnerProtocol]
|
|
role - PartnerRole
|
|
settings - BusinessPartnerSettings
|
|
totalNumIdentifiers - Int
|
|
type - PartnerType
|
|
version - Int
|
¶ Example
{
"address": Address,
"companyID": "xyz789",
"contactInfo": [PartnerContactRecord],
"createdOn": "2007-12-03",
"domains": ["abc123"],
"environment": "abc123",
"id": "xyz789",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocation],
"mergedToPartner": "xyz789",
"name": "abc123",
"nameLowercase": "abc123",
"protocols": [PartnerProtocol],
"role": "Receiver",
"settings": BusinessPartnerSettings,
"totalNumIdentifiers": 123,
"type": "EDIPartner",
"version": 987
}
¶ BusinessPartnerInfo
¶ BusinessPartnerInfoInput
¶ BusinessPartnerInput
¶ Fields
| Input Field | Description |
|---|---|
_id - String
|
|
address - AddressInput
|
|
companyID - String
|
|
contactInfo - [PartnerContactRecordInput]
|
|
createdOn - Date
|
|
domains - [String]
|
|
environment - String
|
|
identifierRefs - [String]
|
|
lastUpdate - Date
|
|
locations - [PartnerLocationInput]
|
|
mergedToPartner - String
|
|
name - String
|
|
nameLowercase - String
|
|
protocols - [PartnerProtocolInput]
|
|
role - PartnerRole
|
|
settings - BusinessPartnerSettingsInput
|
|
totalNumIdentifiers - Int
|
|
type - PartnerType
|
|
version - Int
|
¶ Example
{
"_id": "abc123",
"address": AddressInput,
"companyID": "abc123",
"contactInfo": [PartnerContactRecordInput],
"createdOn": "2007-12-03",
"domains": ["xyz789"],
"environment": "xyz789",
"identifierRefs": ["xyz789"],
"lastUpdate": "2007-12-03",
"locations": [PartnerLocationInput],
"mergedToPartner": "xyz789",
"name": "abc123",
"nameLowercase": "xyz789",
"protocols": [PartnerProtocolInput],
"role": "Receiver",
"settings": BusinessPartnerSettingsInput,
"totalNumIdentifiers": 987,
"type": "EDIPartner",
"version": 123
}
¶ BusinessPartnerSettings
¶ BusinessPartnerSettingsInput
¶ CalendarInterval
¶ CategoryFacet
¶ Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
¶ Example
"ACKNOWLEDGE_BUSINESS_DOCUMENT"
¶ Comment
¶ Comments
¶ Fields
| Field Name | Description |
|---|---|
comment - String
|
|
companyID - String
|
|
createdAt - Date
|
|
createdBy - UserDetails
|
|
environment - String
|
|
id - String
|
|
sourceObjectId - String
|
|
sourceType - SourceType
|
¶ Example
{
"comment": "abc123",
"companyID": "xyz789",
"createdAt": "2007-12-03",
"createdBy": UserDetails,
"environment": "xyz789",
"id": "xyz789",
"sourceObjectId": "abc123",
"sourceType": "BUSINESS_DOCUMENT"
}
¶ Company
¶ Fields
| Field Name | Description |
|---|---|
BPartners - [Company]
|
|
adminGroup_id - String
|
|
avatarID - String
|
|
companyContact - CompanyContact
|
|
complianceLicense - ComplianceLicense
|
|
contactRecords - [ContactRecord]
|
|
dataManagerCompanyID - String
|
|
defaultGroup_id - String
|
|
description - String
|
|
domains - [String]
|
|
groups - [String]
|
|
hasProcessedTa1 - Boolean
|
|
id - String
|
|
industryCode - String
|
|
local - Boolean
|
|
locations - [String]
|
|
managedCompanyIds - [String]
|
|
members - [String]
|
|
name - String
|
|
openSignupDisabled - Boolean
|
|
parentCompany - Company
|
|
passwordRequirements - PasswordRequirements
|
|
pendingDomainRequests - [DomainRequest]
|
|
preferences - CompanyPreferences
|
|
uniqueFilenames - Boolean
|
¶ Example
{
"BPartners": [Company],
"adminGroup_id": "abc123",
"avatarID": "abc123",
"companyContact": CompanyContact,
"complianceLicense": "INVITED_SUPPLIER",
"contactRecords": [ContactRecord],
"dataManagerCompanyID": "abc123",
"defaultGroup_id": "xyz789",
"description": "xyz789",
"domains": ["xyz789"],
"groups": ["xyz789"],
"hasProcessedTa1": false,
"id": "abc123",
"industryCode": "abc123",
"local": false,
"locations": ["xyz789"],
"managedCompanyIds": ["xyz789"],
"members": ["abc123"],
"name": "abc123",
"openSignupDisabled": false,
"parentCompany": Company,
"passwordRequirements": PasswordRequirements,
"pendingDomainRequests": [DomainRequest],
"preferences": CompanyPreferences,
"uniqueFilenames": true
}
¶ CompanyBusinessIdentifier
¶ Example
{
"companyID": "xyz789",
"createdOn": "2007-12-03",
"environment": "abc123",
"hash": "abc123",
"id": "xyz789",
"lastUpdatedOn": "2007-12-03",
"partnerID": "abc123",
"subOrgID": "abc123",
"type": "xyz789"
}
¶ CompanyBusinessIdentifierInput
¶ Example
{
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"hash": "abc123",
"id": "abc123",
"lastUpdatedOn": "2007-12-03",
"partnerID": "abc123",
"subOrgID": "xyz789",
"type": "abc123"
}
¶ CompanyContact
¶ CompanyContactInput
¶ CompanyDomains
¶ Fields
| Field Name | Description |
|---|---|
pendingDomains - [DomainRequest]
|
|
validatedDomains - [String]
|
¶ Example
{
"pendingDomains": [DomainRequest],
"validatedDomains": ["xyz789"]
}
¶ CompanyInfo
¶ CompanyInfoInput
¶ CompanyInput
¶ Fields
| Input Field | Description |
|---|---|
adminGroup_id - String
|
|
avatarID - String
|
|
bpartners - [CompanyInput]
|
|
companyContact - CompanyContactInput
|
|
complianceLicense - ComplianceLicense
|
|
contactRecords - [ContactRecordInput]
|
|
dataManagerCompanyID - String
|
|
defaultGroup_id - String
|
|
description - String
|
|
domains - [String]
|
|
groups - [String]
|
|
hasProcessedTa1 - Boolean
|
|
id - String
|
|
industryCode - String
|
|
local - Boolean
|
|
locations - [String]
|
|
managedCompanyIds - [String]
|
|
members - [String]
|
|
name - String
|
|
openSignupDisabled - Boolean
|
|
parentCompany - CompanyInput
|
|
passwordRequirements - PasswordRequirementsInput
|
|
pendingDomainRequests - [DomainRequestInput]
|
|
preferences - CompanyPreferencesInput
|
|
uniqueFilenames - Boolean
|
¶ Example
{
"adminGroup_id": "xyz789",
"avatarID": "abc123",
"bpartners": [CompanyInput],
"companyContact": CompanyContactInput,
"complianceLicense": "INVITED_SUPPLIER",
"contactRecords": [ContactRecordInput],
"dataManagerCompanyID": "xyz789",
"defaultGroup_id": "xyz789",
"description": "xyz789",
"domains": ["xyz789"],
"groups": ["abc123"],
"hasProcessedTa1": true,
"id": "xyz789",
"industryCode": "abc123",
"local": false,
"locations": ["xyz789"],
"managedCompanyIds": ["abc123"],
"members": ["abc123"],
"name": "abc123",
"openSignupDisabled": false,
"parentCompany": CompanyInput,
"passwordRequirements": PasswordRequirementsInput,
"pendingDomainRequests": [DomainRequestInput],
"preferences": CompanyPreferencesInput,
"uniqueFilenames": false
}
¶ CompanyPreferences
¶ Example
{
"autoLogout": false,
"defaultFilterCurrency": "xyz789",
"lineItemsStoredOnCloud": true,
"primaryProductIdentifier": "abc123",
"showTechnicalDatasets": true
}
¶ CompanyPreferencesInput
¶ Example
{
"autoLogout": true,
"defaultFilterCurrency": "xyz789",
"lineItemsStoredOnCloud": false,
"primaryProductIdentifier": "xyz789",
"showTechnicalDatasets": false
}
¶ ComplianceLicense
¶ CompositeKey
¶ Example
{
"companyID": "abc123",
"displayField": "abc123",
"environment": "abc123",
"fieldName": "xyz789",
"flowDirection": "inbound",
"inboundHash": "abc123",
"outboundHash": "xyz789",
"partnerID": "abc123",
"subOrgID": "xyz789",
"value": "abc123"
}
¶ ConnectionStatus
¶ ContactRecord
¶ ContactRecordInput
¶ ContactRepresentation
¶ ContactRepresentationInput
¶ ContactType
¶ Conversation
¶ Fields
| Field Name | Description |
|---|---|
comments - [String]
|
|
companyID - String
|
|
createdBy - String
|
|
createdOn - Date
|
|
environment - String
|
|
id - String
|
|
ignored - Boolean!
|
|
lastComment - Comment
|
|
lastUpdate - Date
|
|
meta - [MetaData]
|
|
participants - [ParticipantInfo]
|
|
read - Boolean!
|
|
singleConversationParent_id - String
|
|
topic - String
|
|
topicLowercase - String
|
|
users - [String]
|
¶ Example
{
"comments": ["abc123"],
"companyID": "abc123",
"createdBy": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"id": "xyz789",
"ignored": false,
"lastComment": Comment,
"lastUpdate": "2007-12-03",
"meta": [MetaData],
"participants": [ParticipantInfo],
"read": false,
"singleConversationParent_id": "xyz789",
"topic": "xyz789",
"topicLowercase": "abc123",
"users": ["xyz789"]
}
¶ ConversationList
¶ Coordinate
¶ CoordinateInput
¶ CorrelationPointType
¶ Counter
¶ CounterInput
¶ CreditDebitAdjustmentDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
cdAdjustmentNumber - String
|
|
cdAmount - Float
|
|
cdDate - Date
|
|
cdFlagCode - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
currency - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
invoiceDate - Date
|
|
invoiceNumber - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalClaimant - Address
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
refNumber - String
|
|
refNumberQualifier - String
|
|
referenceInfo - [RefSegment]
|
|
reportingLocation - Address
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionCode - String
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"cdAdjustmentNumber": "xyz789",
"cdAmount": 123.45,
"cdDate": "2007-12-03",
"cdFlagCode": "xyz789",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "xyz789",
"currency": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hasPurchaseOrder": true,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"invoiceDate": "2007-12-03",
"invoiceNumber": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalClaimant": Address,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"poNumber": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"refNumber": "xyz789",
"refNumberQualifier": "abc123",
"referenceInfo": [RefSegment],
"reportingLocation": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionCode": "abc123",
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ DTMDate
¶ Fields
| Field Name | Description |
|---|---|
date - Date
|
|
dtmCode - String
|
|
endDate - Date
|
|
endTime - String
|
|
plannedEndDate - Date
|
|
plannedEndTime - String
|
|
plannedStartDate - Date
|
|
plannedStartTime - String
|
|
startDate - Date
|
|
startTime - String
|
|
supportedDate - SupportedDate
|
|
timeQualifier - String
|
|
timeString - String
|
|
timezoneCode - String
|
¶ Example
{
"date": "2007-12-03",
"dtmCode": "xyz789",
"endDate": "2007-12-03",
"endTime": "abc123",
"plannedEndDate": "2007-12-03",
"plannedEndTime": "xyz789",
"plannedStartDate": "2007-12-03",
"plannedStartTime": "abc123",
"startDate": "2007-12-03",
"startTime": "xyz789",
"supportedDate": "ACTUAL_APPOINTMENT",
"timeQualifier": "xyz789",
"timeString": "abc123",
"timezoneCode": "abc123"
}
¶ DTMDateInput
¶ Example
{
"date": "2007-12-03",
"dtmCode": "xyz789",
"endDate": "2007-12-03",
"endTime": "xyz789",
"plannedEndDate": "2007-12-03",
"plannedEndTime": "xyz789",
"plannedStartDate": "2007-12-03",
"plannedStartTime": "xyz789",
"startDate": "2007-12-03",
"startTime": "abc123",
"timeQualifier": "xyz789",
"timeString": "xyz789",
"timezoneCode": "abc123"
}
¶ DashboardConfig
¶ Fields
| Field Name | Description |
|---|---|
companyID - String
|
|
createdOn - Date
|
|
environment - String
|
|
favorite - Boolean
|
|
galleryReferenceID - String
|
|
galleryType - GalleryItemType
|
|
hasEdited - Boolean
|
|
id - String
|
|
lastUpdated - Date
|
|
layout - LayoutConfig
|
|
name - String
|
|
owner - UserDetails
|
|
sharedWith - [UserDetails]
|
|
sharedWithIDs - [String]
|
|
updatedBy - UserDetails
|
|
userID - String
|
|
widgets - [WidgetConfig]
|
¶ Example
{
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"favorite": false,
"galleryReferenceID": "abc123",
"galleryType": "DASHBOARD",
"hasEdited": false,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"layout": LayoutConfig,
"name": "abc123",
"owner": UserDetails,
"sharedWith": [UserDetails],
"sharedWithIDs": ["xyz789"],
"updatedBy": UserDetails,
"userID": "xyz789",
"widgets": [WidgetConfig]
}
¶ DashboardConfigInput
¶ Fields
| Input Field | Description |
|---|---|
companyID - String
|
|
createdOn - Date
|
|
environment - String
|
|
favorite - Boolean
|
|
galleryReferenceID - String
|
|
hasEdited - Boolean
|
|
id - String
|
|
lastUpdated - Date
|
|
layout - LayoutConfigInput
|
|
name - String
|
|
owner - UserDetailsInput
|
|
sharedWith - [UserDetailsInput]
|
|
sharedWithIDs - [String]
|
|
updatedBy - UserDetailsInput
|
|
userID - String
|
|
widgets - [WidgetConfigInput]
|
¶ Example
{
"companyID": "abc123",
"createdOn": "2007-12-03",
"environment": "xyz789",
"favorite": false,
"galleryReferenceID": "xyz789",
"hasEdited": false,
"id": "abc123",
"lastUpdated": "2007-12-03",
"layout": LayoutConfigInput,
"name": "xyz789",
"owner": UserDetailsInput,
"sharedWith": [UserDetailsInput],
"sharedWithIDs": ["xyz789"],
"updatedBy": UserDetailsInput,
"userID": "xyz789",
"widgets": [WidgetConfigInput]
}
¶ DashboardLayoutType
¶ DataConfig
¶ Fields
| Field Name | Description |
|---|---|
datasetID - String
|
|
filter - [Parameter]
|
|
subfilter - [Parameter]
|
|
type - String
|
¶ Example
{
"datasetID": "xyz789",
"filter": [Parameter],
"subfilter": [Parameter],
"type": "abc123"
}
¶ DataConfigInput
¶ Fields
| Input Field | Description |
|---|---|
datasetID - String
|
|
filter - [ParameterInput]
|
|
subfilter - [ParameterInput]
|
|
type - String
|
¶ Example
{
"datasetID": "abc123",
"filter": [ParameterInput],
"subfilter": [ParameterInput],
"type": "xyz789"
}
¶ DataRetentionEntityType
¶ DataRetentionPolicy
¶ Example
{
"MINIMUM_VALUE": 123,
"companyID": "xyz789",
"enabled": true,
"environment": "abc123",
"id": "xyz789",
"lastModifiedBy": UserDetails,
"lastModifiedByID": "abc123",
"lastUpdated": "2007-12-03",
"type": "BUSINESS_DOCUMENT",
"units": "CUSTOM",
"value": 987
}
¶ DataRetentionPolicyDTOInput
¶ Date
¶ DateOrTimeOrReference
¶ Example
{
"date": "2007-12-03",
"dateTimeFormatQualifier": "xyz789",
"dateTimePeriod": "abc123",
"dateTimeQualifier": "abc123",
"time": "xyz789",
"timeCode": "abc123"
}
¶ DeliveryReturnAckAdjDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
adjustNumber - Float
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
cdFlagCode - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
initCode - String
|
|
integrityCheckValue - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverDunsNumber - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierDRNumber - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"adjustNumber": 123.45,
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"cdFlagCode": "abc123",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"initCode": "abc123",
"integrityCheckValue": "abc123",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverDunsNumber": "abc123",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierDRNumber": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ DeliveryReturnBaseRecordDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
cdFlag - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
drDate - Date
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
invoiceTotal - Float
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverDunsNumber - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
receiverLocationNumber - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderDunsNumber - String
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
senderLocationNumber - String
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierDRNumber - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"cdFlag": "xyz789",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"drDate": "2007-12-03",
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"invoiceTotal": 123.45,
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"poNumber": "xyz789",
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverDunsNumber": "xyz789",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"receiverLocationNumber": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderDunsNumber": "xyz789",
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"senderLocationNumber": "abc123",
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierDRNumber": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ Dimension
¶ DimensionInput
¶ DocPermission
¶ Fields
| Field Name | Description |
|---|---|
name - String
|
|
permission - [PermissionValue]
|
¶ Example
{
"name": "xyz789",
"permission": [PermissionValue]
}
¶ DocumentCorrelationPoint
¶ Fields
| Field Name | Description |
|---|---|
companyID - String
|
|
data - Map_String_ObjectScalar
|
|
environment - String
|
|
id - String
|
|
reference - String
|
|
timestamp - Date
|
|
type - DocumentCorrelationPointType
|
¶ Example
{
"companyID": "xyz789",
"data": Map_String_ObjectScalar,
"environment": "xyz789",
"id": "abc123",
"reference": "abc123",
"timestamp": "2007-12-03",
"type": "ASN_BY_PO_NUMBER_ASN_NUMBER_SCAC"
}
¶ DocumentCorrelationPointType
¶ Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
¶ Example
"ASN_BY_PO_NUMBER_ASN_NUMBER_SCAC"
¶ DocumentFlowDirection
¶ DomainRequest
¶ DomainRequestInput
¶ EmailChangeRequest
¶ Environment
¶ EnvironmentInput
¶ EquipmentInformation
¶ Example
{
"equipmentDescriptionCode": "abc123",
"equipmentInitial": "abc123",
"equipmentNumber": "xyz789",
"scacCode": "xyz789",
"volume": 123.45,
"volumeUOM": "xyz789",
"weight": 123.45,
"weightUOM": "abc123"
}
¶ ErrorCode
¶ ErrorCorrelationPoint
¶ Fields
| Field Name | Description |
|---|---|
acknowledgmentAckCode - String
|
|
businessPartner - String
|
|
companyId - String
|
|
entityReferenceId - String
|
|
environment - String
|
|
errors - [RawError]
|
|
groupControlNumber - String
|
|
hash - String
|
|
id - String
|
|
inboundIdentifierHash - String
|
|
outboundIdentifierHash - String
|
|
referenceId - String
|
|
subOrgId - String
|
|
tsControlNumber - String
|
|
tsIdCode - String
|
|
type - CorrelationPointType
|
¶ Example
{
"acknowledgmentAckCode": "xyz789",
"businessPartner": "abc123",
"companyId": "xyz789",
"entityReferenceId": "abc123",
"environment": "xyz789",
"errors": [RawError],
"groupControlNumber": "abc123",
"hash": "xyz789",
"id": "abc123",
"inboundIdentifierHash": "abc123",
"outboundIdentifierHash": "xyz789",
"referenceId": "abc123",
"subOrgId": "abc123",
"tsControlNumber": "abc123",
"tsIdCode": "abc123",
"type": "NO_TED_824"
}
¶ EventSummary
¶ Fields
| Field Name | Description |
|---|---|
arrivedFileKey - String
|
|
companyID - String
|
|
consumerErrorMessage - String
|
|
consumerFileSize - Long
|
|
consumerFilename - String
|
|
consumerID - String
|
|
consumerMailboxPath - String
|
|
consumerName - String
|
|
consumerOperation - String
|
|
consumerPartner - BusinessPartner
|
|
consumerPathFilename - String
|
|
consumerProtocol - String
|
|
consumerRemoteHost - String
|
|
consumerRemoteIP - String
|
|
consumerStatus - EventSummaryStatus
|
|
consumerSteps - [ProcessingStep]
|
|
consumerTimestamp - Date
|
|
delieryErrorMessage - String
|
|
deliveryStatus - EventSummaryStatus
|
|
deliveryTimestamp - Date
|
|
environment - String
|
|
eventSourceName - String
|
|
eventSourceType - String
|
|
eventSourceURL - String
|
|
id - String
|
|
indexName - String
|
|
lastUpdated - Date
|
|
overallStatus - EventSummaryStatus
|
|
parties - [BusinessPartner]
|
|
partiesIDs - String
|
|
processSteps - [ProcessingStep]
|
|
processingErrorMessage - String
|
|
processingStatus - EventSummaryStatus
|
|
processingTimestamp - Date
|
|
producerCode - String
|
|
producerDocumentId - String
|
|
producerErrorMessage - String
|
|
producerFileSize - Long
|
|
producerFilename - String
|
|
producerID - String
|
|
producerMailboxPath - String
|
|
producerMessageId - String
|
|
producerName - String
|
|
producerOperation - String
|
|
producerPartner - BusinessPartner
|
|
producerPathFilename - String
|
|
producerProtocol - String
|
|
producerRemoteHost - String
|
|
producerRemoteIP - String
|
|
producerStatus - EventSummaryStatus
|
|
producerSteps - [ProcessingStep]
|
|
producerTimestamp - Date
|
|
producerUserId - String
|
|
routing - String
|
|
routingTemplateName - String
|
|
timestamp - Date
|
¶ Example
{
"arrivedFileKey": "xyz789",
"companyID": "abc123",
"consumerErrorMessage": "xyz789",
"consumerFileSize": {},
"consumerFilename": "xyz789",
"consumerID": "abc123",
"consumerMailboxPath": "abc123",
"consumerName": "abc123",
"consumerOperation": "abc123",
"consumerPartner": BusinessPartner,
"consumerPathFilename": "xyz789",
"consumerProtocol": "xyz789",
"consumerRemoteHost": "abc123",
"consumerRemoteIP": "abc123",
"consumerStatus": "Failed",
"consumerSteps": [ProcessingStep],
"consumerTimestamp": "2007-12-03",
"delieryErrorMessage": "abc123",
"deliveryStatus": "Failed",
"deliveryTimestamp": "2007-12-03",
"environment": "abc123",
"eventSourceName": "abc123",
"eventSourceType": "abc123",
"eventSourceURL": "xyz789",
"id": "abc123",
"indexName": "xyz789",
"lastUpdated": "2007-12-03",
"overallStatus": "Failed",
"parties": [BusinessPartner],
"partiesIDs": "abc123",
"processSteps": [ProcessingStep],
"processingErrorMessage": "xyz789",
"processingStatus": "Failed",
"processingTimestamp": "2007-12-03",
"producerCode": "xyz789",
"producerDocumentId": "xyz789",
"producerErrorMessage": "xyz789",
"producerFileSize": {},
"producerFilename": "abc123",
"producerID": "abc123",
"producerMailboxPath": "xyz789",
"producerMessageId": "abc123",
"producerName": "abc123",
"producerOperation": "xyz789",
"producerPartner": BusinessPartner,
"producerPathFilename": "abc123",
"producerProtocol": "xyz789",
"producerRemoteHost": "abc123",
"producerRemoteIP": "abc123",
"producerStatus": "Failed",
"producerSteps": [ProcessingStep],
"producerTimestamp": "2007-12-03",
"producerUserId": "xyz789",
"routing": "abc123",
"routingTemplateName": "abc123",
"timestamp": "2007-12-03"
}
¶ EventSummaryStatus
¶ ExceptionDetails
¶ Fields
| Field Name | Description |
|---|---|
additionalFields - Map_String_ObjectScalar
|
|
genericInfo - GenericInfo
|
|
linkedEntity - Map_String_ObjectScalar
|
|
rule - Map_String_ObjectScalar
|
¶ Example
{
"additionalFields": Map_String_ObjectScalar,
"genericInfo": GenericInfo,
"linkedEntity": Map_String_ObjectScalar,
"rule": Map_String_ObjectScalar
}
¶ ExceptionDetailsInput
¶ Fields
| Input Field | Description |
|---|---|
additionalFields - Map_String_ObjectScalar
|
|
genericInfo - GenericInfoInput
|
|
linkedEntity - Map_String_ObjectScalar
|
|
rule - Map_String_ObjectScalar
|
¶ Example
{
"additionalFields": Map_String_ObjectScalar,
"genericInfo": GenericInfoInput,
"linkedEntity": Map_String_ObjectScalar,
"rule": Map_String_ObjectScalar
}
¶ ExceptionEntityType
¶ ExceptionStatus
¶ ExceptionType
¶ Feature
¶ Example
{
"companyAccess": ["abc123"],
"createdOn": "2007-12-03",
"description": "abc123",
"global": false,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"name": "xyz789",
"userAccess": ["abc123"]
}
¶ FeatureInput
¶ Example
{
"companyAccess": ["xyz789"],
"createdOn": "2007-12-03",
"description": "abc123",
"global": true,
"id": "xyz789",
"lastUpdated": "2007-12-03",
"name": "xyz789",
"userAccess": ["abc123"]
}
¶ FileMetadata
¶ Fields
| Field Name | Description |
|---|---|
canDownloadOriginalFile - Boolean
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
conversation - Conversation
|
|
conversation_id - String
|
|
environment - String
|
|
fileType - FileType
|
|
id - String
|
|
indexName - String
|
|
name - String
|
|
originalFileID - String
|
|
path - String
|
|
replayedOn - [Date]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
senderID - String
|
|
size - Long!
|
|
status - ProcessingStatus
|
|
timestamp - Date
|
|
type - String
|
|
watchers - [String]
|
¶ Example
{
"canDownloadOriginalFile": true,
"commenters": [UserInfo],
"companyID": "abc123",
"conversation": Conversation,
"conversation_id": "xyz789",
"environment": "abc123",
"fileType": "Axalta",
"id": "xyz789",
"indexName": "abc123",
"name": "xyz789",
"originalFileID": "xyz789",
"path": "abc123",
"replayedOn": ["2007-12-03"],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"senderID": "xyz789",
"size": {},
"status": "FAILED_PROCESSING",
"timestamp": "2007-12-03",
"type": "xyz789",
"watchers": ["abc123"]
}
¶ FileType
¶ FilterTypeDisambiguator
¶ Filter_ObjectInput
¶ Fields
| Input Field | Description |
|---|---|
field - String
|
|
operation - Operation
|
|
type - FilterTypeDisambiguator
|
Input type discriminator |
value - ObjectScalar
|
|
values - [ObjectScalar]
|
¶ Example
{
"field": "xyz789",
"operation": "CONTAINS",
"type": "DATE",
"value": ObjectScalar,
"values": [ObjectScalar]
}
¶ Float
¶ FunctionalAcknowledgmentDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
acknowledgedEntityIds - [String]
|
|
acknowledgedType - [String]
|
|
acknowledgementCode - String
|
|
acknowledgementDetail - [TransactionHeaderSegment]
|
|
acknowledges - String
|
|
acknowledgmentErrorCode - String
|
|
addressFields - [Address]
|
|
akFuncIDCode - String
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationPoints - [ErrorCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numTransactionsAccepted - Int
|
|
numTransactionsIncluded - Int
|
|
numTransactionsReceived - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"acknowledgedEntityIds": ["abc123"],
"acknowledgedType": ["abc123"],
"acknowledgementCode": "abc123",
"acknowledgementDetail": [TransactionHeaderSegment],
"acknowledges": "xyz789",
"acknowledgmentErrorCode": "abc123",
"addressFields": [Address],
"akFuncIDCode": "abc123",
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationPoints": [ErrorCorrelationPoint],
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numTransactionsAccepted": 123,
"numTransactionsIncluded": 123,
"numTransactionsReceived": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"primary": true,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ FunctionalAcknowledgmentDocumentInput
¶ Fields
| Input Field | Description |
|---|---|
acceptanceStatus - AcceptanceStatusInput
|
|
acknowledgedEntityIds - [String]
|
|
acknowledgedType - [String]
|
|
acknowledgementCode - String
|
|
acknowledgementDetail - [TransactionHeaderSegmentInput]
|
|
acknowledges - String
|
|
acknowledgmentErrorCode - String
|
|
addressFields - [AddressInput]
|
|
akFuncIDCode - String
|
|
appAdviceTransferStatus - String
|
|
billToAddress - AddressInput
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformationInput
|
|
businessPartnerIdentifiers - [IdPairInput]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
commenters - [UserInfoInput]
|
|
companyID - String
|
|
contactRepresentations - [ContactRepresentationInput]
|
|
containerID - String
|
|
conversation_id - String
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
dtmDates - [DTMDateInput]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numTransactionsAccepted - Int
|
|
numTransactionsIncluded - Int
|
|
numTransactionsReceived - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegmentInput]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
sendFrom - PartyInformationInput
|
|
sendTo - PartyInformationInput
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
shipToAddress - AddressInput
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegmentInput]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatusInput,
"acknowledgedEntityIds": ["xyz789"],
"acknowledgedType": ["abc123"],
"acknowledgementCode": "xyz789",
"acknowledgementDetail": [
TransactionHeaderSegmentInput
],
"acknowledges": "xyz789",
"acknowledgmentErrorCode": "xyz789",
"addressFields": [AddressInput],
"akFuncIDCode": "xyz789",
"appAdviceTransferStatus": "abc123",
"billToAddress": AddressInput,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformationInput,
"businessPartnerIdentifiers": [IdPairInput],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"commenters": [UserInfoInput],
"companyID": "xyz789",
"contactRepresentations": [ContactRepresentationInput],
"containerID": "abc123",
"conversation_id": "xyz789",
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "abc123",
"dtmDates": [DTMDateInput],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 123,
"numTransactionsAccepted": 123,
"numTransactionsIncluded": 987,
"numTransactionsReceived": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegmentInput],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"sendFrom": PartyInformationInput,
"sendTo": PartyInformationInput,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"shipToAddress": AddressInput,
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegmentInput],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"]
}
¶ GalleryItem
¶ Fields
| Field Name | Description |
|---|---|
companyID - String
|
|
config - DashboardConfig
|
|
createdOn - Date
|
|
description - String
|
|
id - String
|
|
published - Boolean!
|
|
screenshotID - String
|
|
title - String
|
|
type - GalleryItemType
|
¶ Example
{
"companyID": "abc123",
"config": DashboardConfig,
"createdOn": "2007-12-03",
"description": "abc123",
"id": "abc123",
"published": false,
"screenshotID": "xyz789",
"title": "xyz789",
"type": "DASHBOARD"
}
¶ GalleryItemType
¶ GenericInfo
¶ Fields
| Field Name | Description |
|---|---|
consumerPartner - BusinessPartner
|
|
fileName - String
|
|
producerPartner - BusinessPartner
|
¶ Example
{
"consumerPartner": BusinessPartner,
"fileName": "xyz789",
"producerPartner": BusinessPartner
}
¶ GenericInfoInput
¶ Fields
| Input Field | Description |
|---|---|
consumerPartner - BusinessPartnerInput
|
|
fileName - String
|
|
producerPartner - BusinessPartnerInput
|
¶ Example
{
"consumerPartner": BusinessPartnerInput,
"fileName": "xyz789",
"producerPartner": BusinessPartnerInput
}
¶ GroceryProductsInvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
allowChrgIndicator - String
|
|
appAdviceTransferStatus - String
|
|
billFromParty - Address
|
|
billOfLadingNumber - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
calculatedSACTotalAmount - Float
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
currentScheduleDelivery - Date
|
|
currentScheduleShip - Date
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deliveredOn - Date
|
|
deliveryRequested - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
estimatedDelivery - Date
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
headerSAC - [SAC]
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
invoiceDate - Date
|
|
invoiceNumber - String
|
|
invoiced - Date
|
|
invoicedTo - ContactRepresentation
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
linkSeqNumber - String
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
masterRefLinkNo - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyToReceiveCommercialInvoiceRemittance - Address
|
|
paymentDates - [Date]
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
remitTo - Address
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedShipDate - Date
|
|
routing - String
|
|
sellingParty - Address
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
serviceCode - String
|
|
serviceCodeList - [String]
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shipped - Date
|
|
soldOn - Date
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
taxInfo - [TaxInfo]
|
|
taxMonetaryAmount - Float
|
|
taxPercentage - Float
|
|
taxTypeCode - String
|
|
termsSaleTypeCode - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
thirdPartyCorrelation - DocumentCorrelationPoint
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
totalQuantityInvoiced - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
units - String
|
|
unitsOfMeasure - [String]
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
vendorIdNumber - String
|
|
vendorNumber - String
|
|
vendorOrderNo - String
|
|
vendorOrderNumber - String
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"allowChrgIndicator": "xyz789",
"appAdviceTransferStatus": "xyz789",
"billFromParty": Address,
"billOfLadingNumber": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 123.45,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"currency": "abc123",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"deliveredOn": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": true,
"hasPurchaseOrder": true,
"hasRemittanceAdvice": false,
"headerSAC": [SAC],
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"internalVendorNumber": "abc123",
"invoiceDate": "2007-12-03",
"invoiceNumber": "abc123",
"invoiced": "2007-12-03",
"invoicedTo": ContactRepresentation,
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"linkSeqNumber": "abc123",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"masterRefLinkNo": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"partyToReceiveCommercialInvoiceRemittance": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 987,
"poNumbers": ["xyz789"],
"primary": false,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "xyz789",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"serviceCode": "xyz789",
"serviceCodeList": ["abc123"],
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["abc123"],
"shipped": "2007-12-03",
"soldOn": "2007-12-03",
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"taxInfo": [TaxInfo],
"taxMonetaryAmount": 987.65,
"taxPercentage": 987.65,
"taxTypeCode": "xyz789",
"termsSaleTypeCode": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 987.65,
"totalQuantityInvoiced": 123.45,
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"transactionTypeCode": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "abc123",
"units": "xyz789",
"unitsOfMeasure": ["abc123"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "abc123",
"vendorNumber": "abc123",
"vendorOrderNo": "abc123",
"vendorOrderNumber": "abc123",
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ GroceryProductsPurchaseOrderDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
ackType - String
|
|
ackTypes - [String]
|
|
addressFields - [Address]
|
|
albertsonsDepartmentNumber - String
|
|
alphaCodes - [String]
|
|
appAdviceTransferStatus - String
|
|
arrivedAtCustomsDates - [Date]
|
|
arrivedAtTerminalLocationsDates - [Date]
|
|
arrivedDates - [Date]
|
|
availableForDeliveryDates - [Date]
|
|
billOfLadingNumbers - [String]
|
|
billOfLadingReleasedDates - [Date]
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
bookingConfirmedDates - [Date]
|
|
bookingNumbers - [String]
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyerIdentification - String
|
|
buyingParty - Address
|
|
calculatedSACTotalAmount - Float
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
cancelAfterDate - Date
|
|
cancelIfNotShippedByDate - Date
|
|
cargoReceivedAtContractualPlaceOfReceiptDates - [Date]
|
|
carrierAndCustomsReleaseDates - [Date]
|
|
carrierReleaseDates - [Date]
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
completedUnloadingAtDeliveryLocationDates - [Date]
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
customFields - Map_String_StringScalar
|
|
customsReleasedDates - [Date]
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deferredPaymentDate - Date
|
|
deliveryAppointmentDates - [Date]
|
|
deliveryRequested - Date
|
|
deliveryRequestedDate - Date
|
|
departedPickupLocationDates - [Date]
|
|
departmentNumberText - String
|
|
depositor - Address
|
|
doNotDeliverAfter - Date
|
|
doNotDeliverAfterDate - Date
|
|
doNotDeliverBefore - Date
|
|
doNotDeliverBeforeDate - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
emptyEquipmentDispatchedDates - [Date]
|
|
entityID - String
|
|
environment - String
|
|
equipmentNumberN9Segments - [String]
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
estimatedDeliveryDates - [Date]
|
|
estimatedToArriveDates - [Date]
|
|
estimatedToDepartTerminalLocationDates - [Date]
|
|
eventType - LifeCycleEventType
|
|
expectedReply - Date
|
|
expectedShipDate - Date
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
groceryProductsPODate - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasCreditDebitAdjustment - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasInvoice - Boolean
|
|
hasPOChange - Boolean
|
|
hasPurchaseOrderAcknowledgment - Boolean
|
|
hasPurchaseOrderChange - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
hasReturnMerchandiseAuthorization - Boolean
|
|
hasStatusDetail - Boolean
|
|
hasWarehouseShippingAdvice - Boolean
|
|
hasWarehouseShippingOrder - Boolean
|
|
hasWarehouseStockTransferShipmentAdvice - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
invoiceDates - [Date]
|
|
invoiceNumberCount - Int
|
|
invoiceNumbers - [String]
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
linkSeqNumber - String
|
|
loadedOn - Date
|
|
loadedOnRailDates - [Date]
|
|
loadedOnTruckDates - [Date]
|
|
loadedOnVesselDates - [Date]
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
masterRefLinkNo - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
oceanShipmentStatusCodes - [String]
|
|
oceanShipmentStatuses - [String]
|
|
orderStatusCode - String
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
paymentDates - [Date]
|
|
poAndAsnVendorNumbersMatch - Boolean
|
|
poDate - Date
|
|
poNumber - String
|
|
poType - String
|
|
poTypeCode - String
|
|
pocDates - [Date]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
providedTotalAmount - Float
|
|
purposeCodes - [String]
|
|
railDepartureFromOriginIntermodalRampsDates - [Date]
|
|
receivedAtOriginDates - [Date]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
releaseDate - Date
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedForDeliveryDatePriorTo - Date
|
|
requestedForDeliveryDateWeekOf - Date
|
|
requestedForShipmentDateWeekOf - Date
|
|
requestedPickup - Date
|
|
requestedShipDate - Date
|
|
returnedToCarriersTerminalDates - [Date]
|
|
returnedToShipperDates - [Date]
|
|
routing - String
|
|
sacItems - [SAC]
|
|
salesReqCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipMethodPayment - String
|
|
shipNoLaterDate - Date
|
|
shipNotBeforeDate - Date
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipToCompany - Company
|
|
shipmentCancelledDates - [Date]
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shippersID - String
|
|
shippingMethod - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
taxExemptCode - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
textMessages - [String]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
tsPurposeCodes - [String]
|
|
type - String
|
|
units - String
|
|
unitsOfMeasure - [String]
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
vendorIdNumber - String
|
|
vendorIdNumberAsn - String
|
|
vendorNumber - String
|
|
vendorNumbers - [String]
|
|
vendorOrderNumber - String
|
|
vendorOrderNumberAsn - String
|
|
watchers - [String]
|
|
webOrderNumber - String
|
|
weight - Float
|
|
weightUOM - String
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "xyz789",
"ackTypes": ["abc123"],
"addressFields": [Address],
"albertsonsDepartmentNumber": "xyz789",
"alphaCodes": ["abc123"],
"appAdviceTransferStatus": "abc123",
"arrivedAtCustomsDates": ["2007-12-03"],
"arrivedAtTerminalLocationsDates": [
"2007-12-03"
],
"arrivedDates": ["2007-12-03"],
"availableForDeliveryDates": [
"2007-12-03"
],
"billOfLadingNumbers": ["abc123"],
"billOfLadingReleasedDates": [
"2007-12-03"
],
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"bookingConfirmedDates": ["2007-12-03"],
"bookingNumbers": ["abc123"],
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyerIdentification": "abc123",
"buyingParty": Address,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 123.45,
"canDownloadOriginalFile": true,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"cargoReceivedAtContractualPlaceOfReceiptDates": [
"2007-12-03"
],
"carrierAndCustomsReleaseDates": [
"2007-12-03"
],
"carrierReleaseDates": ["2007-12-03"],
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"completedUnloadingAtDeliveryLocationDates": [
"2007-12-03"
],
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "abc123",
"customFields": Map_String_StringScalar,
"customsReleasedDates": ["2007-12-03"],
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryAppointmentDates": [
"2007-12-03"
],
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"departedPickupLocationDates": [
"2007-12-03"
],
"departmentNumberText": "abc123",
"depositor": Address,
"doNotDeliverAfter": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBefore": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"emptyEquipmentDispatchedDates": [
"2007-12-03"
],
"entityID": "xyz789",
"environment": "xyz789",
"equipmentNumberN9Segments": ["xyz789"],
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDeliveryDates": ["2007-12-03"],
"estimatedToArriveDates": ["2007-12-03"],
"estimatedToDepartTerminalLocationDates": [
"2007-12-03"
],
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedReply": "2007-12-03",
"expectedShipDate": "2007-12-03",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"groceryProductsPODate": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": true,
"hasCreditDebitAdjustment": false,
"hasErrors": false,
"hasExceptions": false,
"hasInvoice": false,
"hasPOChange": false,
"hasPurchaseOrderAcknowledgment": false,
"hasPurchaseOrderChange": false,
"hasRemittanceAdvice": false,
"hasReturnMerchandiseAuthorization": false,
"hasStatusDetail": true,
"hasWarehouseShippingAdvice": true,
"hasWarehouseShippingOrder": true,
"hasWarehouseStockTransferShipmentAdvice": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumberCount": 123,
"invoiceNumbers": ["abc123"],
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"linkSeqNumber": "abc123",
"loadedOn": "2007-12-03",
"loadedOnRailDates": ["2007-12-03"],
"loadedOnTruckDates": ["2007-12-03"],
"loadedOnVesselDates": ["2007-12-03"],
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"masterRefLinkNo": "abc123",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 987,
"oceanShipmentStatusCodes": ["xyz789"],
"oceanShipmentStatuses": ["xyz789"],
"orderStatusCode": "xyz789",
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"paymentDates": ["2007-12-03"],
"poAndAsnVendorNumbersMatch": false,
"poDate": "2007-12-03",
"poNumber": "xyz789",
"poType": "xyz789",
"poTypeCode": "abc123",
"pocDates": ["2007-12-03"],
"primary": false,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"providedTotalAmount": 123.45,
"purposeCodes": ["xyz789"],
"railDepartureFromOriginIntermodalRampsDates": [
"2007-12-03"
],
"receivedAtOriginDates": ["2007-12-03"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedPickup": "2007-12-03",
"requestedShipDate": "2007-12-03",
"returnedToCarriersTerminalDates": [
"2007-12-03"
],
"returnedToShipperDates": ["2007-12-03"],
"routing": "abc123",
"sacItems": [SAC],
"salesReqCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"shipToCompany": Company,
"shipmentCancelledDates": ["2007-12-03"],
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["xyz789"],
"shippersID": "xyz789",
"shippingMethod": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"taxExemptCode": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"textMessages": ["xyz789"],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 123.45,
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"transactionTypeCode": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"tsPurposeCodes": ["xyz789"],
"type": "xyz789",
"units": "xyz789",
"unitsOfMeasure": ["xyz789"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "xyz789",
"vendorIdNumberAsn": "xyz789",
"vendorNumber": "xyz789",
"vendorNumbers": ["abc123"],
"vendorOrderNumber": "abc123",
"vendorOrderNumberAsn": "xyz789",
"watchers": ["abc123"],
"webOrderNumber": "xyz789",
"weight": 987.65,
"weightUOM": "xyz789",
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ Group
¶ Fields
| Field Name | Description |
|---|---|
avatarID - String
|
|
companyID - String
|
|
environment - String
|
|
hasHiddenMembers - Boolean
|
|
id - String
|
|
members - [UserDetails]
|
|
name - String
|
|
permissionList - [String]
|
|
permissions - Map_String_ObjectScalar
|
¶ Example
{
"avatarID": "abc123",
"companyID": "abc123",
"environment": "xyz789",
"hasHiddenMembers": true,
"id": "xyz789",
"members": [UserDetails],
"name": "abc123",
"permissionList": ["xyz789"],
"permissions": Map_String_ObjectScalar
}
¶ GroupInput
¶ Fields
| Input Field | Description |
|---|---|
avatarID - String
|
|
companyID - String
|
|
environment - String
|
|
hasHiddenMembers - Boolean
|
|
id - String
|
|
members - [UserDetailsInput]
|
|
name - String
|
|
permissionList - [String]
|
|
permissions - Map_String_ObjectScalar
|
¶ Example
{
"avatarID": "abc123",
"companyID": "abc123",
"environment": "xyz789",
"hasHiddenMembers": true,
"id": "xyz789",
"members": [UserDetailsInput],
"name": "abc123",
"permissionList": ["xyz789"],
"permissions": Map_String_ObjectScalar
}
¶ Hierarchical
¶ Example
{
"childrenTypes": ["xyz789"],
"id": "abc123",
"line": 123,
"numChildren": 123,
"parentID": "abc123",
"timestamp": "2007-12-03",
"type": "abc123"
}
¶ HierarchicalInput
¶ Example
{
"childrenTypes": ["xyz789"],
"id": "abc123",
"line": 123,
"numChildren": 123,
"parentID": "abc123",
"timestamp": "2007-12-03",
"type": "xyz789"
}
¶ IdPair
¶ IdPairInput
¶ Int
¶ InventoryInquiryAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
actionCode - String
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
depositor - Address
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reportTypeCode - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transferDate - Date
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
warehouse - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"actionCode": "abc123",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"depositor": Address,
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "abc123",
"referenceInfo": [RefSegment],
"reportTypeCode": "abc123",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"transferDate": "2007-12-03",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"warehouse": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ InvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
allowChrgIndicator - String
|
|
appAdviceTransferStatus - String
|
|
billFromParty - Address
|
|
billOfLadingNumber - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
calculatedSACTotalAmount - Float
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
currentScheduleDelivery - Date
|
|
currentScheduleShip - Date
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deliveredOn - Date
|
|
deliveryRequested - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
estimatedDelivery - Date
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
headerSAC - [SAC]
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
invoiceDate - Date
|
|
invoiceNumber - String
|
|
invoiced - Date
|
|
invoicedTo - ContactRepresentation
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyToReceiveCommercialInvoiceRemittance - Address
|
|
paymentDates - [Date]
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
remitTo - Address
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedShipDate - Date
|
|
routing - String
|
|
sellingParty - Address
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
serviceCode - String
|
|
serviceCodeList - [String]
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shipped - Date
|
|
soldOn - Date
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
taxInfo - [TaxInfo]
|
|
taxMonetaryAmount - Float
|
|
taxPercentage - Float
|
|
taxTypeCode - String
|
|
termsSaleTypeCode - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
thirdPartyCorrelation - DocumentCorrelationPoint
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
units - String
|
|
unitsOfMeasure - [String]
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
vendorIdNumber - String
|
|
vendorNumber - String
|
|
vendorOrderNumber - String
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"allowChrgIndicator": "abc123",
"appAdviceTransferStatus": "xyz789",
"billFromParty": Address,
"billOfLadingNumber": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"deliveredOn": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDelivery": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hasPurchaseOrder": true,
"hasRemittanceAdvice": true,
"headerSAC": [SAC],
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"internalVendorNumber": "abc123",
"invoiceDate": "2007-12-03",
"invoiceNumber": "xyz789",
"invoiced": "2007-12-03",
"invoicedTo": ContactRepresentation,
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"partyToReceiveCommercialInvoiceRemittance": Address,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 987,
"poNumbers": ["xyz789"],
"primary": false,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "xyz789",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"serviceCode": "xyz789",
"serviceCodeList": ["abc123"],
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 123,
"shipmentNumbers": ["xyz789"],
"shipped": "2007-12-03",
"soldOn": "2007-12-03",
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"taxInfo": [TaxInfo],
"taxMonetaryAmount": 987.65,
"taxPercentage": 987.65,
"taxTypeCode": "xyz789",
"termsSaleTypeCode": "xyz789",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 123.45,
"totalQuantity": 987.65,
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"transactionTypeCode": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"units": "xyz789",
"unitsOfMeasure": ["abc123"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "abc123",
"vendorNumber": "xyz789",
"vendorOrderNumber": "abc123",
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ InvoiceDocumentInput
¶ Fields
| Input Field | Description |
|---|---|
acceptanceStatus - AcceptanceStatusInput
|
|
addressFields - [AddressInput]
|
|
allowChrgIndicator - String
|
|
appAdviceTransferStatus - String
|
|
billFromParty - AddressInput
|
|
billOfLadingNumber - String
|
|
billToAddress - AddressInput
|
|
billToParty - AddressInput
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformationInput
|
|
businessPartnerIdentifiers - [IdPairInput]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - AddressInput
|
|
calculatedSACTotalAmount - Float
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
commenters - [UserInfoInput]
|
|
companyID - String
|
|
contactRepresentations - [ContactRepresentationInput]
|
|
containerID - String
|
|
conversation_id - String
|
|
currency - String
|
|
currentScheduleDelivery - Date
|
|
currentScheduleShip - Date
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deliveredOn - Date
|
|
deliveryRequested - Date
|
|
docType - String
|
|
dtmDates - [DTMDateInput]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
estimatedDelivery - Date
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
headerSAC - [SACInput]
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
internalVendorNumber - String
|
|
invoiceDate - Date
|
|
invoiceNumber - String
|
|
invoiced - Date
|
|
invoicedTo - ContactRepresentationInput
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyToReceiveCommercialInvoiceRemittance - AddressInput
|
|
paymentDates - [Date]
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegmentInput]
|
|
remitTo - AddressInput
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedShipDate - Date
|
|
sellingParty - AddressInput
|
|
sendFrom - PartyInformationInput
|
|
sendTo - PartyInformationInput
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
serviceCode - String
|
|
serviceCodeList - [String]
|
|
shipFrom - AddressInput
|
|
shipTo - AddressInput
|
|
shipToAddress - AddressInput
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shipped - Date
|
|
soldOn - Date
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
taxInfo - [TaxInfoInput]
|
|
taxMonetaryAmount - Float
|
|
taxPercentage - Float
|
|
taxTypeCode - String
|
|
termsSaleTypeCode - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegmentInput]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
units - String
|
|
unitsOfMeasure - [String]
|
|
vendor - AddressInput
|
|
vendorIdNumber - String
|
|
vendorNumber - String
|
|
vendorOrderNumber - String
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatusInput,
"addressFields": [AddressInput],
"allowChrgIndicator": "abc123",
"appAdviceTransferStatus": "abc123",
"billFromParty": AddressInput,
"billOfLadingNumber": "xyz789",
"billToAddress": AddressInput,
"billToParty": AddressInput,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformationInput,
"businessPartnerIdentifiers": [IdPairInput],
"businessPartnerStrictIdEnabled": false,
"buyingParty": AddressInput,
"calculatedSACTotalAmount": 123.45,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": false,
"commenters": [UserInfoInput],
"companyID": "abc123",
"contactRepresentations": [ContactRepresentationInput],
"containerID": "xyz789",
"conversation_id": "abc123",
"currency": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"currentScheduleShip": "2007-12-03",
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"deliveredOn": "2007-12-03",
"deliveryRequested": "2007-12-03",
"docType": "xyz789",
"dtmDates": [DTMDateInput],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"estimatedDelivery": "2007-12-03",
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hasPurchaseOrder": false,
"hasRemittanceAdvice": false,
"headerSAC": [SACInput],
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"internalVendorNumber": "abc123",
"invoiceDate": "2007-12-03",
"invoiceNumber": "xyz789",
"invoiced": "2007-12-03",
"invoicedTo": ContactRepresentationInput,
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"partyToReceiveCommercialInvoiceRemittance": AddressInput,
"paymentDates": ["2007-12-03"],
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 987,
"poNumbers": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegmentInput],
"remitTo": AddressInput,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedShipDate": "2007-12-03",
"sellingParty": AddressInput,
"sendFrom": PartyInformationInput,
"sendTo": PartyInformationInput,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"serviceCode": "xyz789",
"serviceCodeList": ["abc123"],
"shipFrom": AddressInput,
"shipTo": AddressInput,
"shipToAddress": AddressInput,
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["xyz789"],
"shipped": "2007-12-03",
"soldOn": "2007-12-03",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"taxInfo": [TaxInfoInput],
"taxMonetaryAmount": 987.65,
"taxPercentage": 123.45,
"taxTypeCode": "abc123",
"termsSaleTypeCode": "xyz789",
"testIndicator": "INFORMATION",
"textInfo": [TextSegmentInput],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"transactionTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "xyz789",
"units": "abc123",
"unitsOfMeasure": ["abc123"],
"vendor": AddressInput,
"vendorIdNumber": "xyz789",
"vendorNumber": "abc123",
"vendorOrderNumber": "abc123",
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"]
}
¶ ItemMaintenanceDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
purposeCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
warehouse - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"purposeCode": "abc123",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"warehouse": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ LateMFTEventRule
¶ Fields
| Field Name | Description |
|---|---|
active - Boolean
|
|
companyID - String
|
|
consumerPartner - BusinessPartner
|
|
createdBy - UserDetails
|
|
cronExpression - String
|
|
environment - String
|
|
exceptionEntityType - ExceptionEntityType
|
|
filePattern - String
|
|
id - String
|
|
ignoreOlderThanDelta - Long
|
|
producerPartner - BusinessPartner
|
|
timestamp - Date
|
|
type - RuleType
|
¶ Example
{
"active": true,
"companyID": "xyz789",
"consumerPartner": BusinessPartner,
"createdBy": UserDetails,
"cronExpression": "abc123",
"environment": "abc123",
"exceptionEntityType": "DOCUMENT",
"filePattern": "abc123",
"id": "abc123",
"ignoreOlderThanDelta": {},
"producerPartner": BusinessPartner,
"timestamp": "2007-12-03",
"type": "LATE_MFT_EVENT"
}
¶ LateMFTEventRuleRequestInput
¶ Fields
| Input Field | Description |
|---|---|
active - Boolean
|
|
consumerPartner - BusinessPartnerInput
|
|
createdBy - UserDetailsInput
|
|
cronExpression - String
|
|
exceptionEntityType - ExceptionEntityType
|
|
filePattern - String
|
|
ignoreOlderThanDelta - Long
|
|
producerPartner - BusinessPartnerInput
|
|
timestamp - Date
|
|
type - RuleType
|
¶ Example
{
"active": true,
"consumerPartner": BusinessPartnerInput,
"createdBy": UserDetailsInput,
"cronExpression": "xyz789",
"exceptionEntityType": "DOCUMENT",
"filePattern": "abc123",
"ignoreOlderThanDelta": {},
"producerPartner": BusinessPartnerInput,
"timestamp": "2007-12-03",
"type": "LATE_MFT_EVENT"
}
¶ LayoutConfig
¶ Fields
| Field Name | Description |
|---|---|
type - DashboardLayoutType
|
¶ Example
{"type": "leaf"}
¶ LayoutConfigInput
¶ Fields
| Input Field | Description |
|---|---|
type - DashboardLayoutType
|
¶ Example
{"type": "leaf"}
¶ LifeCycleAudit
¶ LifeCycleCorrelationPoint
¶ Example
{
"businessPartner": "abc123",
"companyId": "abc123",
"environment": "abc123",
"flowDirectionToMatch": "abc123",
"id": "xyz789",
"inboundIdentifierHash": "abc123",
"key": "abc123",
"outboundIdentifierHash": "abc123",
"relationType": "BILL_OF_LADING_AND_PO_NUMBER",
"subOrgID": "xyz789",
"value": "xyz789"
}
¶ LifeCycleEventType
¶ Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
¶ Example
"APPLICATION_ADVICE_EVENT"
¶ LifeCycleRelationType
¶ LineItem
¶ Fields
| Field Name | Description |
|---|---|
documentReferenceID - String
|
|
fileID - String
|
|
handlingMethods - [String]
|
|
id - String
|
|
identifiers - [ProductIdentifier]
|
|
lineNumber - Int
|
|
lineValues - Map_String_ObjectScalar
|
|
numbersCameFromDataSoDontChangeThem - Boolean!
|
|
sdqSegments - [SDQInfo]
|
|
timestamp - Date
|
|
vendorQualifier - String
|
¶ Example
{
"documentReferenceID": "xyz789",
"fileID": "xyz789",
"handlingMethods": ["xyz789"],
"id": "abc123",
"identifiers": [ProductIdentifier],
"lineNumber": 123,
"lineValues": Map_String_ObjectScalar,
"numbersCameFromDataSoDontChangeThem": false,
"sdqSegments": [SDQInfo],
"timestamp": "2007-12-03",
"vendorQualifier": "xyz789"
}
¶ LineItemInput
¶ Fields
| Input Field | Description |
|---|---|
documentReferenceID - String
|
|
fileID - String
|
|
handlingMethods - [String]
|
|
id - String
|
|
identifiers - [ProductIdentifierInput]
|
|
lineNumber - Int
|
|
lineValues - Map_String_ObjectScalar
|
|
numbersCameFromDataSoDontChangeThem - Boolean!
|
|
sdqSegments - [SDQInfoInput]
|
|
timestamp - Date
|
|
vendorQualifier - String
|
¶ Example
{
"documentReferenceID": "xyz789",
"fileID": "abc123",
"handlingMethods": ["xyz789"],
"id": "abc123",
"identifiers": [ProductIdentifierInput],
"lineNumber": 123,
"lineValues": Map_String_ObjectScalar,
"numbersCameFromDataSoDontChangeThem": true,
"sdqSegments": [SDQInfoInput],
"timestamp": "2007-12-03",
"vendorQualifier": "xyz789"
}
¶ LockboxDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
bank - Address
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
payee - Address
|
|
payer - Address
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"bank": Address,
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"payee": Address,
"payer": Address,
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ Long
¶ Map_PipelineStepKey_ProcessingStepStateScalar
¶ Map_String_BooleanScalar
¶ Map_String_CompanyGroupScalar
¶ Map_String_Map_String_ObjectScalar
¶ Map_String_ObjectScalar
¶ Map_String_StringScalar
¶ Map_SupportedDate_DateScalar
¶ Measure
¶ MeasureInput
¶ MetaData
¶ MotorCarrierBillOfLadingDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billTo - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
codMethodPayment - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
currencyCode - String
|
|
customFields - Map_String_StringScalar
|
|
customsHandleCode - String
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
freightPaymentMethod - String
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
orderDate - Date
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
pickupDate - Date
|
|
poNumber - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
sectionSevenCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipTo - String
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
soldTo - String
|
|
statusRequestCode - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billTo": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"codMethodPayment": "abc123",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"currencyCode": "xyz789",
"customFields": Map_String_StringScalar,
"customsHandleCode": "abc123",
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"freightPaymentMethod": "xyz789",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"orderDate": "2007-12-03",
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"pickupDate": "2007-12-03",
"poNumber": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"scac": "xyz789",
"sectionSevenCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipTo": "abc123",
"shipToAddress": Address,
"shipmentID": "abc123",
"soldTo": "abc123",
"statusRequestCode": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ MotorCarrierFreightDetailsAndInvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
amountDue - Float
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
billingDate - Date
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
consignee - Address
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correctionIndc - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
dateQualifier - String
|
|
deliveryDate - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
invoiceNumber - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numDetails - Int
|
|
numOfErrors - Int
|
|
numStops - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
payer - Address
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
remitTo - Address
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipPaymentMethod - String
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shipmentQualifier - String
|
|
shipper - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
tariffCode - String
|
|
termsSaleTypeCode - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transportCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
weightUnitCode - String
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"amountDue": 987.65,
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"billingDate": "2007-12-03",
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"consignee": Address,
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correctionIndc": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"dateQualifier": "abc123",
"deliveryDate": "2007-12-03",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"invoiceNumber": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numDetails": 987,
"numOfErrors": 123,
"numStops": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"payer": Address,
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"scac": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipPaymentMethod": "abc123",
"shipToAddress": Address,
"shipmentID": "abc123",
"shipmentQualifier": "xyz789",
"shipper": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"tariffCode": "abc123",
"termsSaleTypeCode": "xyz789",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"transportCode": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"weightUnitCode": "xyz789",
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ MotorCarrierLoadTenderDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
customsHandleCode - String
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
paymentMethodCode - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shipmentPaymentMethod - String
|
|
shipmentQualifier - String
|
|
shipmentWeightCode - String
|
|
splc - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
tariffCode - String
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalEquipment - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transportTermsCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
weightUnitCode - String
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"customsHandleCode": "abc123",
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"paymentMethodCode": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"scac": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"shipmentID": "xyz789",
"shipmentPaymentMethod": "abc123",
"shipmentQualifier": "xyz789",
"shipmentWeightCode": "abc123",
"splc": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"tariffCode": "abc123",
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalEquipment": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"transportTermsCode": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"weightUnitCode": "abc123",
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ N1Segment
¶ Fields
| Field Name | Description |
|---|---|
billOfLadingNumber - String
|
|
billToParty - String
|
|
buyingParty - String
|
|
contactName - String
|
|
dataQualityRejectReason - String
|
|
email - String
|
|
errorIdentificationCode - String
|
|
interchangeAgreementNumber - String
|
|
invoiceIdentification - String
|
|
locationCode - String
|
|
markForParty - String
|
|
messageAddress - String
|
|
messageFrom - String
|
|
nullAllFields - Boolean!
|
|
packingListNumber - String
|
|
poNumber - String
|
|
remitTo - String
|
|
shipFrom - String
|
|
shipFromLine1 - String
|
|
shipFromLine2 - String
|
|
shipFromLocationCode - String
|
|
shipTo - String
|
|
shipToLine1 - String
|
|
shipToLine2 - String
|
|
shipToLocationCode - String
|
|
shippersIdentifyingNumber - String
|
|
status - String
|
|
store - String
|
|
telephone - String
|
|
vendor - String
|
|
vendorIDNumber - String
|
|
vendorOrderNumber - String
|
¶ Example
{
"billOfLadingNumber": "abc123",
"billToParty": "xyz789",
"buyingParty": "xyz789",
"contactName": "abc123",
"dataQualityRejectReason": "xyz789",
"email": "xyz789",
"errorIdentificationCode": "xyz789",
"interchangeAgreementNumber": "abc123",
"invoiceIdentification": "xyz789",
"locationCode": "abc123",
"markForParty": "xyz789",
"messageAddress": "abc123",
"messageFrom": "xyz789",
"nullAllFields": false,
"packingListNumber": "abc123",
"poNumber": "abc123",
"remitTo": "abc123",
"shipFrom": "abc123",
"shipFromLine1": "abc123",
"shipFromLine2": "xyz789",
"shipFromLocationCode": "xyz789",
"shipTo": "xyz789",
"shipToLine1": "xyz789",
"shipToLine2": "xyz789",
"shipToLocationCode": "abc123",
"shippersIdentifyingNumber": "abc123",
"status": "abc123",
"store": "xyz789",
"telephone": "xyz789",
"vendor": "xyz789",
"vendorIDNumber": "abc123",
"vendorOrderNumber": "xyz789"
}
¶ NumberFormatConfig
¶ NumberFormatConfigInput
¶ OTIReference
¶ Fields
| Field Name | Description |
|---|---|
applicationAckCode - String
|
|
badData - String
|
|
creditDebitFlag - String
|
|
dataElementErrorCode - String
|
|
displayTsIdCode - String
|
|
errorElement - String
|
|
errorSegment - String
|
|
groupControlNumber - String
|
|
inboundDocDate - Date
|
|
invoiceDate - Date
|
|
monetoryAmount - String
|
|
poDate - Date
|
|
referenceIdentification - String
|
|
rejectionReasons - String
|
|
segmentIdCode - String
|
|
shippedDate - Date
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
¶ Example
{
"applicationAckCode": "abc123",
"badData": "abc123",
"creditDebitFlag": "abc123",
"dataElementErrorCode": "xyz789",
"displayTsIdCode": "abc123",
"errorElement": "abc123",
"errorSegment": "xyz789",
"groupControlNumber": "abc123",
"inboundDocDate": "2007-12-03",
"invoiceDate": "2007-12-03",
"monetoryAmount": "abc123",
"poDate": "2007-12-03",
"referenceIdentification": "xyz789",
"rejectionReasons": "abc123",
"segmentIdCode": "xyz789",
"shippedDate": "2007-12-03",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123"
}
¶ ObjectScalar
¶ Operation
¶ OrderStatusReportDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
actionCode - String
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
inquirerDate - Date
|
|
inquirerRefIdent - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
locationCode - String
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
orderCode - String
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
productDate - Date
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
senderRefIdent - String
|
|
senderReportDate - Date
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
statusReportCode - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"actionCode": "xyz789",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"inquirerDate": "2007-12-03",
"inquirerRefIdent": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"locationCode": "xyz789",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 123,
"orderCode": "abc123",
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"productDate": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"senderRefIdent": "xyz789",
"senderReportDate": "2007-12-03",
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"statusReportCode": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ OrganizationalRelationshipsDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyCode - String
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
messageFrom - Address
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionDate - Date
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
tsTypeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyCode": "xyz789",
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"messageFrom": Address,
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "xyz789",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionDate": "2007-12-03",
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"tsTypeCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ OutboundSFTPConfiguration
¶ Fields
| Field Name | Description |
|---|---|
businessPartnerID - String
|
|
companyID - String
|
|
connectionTimeout - Int!
|
|
createdBy - UserDetails
|
|
destinationFolder - String
|
|
environment - String
|
|
host - String
|
|
id - String
|
|
knownHosts - String
|
|
name - String
|
|
passwordHash - String
|
|
port - Int!
|
|
privateKey - String
|
|
retryCount - Int!
|
|
strictHostKeyChecking - Boolean
|
|
timestamp - Date
|
|
type - OutboundSFTPConfigurationType
|
|
username - String
|
¶ Example
{
"businessPartnerID": "abc123",
"companyID": "xyz789",
"connectionTimeout": 123,
"createdBy": UserDetails,
"destinationFolder": "xyz789",
"environment": "abc123",
"host": "abc123",
"id": "xyz789",
"knownHosts": "xyz789",
"name": "abc123",
"passwordHash": "xyz789",
"port": 987,
"privateKey": "xyz789",
"retryCount": 123,
"strictHostKeyChecking": true,
"timestamp": "2007-12-03",
"type": "KEY",
"username": "xyz789"
}
¶ OutboundSFTPConfigurationInput
¶ Fields
| Input Field | Description |
|---|---|
businessPartnerID - String
|
|
companyID - String
|
|
connectionTimeout - Int!
|
|
createdBy - UserDetailsInput
|
|
destinationFolder - String
|
|
environment - String
|
|
host - String
|
|
id - String
|
|
knownHosts - String
|
|
name - String
|
|
passwordHash - String
|
|
port - Int!
|
|
privateKey - String
|
|
retryCount - Int!
|
|
strictHostKeyChecking - Boolean
|
|
timestamp - Date
|
|
type - OutboundSFTPConfigurationType
|
|
username - String
|
¶ Example
{
"businessPartnerID": "abc123",
"companyID": "abc123",
"connectionTimeout": 123,
"createdBy": UserDetailsInput,
"destinationFolder": "abc123",
"environment": "abc123",
"host": "xyz789",
"id": "abc123",
"knownHosts": "abc123",
"name": "xyz789",
"passwordHash": "xyz789",
"port": 123,
"privateKey": "abc123",
"retryCount": 987,
"strictHostKeyChecking": false,
"timestamp": "2007-12-03",
"type": "KEY",
"username": "xyz789"
}
¶ OutboundSFTPConfigurationType
¶ Parameter
¶ ParameterInput
¶ ParticipantInfo
¶ PartnerAddressDTOInput
¶ PartnerConnectionStatus
¶ Fields
| Field Name | Description |
|---|---|
invitationEmail - String
|
|
invitedByCompany - String
|
|
invitedByUser - UserInfo
|
|
partnerCompany - CompanyInfo
|
|
partnerName - String
|
|
status - ConnectionStatus
|
|
text - String
|
|
token - String
|
¶ Example
{
"invitationEmail": "abc123",
"invitedByCompany": "abc123",
"invitedByUser": UserInfo,
"partnerCompany": CompanyInfo,
"partnerName": "xyz789",
"status": "Connected",
"text": "xyz789",
"token": "abc123"
}
¶ PartnerConnectionStatusInput
¶ Fields
| Input Field | Description |
|---|---|
invitationEmail - String
|
|
invitedByCompany - String
|
|
invitedByUser - UserInfoInput
|
|
partnerCompany - CompanyInfoInput
|
|
partnerName - String
|
|
status - ConnectionStatus
|
|
text - String
|
|
token - String
|
¶ Example
{
"invitationEmail": "abc123",
"invitedByCompany": "xyz789",
"invitedByUser": UserInfoInput,
"partnerCompany": CompanyInfoInput,
"partnerName": "abc123",
"status": "Connected",
"text": "xyz789",
"token": "xyz789"
}
¶ PartnerContactDTOInput
¶ Fields
| Input Field | Description |
|---|---|
address - PartnerAddressDTOInput
|
|
contactType - ContactType
|
|
email - String
|
|
firstName - String
|
|
lastName - String
|
|
notes - String
|
|
office - String
|
|
phoneNumbers - PhoneRecordInput
|
|
title - String
|
¶ Example
{
"address": PartnerAddressDTOInput,
"contactType": "business",
"email": "xyz789",
"firstName": "abc123",
"lastName": "abc123",
"notes": "abc123",
"office": "xyz789",
"phoneNumbers": PhoneRecordInput,
"title": "xyz789"
}
¶ PartnerContactRecord
¶ Fields
| Field Name | Description |
|---|---|
accessGrantedOn - Date
|
|
accessRevokedOn - Date
|
|
address - Address
|
|
companyID - String
|
|
contactType - ContactType
|
|
createdOn - Date
|
|
email - String
|
|
emailLower - String
|
|
environment - String
|
|
firstName - String
|
|
firstNameLower - String
|
|
fullName - String
|
|
fullNameLower - String
|
|
id - String
|
|
lastModified - Date
|
|
lastModifiedBy - UserInfo
|
|
lastName - String
|
|
lastNameLower - String
|
|
notes - String
|
|
office - String
|
|
officeLower - String
|
|
partnerID - String
|
|
phoneNumbers - PhoneRecord
|
|
status - PartnerConnectionStatus
|
|
title - String
|
|
titleLower - String
|
¶ Example
{
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": Address,
"companyID": "xyz789",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "xyz789",
"emailLower": "xyz789",
"environment": "abc123",
"firstName": "xyz789",
"firstNameLower": "xyz789",
"fullName": "xyz789",
"fullNameLower": "abc123",
"id": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfo,
"lastName": "abc123",
"lastNameLower": "xyz789",
"notes": "xyz789",
"office": "abc123",
"officeLower": "abc123",
"partnerID": "xyz789",
"phoneNumbers": PhoneRecord,
"status": PartnerConnectionStatus,
"title": "xyz789",
"titleLower": "xyz789"
}
¶ PartnerContactRecordInput
¶ Fields
| Input Field | Description |
|---|---|
accessGrantedOn - Date
|
|
accessRevokedOn - Date
|
|
address - AddressInput
|
|
companyID - String
|
|
contactType - ContactType
|
|
createdOn - Date
|
|
email - String
|
|
emailLower - String
|
|
environment - String
|
|
firstName - String
|
|
firstNameLower - String
|
|
fullName - String
|
|
fullNameLower - String
|
|
id - String
|
|
lastModified - Date
|
|
lastModifiedBy - UserInfoInput
|
|
lastName - String
|
|
lastNameLower - String
|
|
notes - String
|
|
office - String
|
|
officeLower - String
|
|
partnerID - String
|
|
phoneNumbers - PhoneRecordInput
|
|
status - PartnerConnectionStatusInput
|
|
title - String
|
|
titleLower - String
|
¶ Example
{
"accessGrantedOn": "2007-12-03",
"accessRevokedOn": "2007-12-03",
"address": AddressInput,
"companyID": "abc123",
"contactType": "business",
"createdOn": "2007-12-03",
"email": "xyz789",
"emailLower": "xyz789",
"environment": "abc123",
"firstName": "abc123",
"firstNameLower": "abc123",
"fullName": "xyz789",
"fullNameLower": "xyz789",
"id": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": UserInfoInput,
"lastName": "xyz789",
"lastNameLower": "abc123",
"notes": "abc123",
"office": "xyz789",
"officeLower": "xyz789",
"partnerID": "xyz789",
"phoneNumbers": PhoneRecordInput,
"status": PartnerConnectionStatusInput,
"title": "xyz789",
"titleLower": "abc123"
}
¶ PartnerLocation
¶ PartnerLocationInput
¶ Fields
| Input Field | Description |
|---|---|
address - AddressInput
|
|
id - String
|
|
identifiers - [BusinessIdentifierInput]
|
|
name - String
|
¶ Example
{
"address": AddressInput,
"id": "abc123",
"identifiers": [BusinessIdentifierInput],
"name": "abc123"
}
¶ PartnerProtocol
¶ Example
{
"authenticationMethod": "abc123",
"companyID": "xyz789",
"direction": "Inbound",
"directory": "abc123",
"environment": "xyz789",
"hosts": ["abc123"],
"id": "abc123",
"lastModified": "2007-12-03",
"name": "xyz789",
"notes": "xyz789",
"partnerID": "xyz789",
"port": "xyz789",
"protocol": "API",
"user": "xyz789"
}
¶ PartnerProtocolInput
¶ Fields
| Input Field | Description |
|---|---|
authenticationMethod - String
|
|
companyID - String
|
|
direction - ProtocolDirection
|
|
directory - String
|
|
environment - String
|
|
hosts - [String]
|
|
id - String
|
|
lastModified - Date
|
|
name - String
|
|
notes - String
|
|
partnerID - String
|
|
port - String
|
|
protocol - ProtocolType
|
|
user - String
|
¶ Example
{
"authenticationMethod": "abc123",
"companyID": "abc123",
"direction": "Inbound",
"directory": "abc123",
"environment": "xyz789",
"hosts": ["xyz789"],
"id": "abc123",
"lastModified": "2007-12-03",
"name": "abc123",
"notes": "abc123",
"partnerID": "abc123",
"port": "abc123",
"protocol": "API",
"user": "abc123"
}
¶ PartnerRole
¶ PartnerType
¶ PartyInformation
¶ Fields
| Field Name | Description |
|---|---|
businessPartner - BusinessPartnerInfo
|
|
id - String
|
|
rawInfo - Map_String_StringScalar
|
¶ Example
{
"businessPartner": BusinessPartnerInfo,
"id": "xyz789",
"rawInfo": Map_String_StringScalar
}
¶ PartyInformationInput
¶ Fields
| Input Field | Description |
|---|---|
businessPartner - BusinessPartnerInfoInput
|
|
id - String
|
|
rawInfo - Map_String_StringScalar
|
¶ Example
{
"businessPartner": BusinessPartnerInfoInput,
"id": "xyz789",
"rawInfo": Map_String_StringScalar
}
¶ PasswordRequirements
¶ Example
{
"PASSWORD_REQUIREMENTS_VERSION": 987,
"containNumber": false,
"containSpecial": true,
"containUpper": true,
"minimumLength": 987,
"minimumStrength": 123,
"version": 123
}
¶ PasswordRequirementsInput
¶ Example
{
"containNumber": true,
"containSpecial": true,
"containUpper": true,
"minimumLength": 987,
"minimumStrength": 123,
"version": 987
}
¶ Period
¶ PermissionValue
¶ PhoneRecord
¶ PhoneRecordInput
¶ PlanningScheduleDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
contractNumber - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
endDate - Date
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
forecastGenDate - Date
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
messageFrom - Address
|
|
messageTo - Address
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
refIdent - String
|
|
referenceInfo - [RefSegment]
|
|
releaseNumbers - [String]
|
|
reportedPoNumbers - [String]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
schQtyQual - String
|
|
schTypQual - String
|
|
sellerParty - Address
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
startDate - Date
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"contractNumber": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"endDate": "2007-12-03",
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"filename": "xyz789",
"flowDirection": "inbound",
"forecastGenDate": "2007-12-03",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hasPurchaseOrder": true,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"messageFrom": Address,
"messageTo": Address,
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"poNumber": "abc123",
"poNumberCount": 987,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"refIdent": "abc123",
"referenceInfo": [RefSegment],
"releaseNumbers": ["xyz789"],
"reportedPoNumbers": ["xyz789"],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"schQtyQual": "xyz789",
"schTypQual": "abc123",
"sellerParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"startDate": "2007-12-03",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"tsPurposeCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PortAndDateReference
¶ Fields
| Field Name | Description |
|---|---|
dateOrTimeOrReference - DateOrTimeOrReference
|
|
portOrTerminal - PortOrTerminal
|
¶ Example
{
"dateOrTimeOrReference": DateOrTimeOrReference,
"portOrTerminal": PortOrTerminal
}
¶ PortOrTerminal
¶ Example
{
"countryCode": "abc123",
"locationIdentifier": "abc123",
"locationQualifier": "xyz789",
"pierNumber": "xyz789",
"portFunctCode": "xyz789",
"portName": "abc123",
"stateOrProvinceCode": "xyz789",
"terminalName": "xyz789"
}
¶ PriceAuthorizationAcknowledgmentDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
contractNumber - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
priceAuthorizationAckDate - Date
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
purposeCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceIdentifier - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"contractNumber": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"priceAuthorizationAckDate": "2007-12-03",
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"purposeCode": "abc123",
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "abc123",
"referenceIdentifier": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PriceInformationDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
changeTypeCode - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"changeTypeCode": "xyz789",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PriceSalesCatalogDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
catalogCode - String
|
|
catalogNumber - String
|
|
catalogRevNumber - String
|
|
catalogVerNumber - String
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"catalogCode": "abc123",
"catalogNumber": "xyz789",
"catalogRevNumber": "abc123",
"catalogVerNumber": "xyz789",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ProcessingPipeline
¶ Fields
| Field Name | Description |
|---|---|
companyID - String
|
|
createdBy - UserDetails
|
|
environment - String
|
|
filePathRegexp - String
|
|
id - String
|
|
lastUpdate - Date
|
|
name - String
|
|
partner - BusinessPartner
|
|
stepsData - Map_String_Map_String_ObjectScalar
|
|
timestamp - Date
|
¶ Example
{
"companyID": "xyz789",
"createdBy": UserDetails,
"environment": "abc123",
"filePathRegexp": "xyz789",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"name": "xyz789",
"partner": BusinessPartner,
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03"
}
¶ ProcessingPipelineInput
¶ Fields
| Input Field | Description |
|---|---|
companyID - String
|
|
createdBy - UserDetailsInput
|
|
environment - String
|
|
filePathRegexp - String
|
|
id - String
|
|
lastUpdate - Date
|
|
name - String
|
|
partner - BusinessPartnerInput
|
|
stepsData - Map_String_Map_String_ObjectScalar
|
|
timestamp - Date
|
¶ Example
{
"companyID": "xyz789",
"createdBy": UserDetailsInput,
"environment": "abc123",
"filePathRegexp": "abc123",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"name": "xyz789",
"partner": BusinessPartnerInput,
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03"
}
¶ ProcessingState
¶ Example
{
"companyID": "abc123",
"environment": "xyz789",
"eventSummaryId": "xyz789",
"id": "xyz789",
"steps": Map_PipelineStepKey_ProcessingStepStateScalar,
"timestamp": "2007-12-03"
}
¶ ProcessingStatus
¶ ProcessingStep
¶ ProductActivityDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
activityLocation - Company
|
|
activityType - String
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
classOfTrade - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
createdOn - Date
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
documentPurpose - String
|
|
dtmDates - [DTMDate]
|
|
endDateTime - Date
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
invoiceNumber - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receivedOn - Date
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
referenceOrderNumber - String
|
|
reportDateTime - Date
|
|
reportName - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
startDateTime - Date
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionCode - String
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"activityLocation": Company,
"activityType": "abc123",
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"classOfTrade": "xyz789",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"createdOn": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"documentPurpose": "xyz789",
"dtmDates": [DTMDate],
"endDateTime": "2007-12-03",
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"invoiceNumber": "xyz789",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receivedOn": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"referenceOrderNumber": "xyz789",
"reportDateTime": "2007-12-03",
"reportName": "xyz789",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipTo": Address,
"shipToAddress": Address,
"startDateTime": "2007-12-03",
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionCode": "xyz789",
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ProductIdentifier
¶ ProductIdentifierInput
¶ ProductTransferAccountAdjustmentDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
adjustmentDate - Date
|
|
appAdviceTransferStatus - String
|
|
batchNumber - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
contractCount - Int
|
|
contractNumbers - [String]
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
distributorBranch - Address
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
refIdent - String
|
|
refIdentQual - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipToLocations - [Address]
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalChargebackAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"adjustmentDate": "2007-12-03",
"appAdviceTransferStatus": "xyz789",
"batchNumber": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"contractCount": 123,
"contractNumbers": ["xyz789"],
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"distributorBranch": Address,
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"refIdent": "xyz789",
"refIdentQual": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"shipToLocations": [Address],
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalChargebackAmount": 123.45,
"totalQuantity": 987.65,
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"transactionTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ProductTransferAccountAdjustmentResponseDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
chargeBackMemo - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
contractNumbers - [String]
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfContracts - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
refIdent - String
|
|
refIdentQual - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
responseDate - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAdjustedChargebackClaimAmount - Float
|
|
totalSubmittedChargebackClaimAmount - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"chargeBackMemo": "xyz789",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"contractNumbers": ["abc123"],
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfContracts": 987,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"refIdent": "xyz789",
"refIdentQual": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"responseDate": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAdjustedChargebackClaimAmount": 987.65,
"totalSubmittedChargebackClaimAmount": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"tsPurposeCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ProductTransferAndResaleReportDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
actionCode - String
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
distributor - Address
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
multiplier - Float
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
prevReportNumber - String
|
|
priceMultQualifier - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
remitTo - Address
|
|
reportTypeCode - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
securityCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transferResaleDate - Date
|
|
transferResaleNumber - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"actionCode": "abc123",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"distributor": Address,
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"multiplier": 987.65,
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"prevReportNumber": "abc123",
"priceMultQualifier": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reportTypeCode": "xyz789",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"securityCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"transferResaleDate": "2007-12-03",
"transferResaleNumber": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PromotionAnnouncementDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
allowanceChargeCodes - [String]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
promotionNumber - String
|
|
promotionStatusCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"allowanceChargeCodes": ["abc123"],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"promotionNumber": "xyz789",
"promotionStatusCode": "abc123",
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"transactionTypeCode": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ProtocolDirection
¶ ProtocolType
¶ PurchaseOrderAcknowledgmentDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
ackType - String
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
cancelAfterDate - Date
|
|
cancelIfNotShippedByDate - Date
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
currentScheduleDelivery - Date
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deferredPaymentDate - Date
|
|
deliveryRequested - Date
|
|
deliveryRequestedDate - Date
|
|
doNotDeliverAfterDate - Date
|
|
doNotDeliverBeforeDate - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPOChange - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
poType - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
providedTotalAmount - Float
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
releaseDate - Date
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedForDeliveryDatePriorTo - Date
|
|
requestedForDeliveryDateWeekOf - Date
|
|
requestedForShipmentDateWeekOf - Date
|
|
requestedShipDate - Date
|
|
routing - String
|
|
salesReqCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipMethodPayment - String
|
|
shipNoLaterDate - Date
|
|
shipNotBeforeDate - Date
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "abc123",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": false,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"currency": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hasPOChange": true,
"hasPurchaseOrder": true,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["abc123"],
"poType": "xyz789",
"primary": true,
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"providedTotalAmount": 123.45,
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedShipDate": "2007-12-03",
"routing": "xyz789",
"salesReqCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFrom": Address,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PurchaseOrderAcknowledgmentDocumentInput
¶ Fields
| Input Field | Description |
|---|---|
acceptanceStatus - AcceptanceStatusInput
|
|
ackType - String
|
|
addressFields - [AddressInput]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - AddressInput
|
|
billToParty - AddressInput
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformationInput
|
|
businessPartnerIdentifiers - [IdPairInput]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - AddressInput
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
cancelAfterDate - Date
|
|
cancelIfNotShippedByDate - Date
|
|
commenters - [UserInfoInput]
|
|
companyID - String
|
|
contactRepresentations - [ContactRepresentationInput]
|
|
containerID - String
|
|
conversation_id - String
|
|
currency - String
|
|
currentScheduleDelivery - Date
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deferredPaymentDate - Date
|
|
deliveryRequested - Date
|
|
deliveryRequestedDate - Date
|
|
doNotDeliverAfterDate - Date
|
|
doNotDeliverBeforeDate - Date
|
|
docType - String
|
|
dtmDates - [DTMDateInput]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPOChange - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
poType - String
|
|
providedTotalAmount - Float
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegmentInput]
|
|
releaseDate - Date
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedForDeliveryDatePriorTo - Date
|
|
requestedForDeliveryDateWeekOf - Date
|
|
requestedForShipmentDateWeekOf - Date
|
|
requestedShipDate - Date
|
|
salesReqCode - String
|
|
sendFrom - PartyInformationInput
|
|
sendTo - PartyInformationInput
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
shipFrom - AddressInput
|
|
shipMethodPayment - String
|
|
shipNoLaterDate - Date
|
|
shipNotBeforeDate - Date
|
|
shipTo - AddressInput
|
|
shipToAddress - AddressInput
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - AddressInput
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegmentInput]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
vendor - AddressInput
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatusInput,
"ackType": "xyz789",
"addressFields": [AddressInput],
"appAdviceTransferStatus": "abc123",
"billToAddress": AddressInput,
"billToParty": AddressInput,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformationInput,
"businessPartnerIdentifiers": [IdPairInput],
"businessPartnerStrictIdEnabled": false,
"buyingParty": AddressInput,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": true,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"commenters": [UserInfoInput],
"companyID": "abc123",
"contactRepresentations": [ContactRepresentationInput],
"containerID": "xyz789",
"conversation_id": "abc123",
"currency": "xyz789",
"currentScheduleDelivery": "2007-12-03",
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "xyz789",
"dtmDates": [DTMDateInput],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": true,
"hasPOChange": true,
"hasPurchaseOrder": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "abc123",
"poNumberCount": 123,
"poNumbers": ["xyz789"],
"poType": "xyz789",
"providedTotalAmount": 987.65,
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegmentInput],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedShipDate": "2007-12-03",
"salesReqCode": "abc123",
"sendFrom": PartyInformationInput,
"sendTo": PartyInformationInput,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"shipFrom": AddressInput,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": AddressInput,
"shipToAddress": AddressInput,
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierOrManufacturer": AddressInput,
"testIndicator": "INFORMATION",
"textInfo": [TextSegmentInput],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 987.65,
"totalQuantity": 123.45,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"tsPurposeCode": "xyz789",
"type": "xyz789",
"vendor": AddressInput,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"]
}
¶ PurchaseOrderChangeDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hasShipment - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
newTotalAmount - Float
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTotalAmount - Float
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poDate - Date
|
|
poDates - [Date]
|
|
poNumber - String
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
poTypeCode - String
|
|
pocDate - Date
|
|
pocNumber - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
purchaseOrderAffected - String
|
|
purposeCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sellingParty - Address
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unitsOfMeasure - [String]
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"currency": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": true,
"hasPurchaseOrder": true,
"hasShipment": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"newTotalAmount": 123.45,
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTotalAmount": 987.65,
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"poDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumber": "xyz789",
"poNumberCount": 123,
"poNumbers": ["xyz789"],
"poTypeCode": "abc123",
"pocDate": "2007-12-03",
"pocNumber": "abc123",
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"purchaseOrderAffected": "xyz789",
"purposeCode": "xyz789",
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"sellingParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalQuantity": 123.45,
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "xyz789",
"unitsOfMeasure": ["xyz789"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PurchaseOrderDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
ackType - String
|
|
ackTypes - [String]
|
|
addressFields - [Address]
|
|
albertsonsDepartmentNumber - String
|
|
alphaCodes - [String]
|
|
appAdviceTransferStatus - String
|
|
arrivedAtCustomsDates - [Date]
|
|
arrivedAtTerminalLocationsDates - [Date]
|
|
arrivedDates - [Date]
|
|
availableForDeliveryDates - [Date]
|
|
billOfLadingNumbers - [String]
|
|
billOfLadingReleasedDates - [Date]
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
bookingConfirmedDates - [Date]
|
|
bookingNumbers - [String]
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyerIdentification - String
|
|
buyingParty - Address
|
|
calculatedSACTotalAmount - Float
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
cancelAfterDate - Date
|
|
cancelIfNotShippedByDate - Date
|
|
cargoReceivedAtContractualPlaceOfReceiptDates - [Date]
|
|
carrierAndCustomsReleaseDates - [Date]
|
|
carrierReleaseDates - [Date]
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
completedUnloadingAtDeliveryLocationDates - [Date]
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
customFields - Map_String_StringScalar
|
|
customsReleasedDates - [Date]
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deferredPaymentDate - Date
|
|
deliveryAppointmentDates - [Date]
|
|
deliveryRequested - Date
|
|
deliveryRequestedDate - Date
|
|
departedPickupLocationDates - [Date]
|
|
departmentNumberText - String
|
|
doNotDeliverAfter - Date
|
|
doNotDeliverAfterDate - Date
|
|
doNotDeliverBefore - Date
|
|
doNotDeliverBeforeDate - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
emptyEquipmentDispatchedDates - [Date]
|
|
entityID - String
|
|
environment - String
|
|
equipmentNumberN9Segments - [String]
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
estimatedDeliveryDates - [Date]
|
|
estimatedToArriveDates - [Date]
|
|
estimatedToDepartTerminalLocationDates - [Date]
|
|
eventType - LifeCycleEventType
|
|
expectedReply - Date
|
|
expectedShipDate - Date
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasCreditDebitAdjustment - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasInvoice - Boolean
|
|
hasPOChange - Boolean
|
|
hasPurchaseOrderAcknowledgment - Boolean
|
|
hasPurchaseOrderChange - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
hasReturnMerchandiseAuthorization - Boolean
|
|
hasStatusDetail - Boolean
|
|
hasWarehouseShippingAdvice - Boolean
|
|
hasWarehouseShippingOrder - Boolean
|
|
hasWarehouseStockTransferShipmentAdvice - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
invoiceDates - [Date]
|
|
invoiceNumberCount - Int
|
|
invoiceNumbers - [String]
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
loadedOnRailDates - [Date]
|
|
loadedOnTruckDates - [Date]
|
|
loadedOnVesselDates - [Date]
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
oceanShipmentStatusCodes - [String]
|
|
oceanShipmentStatuses - [String]
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
paymentDates - [Date]
|
|
poAndAsnVendorNumbersMatch - Boolean
|
|
poDate - Date
|
|
poNumber - String
|
|
poType - String
|
|
pocDates - [Date]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
providedTotalAmount - Float
|
|
purposeCodes - [String]
|
|
railDepartureFromOriginIntermodalRampsDates - [Date]
|
|
receivedAtOriginDates - [Date]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
releaseDate - Date
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedForDeliveryDatePriorTo - Date
|
|
requestedForDeliveryDateWeekOf - Date
|
|
requestedForShipmentDateWeekOf - Date
|
|
requestedPickup - Date
|
|
requestedShipDate - Date
|
|
returnedToCarriersTerminalDates - [Date]
|
|
returnedToShipperDates - [Date]
|
|
routing - String
|
|
sacItems - [SAC]
|
|
salesReqCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipMethodPayment - String
|
|
shipNoLaterDate - Date
|
|
shipNotBeforeDate - Date
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipToCompany - Company
|
|
shipmentCancelledDates - [Date]
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shippingMethod - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
textMessages - [String]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
tsPurposeCodes - [String]
|
|
type - String
|
|
units - String
|
|
unitsOfMeasure - [String]
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
vendorIdNumber - String
|
|
vendorIdNumberAsn - String
|
|
vendorNumber - String
|
|
vendorNumbers - [String]
|
|
vendorOrderNumber - String
|
|
vendorOrderNumberAsn - String
|
|
watchers - [String]
|
|
webOrderNumber - String
|
|
weight - Float
|
|
weightUOM - String
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"ackType": "xyz789",
"ackTypes": ["abc123"],
"addressFields": [Address],
"albertsonsDepartmentNumber": "xyz789",
"alphaCodes": ["abc123"],
"appAdviceTransferStatus": "xyz789",
"arrivedAtCustomsDates": ["2007-12-03"],
"arrivedAtTerminalLocationsDates": [
"2007-12-03"
],
"arrivedDates": ["2007-12-03"],
"availableForDeliveryDates": [
"2007-12-03"
],
"billOfLadingNumbers": ["xyz789"],
"billOfLadingReleasedDates": [
"2007-12-03"
],
"billToAddress": Address,
"billToParty": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"bookingConfirmedDates": ["2007-12-03"],
"bookingNumbers": ["abc123"],
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyerIdentification": "xyz789",
"buyingParty": Address,
"calculatedSACTotalAmount": 987.65,
"calculatedTotalAmount": 123.45,
"canDownloadOriginalFile": false,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"cargoReceivedAtContractualPlaceOfReceiptDates": [
"2007-12-03"
],
"carrierAndCustomsReleaseDates": [
"2007-12-03"
],
"carrierReleaseDates": ["2007-12-03"],
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"completedUnloadingAtDeliveryLocationDates": [
"2007-12-03"
],
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "abc123",
"customFields": Map_String_StringScalar,
"customsReleasedDates": ["2007-12-03"],
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryAppointmentDates": [
"2007-12-03"
],
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"departedPickupLocationDates": [
"2007-12-03"
],
"departmentNumberText": "abc123",
"doNotDeliverAfter": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBefore": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"emptyEquipmentDispatchedDates": [
"2007-12-03"
],
"entityID": "xyz789",
"environment": "xyz789",
"equipmentNumberN9Segments": ["xyz789"],
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDeliveryDates": ["2007-12-03"],
"estimatedToArriveDates": ["2007-12-03"],
"estimatedToDepartTerminalLocationDates": [
"2007-12-03"
],
"eventType": "APPLICATION_ADVICE_EVENT",
"expectedReply": "2007-12-03",
"expectedShipDate": "2007-12-03",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": false,
"hasApplicationAdvice": true,
"hasCreditDebitAdjustment": false,
"hasErrors": true,
"hasExceptions": false,
"hasInvoice": false,
"hasPOChange": false,
"hasPurchaseOrderAcknowledgment": false,
"hasPurchaseOrderChange": true,
"hasRemittanceAdvice": false,
"hasReturnMerchandiseAuthorization": true,
"hasStatusDetail": true,
"hasWarehouseShippingAdvice": true,
"hasWarehouseShippingOrder": false,
"hasWarehouseStockTransferShipmentAdvice": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumberCount": 987,
"invoiceNumbers": ["xyz789"],
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"loadedOnRailDates": ["2007-12-03"],
"loadedOnTruckDates": ["2007-12-03"],
"loadedOnVesselDates": ["2007-12-03"],
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"oceanShipmentStatusCodes": ["abc123"],
"oceanShipmentStatuses": ["abc123"],
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"paymentDates": ["2007-12-03"],
"poAndAsnVendorNumbersMatch": false,
"poDate": "2007-12-03",
"poNumber": "abc123",
"poType": "xyz789",
"pocDates": ["2007-12-03"],
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"providedTotalAmount": 123.45,
"purposeCodes": ["abc123"],
"railDepartureFromOriginIntermodalRampsDates": [
"2007-12-03"
],
"receivedAtOriginDates": ["2007-12-03"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedPickup": "2007-12-03",
"requestedShipDate": "2007-12-03",
"returnedToCarriersTerminalDates": [
"2007-12-03"
],
"returnedToShipperDates": ["2007-12-03"],
"routing": "abc123",
"sacItems": [SAC],
"salesReqCode": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipMethodPayment": "abc123",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": Address,
"shipToAddress": Address,
"shipToCompany": Company,
"shipmentCancelledDates": ["2007-12-03"],
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 123,
"shipmentNumbers": ["abc123"],
"shippingMethod": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"textMessages": ["xyz789"],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 123.45,
"totalQuantity": 987.65,
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"transactionTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "abc123",
"tsPurposeCodes": ["abc123"],
"type": "xyz789",
"units": "abc123",
"unitsOfMeasure": ["abc123"],
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"vendorIdNumber": "xyz789",
"vendorIdNumberAsn": "xyz789",
"vendorNumber": "xyz789",
"vendorNumbers": ["abc123"],
"vendorOrderNumber": "xyz789",
"vendorOrderNumberAsn": "xyz789",
"watchers": ["abc123"],
"webOrderNumber": "abc123",
"weight": 987.65,
"weightUOM": "abc123",
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ PurchaseOrderDocumentInput
¶ Fields
| Input Field | Description |
|---|---|
acceptanceStatus - AcceptanceStatusInput
|
|
ackType - String
|
|
ackTypes - [String]
|
|
addressFields - [AddressInput]
|
|
albertsonsDepartmentNumber - String
|
|
alphaCodes - [String]
|
|
appAdviceTransferStatus - String
|
|
arrivedAtCustomsDates - [Date]
|
|
arrivedAtTerminalLocationsDates - [Date]
|
|
arrivedDates - [Date]
|
|
availableForDeliveryDates - [Date]
|
|
billOfLadingNumbers - [String]
|
|
billOfLadingReleasedDates - [Date]
|
|
billToAddress - AddressInput
|
|
billToParty - AddressInput
|
|
bodID - String
|
|
bodIDVersion - String
|
|
bookingConfirmedDates - [Date]
|
|
bookingNumbers - [String]
|
|
businessPartner - PartyInformationInput
|
|
businessPartnerIdentifiers - [IdPairInput]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyerIdentification - String
|
|
buyingParty - AddressInput
|
|
calculatedSACTotalAmount - Float
|
|
calculatedTotalAmount - Float
|
|
canDownloadOriginalFile - Boolean
|
|
cancelAfterDate - Date
|
|
cancelIfNotShippedByDate - Date
|
|
cargoReceivedAtContractualPlaceOfReceiptDates - [Date]
|
|
carrierAndCustomsReleaseDates - [Date]
|
|
carrierReleaseDates - [Date]
|
|
commenters - [UserInfoInput]
|
|
companyID - String
|
|
completedUnloadingAtDeliveryLocationDates - [Date]
|
|
contactRepresentations - [ContactRepresentationInput]
|
|
containerID - String
|
|
conversation_id - String
|
|
currency - String
|
|
customsReleasedDates - [Date]
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deferredPaymentDate - Date
|
|
deliveryAppointmentDates - [Date]
|
|
deliveryRequested - Date
|
|
deliveryRequestedDate - Date
|
|
departedPickupLocationDates - [Date]
|
|
departmentNumberText - String
|
|
doNotDeliverAfter - Date
|
|
doNotDeliverAfterDate - Date
|
|
doNotDeliverBefore - Date
|
|
doNotDeliverBeforeDate - Date
|
|
docType - String
|
|
dtmDates - [DTMDateInput]
|
|
emptyEquipmentDispatchedDates - [Date]
|
|
entityID - String
|
|
environment - String
|
|
equipmentNumberN9Segments - [String]
|
|
errorCodes - [String]
|
|
estimatedDeliveryDates - [Date]
|
|
estimatedToArriveDates - [Date]
|
|
estimatedToDepartTerminalLocationDates - [Date]
|
|
expectedReply - Date
|
|
expectedShipDate - Date
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasCreditDebitAdjustment - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasInvoice - Boolean
|
|
hasPOChange - Boolean
|
|
hasPurchaseOrderAcknowledgment - Boolean
|
|
hasPurchaseOrderChange - Boolean
|
|
hasRemittanceAdvice - Boolean
|
|
hasReturnMerchandiseAuthorization - Boolean
|
|
hasStatusDetail - Boolean
|
|
hasWarehouseShippingAdvice - Boolean
|
|
hasWarehouseShippingOrder - Boolean
|
|
hasWarehouseStockTransferShipmentAdvice - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
internalVendorNumber - String
|
|
invoiceDates - [Date]
|
|
invoiceNumberCount - Int
|
|
invoiceNumbers - [String]
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
loadedOnRailDates - [Date]
|
|
loadedOnTruckDates - [Date]
|
|
loadedOnVesselDates - [Date]
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
oceanShipmentStatusCodes - [String]
|
|
oceanShipmentStatuses - [String]
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
paymentDates - [Date]
|
|
poAndAsnVendorNumbersMatch - Boolean
|
|
poDate - Date
|
|
poNumber - String
|
|
poType - String
|
|
pocDates - [Date]
|
|
providedTotalAmount - Float
|
|
purposeCodes - [String]
|
|
railDepartureFromOriginIntermodalRampsDates - [Date]
|
|
receivedAtOriginDates - [Date]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegmentInput]
|
|
releaseDate - Date
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
requestedForDeliveryDatePriorTo - Date
|
|
requestedForDeliveryDateWeekOf - Date
|
|
requestedForShipmentDateWeekOf - Date
|
|
requestedPickup - Date
|
|
requestedShipDate - Date
|
|
returnedToCarriersTerminalDates - [Date]
|
|
returnedToShipperDates - [Date]
|
|
sacItems - [SACInput]
|
|
salesReqCode - String
|
|
sendFrom - PartyInformationInput
|
|
sendTo - PartyInformationInput
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
shipFrom - AddressInput
|
|
shipMethodPayment - String
|
|
shipNoLaterDate - Date
|
|
shipNotBeforeDate - Date
|
|
shipTo - AddressInput
|
|
shipToAddress - AddressInput
|
|
shipToCompany - CompanyInput
|
|
shipmentCancelledDates - [Date]
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shippingMethod - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - AddressInput
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegmentInput]
|
|
textMessages - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - Float
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
tsPurposeCodes - [String]
|
|
type - String
|
|
units - String
|
|
unitsOfMeasure - [String]
|
|
vendor - AddressInput
|
|
vendorIdNumber - String
|
|
vendorIdNumberAsn - String
|
|
vendorNumber - String
|
|
vendorNumbers - [String]
|
|
vendorOrderNumber - String
|
|
vendorOrderNumberAsn - String
|
|
watchers - [String]
|
|
webOrderNumber - String
|
|
weight - Float
|
|
weightUOM - String
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatusInput,
"ackType": "abc123",
"ackTypes": ["xyz789"],
"addressFields": [AddressInput],
"albertsonsDepartmentNumber": "xyz789",
"alphaCodes": ["abc123"],
"appAdviceTransferStatus": "xyz789",
"arrivedAtCustomsDates": ["2007-12-03"],
"arrivedAtTerminalLocationsDates": [
"2007-12-03"
],
"arrivedDates": ["2007-12-03"],
"availableForDeliveryDates": [
"2007-12-03"
],
"billOfLadingNumbers": ["abc123"],
"billOfLadingReleasedDates": [
"2007-12-03"
],
"billToAddress": AddressInput,
"billToParty": AddressInput,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"bookingConfirmedDates": ["2007-12-03"],
"bookingNumbers": ["abc123"],
"businessPartner": PartyInformationInput,
"businessPartnerIdentifiers": [IdPairInput],
"businessPartnerStrictIdEnabled": true,
"buyerIdentification": "xyz789",
"buyingParty": AddressInput,
"calculatedSACTotalAmount": 987.65,
"calculatedTotalAmount": 987.65,
"canDownloadOriginalFile": false,
"cancelAfterDate": "2007-12-03",
"cancelIfNotShippedByDate": "2007-12-03",
"cargoReceivedAtContractualPlaceOfReceiptDates": [
"2007-12-03"
],
"carrierAndCustomsReleaseDates": [
"2007-12-03"
],
"carrierReleaseDates": ["2007-12-03"],
"commenters": [UserInfoInput],
"companyID": "xyz789",
"completedUnloadingAtDeliveryLocationDates": [
"2007-12-03"
],
"contactRepresentations": [ContactRepresentationInput],
"containerID": "abc123",
"conversation_id": "xyz789",
"currency": "abc123",
"customsReleasedDates": ["2007-12-03"],
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"deferredPaymentDate": "2007-12-03",
"deliveryAppointmentDates": [
"2007-12-03"
],
"deliveryRequested": "2007-12-03",
"deliveryRequestedDate": "2007-12-03",
"departedPickupLocationDates": [
"2007-12-03"
],
"departmentNumberText": "abc123",
"doNotDeliverAfter": "2007-12-03",
"doNotDeliverAfterDate": "2007-12-03",
"doNotDeliverBefore": "2007-12-03",
"doNotDeliverBeforeDate": "2007-12-03",
"docType": "xyz789",
"dtmDates": [DTMDateInput],
"emptyEquipmentDispatchedDates": [
"2007-12-03"
],
"entityID": "abc123",
"environment": "abc123",
"equipmentNumberN9Segments": ["xyz789"],
"errorCodes": ["xyz789"],
"estimatedDeliveryDates": ["2007-12-03"],
"estimatedToArriveDates": ["2007-12-03"],
"estimatedToDepartTerminalLocationDates": [
"2007-12-03"
],
"expectedReply": "2007-12-03",
"expectedShipDate": "2007-12-03",
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": false,
"hasCreditDebitAdjustment": true,
"hasErrors": false,
"hasExceptions": false,
"hasInvoice": false,
"hasPOChange": false,
"hasPurchaseOrderAcknowledgment": false,
"hasPurchaseOrderChange": true,
"hasRemittanceAdvice": false,
"hasReturnMerchandiseAuthorization": true,
"hasStatusDetail": false,
"hasWarehouseShippingAdvice": true,
"hasWarehouseShippingOrder": false,
"hasWarehouseStockTransferShipmentAdvice": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumberCount": 987,
"invoiceNumbers": ["abc123"],
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"loadedOnRailDates": ["2007-12-03"],
"loadedOnTruckDates": ["2007-12-03"],
"loadedOnVesselDates": ["2007-12-03"],
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 987,
"oceanShipmentStatusCodes": ["abc123"],
"oceanShipmentStatuses": ["abc123"],
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"paymentDates": ["2007-12-03"],
"poAndAsnVendorNumbersMatch": true,
"poDate": "2007-12-03",
"poNumber": "xyz789",
"poType": "abc123",
"pocDates": ["2007-12-03"],
"providedTotalAmount": 987.65,
"purposeCodes": ["xyz789"],
"railDepartureFromOriginIntermodalRampsDates": [
"2007-12-03"
],
"receivedAtOriginDates": ["2007-12-03"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegmentInput],
"releaseDate": "2007-12-03",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"requestedForDeliveryDatePriorTo": "2007-12-03",
"requestedForDeliveryDateWeekOf": "2007-12-03",
"requestedForShipmentDateWeekOf": "2007-12-03",
"requestedPickup": "2007-12-03",
"requestedShipDate": "2007-12-03",
"returnedToCarriersTerminalDates": [
"2007-12-03"
],
"returnedToShipperDates": ["2007-12-03"],
"sacItems": [SACInput],
"salesReqCode": "xyz789",
"sendFrom": PartyInformationInput,
"sendTo": PartyInformationInput,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"shipFrom": AddressInput,
"shipMethodPayment": "xyz789",
"shipNoLaterDate": "2007-12-03",
"shipNotBeforeDate": "2007-12-03",
"shipTo": AddressInput,
"shipToAddress": AddressInput,
"shipToCompany": CompanyInput,
"shipmentCancelledDates": ["2007-12-03"],
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 987,
"shipmentNumbers": ["xyz789"],
"shippingMethod": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierOrManufacturer": AddressInput,
"testIndicator": "INFORMATION",
"textInfo": [TextSegmentInput],
"textMessages": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": 123.45,
"totalQuantity": 987.65,
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"transactionTypeCode": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"tsPurposeCodes": ["xyz789"],
"type": "xyz789",
"units": "xyz789",
"unitsOfMeasure": ["xyz789"],
"vendor": AddressInput,
"vendorIdNumber": "abc123",
"vendorIdNumberAsn": "xyz789",
"vendorNumber": "xyz789",
"vendorNumbers": ["xyz789"],
"vendorOrderNumber": "xyz789",
"vendorOrderNumberAsn": "xyz789",
"watchers": ["abc123"],
"webOrderNumber": "abc123",
"weight": 123.45,
"weightUOM": "abc123",
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"]
}
¶ RailCarrierInvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
consignee - Address
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
currency - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
destinationCity - String
|
|
destinationPointLocationCode - String
|
|
destinationState - String
|
|
destinationStationCode - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
equipmentDetails - [EquipmentInformation]
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
invoiceAmount - Float
|
|
invoiceDate - Date
|
|
invoiceDueDate - Date
|
|
invoiceNumber - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originCity - String
|
|
originPointLocationCode - String
|
|
originState - String
|
|
originStationCode - String
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyToBeBilled - Address
|
|
partyToReceiveFreightBill - Address
|
|
paymentMethod - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
remitTo - Address
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routeInformation - [RouteInfo]
|
|
routing - String
|
|
scacCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shipper - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
waybillReferences - [WaybillRefInfo]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"consignee": Address,
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "abc123",
"currency": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"destinationCity": "xyz789",
"destinationPointLocationCode": "xyz789",
"destinationState": "xyz789",
"destinationStationCode": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"equipmentDetails": [EquipmentInformation],
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"invoiceAmount": 987.65,
"invoiceDate": "2007-12-03",
"invoiceDueDate": "2007-12-03",
"invoiceNumber": "abc123",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 987,
"originCity": "abc123",
"originPointLocationCode": "abc123",
"originState": "abc123",
"originStationCode": "abc123",
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"partyToBeBilled": Address,
"partyToReceiveFreightBill": Address,
"paymentMethod": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"remitTo": Address,
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routeInformation": [RouteInfo],
"routing": "abc123",
"scacCode": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"shipmentID": "abc123",
"shipper": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"waybillReferences": [WaybillRefInfo],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RailCarrierShipmentDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
consignee - Address
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
customsBroker - Address
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
destinationStation - Station
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
equipmentDetails - [EquipmentInformation]
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originStation - Station
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyToBeBilled - Address
|
|
partyToReceiveFreightBill - Address
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
releaseCode - String
|
|
releaseDate - Date
|
|
releaseTimeZone - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routeInformation - [RouteInfo]
|
|
routing - String
|
|
scacCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shipper - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"consignee": Address,
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"customsBroker": Address,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"destinationStation": Station,
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"equipmentDetails": [EquipmentInformation],
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 123,
"originStation": Station,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"partyToBeBilled": Address,
"partyToReceiveFreightBill": Address,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"releaseCode": "xyz789",
"releaseDate": "2007-12-03",
"releaseTimeZone": "abc123",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routeInformation": [RouteInfo],
"routing": "xyz789",
"scacCode": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"shipmentID": "xyz789",
"shipper": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RailCarrierWaybillDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
consignee - Address
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
destinationStation - Station
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
equipmentDetails - [EquipmentInformation]
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originStation - Station
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyAtPickupLocation - Address
|
|
partyToBeBilled - Address
|
|
partyToReceiveFreightBill - Address
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routeInformation - [RouteInfo]
|
|
routing - String
|
|
scacCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipPaymentMethod - String
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shipmentQualifier - String
|
|
shipper - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"consignee": Address,
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"destinationStation": Station,
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"equipmentDetails": [EquipmentInformation],
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originStation": Station,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"partyAtPickupLocation": Address,
"partyToBeBilled": Address,
"partyToReceiveFreightBill": Address,
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routeInformation": [RouteInfo],
"routing": "xyz789",
"scacCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipPaymentMethod": "abc123",
"shipToAddress": Address,
"shipmentID": "xyz789",
"shipmentQualifier": "abc123",
"shipper": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RawError
¶ Fields
| Field Name | Description |
|---|---|
applicationAckCode - String
|
|
badData - String
|
|
description - String
|
|
elementErrorCode - String
|
|
elementPos - String
|
|
errorCode - String
|
|
errorLocation - String
|
|
idCode - String
|
|
message - String
|
|
notes - [String]
|
|
rejectionReason - String
|
|
segmentPos - String
|
|
sourceDisplayName - String
|
|
sourceId - String
|
|
sourceTimestamp - Date
|
|
sourceType - String
|
¶ Example
{
"applicationAckCode": "xyz789",
"badData": "abc123",
"description": "xyz789",
"elementErrorCode": "abc123",
"elementPos": "xyz789",
"errorCode": "abc123",
"errorLocation": "xyz789",
"idCode": "abc123",
"message": "abc123",
"notes": ["abc123"],
"rejectionReason": "xyz789",
"segmentPos": "xyz789",
"sourceDisplayName": "abc123",
"sourceId": "abc123",
"sourceTimestamp": "2007-12-03",
"sourceType": "abc123"
}
¶ ReceivingAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
appointmentArrivalDate - Date
|
|
appointmentID - String
|
|
appointmentScheduledDate - Date
|
|
billOfLadingNumber - String
|
|
billOfLadingNumbers - [String]
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
generalConditionCode - String
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isFollowUp - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
mutuallyDefinedRef - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumbers - [String]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiveAdviceCode - String
|
|
receiveAdviceDate - Date
|
|
received - Date
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
receivingCompanyID - String
|
|
refIdent - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shippersID - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"appointmentArrivalDate": "2007-12-03",
"appointmentID": "xyz789",
"appointmentScheduledDate": "2007-12-03",
"billOfLadingNumber": "xyz789",
"billOfLadingNumbers": ["abc123"],
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"buyingParty": Address,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"generalConditionCode": "abc123",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isFollowUp": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"mutuallyDefinedRef": "abc123",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"poNumbers": ["xyz789"],
"primary": false,
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiveAdviceCode": "xyz789",
"receiveAdviceDate": "2007-12-03",
"received": "2007-12-03",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"receivingCompanyID": "abc123",
"refIdent": "xyz789",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipTo": Address,
"shipToAddress": Address,
"shippersID": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supplierOrManufacturer": Address,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RefSegment
¶ RefSegmentInput
¶ Reference
¶ ReferenceInput
¶ RemittanceAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
adjustments - [Adjustment]
|
|
appAdviceTransferStatus - String
|
|
billOfLadingNumber - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
carrierReferenceNumber - String
|
|
categoryFacet - CategoryFacet
|
|
checkNumber - String
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
currency - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
forwarder - Address
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasAdvanceShipNotice - Boolean
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasInvoice - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
invoiceDates - [Date]
|
|
invoiceNumber - String
|
|
invoiceNumberCount - Int
|
|
invoiceNumbers - [String]
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
mutuallyDefined - Address
|
|
mutuallyDefinedRef - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
payee - Address
|
|
payer - Address
|
|
paymentDate - Date
|
|
poDates - [Date]
|
|
poNumberCount - Int
|
|
poNumbers - [String]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
receivingBank - Address
|
|
receivingCompanyID - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentDates - [Date]
|
|
shipmentNumberCount - Int
|
|
shipmentNumbers - [String]
|
|
shippersID - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalAmount - String
|
|
totalAmountPaid - Float
|
|
totalDifference - String
|
|
totalInvoicedAmount - String
|
|
totalPaidAmount - String
|
|
trackingNumber - String
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"adjustments": [Adjustment],
"appAdviceTransferStatus": "abc123",
"billOfLadingNumber": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"carrierReferenceNumber": "xyz789",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"checkNumber": "abc123",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"currency": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"forwarder": Address,
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasAdvanceShipNotice": true,
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hasInvoice": true,
"hasPurchaseOrder": true,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"internalVendorNumber": "xyz789",
"invoiceDates": ["2007-12-03"],
"invoiceNumber": "xyz789",
"invoiceNumberCount": 123,
"invoiceNumbers": ["xyz789"],
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"mutuallyDefined": Address,
"mutuallyDefinedRef": "xyz789",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"payee": Address,
"payer": Address,
"paymentDate": "2007-12-03",
"poDates": ["2007-12-03"],
"poNumberCount": 987,
"poNumbers": ["abc123"],
"primary": false,
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"receivingBank": Address,
"receivingCompanyID": "xyz789",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"shipmentDates": ["2007-12-03"],
"shipmentNumberCount": 123,
"shipmentNumbers": ["xyz789"],
"shippersID": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalAmount": "xyz789",
"totalAmountPaid": 987.65,
"totalDifference": "abc123",
"totalInvoicedAmount": "abc123",
"totalPaidAmount": "abc123",
"trackingNumber": "abc123",
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ReplaySftpConfiguration
¶ Example
{
"companyID": "abc123",
"distPath": "abc123",
"environment": "abc123",
"host": "xyz789",
"id": "xyz789",
"knownHosts": "abc123",
"password": "xyz789",
"port": 987,
"timestamp": "2007-12-03",
"userName": "xyz789"
}
¶ ReplaySftpConfigurationInput
¶ Example
{
"companyID": "xyz789",
"distPath": "xyz789",
"environment": "abc123",
"host": "xyz789",
"id": "abc123",
"knownHosts": "abc123",
"password": "xyz789",
"port": 123,
"timestamp": "2007-12-03",
"userName": "xyz789"
}
¶ ReportOfTestResultsDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
partyToReceiveTestReport - Address
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reportTypeCode - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
securityCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
testingLaboratory - Address
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionDate - Date
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"partyToReceiveTestReport": Address,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "abc123",
"referenceInfo": [RefSegment],
"reportTypeCode": "abc123",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"securityCode": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"testingLaboratory": Address,
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionDate": "2007-12-03",
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RepositoryFile
¶ Fields
| Field Name | Description |
|---|---|
comments - String
|
|
companyID - String
|
|
content - String
|
|
defaultVersion - String
|
|
directions - String
|
|
docType - String
|
|
documentType - String
|
|
enable - Boolean!
|
|
environment - String
|
|
fileType - String
|
|
id - String
|
|
indexName - String
|
|
inputFormat - String
|
|
name - String
|
|
outputFormat - String
|
|
partner - String
|
|
readOnly - Boolean!
|
|
routing - String
|
|
size - Long!
|
|
standards - String
|
|
tags - [String]
|
|
template - Boolean!
|
|
timestamp - Date
|
|
xsltMapVersionIds - [String]
|
¶ Example
{
"comments": "xyz789",
"companyID": "abc123",
"content": "abc123",
"defaultVersion": "xyz789",
"directions": "abc123",
"docType": "xyz789",
"documentType": "abc123",
"enable": true,
"environment": "abc123",
"fileType": "xyz789",
"id": "xyz789",
"indexName": "abc123",
"inputFormat": "abc123",
"name": "xyz789",
"outputFormat": "xyz789",
"partner": "xyz789",
"readOnly": false,
"routing": "abc123",
"size": {},
"standards": "xyz789",
"tags": ["xyz789"],
"template": false,
"timestamp": "2007-12-03",
"xsltMapVersionIds": ["xyz789"]
}
¶ RepositoryFileMetadataInput
¶ Example
{
"comments": "xyz789",
"content": "abc123",
"directions": "abc123",
"documentType": "xyz789",
"inputFormat": "xyz789",
"name": "abc123",
"outputFormat": "abc123",
"partner": "abc123",
"standards": "xyz789",
"tags": ["xyz789"]
}
¶ RequestForRoutingInstructionsDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumbers - [String]
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
routingRequestCreationDate - Date
|
|
routingRequestId - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFromAddress - Address
|
|
shipToAddress - Address
|
|
shipmentReferenceId - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"poNumbers": ["abc123"],
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"routingRequestCreationDate": "2007-12-03",
"routingRequestId": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipFromAddress": Address,
"shipToAddress": Address,
"shipmentReferenceId": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "xyz789",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ResponseToLoadTenderDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
acceptedBookingDate - Date
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
reserveActionCode - String
|
|
routing - String
|
|
scac - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"acceptedBookingDate": "2007-12-03",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"reserveActionCode": "abc123",
"routing": "xyz789",
"scac": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"shipmentID": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ Results_AdvanceShipNoticeDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [AdvanceShipNoticeDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [AdvanceShipNoticeDocument],
"totalItems": {}
}
¶ Results_ApplicationAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ApplicationAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ApplicationAdviceDocument],
"totalItems": {}
}
¶ Results_BaseBusinessDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [BaseBusinessDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [BaseBusinessDocument],
"totalItems": {}
}
¶ Results_BaseMFTException
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [BaseMFTException]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [BaseMFTException],
"totalItems": {}
}
¶ Results_BusinessPartner
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [BusinessPartner]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [BusinessPartner],
"totalItems": {}
}
¶ Results_Comments
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [Comments]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [Comments],
"totalItems": {}
}
¶ Results_CreditDebitAdjustmentDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [CreditDebitAdjustmentDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [CreditDebitAdjustmentDocument],
"totalItems": {}
}
¶ Results_DashboardConfig
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [DashboardConfig]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [DashboardConfig],
"totalItems": {}
}
¶ Results_DeliveryReturnAckAdjDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [DeliveryReturnAckAdjDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [DeliveryReturnAckAdjDocument],
"totalItems": {}
}
¶ Results_DeliveryReturnBaseRecordDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [DeliveryReturnBaseRecordDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [DeliveryReturnBaseRecordDocument],
"totalItems": {}
}
¶ Results_Environment
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [Environment]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [Environment],
"totalItems": {}
}
¶ Results_EventSummary
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [EventSummary]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [EventSummary],
"totalItems": {}
}
¶ Results_FileMetadata
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [FileMetadata]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [FileMetadata],
"totalItems": {}
}
¶ Results_FunctionalAcknowledgmentDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [FunctionalAcknowledgmentDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [FunctionalAcknowledgmentDocument],
"totalItems": {}
}
¶ Results_GalleryItem
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [GalleryItem]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [GalleryItem],
"totalItems": {}
}
¶ Results_GroceryProductsInvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [GroceryProductsInvoiceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [GroceryProductsInvoiceDocument],
"totalItems": {}
}
¶ Results_GroceryProductsPurchaseOrderDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [GroceryProductsPurchaseOrderDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [GroceryProductsPurchaseOrderDocument],
"totalItems": {}
}
¶ Results_Group
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [Group]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [Group],
"totalItems": {}
}
¶ Results_InventoryInquiryAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [InventoryInquiryAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [InventoryInquiryAdviceDocument],
"totalItems": {}
}
¶ Results_InvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [InvoiceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [InvoiceDocument],
"totalItems": {}
}
¶ Results_ItemMaintenanceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ItemMaintenanceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ItemMaintenanceDocument],
"totalItems": {}
}
¶ Results_LockboxDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [LockboxDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [LockboxDocument],
"totalItems": {}
}
¶ Results_MotorCarrierBillOfLadingDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [MotorCarrierBillOfLadingDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [MotorCarrierBillOfLadingDocument],
"totalItems": {}
}
¶ Results_MotorCarrierFreightDetailsAndInvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [MotorCarrierFreightDetailsAndInvoiceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [MotorCarrierFreightDetailsAndInvoiceDocument],
"totalItems": {}
}
¶ Results_MotorCarrierLoadTenderDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [MotorCarrierLoadTenderDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [MotorCarrierLoadTenderDocument],
"totalItems": {}
}
¶ Results_OrderStatusReportDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [OrderStatusReportDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [OrderStatusReportDocument],
"totalItems": {}
}
¶ Results_OrganizationalRelationshipsDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [OrganizationalRelationshipsDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [OrganizationalRelationshipsDocument],
"totalItems": {}
}
¶ Results_PartnerContactRecord
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PartnerContactRecord]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PartnerContactRecord],
"totalItems": {}
}
¶ Results_PartnerProtocol
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PartnerProtocol]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PartnerProtocol],
"totalItems": {}
}
¶ Results_PlanningScheduleDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PlanningScheduleDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PlanningScheduleDocument],
"totalItems": {}
}
¶ Results_PriceAuthorizationAcknowledgmentDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PriceAuthorizationAcknowledgmentDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PriceAuthorizationAcknowledgmentDocument],
"totalItems": {}
}
¶ Results_PriceInformationDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PriceInformationDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PriceInformationDocument],
"totalItems": {}
}
¶ Results_PriceSalesCatalogDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PriceSalesCatalogDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PriceSalesCatalogDocument],
"totalItems": {}
}
¶ Results_ProductActivityDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ProductActivityDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ProductActivityDocument],
"totalItems": {}
}
¶ Results_ProductTransferAccountAdjustmentDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ProductTransferAccountAdjustmentDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ProductTransferAccountAdjustmentDocument],
"totalItems": {}
}
¶ Results_ProductTransferAccountAdjustmentResponseDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ProductTransferAccountAdjustmentResponseDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [
ProductTransferAccountAdjustmentResponseDocument
],
"totalItems": {}
}
¶ Results_ProductTransferAndResaleReportDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ProductTransferAndResaleReportDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ProductTransferAndResaleReportDocument],
"totalItems": {}
}
¶ Results_PromotionAnnouncementDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PromotionAnnouncementDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PromotionAnnouncementDocument],
"totalItems": {}
}
¶ Results_PurchaseOrderAcknowledgmentDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PurchaseOrderAcknowledgmentDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PurchaseOrderAcknowledgmentDocument],
"totalItems": {}
}
¶ Results_PurchaseOrderChangeDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PurchaseOrderChangeDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PurchaseOrderChangeDocument],
"totalItems": {}
}
¶ Results_PurchaseOrderDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [PurchaseOrderDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [PurchaseOrderDocument],
"totalItems": {}
}
¶ Results_RailCarrierInvoiceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RailCarrierInvoiceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RailCarrierInvoiceDocument],
"totalItems": {}
}
¶ Results_RailCarrierShipmentDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RailCarrierShipmentDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RailCarrierShipmentDocument],
"totalItems": {}
}
¶ Results_RailCarrierWaybillDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RailCarrierWaybillDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RailCarrierWaybillDocument],
"totalItems": {}
}
¶ Results_ReceivingAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ReceivingAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ReceivingAdviceDocument],
"totalItems": {}
}
¶ Results_RemittanceAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RemittanceAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RemittanceAdviceDocument],
"totalItems": {}
}
¶ Results_ReportOfTestResultsDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ReportOfTestResultsDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ReportOfTestResultsDocument],
"totalItems": {}
}
¶ Results_RepositoryFile
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RepositoryFile]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RepositoryFile],
"totalItems": {}
}
¶ Results_RequestForRoutingInstructionsDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RequestForRoutingInstructionsDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RequestForRoutingInstructionsDocument],
"totalItems": {}
}
¶ Results_ResponseToLoadTenderDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ResponseToLoadTenderDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ResponseToLoadTenderDocument],
"totalItems": {}
}
¶ Results_ReturnMerchandiseAuthorizationDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ReturnMerchandiseAuthorizationDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ReturnMerchandiseAuthorizationDocument],
"totalItems": {}
}
¶ Results_RoutingInstructionsDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [RoutingInstructionsDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [RoutingInstructionsDocument],
"totalItems": {}
}
¶ Results_ShipmentBillingNoticeDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ShipmentBillingNoticeDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ShipmentBillingNoticeDocument],
"totalItems": {}
}
¶ Results_ShippingScheduleDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [ShippingScheduleDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [ShippingScheduleDocument],
"totalItems": {}
}
¶ Results_StatusDetailsDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [StatusDetailsDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [StatusDetailsDocument],
"totalItems": {}
}
¶ Results_String
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [String]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": ["xyz789"],
"totalItems": {}
}
¶ Results_TextMessageDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [TextMessageDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [TextMessageDocument],
"totalItems": {}
}
¶ Results_Token
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [Token]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [Token],
"totalItems": {}
}
¶ Results_TransportationCarrierShipmentStatusMessageDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [TransportationCarrierShipmentStatusMessageDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [
TransportationCarrierShipmentStatusMessageDocument
],
"totalItems": {}
}
¶ Results_UserDetails
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [UserDetails]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [UserDetails],
"totalItems": {}
}
¶ Results_WarehouseInventoryAdjustmentAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [WarehouseInventoryAdjustmentAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseInventoryAdjustmentAdviceDocument],
"totalItems": {}
}
¶ Results_WarehouseShippingAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [WarehouseShippingAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseShippingAdviceDocument],
"totalItems": {}
}
¶ Results_WarehouseShippingOrderDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [WarehouseShippingOrderDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseShippingOrderDocument],
"totalItems": {}
}
¶ Results_WarehouseStockTransferReceiptAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [WarehouseStockTransferReceiptAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseStockTransferReceiptAdviceDocument],
"totalItems": {}
}
¶ Results_WarehouseStockTransferShipmentAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [WarehouseStockTransferShipmentAdviceDocument]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [WarehouseStockTransferShipmentAdviceDocument],
"totalItems": {}
}
¶ Results_XSLTMapVersion
¶ Fields
| Field Name | Description |
|---|---|
aggregations - Map_String_ObjectScalar
|
|
items - [XSLTMapVersion]
|
|
totalItems - Long!
|
¶ Example
{
"aggregations": Map_String_ObjectScalar,
"items": [XSLTMapVersion],
"totalItems": {}
}
¶ ReturnMerchandiseAuthorizationDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionDate - Date
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hasPurchaseOrder": false,
"hierarchyStructure": ["abc123"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"poNumber": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "xyz789",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionDate": "2007-12-03",
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RouteInfo
¶ RoutingInstructionsDocument
¶ Fields
| Field Name | Description |
|---|---|
PONumber - String
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumberCount - Int!
|
|
poNumbers - [String]
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
purposeCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
routingRequestId - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFromAddresses - [Address]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"PONumber": "xyz789",
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "xyz789",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"poNumberCount": 987,
"poNumbers": ["xyz789"],
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"purposeCode": "xyz789",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"routingRequestId": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFromAddresses": [Address],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ RuleType
¶ SAC
¶ Example
{
"allowChrgIndicator": "abc123",
"allowance": 123.45,
"amount": 987.65,
"description": "xyz789",
"handlingMethod": "xyz789",
"id": 123,
"quantity": 987,
"serviceCode": "xyz789"
}
¶ SACInput
¶ Example
{
"allowChrgIndicator": "abc123",
"allowance": 123.45,
"amount": 123.45,
"description": "abc123",
"handlingMethod": "abc123",
"id": 987,
"quantity": 987,
"serviceCode": "xyz789"
}
¶ SDQInfo
¶ SDQInfoInput
¶ SearchRequestInput
¶ Fields
| Input Field | Description |
|---|---|
aggregations - [Aggregation_ObjectInput]
|
|
filters - [Filter_ObjectInput]
|
|
page - Int!
|
|
size - Int!
|
|
sort - SortDefinitionInput
|
¶ Example
{
"aggregations": [Aggregation_ObjectInput],
"filters": [Filter_ObjectInput],
"page": 123,
"size": 123,
"sort": SortDefinitionInput
}
¶ ShipmentBillingNoticeDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructCode - String
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionDate - Date
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
tsTypeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": true,
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructCode": "xyz789",
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "xyz789",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionDate": "2007-12-03",
"transactionEnd": 123,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"tsPurposeCode": "abc123",
"tsTypeCode": "xyz789",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ ShipmentStatusDetails
¶ Example
{
"apptDateTimeCode": "abc123",
"date": "2007-12-03",
"shipStatApptReasonCode": "xyz789",
"shipStatApptReasonCode2": "xyz789",
"shipmentApptStatusCode": "xyz789",
"shipmentStatusCode": "abc123",
"statusApptDate": {},
"transLx": 123
}
¶ ShippingScheduleDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
buyingParty - Address
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
contractNumber - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
endDate - Date
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
errorsCollection - Boolean!
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
forecastGenDate - Date
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
messageFrom - Address
|
|
messageTo - Address
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
refIdent - String
|
|
referenceInfo - [RefSegment]
|
|
reportedPoNumbers - [String]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
rootNode - TreeNode
|
|
routing - String
|
|
schQtyQual - String
|
|
schTypQual - String
|
|
sellerParty - Address
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
startDate - Date
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supplierOrManufacturer - Address
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"buyingParty": Address,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"contractNumber": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"endDate": "2007-12-03",
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"errorsCollection": false,
"filename": "xyz789",
"flowDirection": "inbound",
"forecastGenDate": "2007-12-03",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"messageFrom": Address,
"messageTo": Address,
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"refIdent": "xyz789",
"referenceInfo": [RefSegment],
"reportedPoNumbers": ["abc123"],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"rootNode": TreeNode,
"routing": "abc123",
"schQtyQual": "abc123",
"schTypQual": "abc123",
"sellerParty": Address,
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"startDate": "2007-12-03",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supplierOrManufacturer": Address,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"tsPurposeCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ SortDefinitionInput
¶ Fields
| Input Field | Description |
|---|---|
direction - SortDirection
|
|
sortBy - String
|
¶ Example
{"direction": "ASC", "sortBy": "xyz789"}
¶ SortDirection
¶ SourceType
¶ Split
¶ Example
{
"field": "xyz789",
"period": "abc123",
"shouldLimitSplit": true,
"shouldSplit": true,
"shouldSplitOnPeriod": false,
"splitLimit": 987
}
¶ SplitInput
¶ Example
{
"field": "abc123",
"period": "abc123",
"shouldLimitSplit": true,
"shouldSplit": true,
"shouldSplitOnPeriod": false,
"splitLimit": 987
}
¶ Station
¶ Status
¶ StatusDetailsDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
alphaCode - String
|
|
appAdviceTransferStatus - String
|
|
arrived - Date
|
|
arrivedAtCustoms - Date
|
|
arrivedAtTerminalLocation - Date
|
|
availableForDelivery - Date
|
|
billOfLadingNumber - String
|
|
billOfLadingReleased - Date
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
bookingConfirmed - Date
|
|
bookingNumber - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
cargoReceivedAtContractualPlaceOfReceipt - Date
|
|
carrierAndCustomsRelease - Date
|
|
carrierRelease - Date
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
completedUnloadingAtDeliveryLocation - Date
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
countryCode - String
|
|
customFields - Map_String_StringScalar
|
|
customsReleased - Date
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
date - Date
|
|
deliveryAppointment - Date
|
|
departedPickupLocation - Date
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
emptyEquipmentDispatched - Date
|
|
entityID - String
|
|
environment - String
|
|
equipmentInitial - String
|
|
equipmentNumber - String
|
|
equipmentNumberN9Segment - String
|
|
equipmentStatusCode - String
|
|
equipmentType - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
estimatedDelivery - Date
|
|
estimatedToArrive - Date
|
|
estimatedToDepartTerminalLocation - Date
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flightVoyageNumber - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
loadedOnRail - Date
|
|
loadedOnTruck - Date
|
|
loadedOnVessel - Date
|
|
locationIdentifier - String
|
|
locationQualifier - String
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
oceanShipmentStatus - String
|
|
oceanShipmentStatusCode - String
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
portAndDateReferences - [PortAndDateReference]
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
railDepartureFromOriginIntermodalRamp - Date
|
|
receivedAtOrigin - Date
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceIdent - String
|
|
referenceIdentQual - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
returnedToCarriersTerminal - Date
|
|
returnedToShipper - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentCancelled - Date
|
|
shipmentStatus - String
|
|
shipmentStatusCode - String
|
|
statusTime - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vesselCode - String
|
|
vesselCodeQualifier - String
|
|
vesselName - String
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"alphaCode": "xyz789",
"appAdviceTransferStatus": "xyz789",
"arrived": "2007-12-03",
"arrivedAtCustoms": "2007-12-03",
"arrivedAtTerminalLocation": "2007-12-03",
"availableForDelivery": "2007-12-03",
"billOfLadingNumber": "abc123",
"billOfLadingReleased": "2007-12-03",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"bookingConfirmed": "2007-12-03",
"bookingNumber": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"cargoReceivedAtContractualPlaceOfReceipt": "2007-12-03",
"carrierAndCustomsRelease": "2007-12-03",
"carrierRelease": "2007-12-03",
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"completedUnloadingAtDeliveryLocation": "2007-12-03",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"countryCode": "abc123",
"customFields": Map_String_StringScalar,
"customsReleased": "2007-12-03",
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"date": "2007-12-03",
"deliveryAppointment": "2007-12-03",
"departedPickupLocation": "2007-12-03",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"emptyEquipmentDispatched": "2007-12-03",
"entityID": "xyz789",
"environment": "abc123",
"equipmentInitial": "abc123",
"equipmentNumber": "abc123",
"equipmentNumberN9Segment": "abc123",
"equipmentStatusCode": "xyz789",
"equipmentType": "xyz789",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"estimatedDelivery": "2007-12-03",
"estimatedToArrive": "2007-12-03",
"estimatedToDepartTerminalLocation": "2007-12-03",
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flightVoyageNumber": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"loadedOnRail": "2007-12-03",
"loadedOnTruck": "2007-12-03",
"loadedOnVessel": "2007-12-03",
"locationIdentifier": "xyz789",
"locationQualifier": "abc123",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 123,
"oceanShipmentStatus": "abc123",
"oceanShipmentStatusCode": "xyz789",
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"poNumber": "xyz789",
"portAndDateReferences": [PortAndDateReference],
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"railDepartureFromOriginIntermodalRamp": "2007-12-03",
"receivedAtOrigin": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceIdent": "abc123",
"referenceIdentQual": "abc123",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"returnedToCarriersTerminal": "2007-12-03",
"returnedToShipper": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"shipmentCancelled": "2007-12-03",
"shipmentStatus": "xyz789",
"shipmentStatusCode": "xyz789",
"statusTime": "xyz789",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "xyz789",
"unknownFields": Map_String_ObjectScalar,
"vesselCode": "xyz789",
"vesselCodeQualifier": "abc123",
"vesselName": "abc123",
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ String
¶ SubOrg
¶ SubOrgDTO
¶ Fields
| Field Name | Description |
|---|---|
children - [SubOrgDTO]
|
|
companyID - String
|
|
id - String
|
|
identifiers - [CompanyBusinessIdentifier]
|
|
name - String
|
|
parentID - String
|
|
removeable - Boolean!
|
¶ Example
{
"children": [SubOrgDTO],
"companyID": "abc123",
"id": "abc123",
"identifiers": [CompanyBusinessIdentifier],
"name": "abc123",
"parentID": "abc123",
"removeable": true
}
¶ SubOrgDTOInput
¶ Fields
| Input Field | Description |
|---|---|
children - [SubOrgDTOInput]
|
|
companyID - String
|
|
id - String
|
|
identifiers - [CompanyBusinessIdentifierInput]
|
|
name - String
|
|
parentID - String
|
|
removeable - Boolean!
|
¶ Example
{
"children": [SubOrgDTOInput],
"companyID": "abc123",
"id": "xyz789",
"identifiers": [CompanyBusinessIdentifierInput],
"name": "abc123",
"parentID": "xyz789",
"removeable": true
}
¶ SupportedDate
¶ Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
¶ Example
"ACTUAL_APPOINTMENT"
¶ TaxInfo
¶ TaxInfoInput
¶ TextMessageDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
corporateOffice - Address
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
description - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
documentReference - String
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
messageFrom - Address
|
|
messageTo - Address
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
purposeCode - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
vendor - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"corporateOffice": Address,
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"description": "abc123",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"documentReference": "xyz789",
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["abc123"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "xyz789",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"messageFrom": Address,
"messageTo": Address,
"name": "abc123",
"numOfErrors": 987,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"purposeCode": "abc123",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"vendor": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ TextSegment
¶ TextSegmentInput
¶ Timeline
¶ Fields
| Field Name | Description |
|---|---|
bodID - String
|
|
businessPartner - PartyInformation
|
|
companyInfo - CompanyInfo
|
|
company_id - String
|
|
compositeKey - String
|
|
conversation - Conversation
|
|
endTime - Date
|
|
environment - String
|
|
exceededMaximumAmountOfItems - Boolean
|
|
flowDirection - DocumentFlowDirection
|
|
hasExceptions - Boolean
|
|
id - String
|
|
items - [String]
|
|
lastCommentedOn - Date
|
|
lastUpdated - Date
|
|
partnerInfo - CompanyInfo
|
|
sharedToCompanies - [String]
|
|
sharedToCompanyItems - [Company]
|
|
startTime - Date
|
|
subOrgId - String
|
|
timelineItems - [TimelineItem]
|
|
timelineVersion - Int
|
|
title - String
|
¶ Example
{
"bodID": "abc123",
"businessPartner": PartyInformation,
"companyInfo": CompanyInfo,
"company_id": "abc123",
"compositeKey": "abc123",
"conversation": Conversation,
"endTime": "2007-12-03",
"environment": "abc123",
"exceededMaximumAmountOfItems": false,
"flowDirection": "inbound",
"hasExceptions": true,
"id": "abc123",
"items": ["abc123"],
"lastCommentedOn": "2007-12-03",
"lastUpdated": "2007-12-03",
"partnerInfo": CompanyInfo,
"sharedToCompanies": ["xyz789"],
"sharedToCompanyItems": [Company],
"startTime": "2007-12-03",
"subOrgId": "xyz789",
"timelineItems": [TimelineItem],
"timelineVersion": 123,
"title": "xyz789"
}
¶ TimelineItem
¶ Fields
| Field Name | Description |
|---|---|
acknowledged - Boolean
|
|
acknowledgedOn - Date
|
|
allowedToView - Boolean!
|
|
applicationAdviceStatus - AcceptanceStatus
|
|
bodID - String
|
|
businessPartner - PartyInformation
|
|
customFields - Map_String_StringScalar
|
|
description - String
|
|
direction - DocumentFlowDirection
|
|
documentType - String
|
|
entityID - String
|
|
facet - CategoryFacet
|
|
functionalAcknowledgmentCode - String
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
hasApplicationAdvice - Boolean
|
|
id - String
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
processSubType - String
|
|
processType - String
|
|
techWorkflowID - String
|
|
timeStamp - Date
|
¶ Example
{
"acknowledged": false,
"acknowledgedOn": "2007-12-03",
"allowedToView": true,
"applicationAdviceStatus": AcceptanceStatus,
"bodID": "xyz789",
"businessPartner": PartyInformation,
"customFields": Map_String_StringScalar,
"description": "abc123",
"direction": "inbound",
"documentType": "xyz789",
"entityID": "abc123",
"facet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"functionalAcknowledgmentCode": "xyz789",
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"hasApplicationAdvice": true,
"id": "abc123",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "xyz789",
"processSubType": "xyz789",
"processType": "abc123",
"techWorkflowID": "xyz789",
"timeStamp": "2007-12-03"
}
¶ Token
¶ Example
{
"companyId": "xyz789",
"createdByUserId": "abc123",
"creationDate": "2007-12-03",
"environment": "xyz789",
"expirationDate": "2007-12-03",
"name": "xyz789",
"safeId": "xyz789",
"status": "ACTIVE",
"type": "UUID"
}
¶ TokenStatus
¶ TokenType
¶ TransactionHeaderSegment
¶ Example
{
"acknowledgementCode": "xyz789",
"acknowledgmentErrorCode": "abc123",
"functionalAcknowledgmentCode": "abc123",
"tsControlNumber": "abc123",
"tsIDCode": "abc123"
}
¶ TransactionHeaderSegmentInput
¶ Example
{
"acknowledgementCode": "abc123",
"acknowledgmentErrorCode": "xyz789",
"functionalAcknowledgmentCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123"
}
¶ TransactionProcessingPipeline
¶ Example
{
"companyID": "abc123",
"createdBy": UserDetails,
"environment": "xyz789",
"id": "abc123",
"lastUpdate": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03",
"type": "abc123"
}
¶ TransactionProcessingPipelineInput
¶ Example
{
"companyID": "abc123",
"createdBy": UserDetailsInput,
"environment": "abc123",
"id": "xyz789",
"lastUpdate": "2007-12-03",
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"stepsData": Map_String_Map_String_ObjectScalar,
"timestamp": "2007-12-03",
"type": "abc123"
}
¶ TransportationCarrierShipmentStatusMessageDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
arrivedAtDeliveryLocation - [Date]
|
|
arrivedAtPickUpLocation - [Date]
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
carrierDepartedDeliveryLocation - [Date]
|
|
carrierDepartedPickUpLocation - [Date]
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
condRespCode - String
|
|
consignee - Address
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
deliveryAppointmentDate - [Date]
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
inquiryReqNumber - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
pickUpAppointment - [Date]
|
|
poNumber - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
proNumber - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceID - String
|
|
referenceIDQualifier - String
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
scacCode - [String]
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shipmentStatus - String
|
|
shipmentStatusDetails - [ShipmentStatusDetails]
|
|
shipmentStatusReason - [String]
|
|
shipmentStatusReasonData - [String]
|
|
shipper - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
thirdPartyCorrelation - DocumentCorrelationPoint
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transLxItems - Int
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"arrivedAtDeliveryLocation": [
"2007-12-03"
],
"arrivedAtPickUpLocation": ["2007-12-03"],
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"carrierDepartedDeliveryLocation": [
"2007-12-03"
],
"carrierDepartedPickUpLocation": [
"2007-12-03"
],
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"condRespCode": "xyz789",
"consignee": Address,
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"deliveryAppointmentDate": ["2007-12-03"],
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "xyz789",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "xyz789",
"inquiryReqNumber": "abc123",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "xyz789",
"partnerHash": "xyz789",
"pickUpAppointment": ["2007-12-03"],
"poNumber": "abc123",
"primary": false,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"proNumber": "abc123",
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceID": "xyz789",
"referenceIDQualifier": "xyz789",
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"scac": "xyz789",
"scacCode": ["abc123"],
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"shipmentID": "xyz789",
"shipmentStatus": "abc123",
"shipmentStatusDetails": [ShipmentStatusDetails],
"shipmentStatusReason": ["abc123"],
"shipmentStatusReasonData": ["xyz789"],
"shipper": Address,
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transLxItems": 987,
"transactionBegin": 123,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ TreeNode
¶ Fields
| Field Name | Description |
|---|---|
children - [TreeNode]
|
|
depth - Int!
|
|
hierarchyCode - String
|
|
value - Hierarchical
|
¶ Example
{
"children": [TreeNode],
"depth": 987,
"hierarchyCode": "abc123",
"value": Hierarchical
}
¶ TreeNodeInput
¶ Fields
| Input Field | Description |
|---|---|
children - [TreeNodeInput]
|
|
depth - Int!
|
|
hierarchyCode - String
|
|
value - HierarchicalInput
|
¶ Example
{
"children": [TreeNodeInput],
"depth": 987,
"hierarchyCode": "xyz789",
"value": HierarchicalInput
}
¶ Type
¶ UsageIndicator
¶ User
¶ Fields
| Field Name | Description |
|---|---|
accountID - String
|
|
aggregatePermissions - UserPermissions
|
|
avatarID - String
|
|
bio - String
|
|
canManageOtherCompanies - Boolean
|
|
company - CompanyInfo
|
|
companyID - String
|
|
createdOn - Date
|
|
customDepartmentName - String
|
|
department - String
|
|
disabled - Boolean
|
|
disabledOn - Date
|
|
email - String
|
|
email2 - String
|
|
emailChangeRequest - EmailChangeRequest
|
|
environment - String
|
|
firstName - String
|
|
fullName - String
|
|
groupIDs - [String]
|
|
groups - [Group]
|
|
id - String
|
|
invited - Boolean
|
|
invitedByCompanies - [String]
|
|
jobTitle - String
|
|
lastActivity - Date
|
|
lastName - String
|
|
lastVerified - Date
|
|
loginAttempt - Int
|
|
passwordBcryptHash - String
|
|
passwordHash - String
|
|
permissions - [DocPermission]
|
|
root - Boolean
|
|
salt - Base64String
|
|
technical - Boolean
|
|
tokenPassword - String
|
|
tokenPasswordTime - Date
|
|
unlockDateTime - Date
|
|
userContact - UserContact
|
|
userPreferences - UserPreferences
|
|
verificationAttempts - Int
|
|
verificationHash - String
|
|
verificationHashExpiration - Date
|
|
verificationLockoutExpiration - Date
|
|
verified - Boolean!
|
¶ Example
{
"accountID": "xyz789",
"aggregatePermissions": UserPermissions,
"avatarID": "xyz789",
"bio": "abc123",
"canManageOtherCompanies": false,
"company": CompanyInfo,
"companyID": "xyz789",
"createdOn": "2007-12-03",
"customDepartmentName": "xyz789",
"department": "abc123",
"disabled": true,
"disabledOn": "2007-12-03",
"email": "abc123",
"email2": "abc123",
"emailChangeRequest": EmailChangeRequest,
"environment": "xyz789",
"firstName": "xyz789",
"fullName": "xyz789",
"groupIDs": ["abc123"],
"groups": [Group],
"id": "xyz789",
"invited": true,
"invitedByCompanies": ["abc123"],
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"lastVerified": "2007-12-03",
"loginAttempt": 987,
"passwordBcryptHash": "xyz789",
"passwordHash": "xyz789",
"permissions": [DocPermission],
"root": true,
"salt": Base64String,
"technical": false,
"tokenPassword": "xyz789",
"tokenPasswordTime": "2007-12-03",
"unlockDateTime": "2007-12-03",
"userContact": UserContact,
"userPreferences": UserPreferences,
"verificationAttempts": 123,
"verificationHash": "abc123",
"verificationHashExpiration": "2007-12-03",
"verificationLockoutExpiration": "2007-12-03",
"verified": true
}
¶ UserContact
¶ Example
{
"email": "abc123",
"facebook": "xyz789",
"fax": "xyz789",
"mobilePhone": "xyz789",
"officePhone": "abc123",
"twitter": "xyz789",
"website": "xyz789"
}
¶ UserContactInput
¶ Example
{
"email": "abc123",
"facebook": "abc123",
"fax": "xyz789",
"mobilePhone": "abc123",
"officePhone": "xyz789",
"twitter": "abc123",
"website": "xyz789"
}
¶ UserDetails
¶ Fields
| Field Name | Description |
|---|---|
avatarID - String
|
|
bio - String
|
|
companyID - String
|
|
createdOn - Date
|
|
department - String
|
|
disabled - Boolean!
|
|
email - String
|
|
emailVerified - Boolean
|
|
environment - String
|
|
firstName - String
|
|
groups - [Group]
|
|
id - String
|
|
invited - Boolean!
|
|
jobTitle - String
|
|
lastActivity - Date
|
|
lastName - String
|
|
permissionMap - Map_String_ObjectScalar
|
|
permissions - [String]
|
|
userContact - UserContact
|
|
userPreferences - UserPreferences
|
¶ Example
{
"avatarID": "xyz789",
"bio": "xyz789",
"companyID": "xyz789",
"createdOn": "2007-12-03",
"department": "abc123",
"disabled": true,
"email": "abc123",
"emailVerified": false,
"environment": "abc123",
"firstName": "xyz789",
"groups": [Group],
"id": "abc123",
"invited": true,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "abc123",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["abc123"],
"userContact": UserContact,
"userPreferences": UserPreferences
}
¶ UserDetailsInput
¶ Fields
| Input Field | Description |
|---|---|
avatarID - String
|
|
bio - String
|
|
companyID - String
|
|
createdOn - Date
|
|
department - String
|
|
disabled - Boolean!
|
|
email - String
|
|
emailVerified - Boolean
|
|
environment - String
|
|
firstName - String
|
|
groups - [GroupInput]
|
|
id - String
|
|
invited - Boolean!
|
|
jobTitle - String
|
|
lastActivity - Date
|
|
lastName - String
|
|
permissionMap - Map_String_ObjectScalar
|
|
permissions - [String]
|
|
userContact - UserContactInput
|
|
userPreferences - UserPreferencesInput
|
¶ Example
{
"avatarID": "abc123",
"bio": "xyz789",
"companyID": "abc123",
"createdOn": "2007-12-03",
"department": "xyz789",
"disabled": false,
"email": "xyz789",
"emailVerified": false,
"environment": "abc123",
"firstName": "xyz789",
"groups": [GroupInput],
"id": "xyz789",
"invited": false,
"jobTitle": "xyz789",
"lastActivity": "2007-12-03",
"lastName": "xyz789",
"permissionMap": Map_String_ObjectScalar,
"permissions": ["xyz789"],
"userContact": UserContactInput,
"userPreferences": UserPreferencesInput
}
¶ UserInfo
¶ UserInfoInput
¶ UserPermissions
¶ Fields
| Field Name | Description |
|---|---|
admin - Boolean!
|
|
canManageOtherCompanies - Boolean!
|
|
contactViewPermissions - Map_String_BooleanScalar
|
|
documentPermissions - Map_String_BooleanScalar
|
|
environment - String
|
|
id - String
|
|
lastUpdated - Date
|
|
managedCompanies - [String]
|
|
partnerRestrictionList - [String]
|
|
permissions - Map_String_BooleanScalar
|
|
restrictByContactType - Boolean
|
|
restrictByDocumentType - Boolean
|
|
restrictPartner - Boolean
|
|
restrictSubsidiary - Boolean
|
|
subsidiaryRestrictionList - [String]
|
|
userID - String
|
|
version - Int!
|
¶ Example
{
"admin": true,
"canManageOtherCompanies": false,
"contactViewPermissions": Map_String_BooleanScalar,
"documentPermissions": Map_String_BooleanScalar,
"environment": "abc123",
"id": "xyz789",
"lastUpdated": "2007-12-03",
"managedCompanies": ["abc123"],
"partnerRestrictionList": ["abc123"],
"permissions": Map_String_BooleanScalar,
"restrictByContactType": false,
"restrictByDocumentType": false,
"restrictPartner": false,
"restrictSubsidiary": true,
"subsidiaryRestrictionList": ["abc123"],
"userID": "xyz789",
"version": 987
}
¶ UserPreferences
¶ UserPreferencesInput
¶ WarehouseInventoryAdjustmentAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
actionCode - String
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
depositor - Address
|
|
depositorAdjNumber - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionDate - Date
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
warehouse - Address
|
|
warehouseAdjNumber - String
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"actionCode": "xyz789",
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "abc123",
"depositor": Address,
"depositorAdjNumber": "abc123",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "xyz789",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "abc123",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "xyz789",
"isaEnd": 987,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primary": true,
"primaryContent": "abc123",
"primaryIdentifier": ["abc123"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionDate": "2007-12-03",
"transactionEnd": 987,
"transactionRefNum": "xyz789",
"transactionTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"warehouse": Address,
"warehouseAdjNumber": "xyz789",
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ WarehouseShippingAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
asnNumber - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
consignee - Address
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
depositor - Address
|
|
depositorOrderNumber - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
linkSequenceNumber - String
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
masterRefNumber - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reportingCode - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
shippingAdviceDate - Date
|
|
specialHandleCode - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
thirdPartyCorrelation - DocumentCorrelationPoint
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
warehouse - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"asnNumber": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": true,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "abc123",
"compositeKeys": [CompositeKey],
"consignee": Address,
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"depositor": Address,
"depositorOrderNumber": "xyz789",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "xyz789",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": true,
"hasExceptions": false,
"hasPurchaseOrder": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 987,
"isaControlNumber": "xyz789",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"linkSequenceNumber": "xyz789",
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"masterRefNumber": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numberOfItems": 123,
"originalDocumentID": "abc123",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"poNumber": "xyz789",
"primary": true,
"primaryContent": "xyz789",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reportingCode": "xyz789",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"scac": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentID": "abc123",
"shippingAdviceDate": "2007-12-03",
"specialHandleCode": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "xyz789",
"subOrgName": "abc123",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["abc123"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalQuantity": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"transactionTypeCode": "xyz789",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"warehouse": Address,
"watchers": ["xyz789"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ WarehouseShippingOrderDocument
¶ Fields
| Field Name | Description |
|---|---|
SLAFields - Map_SupportedDate_DateScalar
|
|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
billToParty - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlatedByPoints - [LifeCycleCorrelationPoint]
|
|
correlatesOnPoints - [LifeCycleCorrelationPoint]
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
depositor - Address
|
|
depositorOrderNumber - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
eventType - LifeCycleEventType
|
|
filename - String
|
|
filteringMetadata - Map_String_ObjectScalar
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
internalVendorNumber - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lifeCycleAudit - LifeCycleAudit
|
|
lifeCycleUUIDs - Map_String_StringScalar
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
orderStatusCode - String
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
primary - Boolean!
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scacCode - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
supportedDateFields - Map_SupportedDate_DateScalar
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
thirdPartyCorrelation - DocumentCorrelationPoint
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
totalQuantity - Float
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transactionTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
warehouse - Address
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"SLAFields": Map_SupportedDate_DateScalar,
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"billToParty": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": true,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlatedByPoints": [LifeCycleCorrelationPoint],
"correlatesOnPoints": [LifeCycleCorrelationPoint],
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "abc123",
"depositor": Address,
"depositorOrderNumber": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"eventType": "APPLICATION_ADVICE_EVENT",
"filename": "abc123",
"filteringMetadata": Map_String_ObjectScalar,
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "xyz789",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": true,
"hasErrors": false,
"hasExceptions": false,
"hasPurchaseOrder": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "abc123",
"indexName": "abc123",
"internalVendorNumber": "abc123",
"isDeleted": false,
"isaBegin": 987,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "xyz789",
"lastCommentedOn": "2007-12-03",
"lifeCycleAudit": LifeCycleAudit,
"lifeCycleUUIDs": Map_String_StringScalar,
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 123,
"orderStatusCode": "xyz789",
"originalDocumentID": "xyz789",
"originalTransactionID": "abc123",
"outboundIdentifierHash": "abc123",
"partnerHash": "abc123",
"poNumber": "abc123",
"primary": true,
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"receiverID": "xyz789",
"receiverIDQualifier": "abc123",
"receiverIDValue": "xyz789",
"receiverIdentifierHash": "xyz789",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "abc123",
"scacCode": "abc123",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "xyz789",
"senderIDValue": "abc123",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"supportedDateFields": Map_SupportedDate_DateScalar,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"thirdPartyCorrelation": DocumentCorrelationPoint,
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"totalQuantity": 987.65,
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "xyz789",
"transactionTypeCode": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "abc123",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"warehouse": Address,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "xyz789",
"xmlCorrelationExists": false,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ WarehouseStockTransferReceiptAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
depositorOrderNo - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
equipmentInitial - String
|
|
equipmentNumber - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
quantityDamaged - Float
|
|
quantityReceived - Float
|
|
quantityShipped - Float
|
|
receiptDate - Date
|
|
receiptNo - String
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reportingCode - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipToAddress - Address
|
|
shipmentID - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transportTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "abc123",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "abc123",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "abc123",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "xyz789",
"correlationReferenceId": "abc123",
"customFields": Map_String_StringScalar,
"dataFormat": "xyz789",
"dataFormatVersion": "xyz789",
"depositorOrderNo": "xyz789",
"docType": "xyz789",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "xyz789",
"environment": "xyz789",
"equipmentInitial": "xyz789",
"equipmentNumber": "abc123",
"errorCodes": ["xyz789"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "abc123",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "abc123",
"functionalAcknowledgmentErrorCode": "xyz789",
"functionallyAcknowledged": false,
"functionallyAcknowledgedBy": "abc123",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "xyz789",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": true,
"hasExceptions": true,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": false,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 987,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": true,
"manuallyAcknowledgedBy": "xyz789",
"name": "xyz789",
"numOfErrors": 123,
"numberOfItems": 987,
"originalDocumentID": "abc123",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"primaryContent": "abc123",
"primaryIdentifier": ["xyz789"],
"quantityDamaged": 123.45,
"quantityReceived": 987.65,
"quantityShipped": 987.65,
"receiptDate": "2007-12-03",
"receiptNo": "xyz789",
"receiverID": "xyz789",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reportingCode": "xyz789",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"scac": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "xyz789",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "xyz789",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["xyz789"],
"shipToAddress": Address,
"shipmentID": "xyz789",
"strictIdInboundIdentifierHash": "xyz789",
"strictIdOutboundIdentifierHash": "abc123",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": false,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 987,
"transactionEnd": 123,
"transactionRefNum": "abc123",
"transportTypeCode": "abc123",
"tsControlNumber": "xyz789",
"tsIDCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["abc123"],
"wildcardReceiverIdentifierHash": "xyz789",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["xyz789"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ WarehouseStockTransferShipmentAdviceDocument
¶ Fields
| Field Name | Description |
|---|---|
acceptanceStatus - AcceptanceStatus
|
|
addressFields - [Address]
|
|
appAdviceTransferStatus - String
|
|
billToAddress - Address
|
|
bodID - String
|
|
bodIDVersion - String
|
|
businessPartner - PartyInformation
|
|
businessPartnerIdentifiers - [IdPair]
|
|
businessPartnerStrictIdEnabled - Boolean
|
|
canDownloadOriginalFile - Boolean
|
|
categoryFacet - CategoryFacet
|
|
commenters - [UserInfo]
|
|
companyID - String
|
|
compositeKeys - [CompositeKey]
|
|
contactRepresentations - [ContactRepresentation]
|
|
containerID - String
|
|
conversation - Conversation
|
|
conversationList - [ConversationList]
|
|
conversation_id - String
|
|
correlationReferenceId - String
|
|
customFields - Map_String_StringScalar
|
|
dataFormat - String
|
|
dataFormatVersion - String
|
|
depositor - Address
|
|
depositorOrderNumber - String
|
|
docType - String
|
|
documentCorrelationPoints - [DocumentCorrelationPoint]
|
|
dtmDates - [DTMDate]
|
|
entityID - String
|
|
environment - String
|
|
equipmentInitial - String
|
|
equipmentNumber - String
|
|
errorCodes - [String]
|
|
errorCorrelationPoints - [ErrorCorrelationPoint]
|
|
filename - String
|
|
flowDirection - DocumentFlowDirection
|
|
functionalAcknowledgmentCode - String
|
|
functionalAcknowledgmentErrorCode - String
|
|
functionallyAcknowledged - Boolean
|
|
functionallyAcknowledgedBy - String
|
|
functionallyAcknowledgedByDocType - String
|
|
functionallyAcknowledgedOn - Date
|
|
gsFuncIDCode - String
|
|
gsReceiverID - String
|
|
gsSenderID - String
|
|
gsTimestamp - Date
|
|
hasApplicationAdvice - Boolean
|
|
hasErrors - Boolean
|
|
hasExceptions - Boolean
|
|
hasPurchaseOrder - Boolean
|
|
hierarchyStructure - [String]
|
|
id - String
|
|
identifierType - BusinessIdentifierType
|
|
inboundIdentifierHash - String
|
|
indexName - String
|
|
isDeleted - Boolean
|
|
isaBegin - Int
|
|
isaControlNumber - String
|
|
isaEnd - Int
|
|
laVersion - String
|
|
lastCommentedOn - Date
|
|
lineItems - [LineItem]
|
|
loadedOn - Date
|
|
manuallyAcknowledged - Boolean
|
|
manuallyAcknowledgedBy - String
|
|
name - String
|
|
numOfErrors - Int
|
|
numUnitsShipped - Float
|
|
numberOfItems - Int
|
|
originalDocumentID - String
|
|
originalTransactionID - String
|
|
outboundIdentifierHash - String
|
|
partnerHash - String
|
|
poNumber - String
|
|
primaryContent - String
|
|
primaryIdentifier - [String]
|
|
receiverID - String
|
|
receiverIDQualifier - String
|
|
receiverIDValue - String
|
|
receiverIdentifierHash - String
|
|
receiverIdentifierMap - Map_String_StringScalar
|
|
referenceInfo - [RefSegment]
|
|
reportingCode - String
|
|
reprocessOn - [Date]
|
|
reprocessedOn - Date
|
|
routing - String
|
|
scac - String
|
|
sendFrom - PartyInformation
|
|
sendTo - PartyInformation
|
|
senderID - String
|
|
senderIDQualifier - String
|
|
senderIDValue - String
|
|
senderIdentifierHash - String
|
|
senderIdentifierMap - Map_String_StringScalar
|
|
sharedToCompanies - [String]
|
|
shipFrom - Address
|
|
shipTo - Address
|
|
shipToAddress - Address
|
|
shipmentDate - Date
|
|
shipmentID - String
|
|
strictIdInboundIdentifierHash - String
|
|
strictIdOutboundIdentifierHash - String
|
|
subOrgID - String
|
|
subOrgName - String
|
|
subOrgStrictIdEnabled - Boolean
|
|
testIndicator - UsageIndicator
|
|
textInfo - [TextSegment]
|
|
timeline - [String]
|
|
timestamp - Date
|
|
timezoneOffset - Long
|
|
transactionBegin - Int
|
|
transactionEnd - Int
|
|
transactionRefNum - String
|
|
transportTypeCode - String
|
|
tsControlNumber - String
|
|
tsIDCode - String
|
|
tsPurposeCode - String
|
|
type - String
|
|
unknownFields - Map_String_ObjectScalar
|
|
watchers - [String]
|
|
weight - Float
|
|
weightUOM - String
|
|
wildcardReceiverIdentifierHash - String
|
|
wildcardSenderIdentifierHash - String
|
|
xmlCorrelationExists - Boolean
|
|
xmlCorrelationFileID - [String]
|
|
xmlCorrelationPoints - [XmlCorrelationPoint]
|
¶ Example
{
"acceptanceStatus": AcceptanceStatus,
"addressFields": [Address],
"appAdviceTransferStatus": "xyz789",
"billToAddress": Address,
"bodID": "abc123",
"bodIDVersion": "xyz789",
"businessPartner": PartyInformation,
"businessPartnerIdentifiers": [IdPair],
"businessPartnerStrictIdEnabled": false,
"canDownloadOriginalFile": false,
"categoryFacet": "ACKNOWLEDGE_BUSINESS_DOCUMENT",
"commenters": [UserInfo],
"companyID": "xyz789",
"compositeKeys": [CompositeKey],
"contactRepresentations": [ContactRepresentation],
"containerID": "xyz789",
"conversation": Conversation,
"conversationList": [ConversationList],
"conversation_id": "abc123",
"correlationReferenceId": "xyz789",
"customFields": Map_String_StringScalar,
"dataFormat": "abc123",
"dataFormatVersion": "xyz789",
"depositor": Address,
"depositorOrderNumber": "xyz789",
"docType": "abc123",
"documentCorrelationPoints": [DocumentCorrelationPoint],
"dtmDates": [DTMDate],
"entityID": "abc123",
"environment": "abc123",
"equipmentInitial": "xyz789",
"equipmentNumber": "abc123",
"errorCodes": ["abc123"],
"errorCorrelationPoints": [ErrorCorrelationPoint],
"filename": "xyz789",
"flowDirection": "inbound",
"functionalAcknowledgmentCode": "xyz789",
"functionalAcknowledgmentErrorCode": "abc123",
"functionallyAcknowledged": true,
"functionallyAcknowledgedBy": "xyz789",
"functionallyAcknowledgedByDocType": "abc123",
"functionallyAcknowledgedOn": "2007-12-03",
"gsFuncIDCode": "abc123",
"gsReceiverID": "xyz789",
"gsSenderID": "abc123",
"gsTimestamp": "2007-12-03",
"hasApplicationAdvice": false,
"hasErrors": false,
"hasExceptions": false,
"hasPurchaseOrder": false,
"hierarchyStructure": ["xyz789"],
"id": "abc123",
"identifierType": "DUNS",
"inboundIdentifierHash": "xyz789",
"indexName": "abc123",
"isDeleted": true,
"isaBegin": 123,
"isaControlNumber": "abc123",
"isaEnd": 123,
"laVersion": "abc123",
"lastCommentedOn": "2007-12-03",
"lineItems": [LineItem],
"loadedOn": "2007-12-03",
"manuallyAcknowledged": false,
"manuallyAcknowledgedBy": "abc123",
"name": "abc123",
"numOfErrors": 123,
"numUnitsShipped": 123.45,
"numberOfItems": 123,
"originalDocumentID": "xyz789",
"originalTransactionID": "xyz789",
"outboundIdentifierHash": "abc123",
"partnerHash": "xyz789",
"poNumber": "abc123",
"primaryContent": "xyz789",
"primaryIdentifier": ["abc123"],
"receiverID": "abc123",
"receiverIDQualifier": "xyz789",
"receiverIDValue": "abc123",
"receiverIdentifierHash": "abc123",
"receiverIdentifierMap": Map_String_StringScalar,
"referenceInfo": [RefSegment],
"reportingCode": "xyz789",
"reprocessOn": ["2007-12-03"],
"reprocessedOn": "2007-12-03",
"routing": "xyz789",
"scac": "xyz789",
"sendFrom": PartyInformation,
"sendTo": PartyInformation,
"senderID": "abc123",
"senderIDQualifier": "abc123",
"senderIDValue": "xyz789",
"senderIdentifierHash": "abc123",
"senderIdentifierMap": Map_String_StringScalar,
"sharedToCompanies": ["abc123"],
"shipFrom": Address,
"shipTo": Address,
"shipToAddress": Address,
"shipmentDate": "2007-12-03",
"shipmentID": "abc123",
"strictIdInboundIdentifierHash": "abc123",
"strictIdOutboundIdentifierHash": "xyz789",
"subOrgID": "abc123",
"subOrgName": "xyz789",
"subOrgStrictIdEnabled": true,
"testIndicator": "INFORMATION",
"textInfo": [TextSegment],
"timeline": ["xyz789"],
"timestamp": "2007-12-03",
"timezoneOffset": {},
"transactionBegin": 123,
"transactionEnd": 987,
"transactionRefNum": "abc123",
"transportTypeCode": "xyz789",
"tsControlNumber": "abc123",
"tsIDCode": "abc123",
"tsPurposeCode": "xyz789",
"type": "abc123",
"unknownFields": Map_String_ObjectScalar,
"watchers": ["xyz789"],
"weight": 123.45,
"weightUOM": "abc123",
"wildcardReceiverIdentifierHash": "abc123",
"wildcardSenderIdentifierHash": "abc123",
"xmlCorrelationExists": true,
"xmlCorrelationFileID": ["abc123"],
"xmlCorrelationPoints": [XmlCorrelationPoint]
}
¶ WaybillRefInfo
¶ WidgetConfig
¶ Fields
| Field Name | Description |
|---|---|
data - DataConfig
|
|
dimension - Dimension
|
|
drilldown - Map_String_ObjectScalar
|
|
format - NumberFormatConfig
|
|
id - String
|
|
measure - Measure
|
|
split - Split
|
|
title - String
|
¶ Example
{
"data": DataConfig,
"dimension": Dimension,
"drilldown": Map_String_ObjectScalar,
"format": NumberFormatConfig,
"id": "abc123",
"measure": Measure,
"split": Split,
"title": "xyz789"
}
¶ WidgetConfigInput
¶ Fields
| Input Field | Description |
|---|---|
data - DataConfigInput
|
|
dimension - DimensionInput
|
|
drilldown - Map_String_ObjectScalar
|
|
format - NumberFormatConfigInput
|
|
id - String
|
|
measure - MeasureInput
|
|
split - SplitInput
|
|
title - String
|
¶ Example
{
"data": DataConfigInput,
"dimension": DimensionInput,
"drilldown": Map_String_ObjectScalar,
"format": NumberFormatConfigInput,
"id": "xyz789",
"measure": MeasureInput,
"split": SplitInput,
"title": "abc123"
}
¶ XMLConfigurationFieldType
¶ XMLConfigurationType
¶ XSLTMapVersion
¶ Example
{
"comments": "abc123",
"companyID": "abc123",
"content": "abc123",
"docType": "xyz789",
"editedBy": "xyz789",
"editedDate": "2007-12-03",
"environment": "xyz789",
"fileType": "abc123",
"id": "xyz789",
"indexName": "abc123",
"name": "xyz789",
"parentId": "abc123",
"routing": "xyz789",
"size": {},
"timestamp": "2007-12-03"
}
¶ XmlCorrelationPoint
¶ Fields
| Field Name | Description |
|---|---|
companyId - String
|
|
configurationType - XMLConfigurationType
|
|
entityReferenceId - String
|
|
environment - String
|
|
fieldType - XMLConfigurationFieldType
|
|
hash - String
|
|
referenceId - String
|
¶ Example
{
"companyId": "abc123",
"configurationType": "ADVANCE_SHIP_NOTICE",
"entityReferenceId": "abc123",
"environment": "xyz789",
"fieldType": "IDOC_SHIPMENT_NUMBER",
"hash": "abc123",
"referenceId": "xyz789"
}