RemittanceAdviceHeader
The Remittance Advice Header contains information that applies to the entire remittance advice. This Component is required.
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/RemittanceAdvice.xsd
Type: RemittanceAdviceHeaderType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- Sequence
[0..1]
- DocumentID [0..1] Is the primary document id for the document associated.
- AlternateDocumentID [0..*] Is the alternate document id for the associated document.
- 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.
- Sequence
[0..1]
- Description [0..*]
- Note [0..*]
- 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.
- Status [0..*] Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
- EffectiveDate [0..1] This is the Date the associated object is made effective
- InitiatingParty [0..1] Party initiating the payment to the forwarding or first agent. This can be the debtor (in a credit transfer), the creditor (in a direct debit) or a party that initiates the payment on behalf of the debtor or creditor.
- BillToParty [0..1] Identifies the party that the bill or invoice is to be sent. In most cases this is the same as the CustomerParty however there are many cases where the CustomerParty and the BillToParty will be different.
- FinancialParty [0..1] Financial institution that receives the payment transaction from the account owner or authorised party and processes the instruction.
- RemitToParty [0..1] Identifies the party or location that the payment is to be remitted to or sent to.
- 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.
- ChequeInstruction [0..1] Information related to a cheque instruction.
- PaymentMethodCode [0..1] Is the payment method code for the associate entity.
- TotalAmount [0..1] Indicates the total amount of the object associated. This includes the Price and the total of all the charges, allowances and taxes.
- TransactionID [0..1] Unique and unambiguous identification of a payment transaction, as assigned by any of the parties on the initiating side, which will be passed on throughout the entire end-to-end chain.
- 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 HeaderTypefrom group DocumentIDsGroupfrom group FreeFormTextGroupfrom group ReferencesGroupfrom type StatusEnabledHeaderType - Sequence
[0..1]
Attributes
None
Used in
- Type RemittanceAdviceType (Element RemittanceAdvice)
Sample instance
<RemittanceAdviceHeader> <DocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </DocumentID> <AlternateDocumentID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </AlternateDocumentID> <LastModificationDateTime>2000-01-01</LastModificationDateTime> <DocumentDateTime>2000-01-01</DocumentDateTime> <Description>string</Description> <Note>string</Note> <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> <Status> <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> </Status> <EffectiveDate>2000-01-01</EffectiveDate> <InitiatingParty> <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> </InitiatingParty> <BillToParty> <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> <CustomerAccountID>normalizedString</CustomerAccountID> <RequesterContact> <ID>normalizedString</ID> <Name>string</Name> <JobTitle>string</JobTitle> <Responsibility>string</Responsibility> <DepartmentName>string</DepartmentName> <Communication>... </Communication> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </RequesterContact> <PlannerContact> <ID>normalizedString</ID> <Name>string</Name> <JobTitle>string</JobTitle> <Responsibility>string</Responsibility> <DepartmentName>string</DepartmentName> <Communication>... </Communication> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </PlannerContact> <BuyerContact> <ID>normalizedString</ID> <Name>string</Name> <JobTitle>string</JobTitle> <Responsibility>string</Responsibility> <DepartmentName>string</DepartmentName> <Communication>... </Communication> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </BuyerContact> <ReceivingContact> <ID>normalizedString</ID> <Name>string</Name> <JobTitle>string</JobTitle> <Responsibility>string</Responsibility> <DepartmentName>string</DepartmentName> <Communication>... </Communication> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </ReceivingContact> <UserArea> <!--any element--> </UserArea> </BillToParty> <FinancialParty> <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> <ClearingSystemMemberID>normalizedString</ClearingSystemMemberID> <BranchParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </BranchParty> <FinancialAccount> <ID>normalizedString</ID> <AccountIDs>... </AccountIDs> <CurrencyCode>AED</CurrencyCode> <Name>string</Name> <Type>normalizedString</Type> <UserArea> <!--any element--> </UserArea> </FinancialAccount> <CountryCode>normalizedString</CountryCode> <UserArea> <!--any element--> </UserArea> </FinancialParty> <RemitToParty> <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> <FinancialAccount> <ID>normalizedString</ID> <AccountIDs>... </AccountIDs> <CurrencyCode>AED</CurrencyCode> <Name>string</Name> <Type>normalizedString</Type> <UserArea> <!--any element--> </UserArea> </FinancialAccount> <UserArea> <!--any element--> </UserArea> </RemitToParty> <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> <ChequeInstruction> <ChequeNumber>normalizedString</ChequeNumber> <DeliveryMethodCode>normalizedString</DeliveryMethodCode> <ChequeFromParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </ChequeFromParty> <DeliverToParty> <PartyIDs>... </PartyIDs> <AccountID>normalizedString</AccountID> <Name>string</Name> <Location>... </Location> <Contact>... </Contact> <UserArea> <!--any element--> </UserArea> </DeliverToParty> <PriorityCode>normalizedString</PriorityCode> <ChequeMaturityDate>2000-01-01</ChequeMaturityDate> <ChequeFormsCode>normalizedString</ChequeFormsCode> <ChequeMemoFieldText>string</ChequeMemoFieldText> <RegionalClearingZoneID>normalizedString</RegionalClearingZoneID> <UserArea> <!--any element--> </UserArea> </ChequeInstruction> <PaymentMethodCode>Cash</PaymentMethodCode> <TotalAmount currencyID="AED">1.0</TotalAmount> <TransactionID>normalizedString</TransactionID> <UserArea> <!--any element--> </UserArea> </RemittanceAdviceHeader>