GetCredit schema, example, validation rules, validation stylesheet

GetCredit type: 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.

GetCredit extends: BusinessObjectDocument
Structure:
Elements:
Name Type Description
DataArea GetCreditDataArea

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).

GetCreditDataArea extends: DataArea
Structure:
Elements:
Name Type Description
Credit reference
Get reference

GetCredit Scenario Diagram

Get schema

Get type: Get

The GET verb is to communicate to a business software component a request for an existing piece of information to be returned. The GET may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the SHOW verb. The behavior of a BOD with a GET verb is quite predictable across most of the nouns it may be paired with.The GET is designed to retrieve a single piece of information by using that information's primary retrieval field, or key field. The GET verb is not used to request several documents at once. The GETLIST verb is designed to achieve that purpose and will be covered in more detail later.Selection Criteria:There are two types of selection capabilities for most BOD's that use the GET verb.1) The first selection capability is called Field-Based Selection. Within a GET-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for GET-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the GET verb. The Data Types are identified for retrieval within the GET instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the GET request and this will signify to the responding component that the Data Type is not to be returned.

Get extends: RequestVerb
Structure:
Attributes:
Name Type Usage Description
show xs:string

Credit schema

Credit type: Credit

Credit represents customer credit information, and is used in the context of credit checking new sales orders.

Credit extends: Noun

The receiver of this BOD is always the credit management function. If the sender is the accounts receivable application, the OpenItemAmount is the only required amount field. When the sender is the customer order management application, the OrderAmount is the only required amount field

Structure:
Elements:
Name Type Description
Approve Indicator

Indicates whether an order has passed the credit checking criteria. Valid values are: false = Order does not meet the accounts receivable application approval criteria. true = Order meets the accounts receivable application approval criteria.

Indicates if the semantic name is needed or not.

ApprovedOrderAmounts Amounts

Is the total amount of orders approved but not yet invoiced.

AvailableAmounts Amounts

Is the credit amount available for a trading partner to make an additional order against. This amount is typically a combination of orders approved but not yet invoiced and orders invoiced yet still considered open items in the receivables balance.

Description Description

Is a free-form description of the transaction or any portion of the transaction.

Free-form text description of the Noun or Componenet in which the description occurs. The lang attribute indicates the language the description is in. Owner inidcates the user or entity that provided teh description..

DocumentDateTime DateTime

Is the timestamp in which the document was credit.

DocumentReferences reference
EffectiveDateTime DateTime

Defines the date and time when a particular document or item takes effect or becomes valid.

GLEntity GLEntity

Is the primary balancing segment of the GL Account structure. Typically, this is the owning entity for the transaction. A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law. P&L statements are required at this level.

The primary balancing segment of the G/L Account structure. P and L statements are required at this level. A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law.

Synonyms: Business Unit, Fund, General Ledger Company, Joint Venture, Non-Profit Association Name

Ledger Id

Identifies the financial ledger to be used when updating balances.

Generic identifier type with open qualifyingAgency.

OpenItemAmounts Amounts

Is the total orders invoiced yet still considered open items in the receivables balance.

OrderAmounts Amounts

Is the total of the sales order that is typically used to compare against a credit limit during credit checking.

OrderLimitAmounts Amounts

Is the credit limit of a single sales order used during credit checking.

Parties reference
Status reference
TotalCreditLimitAmounts Amounts

Is the total credit limit for a trading partner used during credit checking.

UserArea reference

Verb Common Files

Verb.xsd schema

AcknowledgableVerb extends: ConfirmableVerb
Structure:
Attributes:
Name Type Usage Description
acknowledge AcknowledgementType

AcknowledgementType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

ConfirmableVerb extends: Verb
Structure:
Attributes:
Name Type Usage Description
confirm ConfirmType

ConfirmType restricts: xs:NMTOKEN
Enumerations:
Always
Never
OnChange

Expression restricts: xs:string

ExpressionCriteria
Structure:
Elements:
Name Type Description
SelectExpression Expression

Allows the 1-n number of selection expressions for the information to be returned.

Attributes:
Name Type Usage Description
expressionLanguage xs:string optional

RequestVerb extends: ConfirmableVerb
Structure:
Elements:
Name Type Description
ReturnCriteria

Allows the initator of the BOD to indicate the information (down to the field level) that is requested to be returned. The expressionLanguage indicates the expression language being used.

VerbBase.xsd schema

Verb type: Verb

Verb
Structure:

Noun Common Files