Document Types
Every document type defined by UBL 2.1 to 2.5 is available as a class under Doc in the model
of each version that has it (Derafu\Ubl\V21\Oasis\Doc\Invoice, Derafu\Ubl\V25\Oasis\Doc\Invoice…),
named exactly like the document (Quotation, Invoice, CreditNote, …). There is no
sub-namespace per business domain: most of the underlying building blocks (Party,
MonetaryTotal, TaxTotal, every *Line type) are shared across nearly all of them
regardless of domain, and a document does not belong to a single domain either (an Invoice
is billing, but it is referenced from other flows through BillingReference).
A document is in the model of the version that introduced it and in all the later ones (see Versions).
Available Documents
| Class | Since | Definition |
|---|---|---|
ApplicationResponse |
2.1 | A document to indicate the application’s response to a transaction. This may be a business response initiated by a user or a technical response sent automatically by an application. |
AttachedDocument |
2.1 | A wrapper that allows a document of any kind to be packaged with the UBL document that references it. |
AwardedNotification |
2.1 | The document used to communicate a contract award to the winner. |
BillOfLading |
2.1 | A document issued by the party who acts as an agent for a transportation carrier or other agents to the party who gives instructions for the transportation services (shipper, consignor, etc.) stating the details of the transportation, charges, and terms and conditions under which the transportation service is provided. The party issuing this document does not necessarily provide the physical transportation service. The information in the Bill of Lading corresponds to the information on the Forwarding Instructions. It is used for any mode of transport. A Bill of Lading can serve as a contractual document between the parties for the transportation service. The document evidences a contract of carriage by sea and the acceptance of responsibility for the goods by the carrier, by which the carrier undertakes to deliver the goods against surrender of the document. A provision in the document that the goods are to be delivered to the order of a named person, or to order, or to bearer, constitutes such an undertaking. |
BusinessCard |
2.2 | A document used to provide information about a business party and its business capabilities. |
BusinessInformation |
2.4 | A document used to provide information about a business. |
CallForTenders |
2.1 | A document used by a Contracting Party to define a procurement project to buy goods, services, or works during a specified period. |
Catalogue |
2.1 | A document that describes items, prices, and price validity. |
CatalogueDeletion |
2.1 | A document used to cancel an entire Catalogue. |
CatalogueItemSpecificationUpdate |
2.1 | A document used to update information (e.g., technical descriptions and properties) about Items in an existing Catalogue. |
CataloguePricingUpdate |
2.1 | A document used to update information about prices in an existing Catalogue. |
CatalogueRequest |
2.1 | A document used to request a Catalogue. |
CertificateOfOrigin |
2.1 | A document that describes the Certificate of Origin. |
CommonTransportationReport |
2.3 | A common document used for reporting transport related issues to authorities or regulators. |
ContractAwardNotice |
2.1 | A document published by a Contracting Party to announce the awarding of a procurement project. |
ContractNotice |
2.1 | A document used by a Contracting party to announce a project to buy goods, services, or works. |
CreditNote |
2.1 | A document used to specify credits due to the Debtor from the Creditor. |
DebitNote |
2.1 | A document used to specify debts incurred by the Debtor. |
DeliveryNote |
2.5 | A document confirming the actual delivery of goods or services, detailing delivered items, quantities, and shipment information. |
DespatchAdvice |
2.1 | A document used to describe the despatch or delivery of goods and services. |
DigitalAgreement |
2.2 | A document used to support business parties agreeing on a set of digital processes, terms and conditions to ensure interoperability. |
DigitalCapability |
2.2 | A document used to provide information about a business party and its digital trade capabilities. |
DocumentStatus |
2.1 | A document used to provide information about document status. |
DocumentStatusRequest |
2.1 | A document used to request the status of another document. |
Enquiry |
2.2 | A document sent by a requestor to a responder resquesting information about a particular business process. |
EnquiryResponse |
2.2 | A document sent by a responder to a requester answering a particular enqury. |
ExceptionCriteria |
2.1 | A document used to specify the thresholds for forecast variance, product activity, and performance history beyond which exceptions should be triggered. |
ExceptionNotification |
2.1 | A document used to notify an exception in forecast variance, product activity, or performance history. |
ExportCustomsDeclaration |
2.3 | A customs declaration document for exporting goods |
ExpressionOfInterestRequest |
2.2 | An expression of interest to a tendering process. An Economic Operator can demonstrate interest in a tendering process issuing an Expression Of Interest document to the contracting party. Upon reception, the Contracting Party registers the interest of the Economic Operator sending the relevant information for the tendering process. |
ExpressionOfInterestResponse |
2.2 | An expression of interest confirmation issued by a Contracting Party in reply to an expression of interest. The purpose of this document is to inform the Economic Operator he has been registered as an interested party. |
Forecast |
2.1 | A document used to forecast sales or orders. |
ForecastRevision |
2.1 | A document used to revise a Forecast. |
ForwardingInstructions |
2.1 | A document issued to a forwarder, giving instructions regarding the action to be taken for the forwarding of goods described therein. Forwarding Instructions is used by any party who gives instructions for the transportation services required for a consignment of goods to any party who is contracted to provide the transportation services. The parties who issue this document are commonly referred to as the shipper or consignor, while the parties who receive this document are forwarders, carriers, shipping agents, etc. This document may also be issued by a forwarder or shipping agent in its capacity as a shipper. This document can be used to arrange for the transportation (1) of different types of goods or cargoes; (2) whether containerized or non-containerized; (3) through different modes of transport including multi-modal; and (4) from any origin to any destination. |
FreightInvoice |
2.1 | A document stating the charges incurred for a logistics service. |
FulfilmentCancellation |
2.1 | A document used to cancel an entire fulfilment document (Despatch Advice or Receipt Advice). |
GoodsCertificate |
2.3 | A document that describes a certificate of goods for importation and exportation |
GoodsItemItinerary |
2.1 | A document providing details relating to a transport service, such as transport movement, identification of equipment and goods, subcontracted service providers, etc. |
GoodsItemPassport |
2.3 | A document providing a temporary export license, also knowned as an ATA Carnet |
GuaranteeCertificate |
2.1 | A document to notify the deposit of a bid bond guarantee. |
ImportCustomsDeclaration |
2.3 | A customs declaration document for importing goods. |
InstructionForReturns |
2.1 | A document used to initiate a return of goods. The producer is requesting the return of products that are not selling well, either to use in other places or to free up rack or shelf space. |
InventoryReport |
2.1 | A report on the quantities of each item that are, or will be, in stock. This document is sent by a Buyer (for example a retailer) to a Seller (for example a producer). |
Invoice |
2.1 | A document used to request payment. |
InvoiceStatusRequest |
2.5 | A document used to request the status of a previously issued Invoice. |
InvoiceStatusResponse |
2.5 | A document used to provide information about the status of a collaboration/process associated with a document. |
ItemInformationRequest |
2.1 | A document used to request product activity, forecast, or performance data. |
Manifest |
2.3 | A document listing the contents, cargo, passengers and crew of an airplane, a ship, a truck or a vagon. |
Order |
2.1 | A document used to order goods and services. |
OrderCancellation |
2.1 | A document used to cancel an entire Order. |
OrderChange |
2.1 | A document used to specify changes to an existing Order. |
OrderResponse |
2.1 | A document used to indicate detailed acceptance or rejection of an Order or to make a counter-offer. |
OrderResponseSimple |
2.1 | A document used to indicate simple acceptance or rejection of an entire Order. |
PackingList |
2.1 | A document describing how goods are packed. |
PriorInformationNotice |
2.1 | A document used by a contracting party to declare the intention to buy goods, services, or works during a specified period. |
ProcurementStatus |
2.5 | A document sent by a Contracting Party to an Economic Operator describing the status of a procurement procedure, Project, or Lot. |
ProcurementStatusRequest |
2.5 | A document sent by an Economic Operator to a Contracting Party asking about the details and status of a procurement procedure, Project, or Lot. |
ProductActivity |
2.1 | A document reporting the movement of goods at specified retail locations for inventory tracking purposes. |
ProofOfReexportation |
2.3 | A document providing a status or a proof that goods have been re-exported |
ProofOfReexportationReminder |
2.3 | A reminder that a requested Proof of Reexportation is pending. |
ProofOfReexportationRequest |
2.3 | A document requesting the status or proof that goods have been re-exported |
PurchaseReceipt |
2.4 | A receipt for a purchase made with cash or cash equivalents. |
QualificationApplicationRequest |
2.2 | A document issued by a procurement organization to notify an economic operator whether it has been admitted to or excluded from the tendering process. |
QualificationApplicationResponse |
2.2 | A document issued by a procurement organization to notify an economic operator whether it has been admitted to or excluded from the tendering process. |
Quotation |
2.1 | A document used to quote for the provision of goods and services. |
ReceiptAdvice |
2.1 | A document used to describe the receipt of goods and services. |
Reminder |
2.1 | A document used to remind a customer of payments past due. |
RemittanceAdvice |
2.1 | A document that specifies details of an actual payment. |
RequestForQuotation |
2.1 | A document used to request a Quotation for goods and services from a Seller. |
RetailEvent |
2.1 | A document used to specify basic information about retail events (such as promotions, product introductions, and community or environmental events) that affect supply or demand. |
SelfBilledCreditNote |
2.1 | A credit note created by the debtor in a self billing arrangement with a creditor; Self Billed Credit Note replaces Debit Note in such arrangements. |
SelfBilledInvoice |
2.1 | An Invoice document created by the Customer (rather than the Supplier) in a Self Billing relationship. |
Statement |
2.1 | A document used to report the status of orders, billing, and payment. This document is a statement of account, not a summary invoice. |
StockAvailabilityReport |
2.1 | A report on the quantities of each item that are, or will be, in stock. This document is sent by a Seller (for example a producer) to a Buyer (for example a retailer). |
Tender |
2.1 | A document whereby an economic operator (the tenderer) makes a formal offer (the tender) to a contracting authority to execute an order for the supply or purchase of goods, or for the execution of work, according to the terms of a proposed contract. |
TenderContract |
2.2 | A document published by a Contracting Party to announce the awarding of a procurement project. |
TenderReceipt |
2.1 | A document sent by a contracting party to an economic operator acknowledging receipt of a Tender. |
TenderStatus |
2.2 | A document sent by the Contracting Party to an Economic Operator describing the status of a tendering procedure. |
TenderStatusRequest |
2.2 | A document sent by an Economic Operator asking about the details and status of a tendering procedure. |
TenderWithdrawal |
2.2 | A document sent by an Economic Operator to a Contracting Party with the intention of withdrawing a previously sent Tender document. |
TendererQualification |
2.1 | A document declaring the qualifications of a tenderer. |
TendererQualificationResponse |
2.1 | A document issued by a procurement organization to notify an economic operator whether it has been admitted to or excluded from the tendering process. |
TradeItemLocationProfile |
2.1 | A document specifying trade item attributes relating to replenishment policies. |
TransitCustomsDeclaration |
2.3 | A document that describes an import customs declaration. |
TransportExecutionPlan |
2.1 | A document used in the negotiation of a transport service between a transport user and a transport service provider. |
TransportExecutionPlanRequest |
2.1 | A document sent by a transport user to request a transport service from a transport service provider. |
TransportProgressStatus |
2.1 | A document sent from a Transportation Network Manager to a Transport Service Provider giving the status of the whereabouts and schedule of the transport means involved in a transport service. |
TransportProgressStatusRequest |
2.1 | A document sent from a transport service provider to a transportation network manager requesting a Transport Progress Status. |
TransportServiceDescription |
2.1 | A document sent by a transport service provider to announce the availability of a transport service. |
TransportServiceDescriptionRequest |
2.1 | A document requesting a Transport Service Description, sent from a party with a transport demand (transport user) to a party providing transport services (transport service provider). |
TransportationStatus |
2.1 | A document to circulate reports of transportation status or changes in status (events) among a group of participants. |
TransportationStatusRequest |
2.1 | A document requesting a Transportation Status report. |
UnawardedNotification |
2.1 | A document communicating to a tenderer that the contract has been awarded to different tenderer. |
UnsubscribeFromProcedureRequest |
2.2 | A request to unsubscribe from a tendering procedure. Economic Operators can subscribe to a tendering procedure using the Expression Of Interest. Upon subscription, the Economic Operator keeps receiving relevant documentation for the tendering process. The unsubscribe to procedure document allows the Economic Operator to be removed from the list of interested parties. |
UnsubscribeFromProcedureResponse |
2.2 | A document sent from a Contracting Party to the Economic Operator confirming that the latter has been unsubscribed from a tendering procedure. |
UtilityStatement |
2.1 | A supplement to an Invoice or Credit Note, containing information on the consumption of services provided by utility suppliers to private and public customers, including electricity, gas, water, and telephone services. |
WasteMovement |
2.5 | A document used to report the transport of waste. |
WasteNotification |
2.5 | A document used to notify the competent authorities of planned movements of waste. |
Waybill |
2.1 | A transport document describing a shipment It is issued by the party who undertakes to provide transportation services, or undertakes to arrange for their provision, to the party who gives instructions for the transportation services (shipper, consignor, etc.). It states the instructions for the beneficiary and may contain the details of the transportation, charges, and terms and conditions under which the transportation service is provided. |
WeightStatement |
2.2 | A document used to report weight or verified mass measurements in the transport chain. |
WorkReport |
2.5 | A document used to report work performed. |
Working with a Document
A document is a plain object: build it with its setters, or hydrate one from data with
fromArray(). See Introduction for a complete example, and Formats for reading and
writing documents as json, yaml or xml.