GetCredit

The purpose of the GetCredit is for the order management application to request Credit data for a trading partner from the Credit management function.  The GetCredit does not imply any update, it is only an inquiry function.  The ShowCredit discussed in the next chapter will be the response back to the order management application.

Discussed in a later chapter is the UpdateCredit.  The UpdateCredit may be used in both directions between the order management and the accounts receivable application.  Its purpose is to keep order, shipment and open item amounts current.  Finally, the ChangeCreditStatus is used to update the order management application with any changes in business status for a particular trading partner.

Element information

Namespace: http://www.openapplications.org/oagis/10

Schema document: GetCredit.xsd

Type: GetCreditType

Properties: Global, Qualified, ID: oagis-id-ce1856e858a74ef78bb488edc50044e5

Content

Sequence [1..1]
1. DataArea [1..1] Is where the information that the BOD message carries is provided, in this case GetCredit. The information consists of a Verb and one or more Nouns. The verb (Get) indicates the action to be performed on the Noun (Credit).

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

<GetCredit 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>
      <Credit>
         <ID/>
         <IDSet>...
         </IDSet>
         <GeneralLedgerElement>...
         </GeneralLedgerElement>
         <ApprovalStatus>...
         </ApprovalStatus>
         <Description/>
         <Note/>
         <Party>...
         </Party>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <OpenItemAmount/>
         <OrderAmount/>
         <ApprovedOrderAmount/>
         <AvailableAmount/>
         <OrderLimitAmount/>
         <TotalCreditLimitAmount/>
         <DocumentDateTime></DocumentDateTime>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <LedgerID>normalizedString</LedgerID>
         <Payment>...
         </Payment>
         <Extension>.......................................
         </Extension>
      </Credit>
   </DataArea>
</GetCredit>