GetFreightInvoice
The purpose of the Get FreightInvoice is to enable a business application module to request information concerning a specific purchase order from another business application. The reply to this BOD is the Show FreightInvoice. There are several environments that may use this capability. For example, an MRP application may use this BOD to ask for information from a Order Management application, or a Plant Data Collection application may also use this BOD to request information from a Order Management application. This may als happen across business parties. This BOD does not usually cause updates to occur.
Element information
Namespace: http://www.openapplications.org/oagis/10
Schema document: GetFreightInvoice.xsd
Type: GetFreightInvoiceType
Properties: Global, Qualified, ID: oagis-id-1288d9cf6156441cb53626bee903a80e
Content
- Sequence [1..1]
- ApplicationArea [1..1] Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
- DataArea [1..1] Is where the information that the BOD message carries is provided, in this case GetFreightInvoice. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (FreightInvoice).
from type BusinessObjectDocumentType
Attributes
Name | Occ | Type | Description | Notes |
---|---|---|---|---|
releaseID | [1..1] | NormalizedStringType | OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on. | from type BusinessObjectDocumentType |
versionID | [0..1] | NormalizedStringType | Indicates the version of the given BOD definition. | from type BusinessObjectDocumentType |
systemEnvironmentCode | [0..1] | SystemEnvironmentCodeContentType | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Default value is "Production". from type BusinessObjectDocumentType |
languageCode | [0..1] | LanguageCodeContentType | Indicates the language that the contents of the BOD is in unless otherwise stated. | Default value is "en-US". from type BusinessObjectDocumentType |
Sample instance
<GetFreightInvoice releaseID="normalizedString"> <ApplicationArea> <Sender> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <TaskID>normalizedString</TaskID> <ReferenceID>normalizedString</ReferenceID> <ConfirmationCodes>... </ConfirmationCodes> <AuthorizationID>normalizedString</AuthorizationID> </Sender> <Receiver> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <ID/> </Receiver> <CreationDateTime></CreationDateTime> <Signature> <!--any element--> </Signature> <ScenarioID>normalizedString</ScenarioID> <CorrelationID>normalizedString</CorrelationID> <BODID>normalizedString</BODID> <Extension> <AnyExtension> <!--any element--> </AnyExtension> <Amount/> <Code/> <DateTime></DateTime> <ID/> <Indicator>true</Indicator> <Measure/> <Name/> <Number>1.0</Number> <Quantity/> <Text/> <Time></Time> <ValueText>string</ValueText> </Extension> </ApplicationArea> <DataArea> <Get> <Expression>token</Expression> </Get> <FreightInvoice> <FreightInvoiceHeader>... </FreightInvoiceHeader> <FreightInvoiceLine>... </FreightInvoiceLine> </FreightInvoice> </DataArea> </GetFreightInvoice>