CreditStatus

CreditStatus represents the credit approval status of a customer or a specific customer order.

Element information

Content

• Sequence [1..1]
  from type IdentificationType
  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.
  IDSet [0..*]    
  from type CreditBaseType
  GeneralLedgerElement [0..1]    Accounting code elements
  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.
  from group FreeFormTextGroup
  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.
  from group ReferencesGroup
  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 Amount of the Order.
  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]    The date that document was created within the system of record.
  EffectiveTimePeriod [0..1]    A time period in which an associated object is effective.
  LedgerID [0..1]    Identifies the financial ledger to be used when updating balances
  Payment [0..*]    
  from type CreditStatusBaseType
  SalesOrderReference [0..1]    Is a reference to a SalesOrder
  PurchaseOrderReference [0..1]    Is a reference to a PurchaseOrder
  1. Extension [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 Extension is always the last element in all components, except where the component has been extended inline.

Attributes

Used in

• Type AcknowledgeCreditStatusDataAreaType (Element DataArea)
• Type CancelAcknowledgeCreditStatusDataAreaType (Element DataArea)
• Type CancelCreditStatusDataAreaType (Element DataArea)
• Type ChangeAcknowledgeCreditStatusDataAreaType (Element DataArea)
• Type ChangeCreditStatusDataAreaType (Element DataArea)
• Type GetCreditStatusDataAreaType (Element DataArea)
• Type NotifyCreditStatusDataAreaType (Element DataArea)
• Type ProcessCreditStatusDataAreaType (Element DataArea)
• Type ShowCreditStatusDataAreaType (Element DataArea)
• Type SyncCreditStatusDataAreaType (Element DataArea)
• Type SyncResponseCreditStatusDataAreaType (Element DataArea)

Sample instance

<CreditStatus>
   <ID/>
   <IDSet>
      <ID/>
   </IDSet>
   <GeneralLedgerElement>
      <Element/>
   </GeneralLedgerElement>
   <ApprovalStatus>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Code/>
      <Description/>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason/>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </EffectiveTimePeriod>
      <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>
   </ApprovalStatus>
   <Description/>
   <Note/>
   <Party>
      <ID/>
      <PartyIDSet>
         <ID/>
      </PartyIDSet>
      <TaxIDSet>
         <ID/>
      </TaxIDSet>
      <TaxID>normalizedString</TaxID>
      <DUNSID>normalizedString</DUNSID>
      <CAGEID>normalizedString</CAGEID>
      <DODAACID>normalizedString</DODAACID>
      <BICID>normalizedString</BICID>
      <SCACID>normalizedString</SCACID>
      <AccountID>normalizedString</AccountID>
      <Name/>
      <Location>
         <ID/>
         <IDSet>...
         </IDSet>
         <Name/>
         <Directions/>
         <Coordinate>...
         </Coordinate>
         <Address>...
         </Address>
         <Contact>...
         </Contact>
         <Communication>...
         </Communication>
         <PostalAddress>...
         </PostalAddress>
         <PhysicalAddress>...
         </PhysicalAddress>
         <Description/>
         <Note/>
         <TimeZoneCode>M0100</TimeZoneCode>
         <AvailableTimePeriod>..................
         </AvailableTimePeriod>
         <LocationEquipmentSpecification>...
         </LocationEquipmentSpecification>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Location>
      <Contact>
         <ID/>
         <IDSet>...
         </IDSet>
         <PersonName>...
         </PersonName>
         <RoleCode>normalizedString</RoleCode>
         <JobTitle/>
         <Responsibility/>
         <OrganizationUnitID>normalizedString</OrganizationUnitID>
         <Communication>...
         </Communication>
         <TelephoneCommunication>...
         </TelephoneCommunication>
         <EMailAddressCommunication>...
         </EMailAddressCommunication>
         <InternetAddressCommunication>...
         </InternetAddressCommunication>
         <Preference>...
         </Preference>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Contact>
      <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>
   </Party>
   <DocumentReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <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>
   </DocumentReference>
   <Attachment>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <EmbeddedDataBinaryObject/>
      <URI>normalizedString</URI>
      <ISBN>normalizedString</ISBN>
      <FileName/>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <FileTypeCode>normalizedString</FileTypeCode>
      <FileSizeQuantity>1.0</FileSizeQuantity>
      <Title/>
      <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>
   </Attachment>
   <OpenItemAmount/>
   <OrderAmount/>
   <ApprovedOrderAmount/>
   <AvailableAmount/>
   <OrderLimitAmount/>
   <TotalCreditLimitAmount/>
   <DocumentDateTime></DocumentDateTime>
   <EffectiveTimePeriod>
      <InclusiveIndicator>true</InclusiveIndicator>
      <StartDateTime></StartDateTime>
      <StartTime>token</StartTime>
      <Duration>P1Y2M3DT10H</Duration>
      <EndDateTime></EndDateTime>
      <EndTime>token</EndTime>
   </EffectiveTimePeriod>
   <LedgerID>normalizedString</LedgerID>
   <Payment>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Description/>
      <Note/>
      <PaymentTerm>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <EffectiveDateTime></EffectiveDateTime>
         <DueDateTime></DueDateTime>
         <PaymentBasisCode>token</PaymentBasisCode>
         <Duration>P1Y2M3DT10H</Duration>
         <DiscountPercent>1.0</DiscountPercent>
         <SurchargePercent>1.0</SurchargePercent>
         <Amount/>
         <ProxMonth>1</ProxMonth>
         <ProxDayOfMonth>---31</ProxDayOfMonth>
         <Extension>.......................................
         </Extension>
      </PaymentTerm>
      <Discount>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <EffectiveDateTime></EffectiveDateTime>
         <DueDateTime></DueDateTime>
         <PaymentBasisCode>token</PaymentBasisCode>
         <Duration>P1Y2M3DT10H</Duration>
         <DiscountPercent>1.0</DiscountPercent>
         <SurchargePercent>1.0</SurchargePercent>
         <Amount/>
         <ProxMonth>1</ProxMonth>
         <ProxDayOfMonth>---31</ProxDayOfMonth>
         <Extension>.......................................
         </Extension>
      </Discount>
      <Penalty>
         <ID/>
         <IDSet>...
         </IDSet>
         <Description/>
         <EffectiveDateTime></EffectiveDateTime>
         <DueDateTime></DueDateTime>
         <PaymentBasisCode>token</PaymentBasisCode>
         <Duration>P1Y2M3DT10H</Duration>
         <DiscountPercent>1.0</DiscountPercent>
         <SurchargePercent>1.0</SurchargePercent>
         <Amount/>
         <ProxMonth>1</ProxMonth>
         <ProxDayOfMonth>---31</ProxDayOfMonth>
         <Extension>.......................................
         </Extension>
      </Penalty>
      <DeferredTerm>
         <ID/>
         <IDSet>...
         </IDSet>
         <FullPaymentTerm>...
         </FullPaymentTerm>
         <PaymentPlanTerm>...
         </PaymentPlanTerm>
         <Extension>.......................................
         </Extension>
      </DeferredTerm>
      <LetterOfCredit>
         <ID/>
         <RevisionID>normalizedString</RevisionID>
         <VariationID>normalizedString</VariationID>
         <DocumentIDSet>...
         </DocumentIDSet>
         <DocumentReference>...
         </DocumentReference>
         <Attachment>...
         </Attachment>
         <IssuingParty>...
         </IssuingParty>
         <BuyerParty>...
         </BuyerParty>
         <SupplierParty>...
         </SupplierParty>
         <GuarenteeDate></GuarenteeDate>
         <GuarnteeAmount/>
         <Extension>.......................................
         </Extension>
      </LetterOfCredit>
      <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>
   </Payment>
   <SalesOrderReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <ReleaseNumberID>normalizedString</ReleaseNumberID>
      <ScheduleLineNumberID>normalizedString</ScheduleLineNumberID>
      <SubLineNumberID>normalizedString</SubLineNumberID>
      <OrderQuantity>1.0</OrderQuantity>
      <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>
   </SalesOrderReference>
   <PurchaseOrderReference>
      <ID/>
      <RevisionID>normalizedString</RevisionID>
      <VariationID>normalizedString</VariationID>
      <DocumentIDSet>
         <ID/>
      </DocumentIDSet>
      <DocumentDateTime></DocumentDateTime>
      <Description/>
      <Note/>
      <Status>
         <ID/>
         <IDSet>...
         </IDSet>
         <Code/>
         <Description/>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason/>
         <EffectiveTimePeriod>..................
         </EffectiveTimePeriod>
         <Extension>.......................................
         </Extension>
      </Status>
      <LineNumberID/>
      <LineIDSet>
         <ID/>
      </LineIDSet>
      <ReleaseNumberID>normalizedString</ReleaseNumberID>
      <ScheduleLineNumberID>normalizedString</ScheduleLineNumberID>
      <SubLineNumberID>normalizedString</SubLineNumberID>
      <OrderQuantity>1.0</OrderQuantity>
      <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>
   </PurchaseOrderReference>
   <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>
</CreditStatus>