InvoiceLedgerEntryHeader

Information that applies to the entire unapproved invoice document.

The InvoiceReference in the Header is a reference to the external invoice that is being referred to in the document.

The Voucher Reference is an internal voucher, possibly against the external invoice

The Tax element contains any tax information such as the taxable amounts and the tax codes.  It is optional and used to summarize tax amounts across all the document lines. The principal intent of this data type is for use as a memo item

Element information

Content

• Sequence [1..1]
  from type DocumentIdentificationBaseType
  ID [0..1]    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.
  RevisionID [0..1]    Is the revision of the semantically named document. The combination of the ID and its revision uniquely identifies the associated entity.
  VariationID [0..1]    
  DocumentIDSet [0..*]    
  from type HeaderBaseType
  LastModificationDateTime [0..1]    The datetime on which the object was last modified
  DocumentDateTime [0..1]    The date that document was created within the system of record.
  from group FreeFormTextGroup
  Description [0..*]    
  Note [0..*]    
  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.
  from type StatusHeaderBaseType
  Status [0..*]    Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
  from type LedgerEntryHeaderBaseType
  LedgerID [0..1]    Identifies the financial ledger to be used when updating balances
  GLEntityID [0..1]    A G/L entity is the smallest organizational unit for which individual financial statements must be drawn up according to relevant commercial law. It is normally the primary balancing segment of the GL Account structure. Typically, this is the owning entity for the transaction. Synonyms are Business Unit, Fund, G/L Company, Joint Venture, Non-Profit Association Name
  AccountingPeriod [0..1]    A period used for accounting period.
  SourceDocumentReference [0..1]    This is the link that ties back to a sub ledger transaction entry ID. It is the identifier of an original/ source transaction or document. The type indicates the type of document i.e. PurchaseOrder, Invoice, Receipt, Credit Memo, Voucher etc. For example, it could be the receipt or the summarized inventory activity. This is the singular field that refers to an audit record. Together with the Sender information, this is part of the referencing system, which will enable drill back audit trail functionality.
  from group LedgerAmountGroup
  Amount [0..1]    The monetary value of the object in which the amount is associated
  DebitCreditCode [0..1]    
  TaxBaseAmount [0..1]    This is the Amount for the associated object expressed in the ledger or base currency
  FunctionalAmount [0..1]    The monetary value of the object to which the FunctionalAmount is associated, expressed in the ledger or base currency
  TaxBaseFunctionalAmount [0..1]    This is the Tax Amount for the associated object expressed in the ledger or base currency
  CurrencyExchangeRate [0..1]    A rate of exchange between two currencies.
  EntryCreatorUser [0..1]    Identifies the user that creates the associated transaction
  PaymentTerm [0..*]    Identifies the Terms i.e. the time and number of payments and the amount or percentage of the payment.
  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 type InvoiceLedgerEntryHeaderBaseType
  VoucherReference [0..1]    Is a reference to a voucher document. This is typically an internal voucher, possibly created as a a payable reference against an external invoice
  RemittanceID [0..1]    Remittance refers to a reference identifier to print on a remittance advice, for example, supplier invoice number.
  PayeeParty [0..1]    This is a Party that is identified as a Payee on an Accounts Payable document. The SupplierParty of the goods or services typically.
  RemitToParty [0..1]    Identifies the party or location that the payment is to be remitted to or sent to.
  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

None

Used in

• Type InvoiceLedgerEntryType (Element InvoiceLedgerEntry)

Sample instance

<InvoiceLedgerEntryHeader>
   <ID/>
   <RevisionID>normalizedString</RevisionID>
   <VariationID>normalizedString</VariationID>
   <DocumentIDSet>
      <ID/>
   </DocumentIDSet>
   <LastModificationDateTime></LastModificationDateTime>
   <DocumentDateTime></DocumentDateTime>
   <Description/>
   <Note/>
   <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>
   <Status>
      <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>
   </Status>
   <LedgerID>normalizedString</LedgerID>
   <GLEntityID>normalizedString</GLEntityID>
   <AccountingPeriod>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <PeriodID>normalizedString</PeriodID>
      <PostDateTime></PostDateTime>
      <Year>1999</Year>
      <Name/>
      <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>
   </AccountingPeriod>
   <SourceDocumentReference>
      <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>
   </SourceDocumentReference>
   <Amount/>
   <DebitCreditCode>token</DebitCreditCode>
   <TaxBaseAmount/>
   <FunctionalAmount/>
   <TaxBaseFunctionalAmount/>
   <CurrencyExchangeRate>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <SourceCurrencyCode>token</SourceCurrencyCode>
      <SourceUnitBaseNumber>1.0</SourceUnitBaseNumber>
      <TargetCurrencyCode>token</TargetCurrencyCode>
      <TargetUnitBaseNumber>1.0</TargetUnitBaseNumber>
      <RateNumber>1.0</RateNumber>
      <SetDateTime></SetDateTime>
      <SourceID>normalizedString</SourceID>
      <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>
   </CurrencyExchangeRate>
   <EntryCreatorUser>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <GroupID>normalizedString</GroupID>
      <UserAccount>
         <ID/>
         <IDSet>...
         </IDSet>
         <SystemID>normalizedString</SystemID>
         <AccountID>normalizedString</AccountID>
         <AccountTypeCode>normalizedString</AccountTypeCode>
         <UserAuthorization>...
         </UserAuthorization>
         <Extension>.......................................
         </Extension>
      </UserAccount>
      <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>
   </EntryCreatorUser>
   <PaymentTerm>
      <ID/>
      <IDSet>
         <ID/>
      </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>
         <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>
   </PaymentTerm>
   <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>
   <VoucherReference>
      <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>
   </VoucherReference>
   <RemittanceID>normalizedString</RemittanceID>
   <PayeeParty>
      <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>
   </PayeeParty>
   <RemitToParty>
      <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>
      <FinancialAccount>
         <ID/>
         <BBANID>normalizedString</BBANID>
         <IBANID>normalizedString</IBANID>
         <UPICID>normalizedString</UPICID>
         <AccountIDs>...
         </AccountIDs>
         <CurrencyCode>token</CurrencyCode>
         <Name/>
         <Extension>.......................................
         </Extension>
      </FinancialAccount>
      <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>
   </RemitToParty>
   <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>
</InvoiceLedgerEntryHeader>