BillOfLadingReference
Is a reference to the associated Bill of Lading document.
See http://www.openapplications.org/platform/1.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_platform/1_1_1/Common/OAGi/Components/Components.xsd
Type: DocumentReferenceType
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.
- DocumentDateTime [0..1] The date that document was created within the system of record.
- Sequence
[0..1]
- Description [0..*]
- Note [0..*]
- StatusCode [0..1] Is the Code to indicate the status for the Noun or Component in which the Status Component occurs.
- Status [0..*] Indicates the status of the associated object by providing the Status Code along with a description and when the status is effective.
- LineNumber [0..1] Is the Line Number of the given Line Coponent within the document. LineNumbers are assigned by the sending system.
- ItemIDs [0..1] The Item identifiers that uniquily identify a given item. These identifiers may be specific to the party in which they make reference.
- Facility [0..*] A Facility identifies a location within an entity. The facility may have sub-locators identified using a sequenced identification notation e.g. Warehouse A100 Sub-Location 11, Row R10 would be represented as an array of three Facility elements with values as A100, 11, R10, name attribute as Warehouse, Sub-Location and Row and sequence attribute as 1,2 and 3 respectively.
- SerializedLot [0..*] Is the Lot and Setial numbers for the items contained in the associated component by identifing the number of items and the uniques serial number of those items that belong to a given Lot.
- SalesOrderReference [0..*] Is a reference to a SalesOrder
- PurchaseOrderReference [0..*] Is a reference to a PurchaseOrder
- GroupName [0..*] Identifies a grouping of entities together. An example usage may be a grouping of Operatations for a Routing.
- SequenceCode [0..1] Identifies the sequence in which the associated entity is to occur with in a given operation, step or business process..
- StepID [0..1] Identifies the step of the operation being reported against.
- StepType [0..1] Indicates the type of step that the operations reference is..
- IssuingParty [0..1] Identifies the Party that issued the invoice
- OperationReference [0..*] Is a reference to an associated work-in-process operation.
- ReleaseNumber [0..1] Identifies the Release Number in the case of Blanket POs
- ScheduleLineNumber [0..1] Is the ScheduleLineNumber of a particular item of interest for the given DocumentReference. The Line Number is of the primary DocumentId of the sender indicated by the DocumentId under DocumentIds.
- SubLineNumber [0..1] Is the SublineNumber of a particular item of interest for the given DocumentReference. The Line Number is of the primary DocumentId of the sender indicated by the DocumentId under DocumentIds.
- ShipUnitReference [0..1]
- EffectiveTimePeriod [0..1] Indicates the time period in which the associated component is effective.
- Item [0..1] Identifies the Item associated with the Line or Detail of a transaction. The item provides the details of the generic Item component information.
- 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.
- SealID [0..1] Identifies the tamper-proof seal placed on a shipping container to prevent pilfering of the contents.
- Type [0..1] Indicates the type of the object in which assoicated.
- FreightItemID [0..1] Identifies the item number assigned to the type of goods for the purposes of freight classification and cost calculation.
- ShippingTrackingID [0..1] Is a unique identifier for the purpose of tracking an individual package or shipment.
- Quantity [0..*] Identifies the quantity of the associated service or item that is addresses by the component in which the quantity is associated.
- 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 DocumentReferenceBaseTypefrom group DocumentIDsGroupfrom group FreeFormTextGroup - Sequence
[0..1]
Attributes
Name | Occ | Type | Description | Notes |
---|---|---|---|---|
type | [0..1] | TokenType |
Used in
- Type ShipmentHeaderBaseType
- Type PickListHeaderType (Element PickListHeader)
- Type StopDetailType (Element StopDetail)
- Type ReceiveDeliveryHeaderType via extension of ShipmentHeaderBaseType (Element ReceiveDeliveryHeader)
- Type ShipmentHeaderType via extension of ShipmentHeaderBaseType (Element ShipmentHeader)
Sample instance
<BillOfLadingReference> <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> <InclusiveIndicator>true</InclusiveIndicator> <StartDateTime>2000-01-01</StartDateTime> <Duration>P1Y2M3DT10H</Duration> </TimePeriod> <UserArea> <!--any element--> </UserArea> </Status> <LineNumber>normalizedString</LineNumber> <ItemIDs> <ItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </ItemID> <CustomerItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </CustomerItemID> <ManufacturerItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </ManufacturerItemID> <SupplierItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> </ItemIDs> <Facility> <IDs> <ID>normalizedString</ID> </IDs> <Name>string</Name> <Description>string</Description> <Note>string</Note> <Address> <ID>normalizedString</ID> <FormatCode>normalizedString</FormatCode> <AttentionOfName>string</AttentionOfName> <CareOfName>string</CareOfName> <AddressLine>string</AddressLine> <CitySubDivisionName>string</CitySubDivisionName> <CityName>string</CityName> <CountrySubDivisionCode>normalizedString</CountrySubDivisionCode> <CountryCode>normalizedString</CountryCode> <PostalCode>normalizedString</PostalCode> <Status>... </Status> <Preference>... </Preference> <UserArea> <!--any element--> </UserArea> </Address> <Coordinate> <Latitude>... </Latitude> <Longitude>... </Longitude> <AltitudeMeasure unitCode="normalizedString">1.0</AltitudeMeasure> <UserArea> <!--any element--> </UserArea> </Coordinate> <UserArea> <!--any element--> </UserArea> </Facility> <SerializedLot> <ItemQuantity>1.0</ItemQuantity> <Lot> <LotIDs>... </LotIDs> <EffectiveTimePeriod>... </EffectiveTimePeriod> <Quantity>1.0</Quantity> <SerialNumber>normalizedString</SerialNumber> <RFID>normalizedString</RFID> <UserArea> <!--any element--> </UserArea> </Lot> <Disposition> <Code>normalizedString</Code> <Description>string</Description> <EffectiveDateTime>2000-01-01</EffectiveDateTime> <ReasonCode>normalizedString</ReasonCode> <Reason>string</Reason> <TimePeriod>... </TimePeriod> <UserArea> <!--any element--> </UserArea> </Disposition> <SerialNumber>normalizedString</SerialNumber> <ParentSerialNumber>normalizedString</ParentSerialNumber> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </SerializedLot> <SalesOrderReference> <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> <ReleaseNumber>normalizedString</ReleaseNumber> <LineNumber>normalizedString</LineNumber> <ScheduleLineNumber>normalizedString</ScheduleLineNumber> <SubLineNumber>normalizedString</SubLineNumber> <UserArea> <!--any element--> </UserArea> </SalesOrderReference> <PurchaseOrderReference> <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> <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> <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> </IssuingParty> <OperationReference> <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> <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> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </ItemID> <CustomerItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </CustomerItemID> <ManufacturerItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </ManufacturerItemID> <SupplierItemID> <ID>normalizedString</ID> <RevisionID>normalizedString</RevisionID> <VariationID>normalizedString</VariationID> </SupplierItemID> <UPCID>normalizedString</UPCID> <EPCID>normalizedString</EPCID> <ServiceIndicator>true</ServiceIndicator> <Description>string</Description> <Note>string</Note> <Classification> <Codes> </Codes> <Description>string</Description> <Note>string</Note> <UserArea> <!--any element--> </UserArea> </Classification> <Specification> <ID>normalizedString</ID> <Property>... </Property> <UserArea> <!--any element--> </UserArea> </Specification> <HazardousMaterial> <ID>normalizedString</ID> <MFAGID>normalizedString</MFAGID> <TechnicalName>string</TechnicalName> <PlacardEndorsement>string</PlacardEndorsement> <PlacardNotation>string</PlacardNotation> <MarinePollutionLevelCode>normalizedString</MarinePollutionLevelCode> <ToxicityZoneCode>normalizedString</ToxicityZoneCode> <Temperature unitCode="normalizedString">1.0</Temperature> <FlashpointTemperature unitCode="normalizedString">1.0</FlashpointTemperature> <PrimaryEntryRoute>string</PrimaryEntryRoute> <Description>string</Description> <EmergencyContact>... </EmergencyContact> <UserArea> <!--any element--> </UserArea> </HazardousMaterial> <Packaging> <ID>normalizedString</ID> <Description>string</Description> <Note>string</Note> <Type>normalizedString</Type> <Dimensions>... </Dimensions> <UPCPackagingLevelCode>normalizedString</UPCPackagingLevelCode> <PerPackageQuantity>1.0</PerPackageQuantity> <CapacityPerPackageQuantity>1.0</CapacityPerPackageQuantity> <UserArea> <!--any element--> </UserArea> </Packaging> <CountryOfOriginCode>normalizedString</CountryOfOriginCode> <RFID>normalizedString</RFID> <SerialNumber>normalizedString</SerialNumber> <Lot> <LotIDs>... </LotIDs> <EffectiveTimePeriod>... </EffectiveTimePeriod> <Quantity>1.0</Quantity> <SerialNumber>normalizedString</SerialNumber> <RFID>normalizedString</RFID> <UserArea> <!--any element--> </UserArea> </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> </BillOfLadingReference>