version: working
Introduction
Regulatory processes often involve certificates that assert compliance of a shipment with some specification or legislative framework. For example
- A Certificate of Origin (CoO) is issued by an accredited body on behalf of an exporter and is required by the importing regulator. It asserts that the goods in a consignment conform to the terms of a Free Trade Agreement (FTA) and so may attract concenssional duty terms.
- A Certifictae of Non Manipulation (CoNM) is issued by an accredited body on behalf of a transhipment port/country and it asserts that goods in a consignment were not altered during transhipment.
- A PhtoSanitary certificate is issued by an accredity authority on behalf of an exporter of food products and is required to meet the food safety standards of the importing regulator.
- And dozens of others.
In most cases certificates are about a consignment of goods. Accordingly, the edi3 approach to defining the data model of certifictaes is to “attach” certificate data to the existing UN/CEFACT trade and transport data models.
Goals
To publish a consistent suite of data models and state lifecycles for various certifictaes used to satisfy regulatory processes and to support the Inter Customs Ledger project.
Status
This specification is in draft state. This means that design consensus has been reached and the specification is ready for implementation verification.
All material published on edi3.org including all parts of this specification are the intellectual property of the UN as per the UN/CEFACT IPR Policy.
This Specification is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. See http://www.gnu.org/licenses.
Change Process
This document is governed by the 2/COSS (COSS).
Language
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Certificate Of Origin
Data Model of jargon/CustomsDeclaration
The Certificate of Origin (CoO) Data model is drawn from the UN/CEFACT Buy-Ship-Pay reference data model and conforms to the edi3 UML profile specification
Data Definitions of jargon/CustomsDeclaration
ExportDeclaration
| Property | Definition | Type |
|---|---|---|
| sender | SenderDetails | |
| expectedDateOfExport | The date, time, date time or other date time value when this supply chain consignment will exit, or has exited from the last port, airport, or border post of the country of export. | Text |
| consignmentId | The unique identifier of this logistics label. | Text |
| warehouseId | The unique identifier of this logistics label. | Text |
| branchId | The unique identifier of this logistics label. | Text |
| customableExciseIndicator | Identifies if this export is excisable. | Indicator |
| goodsOwner | PartyDetails | |
| confirmingExportType | An identifier assigned to indicate conformity with a regulation or standard for this trade product, such as "CE" which declares that the product conforms with the essential requirements of the applicable EC directives. | Text |
| transport | TransportDetails | |
| goodsDetails | GoodsDetail | |
| invoiceDetails | InvoiceDetail | |
| items | ItemDetails |
DeclarationReciept
| Property | Definition | Type |
|---|---|---|
| notes | An additional statement note for this exchanged declaration. | Note |
| declarantAgentParty | The name, expressed as text, for this trade product group. | Text |
| identificationId | The unique identifier of this logistics label. | Text |
| issueDateTime | The date, time, date time or other date time value for the issuance of this acknowledgement document. | Text |
ItemDetails
| Property | Definition | Type |
|---|---|---|
| globalId | A globally unique identifier of this trade party. | Text |
| description | A textual description of this supply chain schedule. | Text |
| weight | The measure of the gross weight (mass) of this referenced logistics package and its contents. | Text |
| unitValue | A monetary value of the unit of this trade price. | Text |
| quantity | The number of packages in this subordinate line trade delivery. | Text |
InvoiceDetail
| Property | Definition | Type |
|---|---|---|
| currencyCode | The code specifying the source currency of a trade related currency conversion. | Text |
| FOBCurrencyCode | The code specifying the source currency of a trade related currency conversion. | Text |
| totalFOBValue | The monetary value of all freight and other service charges for this supply chain consignment item. | Text |
GoodsDetail
| Property | Definition | Type |
|---|---|---|
| exportGoodsType | The code specifying the type of specification query. | Text |
| totalPackages | The number of packages in this subordinate line trade delivery. | Text |
| totalContainers | The number of packages in this subordinate line trade delivery. | Text |
TransportDetails
| Property | Definition | Type |
|---|---|---|
| consigneeName | The name, expressed as text, for this trade product group. | Text |
| consigneeCity | The name, expressed as text, of the city, town or village of this trade address. | Text |
| portOfLoading | The name, expressed as text, for this trade product group. | Text |
| firstPortOfDischarge | The name, expressed as text, for this trade product group. | Text |
| finalDestinationCountryCode | The unique identifier of this logistics label. | Text |
| modeOfTransport | The type, as expressed as text, of the logistics transport movement. | Text |
| vesselId | The unique identifier of this logistics label. | Text |
| voyageNumber | A unique identifier for this logistics transport movement, such as a voyage number, flight number, or trip number, as stated in a schedule. | Text |
| flightNumber | A unique identifier for this logistics transport movement, such as a voyage number, flight number, or trip number, as stated in a schedule. | Text |
SenderDetails
| Property | Definition | Type |
|---|---|---|
| partyDetails | PartyDetails | |
| senderReference | The sender-recipient sequence identifier for this supply chain trade transaction. | Text |
PartyDetails
| Property | Definition | Type |
|---|---|---|
| id | The unique Business Entity Identifier (BEI) as defined by ISO 9362 (Banking telecommunication messages, Bank Identifier Codes) for this requesting party. | Text |
State Diagram of Declaration
The Certificate of Origin (CoO) Data model is drawn from the UN/CEFACT Buy-Ship-Pay reference data model and conforms to the edi3 UML profile specification
State Diagram of Invoice
The Certificate of Origin (CoO) Data model is drawn from the UN/CEFACT Buy-Ship-Pay reference data model and conforms to the edi3 UML profile specification
Open API Specification of jargon/CustomsDeclaration
This specification is available in different forms:
- As a JSON specification
- As a browsable Swagger Ui page
Code Tables of jargon/Payroll
PaymentType
| Name | Description | Numeric |
|---|---|---|
| Payment | A regular, recurring payment | 01 |
| Benefit | An irregular payment, for a specific condition of employment or occurance | 02 |
| Pension | A recurring payment after employment is termniated | 03 |
| Allowance | A regular, recurring payment | 04 |
AccrualPeriod
| Name | Value | Description |
|---|---|---|
| Montly | M | Happens on a monthly basis |
| Weekly | W | Happens on a weekly basis |
| Annual | A | Happens yearly |
SuperannutionContribution
| Name | Description |
|---|---|
| Voluntary | A contribution above the legal minimum |
| Mandatory | The legal minimum required contribution |
Allowances
| Name | Value | Description |
|---|---|---|
| Car | C | For a work vehicle |
| Laundry | L | For cleaning work outfits and apparel |
| Meals | M | For meals during work activities |
Imported Domains
- [declaration] - jargon/CustomsDeclaration:0.0.2
- [payroll] - jargon/Payroll:0.0.1
- [rfc2119] - jargon/rfc2119:0.0.1