FreightInvoiceHeaderType

The InvoiceHeader type supports summary amounts for line items, charges and allowances.

Complex type 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 FreightInvoiceHeaderBaseType
  ExtendedAmount [0..1]    Is an amount not including taxes or charges. In the case of orders, this is typically the Unit Price times the Order Quantity.
  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.
  AmountDiscount [0..*]    Specifies details for how an amount is calculated
  SupplierParty [0..1]    Identifies the supplier organization/entity of the items or inventory for the associated transaction. In most cases there is one SupplierParty per transaction. i.e. one SupplierParty for a given PurchaseOrder. However in the cases where an transaction Broker is involved there are cases where a single transaction may have different SupplierParties at the line level or in the case of a Catalog for the Catalog.
  CustomerParty [0..1]    Is the organization that is the end customer of the goods or services being provided in the associated transaction.
  RemitToParty [0..1]    Identifies the party or location that the payment is to be remitted to or sent to.
  ShipToParty [0..*]    Identifies the ShipToParty for the document or the line. In a lot of cases, this is the same as the CustomerParty. In multi-organization purchasing, the CustomerParty may be different from the BuyerParty
  CarrierParty [0..*]    Identifies the party that serves as the carrier of the goods or services for the transaction.
  BillToParty [0..*]    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.
  ShipFromParty [0..*]    Identifies the party that the goods or services are being shipped or sent from.
  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.
  ReasonCode [0..1]    Identifies the reason for an activity
  PurchaseOrderReference [0..*]    Is a reference to a PurchaseOrder
  ContractReference [0..*]    Is a reference to a contract
  AdditionalDocumentRequest [0..*]    Request to send additional documents be sent along with item (shipment message, warranty information, financial information) and where to send
  PaymentTerm [0..*]    Identifies the Terms i.e. the time and number of payments and the amount or percentage of the payment.
  Payment [0..1]    
  Tax [0..*]    Specifies all the details needed for specific kinds of Taxes and Tax charges
  DistributeCharge [0..*]    Specifies the details for allocating a portion of a charge properly
  DistributeTax [0..*]    Specifies the details for allocating a portion of a tax properly
  Distribution [0..*]    A distribution of the financial credit or debit of the transaction across an organization.
  Charge [0..*]    Specifies the details for Charges that may be applied to the associated transaction
  Allowance [0..*]    Specifies the discount or allowance that the Customer is to receive off of the TotalAmount owed as a result of the associated document or sub-portion of a document.
  TransportationMethodCode [0..1]    Identifies the general type of carrier transportation used to deliver goods.
  TransportationTerm [0..*]    The terms of the transportation agreement.
  from group ShippingWeightAndVolumeGroup
  DunnageWeightMeasure [0..1]    Specifies details of the shipped unit weight
  TareWeightMeasure [0..1]    Tare weight of the associated Entity. The Tare weight is the weight of the packaging when empty (in the case of a pallet the weight of the empty pallet) that when subtracted from the Gross weight results in the Net weight.
  NetWeightMeasure [0..1]    Net weight of the associaed item. The net weight is calculated by subtracting the tare weight or the weight of the container from the GrossWeight.
  GrossWeightMeasure [0..1]    Gross weight of the associated entity. The total weight of the entity without reduction of packaging or container. I.e The Gross wieght of a pallet of goods includes the weight of the pallet.
  NetVolumeMeasure [0..1]    
  TotalVolumeMeasure [0..1]    Quantifies the volume, or amount of space, that is occupied by an item, container or shipment.
  TransportStep [0..*]    
  Event [0..*]    Specifies details about a specific occurrence in time
  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 by

• Element FreightInvoiceHeader

Type inheritance chain

• DocumentIdentificationBaseType
  • HeaderBaseType
    • StatusHeaderBaseType
      • FreightInvoiceHeaderBaseType
        • FreightInvoiceHeaderType