Credit
Credit represents customer credit information, and is used in the context of credit checking new sales orders.
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/Nouns/Credit.xsd
Type: CreditType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- Sequence
[0..1]
- ID [0..*] Is the Identifiers of the given instance of an entity within the scope of the integration. The schemeAgencyID attribute identifies the party that provided or knows this party by the given identifier.
- GLElement [0..1] 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.
- ApprovalStatus [0..1] A code to reflect the approval status of a process. A process may be approved as a way of performing a task. A non standard process may be approved because of local legal or cultural norms.
- Sequence
[0..1]
- Description [0..*]
- Note [0..*]
- Party [0..*] A generic Party for non-validated or application-validated parties. A work-around for situations where Schema-validation of Parties is not feasible or not desired.
- Sequence
[0..1]
- DocumentReference [0..*]
- Attachment [0..*] The Attachment represents binary data files that may be included within a BOD. These files replace the paper specifications and drawings attached to a BOD definition to clearly communicate design requirements. This Data Type is optional. Attachment usage is further defined by its position.
- OpenItemAmount [0..1] Is the total orders invoiced yet still considered open items in the receivables balance.
- OrderAmount [0..1] Is the total of the sales order that is typically used to compare against a credit limit during credit checking.
- ApprovedOrderAmount [0..1] Is the total amount of orders approved but not yet invoiced.
- AvailableAmount [0..1] 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.
- OrderLimitAmount [0..1] Is the credit limit of a single sales order used during credit checking.
- TotalCreditLimitAmount [0..1] Is the total credit limit for a trading partner used during credit checking.
- DocumentDateTime [0..1] Is the timestamp in which the document was created.
- EffectiveTimePeriod [0..1] Defines the date and time when a particular document or item takes effect or becomes valid.
- LedgerID [0..1] Identifies the financial ledger to be used when updating balances.
- Payment [0..*]
- UserArea [0..1] Allows the user of OAGIS to extend the specification in order to provide additional information that is not captured in OAGIS.This is done by defining the additional information in XML Schema and referencing the new schema in the xml instance document through the use of namespaces. Once this is done the additional information defined there can be carried in the BOD XML instance document.The Open Applications Group will make best efforts to quickly consider all proposed submissions.The USERAREA is always the last element in all components, except where the component has been extended inline.
from type CreditBaseTypefrom group IDsGroupfrom group FreeFormTextGroupfrom group ReferencesGroup - Sequence
[0..1]
Attributes
None
Used in
- Type AcknowledgeCreditDataAreaType (Element DataArea)
- Type ChangeCreditDataAreaType (Element DataArea)
- Type GetCreditDataAreaType (Element DataArea)
- Type NotifyCreditDataAreaType (Element DataArea)
- Type OAGIS9NounsType (Element OAGIS9Nouns)
- Type ProcessCreditDataAreaType (Element DataArea)
- Type RespondCreditDataAreaType (Element DataArea)
- Type ShowCreditDataAreaType (Element DataArea)
- Type SyncCreditDataAreaType (Element DataArea)
- Type UpdateCreditDataAreaType (Element DataArea)
Sample instance
<Credit> <ID>normalizedString</ID> <GLElement> <Element>string</Element> </GLElement> <ApprovalStatus> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </TimePeriod> <UserArea> <!--any element--> </UserArea> </ApprovalStatus> <Description>string</Description> <Note>string</Note> <Party> <PartyIDs> <ID>normalizedString</ID> <TaxID>normalizedString</TaxID> <DUNSID>normalizedString</DUNSID> <CAGEID>normalizedString</CAGEID> <DODAACID>normalizedString</DODAACID> <BICID>normalizedString</BICID> </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location> <ID>normalizedString</ID> <Name>string</Name> <Directions>string</Directions> <Coordinate>... </Coordinate> <Address>... </Address> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Location> <Contact> <ID>normalizedString</ID> <Name>string</Name> <JobTitle>string</JobTitle> <Responsibility>string</Responsibility> <DepartmentName>string</DepartmentName> <Communication>... </Communication> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </Contact> <UserArea> <!--any element--> </UserArea> </Party> <DocumentReference> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> </ItemIDs> <Facility> <IDs>... </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address>... </Address> <Coordinate>... </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot>... </Lot> <Disposition>... </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <SalesOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <PurchaseOrderReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </PurchaseOrderReference> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <IssuingParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </IssuingParty> <OperationReference> <DocumentID>... </DocumentID> <AlternateDocumentID>... </AlternateDocumentID> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <StatusCode>normalizedString</StatusCode> <Status>... </Status> <GroupName>string</GroupName> <SequenceCode>normalizedString</SequenceCode> <StepID>normalizedString</StepID> <StepType>normalizedString</StepType> <UserArea> <!--any element--> </UserArea> </OperationReference> <ReleaseNumber>normalizedString</ReleaseNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <ShipUnitReference> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <UserArea> <!--any element--> </UserArea> </ShipUnitReference> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </EffectiveTimePeriod> <Item> <ItemID>... </ItemID> <CustomerItemID>... </CustomerItemID> <ManufacturerItemID>... </ManufacturerItemID> <SupplierItemID>... </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <ServiceIndicator>true</ServiceIndicator> <Description>string</Description> <Note>string</Note> <Classification>... </Classification> <Specification>... </Specification> <HazardousMaterial>... </HazardousMaterial> <Packaging>... </Packaging> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumber>normalizedString</SerialNumber> <Lot>... </Lot> <UserArea> <!--any element--> </UserArea> </Item> <ID>normalizedString</ID> <SealID>normalizedString</SealID> <Type>normalizedString</Type> <FreightItemID>normalizedString</FreightItemID> <ShippingTrackingID>normalizedString</ShippingTrackingID> <Quantity>1.0</Quantity> <UserArea> <!--any element--> </UserArea> </DocumentReference> <Attachment> <EmbeddedData mimeCode="normalizedString">GpM7</EmbeddedData> <URI>http://www.example.com/</URI> <ISBN>normalizedString</ISBN> <FileName>string</FileName> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <FileType>normalizedString</FileType> <FileSizeQuantity>1.0</FileSizeQuantity> <Title>string</Title> <UserArea> <!--any element--> </UserArea> </Attachment> <OpenItemAmount currencyID="AED">1.0</OpenItemAmount> <OrderAmount currencyID="AED">1.0</OrderAmount> <ApprovedOrderAmount currencyID="AED">1.0</ApprovedOrderAmount> <AvailableAmount currencyID="AED">1.0</AvailableAmount> <OrderLimitAmount currencyID="AED">1.0</OrderLimitAmount> <TotalCreditLimitAmount currencyID="AED">1.0</TotalCreditLimitAmount> <DocumentDateTime>2000-01-01</DocumentDateTime> <EffectiveTimePeriod> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </EffectiveTimePeriod> <LedgerID>normalizedString</LedgerID> <Payment> <CashIndicator>true</CashIndicator> <Amount currencyID="AED">1.0</Amount> <UserArea> <!--any element--> </UserArea> </Payment> <UserArea> <!--any element--> </UserArea> </Credit>