DEX Schemas (1.0.1 DRAFT)
Download OpenAPI specification:
This document describes the Schemas used for the various use cases.
For the full API specifications please CLICK HERE.
Look for the Use Case you are using on the left menu
Check the API you are using to see if you need
payloadorparameters.
The following APIs usepayload:- PUSH
/data/push - STORE
/data/store - RECEIVE
/data/receive
The following APIs use
parameters:- PULL
/data/pull - FORWARD
/data/forward - PROVIDE
/data/provide
- PUSH
For
payload, look under the (Payload) section in the use case;
forparameters, look under the (Parameters) section in the use case.Look for the Data Element you require under the appropriate Payload/Parameter section, and find the sample JSON format on the panel on the right-hand side.
Copy the sample JSON format and insert it into the relevant
payloadorparametersattribute in your API request/response, along with the appropriate values in the JSON.
For /data/push/bill_of_lading:
You would take the sample JSON from Use Case A (Payload) -> Oil Cargo Bill
of Lading.
Sample JSON payload:
{
"bl_doc_no": "string",
"bl_dt": "2019-08-24",
"bl_shipper_nm": "string",
"bl_consignee_nm": "string",
"bl_terminal_nm": "string",
"bl_port_of_loading": "string",
"bl_port_of_discharge": "string",
"bl_vessel_nm": "string",
"bl_country_of_origin": "string",
"bl_country_of_destination": "string",
"bl_goods_particulars": [
{
"bl_goods_nm": "string",
"bl_goods_qty_amt": "string",
"bl_goods_qty_uom": "string"
}
],
"attachments": [
{
"filename": "string",
"file_content": "string"
}
],
"bl_order_no": "string",
"bl_vessel_flag": "string",
"bl_master_nm": "string",
"bl_terms_and_condition_and_other_text": "string",
"bl_vessel_imo_no": "string",
"bl_notify_party_nm": "string"
}
Final API request body would look something like this:
{
"parent_node_id": "string",
"parent_node_type": "FOLDER",
"payload": [
{
"bl_doc_no": "BL_001",
"bl_dt": "2019-08-24",
"bl_shipper_nm": "string",
"bl_consignee_nm": "string",
"bl_terminal_nm": "string",
"bl_port_of_loading": "string",
"bl_port_of_discharge": "string",
"bl_vessel_nm": "string",
"bl_country_of_origin": "string",
"bl_country_of_destination": "string",
"bl_goods_particulars": [
{
"bl_goods_nm": "string",
"bl_goods_qty_amt": "string",
"bl_goods_qty_uom": "string"
}
],
"attachments": [
{
"filename": "string",
"file_content": "string"
}
],
"bl_order_no": "string",
"bl_vessel_flag": "string",
"bl_master_nm": "string",
"bl_terms_and_condition_and_other_text": "string",
"bl_vessel_imo_no": "string",
"bl_notify_party_nm": "string"
}
,
{
"bl_doc_no": "BL_002",
"bl_dt": "2019-08-24",
"bl_shipper_nm": "string",
"bl_consignee_nm": "string",
"bl_terminal_nm": "string",
"bl_port_of_loading": "string",
"bl_port_of_discharge": "string",
"bl_vessel_nm": "string",
"bl_country_of_origin": "string",
"bl_country_of_destination": "string",
"bl_goods_particulars": [
{
"bl_goods_nm": "string",
"bl_goods_qty_amt": "string",
"bl_goods_qty_uom": "string"
}
],
"attachments": [
{
"filename": "string",
"file_content": "string"
}
],
"bl_order_no": "string",
"bl_vessel_flag": "string",
"bl_master_nm": "string",
"bl_terms_and_condition_and_other_text": "string",
"bl_vessel_imo_no": "string",
"bl_notify_party_nm": "string"
}
],
"requestId": "string",
"participants": [
{
"request_id": "string",
"id": "string",
"name": "string",
"system": {
"id": "string",
"name": "string",
"sourceSystemId": "string"
},
"meta": {
"data_ref_id": "string"
}
}
],
"on_behalf_of": [
"string"
]
}
Data Element ID: certificate_of_quality
| coq_job_no | string or null (Coq Job No)
|
| coq_sample_no required | string (Coq Sample No)
|
| coq_location_or_terminal | string or null (Coq Location Or Terminal)
|
| coq_sample_product_nm | string or null (Coq Sample Product Nm)
|
| coq_source_of_sample | string or null (Coq Source Of Sample)
|
| coq_type_of_sample | string or null (Coq Type Of Sample)
|
| coq_summary_of_sample | string or null (Coq Summary Of Sample)
|
| coq_sample_sampled_dt | string or null <date> (Coq Sample Sampled Dt)
|
| coq_sample_received_dt | string or null <date> (Coq Sample Received Dt)
|
| coq_sample_tested_dt | string or null <date> (Coq Sample Tested Dt)
|
| coq_sample_reported_dt | string or null <date> (Coq Sample Reported Dt)
|
Array of objects or null (Coq Results)
| |
| coq_surveyor_company_nm | string or null (Coq Surveyor Company Nm)
|
Array of objects or null (Attachments) non-empty
|
{- "coq_job_no": "string",
- "coq_sample_no": "string",
- "coq_location_or_terminal": "string",
- "coq_sample_product_nm": "string",
- "coq_source_of_sample": "string",
- "coq_type_of_sample": "string",
- "coq_summary_of_sample": "string",
- "coq_sample_sampled_dt": "2019-08-24",
- "coq_sample_received_dt": "2019-08-24",
- "coq_sample_tested_dt": "2019-08-24",
- "coq_sample_reported_dt": "2019-08-24",
- "coq_results": [
- {
- "test": "string",
- "method": "string",
- "unit": "string",
- "spec_max": "string",
- "spec_min": "string",
- "results": "string"
}
], - "coq_surveyor_company_nm": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: certificate_of_quantity
| cq_dt | string or null <date> (Cq Dt)
|
| cq_doc_no required | string (Cq Doc No)
|
| cq_seller_nm | string or null (Cq Seller Nm)
|
| cq_source | string or null (Source (Vessel/Barge/Tank Name))
|
| cq_destination | string or null (Destination (Vessel/Barge/Tank Name))
|
| cq_buyer_nm | string or null (Cq Buyer Nm)
|
| cq_port_of_loading | string or null (Cq Port Of Loading)
|
| cq_port_of_discharge | string or null (Cq Port Of Discharge)
|
| cq_country_of_origin | string or null (Cq Country Of Origin)
|
| cq_country_of_destination | string or null (Cq Country Of Destination)
|
Array of objects or null (Attachments)
| |
| cq_terminal_nm | string or null (Cq Terminal Nm)
|
Array of objects or null (Cq Goods Particulars)
| |
| cq_order_no | string or null (Cq Order No)
|
| cq_start_pump_dt | string or null <date-time> (Cq Start Pump Dt)
|
| cq_end_pump_dt | string or null <date-time> (Cq End Pump Dt)
|
| cq_terminal_rep_nm | string or null (Cq Terminal Rep Nm)
|
| cq_vessel_flag | string or null (Cq Vessel Flag)
|
| cq_surveyor_nm | string or null (Cq Surveyor Nm)
|
| cq_terms_and_condition_and_other_text | string or null (Cq Terms And Condition And Other Text)
|
{- "cq_dt": "2019-08-24",
- "cq_doc_no": "string",
- "cq_seller_nm": "string",
- "cq_source": "string",
- "cq_destination": "string",
- "cq_buyer_nm": "string",
- "cq_port_of_loading": "string",
- "cq_port_of_discharge": "string",
- "cq_country_of_origin": "string",
- "cq_country_of_destination": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "cq_terminal_nm": "string",
- "cq_goods_particulars": [
- {
- "goods_description": "string",
- "goods_qty": "string",
- "goods_uom": "string",
- "matching_nom": "string"
}
], - "cq_order_no": "string",
- "cq_start_pump_dt": "2019-08-24T14:15:22Z",
- "cq_end_pump_dt": "2019-08-24T14:15:22Z",
- "cq_terminal_rep_nm": "string",
- "cq_vessel_flag": "string",
- "cq_surveyor_nm": "string",
- "cq_terms_and_condition_and_other_text": "string"
}Data Element ID: inter_tank_transfer_certificate
| ittc_certificate_number required | string (Ittc Certificate Number)
|
| ittc_terminal_name | string or null (Ittc Terminal Name)
|
| ittc_terminal_address | string or null (Ittc Terminal Address)
|
| ittc_datetime | string or null <date-time> (Ittc Datetime)
|
| ittc_seller_name | string or null (Ittc Seller Name)
|
| ittc_seller_tank_number | string or null (Ittc Seller Tank Number)
|
| ittc_buyer_name | string or null (Ittc Buyer Name)
|
| ittc_buyer_tank_number | string or null (Ittc Buyer Tank Number)
|
| ittc_goods_quantity | number or null (Ittc Goods Quantity)
|
| ittc_goods_quantity_uom | string or null (Ittc Goods Quantity Uom)
|
Array of objects or null (Attachments) non-empty
| |
| ittc_goods_particulars | string or null (Ittc Goods Particulars)
|
{- "ittc_certificate_number": "string",
- "ittc_terminal_name": "string",
- "ittc_terminal_address": "string",
- "ittc_datetime": "2019-08-24T14:15:22Z",
- "ittc_seller_name": "string",
- "ittc_seller_tank_number": "string",
- "ittc_buyer_name": "string",
- "ittc_buyer_tank_number": "string",
- "ittc_goods_quantity": 0,
- "ittc_goods_quantity_uom": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "ittc_goods_particulars": "string"
}Data Element ID: vessel_event
required | Array of objects (Vessel Particulars)
|
| vessel_location required | string (Vessel Location)
|
| vessel_arrived_dt required | string <date-time> (Vessel Arrived Dt)
|
| vessel_grid required | string (Vessel Grid)
|
| vessel_purpose required | string (Vessel Purpose)
|
| vessel_agent required | string (Vessel Agent)
|
{- "vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string"
}
], - "vessel_location": "string",
- "vessel_arrived_dt": "2019-08-24T14:15:22Z",
- "vessel_grid": "string",
- "vessel_purpose": "string",
- "vessel_agent": "string"
}Data Element ID: lei_record
| lei_code required | string (LEI Code)
|
| legal_name required | string (Legal Name)
|
| registration_status required | string (Registration Status)
|
| managing_lou required | string (Managing LOU)
|
| initial_registration_date required | string <date-time> (Initial Registration Date)
|
| last_update_date required | string <date-time> (Last Update Date)
|
Array of objects or null (LEI Record Attachment)
|
{- "lei_code": "string",
- "legal_name": "string",
- "registration_status": "string",
- "managing_lou": "string",
- "initial_registration_date": "2019-08-24T14:15:22Z",
- "last_update_date": "2019-08-24T14:15:22Z",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: letter_of_credit
| lc_doc_lc_form | string or null (Form of Documentary Credit)
|
| lc_dt_of_issue required | string <date> (Date Of Issue)
|
| lc_doc_lc_no | string or null (Documentary Credit Number)
|
| lc_dt_and_place_of_expiry | string or null (Date and Place of Expiry)
|
| lc_applicant | string or null (Applicant)
|
| lc_beneficiary_nm_and_address | string or null (Beneficiary)
|
| lc_doc_lc_currency_cd_and_amount | string or null (Currency Code, Amount)
|
| lc_available_with_by | string or null (Available with and by)
|
| lc_negotiation_deferred_payment_details | string or null (Negotiation/Deferred Payment Details)
|
| lc_partial_shipments | string or null (Partial Shipments)
|
| lc_transhipment | string or null (Transhipment)
|
| lc_latest_dt_of_shipment | string or null <date> (Latest Date of Shipment)
|
| lc_confirmation_instructions | string or null (Confirmation Instructions)
|
| lc_percentage_credit_amt_tolerance | string or null (Percentage Credit Amount Tolerance)
|
| lc_mixed_payment_details | string or null (Mixed Payment Details)
|
| lc_period_for_presentation_in_days | string or null (Period for Presentaton in Days)
|
Array of objects or null (Letter of Credit Attachment)
|
{- "lc_doc_lc_form": "string",
- "lc_dt_of_issue": "2019-08-24",
- "lc_doc_lc_no": "string",
- "lc_dt_and_place_of_expiry": "string",
- "lc_applicant": "string",
- "lc_beneficiary_nm_and_address": "string",
- "lc_doc_lc_currency_cd_and_amount": "string",
- "lc_available_with_by": "string",
- "lc_negotiation_deferred_payment_details": "string",
- "lc_partial_shipments": "string",
- "lc_transhipment": "string",
- "lc_latest_dt_of_shipment": "2019-08-24",
- "lc_confirmation_instructions": "string",
- "lc_percentage_credit_amt_tolerance": "string",
- "lc_mixed_payment_details": "string",
- "lc_period_for_presentation_in_days": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: letter_of_credit_application
| lca_date required | string <date> (Date)
|
| lca_applicant_name | string or null (Applicant's Name)
|
| lca_applicant_address | string or null (Applicant's Address)
|
| lca_contact_person_applicant | string or null (Contact Person (Applicant))
|
| lca_telephone_number_applicant | number or null <double> (Telephone Number (Applicant))
|
| lca_fax_applicant | number or null <double> (Fax No (Applicant))
|
| lca_debit_account_no | string or null (Debit Account No.)
|
| lca_beneficiary_type | string or null (Beneficiary Type (Local / Overseas))
|
| lca_beneficiary_name | string or null (Beneficiary's Name)
|
| lca_beneficiary_address | string or null (Beneficiary's Address)
|
| lca_contact_person_beneficiary | string or null (Contact Person (Beneficiary))
|
| lca_telephone_number_beneficiary | number or null <double> (Telephone Number (Beneficiary))
|
| lca_fax_beneficiary | number or null <double> (Fax No (Beneficiary))
|
| lca_third_party_name | string or null (Third Party Name)
|
| lca_third_party_address | string or null (Third Party Address)
|
| lca_advising_bank_name | string or null (Advising Bank Name)
|
| lca_advising_bank_address | string or null (Advising Bank Address)
|
| lca_advising_bank_swift_address | string or null (Advising Bank SWIFT Address)
|
| lca_currency | string or null (Currency)
|
| lca_amount | number or null <double> (Amount)
|
| lca_issuance_date | string or null <date> (LC Issuance Date)
|
| lca_date_expiry_beneficiary_country | string or null <date> (Expiry Date (Beneficiary Country))
|
| lca_date_expiry_applicant_country | string or null <date> (Expiry Date (Applicant Country))
|
| lca_charges | string or null (Charges)
|
| lca_documents | string or null (Documents Required)
|
| lca_special_instructions | string or null (Special Instructions)
|
| lca_special_type_credit_governing_rule | string or null (Special Type of Credit- Governing Rule)
|
| lca_tenor | string or null (Tenor )
|
| lca_shipment_from | string or null (Shipment From)
|
| lca_shipment_to | string or null (Shipment To)
|
| lca_date_latest_shipment | string or null <date> (Latest Shipment Date)
|
| lca_present_documents_in_X_days_after_shipment_date_but_before_LC_expiry | number or null <double> (Present documents in X days after shipment date but before LC expiry)
|
| lca_issuance_mode | string or null (LC issuance mode)
|
| lca_lc_to_be_confirmed_by_advising_bank | string or null (LC To Be Confirmed by Advising Bank)
|
| lca_confirmation_charges | string or null (Confirmation Charges)
|
| lca_tolerance | string or null (Tolerance)
|
| lca_goods_description | string or null (Goods description)
|
| lca_transshipment_allowed | string or null (Transshipment Allowed)
|
| lca_partial_shipment_allowed | string or null (Partial Shipment Allowed)
|
| lca_incoterms | string or null (Incoterms)
|
| lca_insurance_to_be_covered_by | string or null (Insurance To Be Covered By)
|
| lca_cover_no | string or null (Cover No.)
|
| lca_insurance_company | string or null (Insurance Company)
|
Array of objects or null (Letter of Credit Application Attachment)
|
{- "lca_date": "2019-08-24",
- "lca_applicant_name": "string",
- "lca_applicant_address": "string",
- "lca_contact_person_applicant": "string",
- "lca_telephone_number_applicant": 0.1,
- "lca_fax_applicant": 0.1,
- "lca_debit_account_no": "string",
- "lca_beneficiary_type": "string",
- "lca_beneficiary_name": "string",
- "lca_beneficiary_address": "string",
- "lca_contact_person_beneficiary": "string",
- "lca_telephone_number_beneficiary": 0.1,
- "lca_fax_beneficiary": 0.1,
- "lca_third_party_name": "string",
- "lca_third_party_address": "string",
- "lca_advising_bank_name": "string",
- "lca_advising_bank_address": "string",
- "lca_advising_bank_swift_address": "string",
- "lca_currency": "string",
- "lca_amount": 0.1,
- "lca_issuance_date": "2019-08-24",
- "lca_date_expiry_beneficiary_country": "2019-08-24",
- "lca_date_expiry_applicant_country": "2019-08-24",
- "lca_charges": "string",
- "lca_documents": "string",
- "lca_special_instructions": "string",
- "lca_special_type_credit_governing_rule": "string",
- "lca_tenor": "string",
- "lca_shipment_from": "string",
- "lca_shipment_to": "string",
- "lca_date_latest_shipment": "2019-08-24",
- "lca_present_documents_in_X_days_after_shipment_date_but_before_LC_expiry": 0.1,
- "lca_issuance_mode": "string",
- "lca_lc_to_be_confirmed_by_advising_bank": "string",
- "lca_confirmation_charges": "string",
- "lca_tolerance": "string",
- "lca_goods_description": "string",
- "lca_transshipment_allowed": "string",
- "lca_partial_shipment_allowed": "string",
- "lca_incoterms": "string",
- "lca_insurance_to_be_covered_by": "string",
- "lca_cover_no": "string",
- "lca_insurance_company": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: nominated_terminal
| nt_nom_ref | string or null (Nomination Reference Number)
|
| nt_issuer_nm | string or null (Issuer of Nomination)
|
| nt_executor_nm | string or null (Executor of Nomination)
|
| nt_receiver_nm | string or null (Receiver)
|
| nt_start_dt | string or null <date-time> (Nomination Start Date)
|
| nt_end_dt | string or null <date-time> (Nomination End Date)
|
| nt_vessel_nm | string or null (Vessel Name)
|
| nt_vessel_est_arrived_dt | string or null <date-time> (Vessel Estimated Time of Arrival)
|
Array of objects or null (Goods Particulars)
| |
| nt_laycan | string or null (Laycan)
|
| nt_doc_instruction | string or null (Document Instruction)
|
| nt_nom_desc | string or null (Nomination Description)
|
Array of objects or null (Attachments)
|
{- "nt_nom_ref": "string",
- "nt_issuer_nm": "string",
- "nt_executor_nm": "string",
- "nt_receiver_nm": "string",
- "nt_start_dt": "2019-08-24T14:15:22Z",
- "nt_end_dt": "2019-08-24T14:15:22Z",
- "nt_vessel_nm": "string",
- "nt_vessel_est_arrived_dt": "2019-08-24T14:15:22Z",
- "nt_goods_particulars": [
- {
- "nt_nm_movement": "string",
- "nt_movement_type": "string",
- "nt_total_qty": "string",
- "nt_uom_total": "string",
- "nt_goods_nm": "string",
- "nt_goods_qty_amt": 0.1,
- "nt_goods_qty_uom": "string",
- "nt_goods_source": "string",
- "nt_goods_destination": "string",
- "nt_goods_sequence": "string",
- "nt_goods_minmax": "string",
- "nt_movement_ref": "string",
- "nt_add_inf": "string"
}
], - "nt_laycan": "string",
- "nt_doc_instruction": "string",
- "nt_nom_desc": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: notice_of_readiness
| nor_charter_party | string or null (Nor Charter Party)
|
| nor_vessel_nm required | string (Nor Vessel Nm)
|
| nor_vessel_flag | string or null (Nor Vessel Flag)
|
| nor_call_sign | string or null (Nor Call Sign)
|
| nor_arrival_time required | string <date-time> (Nor Arrival Time)
|
| nor_arrival_date required | string <date> (Nor Arrival Date)
|
| nor_port required | string (Nor Port)
|
| nor_cargo required | string (Nor Cargo)
|
| nor_flow required | string (Nor Flow)
|
| nor_issuance_place required | string (Nor Issuance Place)
|
| nor_issuance_time required | string <date-time> (Nor Issuance Time)
|
| nor_issuance_date required | string <date> (Nor Issuance Date)
|
| nor_statement | string or null (Nor Statement)
|
Array of objects or null (Attachments) non-empty
|
{- "nor_charter_party": "string",
- "nor_vessel_nm": "string",
- "nor_vessel_flag": "string",
- "nor_call_sign": "string",
- "nor_arrival_time": "2019-08-24T14:15:22Z",
- "nor_arrival_date": "2019-08-24",
- "nor_port": "string",
- "nor_cargo": "string",
- "nor_flow": "string",
- "nor_issuance_place": "string",
- "nor_issuance_time": "2019-08-24T14:15:22Z",
- "nor_issuance_date": "2019-08-24",
- "nor_statement": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bill_of_lading
| bl_doc_no | string or null (Bl Doc No)
|
| bl_dt required | string <date> (Bl Dt)
|
| bl_shipper_nm | string or null (Bl Shipper Nm)
|
| bl_consignee_nm | string or null (Bl Consignee Nm)
|
| bl_terminal_nm | string or null (Bl Terminal Nm)
|
| bl_port_of_loading | string or null (Bl Port Of Loading)
|
| bl_port_of_discharge | string or null (Bl Port Of Discharge)
|
| bl_vessel_nm | string or null (Bl Vessel Nm)
|
| bl_country_of_origin | string or null (Bl Country Of Origin)
|
| bl_country_of_destination | string or null (Bl Country Of Destination)
|
Array of objects or null (Bl Goods Particulars)
| |
Array of objects or null (Attachments) non-empty
| |
| bl_order_no | string or null (Bl Order No)
|
| bl_vessel_flag | string or null (Bl Vessel Flag)
|
| bl_master_nm | string or null (Bl Master Nm)
|
| bl_terms_and_condition_and_other_text | string or null (Bl Terms And Condition And Other Text)
|
| bl_vessel_imo_no | string or null (Bl Vessel Imo No)
|
| bl_notify_party_nm | string or null (Bl Notify Party Nm)
|
{- "bl_doc_no": "string",
- "bl_dt": "2019-08-24",
- "bl_shipper_nm": "string",
- "bl_consignee_nm": "string",
- "bl_terminal_nm": "string",
- "bl_port_of_loading": "string",
- "bl_port_of_discharge": "string",
- "bl_vessel_nm": "string",
- "bl_country_of_origin": "string",
- "bl_country_of_destination": "string",
- "bl_goods_particulars": [
- {
- "bl_goods_nm": "string",
- "bl_goods_qty_amt": "string",
- "bl_goods_qty_uom": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "bl_order_no": "string",
- "bl_vessel_flag": "string",
- "bl_master_nm": "string",
- "bl_terms_and_condition_and_other_text": "string",
- "bl_vessel_imo_no": "string",
- "bl_notify_party_nm": "string"
}Data Element ID: contract
| contract_no | string or null (Contract No)
|
| contract_trade_no required | string (Contract Trade No)
|
| contract_trade_type | string or null (Contract Trade Type)
|
| contract_company_nm | string or null (Contract Company Nm)
|
| contract_counterparty_nm | string or null (Contract Counterparty Nm)
|
Array of objects or null (Contract Goods Particulars)
| |
| contract_currency | string or null (Contract Currency)
|
| contract_payment_terms | string or null (Contract Payment Terms)
|
| contract_credit_terms | string or null (Contract Credit Terms)
|
| contract_inco_terms | string or null (Contract Inco Terms)
|
| contract_quantity_tolerance | string or null (Contract Quantity Tolerance)
|
| contract_port_of_loading | string or null (Contract Port Of Loading)
|
| contract_port_of_discharge | string or null (Contract Port Of Discharge)
|
Array of objects or null (Attachments) non-empty
|
{- "contract_no": "string",
- "contract_trade_no": "string",
- "contract_trade_type": "string",
- "contract_company_nm": "string",
- "contract_counterparty_nm": "string",
- "contract_goods_particulars": [
- {
- "contract_goods_nm": "string",
- "contract_goods_qty_amt": 0.1,
- "contract_goods_qty_uom": "string",
- "contract_goods_unit_price": 0.1
}
], - "contract_currency": "string",
- "contract_payment_terms": "string",
- "contract_credit_terms": "string",
- "contract_inco_terms": "string",
- "contract_quantity_tolerance": "string",
- "contract_port_of_loading": "string",
- "contract_port_of_discharge": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: discharge_certificate
| discharge_doc_no required | string (Discharge Doc No)
|
| discharge_order_no required | string (Discharge Order No)
|
| discharge_dt required | string <date> (Discharge Dt)
|
| discharge_customer_nm required | string (Discharge Customer Nm)
|
| discharge_started_dt required | string <date-time> (Discharge Started Dt)
|
| discharge_finished_dt required | string <date-time> (Discharge Finished Dt)
|
| discharge_vessel_est_sailing_dt required | string <date-time> (Discharge Vessel Est Sailing Dt)
|
| discharge_address required | string (Discharge Address)
|
| discharge_city required | string (Discharge City)
|
| discharge_country required | string (Discharge Country)
|
| discharge_vessel_nm required | string (Discharge Vessel Nm)
|
| discharge_vessel_flag | string or null (Discharge Vessel Flag)
|
required | Array of objects (Discharge Goods Particulars)
|
required | Array of objects (Attachments) non-empty
|
{- "discharge_doc_no": "string",
- "discharge_order_no": "string",
- "discharge_dt": "2019-08-24",
- "discharge_customer_nm": "string",
- "discharge_started_dt": "2019-08-24T14:15:22Z",
- "discharge_finished_dt": "2019-08-24T14:15:22Z",
- "discharge_vessel_est_sailing_dt": "2019-08-24T14:15:22Z",
- "discharge_address": "string",
- "discharge_city": "string",
- "discharge_country": "string",
- "discharge_vessel_nm": "string",
- "discharge_vessel_flag": "string",
- "discharge_goods_particulars": [
- {
- "discharge_goods_nm": "string",
- "discharge_goods_qty_amt": 0.1,
- "discharge_goods_qty_uom": "string",
- "discharge_tank_id": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: holding_certificate
| holding_customer_nm | string or null (Holding Customer Nm)
|
| holding_dt required | string <date> (Holding Dt)
|
| holding_customer_address | string or null (Holding Customer Address)
|
| holding_terminal_operator | string or null (Holding Terminal Operator)
|
| holding_terminal_operator_address | string or null (Holding Terminal Operator Address)
|
| holding_reference_no | string or null (Reference Number)
|
Array of objects or null (Holding Goods Particulars)
| |
| holding_financing_bank | string or null (Holding Financing Bank)
|
Array of objects or null (Attachments) non-empty
|
{- "holding_customer_nm": "string",
- "holding_dt": "2019-08-24",
- "holding_customer_address": "string",
- "holding_terminal_operator": "string",
- "holding_terminal_operator_address": "string",
- "holding_reference_no": "string",
- "holding_goods_particulars": [
- {
- "holding_goods_nm": "string",
- "holding_goods_qty_amt": 0.1,
- "holding_goods_qty_uom": "string",
- "holding_tank_id": "string"
}
], - "holding_financing_bank": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: invoice
| invoice_no | string or null (Invoice No)
|
| invoice_trade_no required | string (Invoice Trade No)
|
| invoice_dt | string or null <date> (Invoice Dt)
|
| invoice_beneficiary_bank_nm | string or null (Invoice Beneficiary Bank Nm)
|
| invoice_beneficiary_bank_swift_cd | string or null (Invoice Beneficiary Bank Swift Cd)
|
Array of objects or null (Invoice Goods Particulars)
| |
| invoice_total_payment_amt | number or null <double> (Invoice Total Payment Amt)
|
| invoice_currency | string or null (Invoice Currency)
|
Array of objects or null (Attachments) non-empty
|
{- "invoice_no": "string",
- "invoice_trade_no": "string",
- "invoice_dt": "2019-08-24",
- "invoice_beneficiary_bank_nm": "string",
- "invoice_beneficiary_bank_swift_cd": "string",
- "invoice_goods_particulars": [
- {
- "invoice_goods_nm": "string",
- "invoice_goods_qty_amt": 0.1,
- "invoice_goods_qty_uom": "string",
- "invoice_goods_unit_price": 0.1
}
], - "invoice_total_payment_amt": 0.1,
- "invoice_currency": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: inventory_transaction
| it_case_type required | string (It Case Type)
|
| it_transaction_type required | string (It Transaction Type)
|
| it_case_title required | string (It Case Title)
|
| it_trade_no required | string (It Trade No)
|
| it_transport_unit required | string (It Transport Unit)
|
Array of objects or null (It Goods Particulars)
| |
Array of objects or null (Attachments)
| |
| it_comments | string or null (It Comments)
|
| it_financier_financing_line_info | string or null (It Financier Financing Line Info)
|
| it_financier_approval | string or null (It Financier Approval)
|
| it_terminal_ack | string or null (It Terminal Ack)
|
{- "it_case_type": "string",
- "it_transaction_type": "string",
- "it_case_title": "string",
- "it_trade_no": "string",
- "it_transport_unit": "string",
- "it_goods_particulars": [
- {
- "it_tank_no": "string",
- "it_goods_nm": "string",
- "it_goods_qty_amt": 0,
- "it_goods_qty_uom": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "it_comments": "string",
- "it_financier_financing_line_info": "string",
- "it_financier_approval": "string",
- "it_terminal_ack": "string"
}Data Element ID: on_board_quantity
| obq_vessel required | string (Obq Vessel)
|
| obq_cargo required | string (Obq Cargo)
|
| obq_port required | string (Obq Port)
|
| obq_datetime required | string <date-time> (Obq Datetime)
|
Array of objects or null (Obq Particulars)
| |
Array of objects or null (Obq Totals)
| |
Array of objects or null (Obq Draft)
|
{- "obq_vessel": "string",
- "obq_cargo": "string",
- "obq_port": "string",
- "obq_datetime": "2019-08-24T14:15:22Z",
- "obq_particulars": [
- {
- "tank_no": "string",
- "location of reference gauge point": "string",
- "innage units": 0,
- "innage_uncorrected": 0,
- "innage_corrected": 0,
- "innage_total_observed_volume_non_liquid": 0,
- "total_observed_volume_calib": 0,
- "total_observed_volume_wedge": 0,
- "free_water_uncorrected": "string",
- "free_water_corrected": "string",
- "free_water_volume": 0
}
], - "obq_totals": [
- {
- "non_liquid": 0,
- "liquid": 0,
- "free_water": 0,
- "grand_total": 0
}
], - "obq_draft": [
- {
- "fwd": 0,
- "aft": 0,
- "trim": 0,
- "list": "string"
}
]
}Data Element ID: release_consent
| rc_terminal_nm required | string (Terminal Name)
|
| rc_bank_nm | string or null (Bank Name)
|
| rc_bank_dept | string or null (Bank Department)
|
| rc_bank_email | string or null (Bank's Email)
|
| rc_issue_dt | string or null <date> (Issue Date)
|
| rc_trader_nm | string or null (Trader Name)
|
| rc_reference_no | string or null (Reference Number)
|
| rc_effective_dt | string or null <date-time> (Effective Date and Time)
|
| rc_expiry_dt | string or null <date-time> (Expiry Date and Time)
|
Array of objects or null (Goods Particulars)
| |
| rc_to_order_of | string or null (To Order of)
|
| rc_charges_payment_to | string or null (Payment of Charges - Issue Invoice To)
|
Array of objects or null (Attachments) non-empty
|
{- "rc_terminal_nm": "string",
- "rc_bank_nm": "string",
- "rc_bank_dept": "string",
- "rc_bank_email": "string",
- "rc_issue_dt": "2019-08-24",
- "rc_trader_nm": "string",
- "rc_reference_no": "string",
- "rc_effective_dt": "2019-08-24T14:15:22Z",
- "rc_expiry_dt": "2019-08-24T14:15:22Z",
- "rc_goods_particulars": [
- {
- "rc_tank_no": "string",
- "rc_product": "string",
- "rc_qty_amt": 0,
- "rc_qty_uom": "string"
}
], - "rc_to_order_of": "string",
- "rc_charges_payment_to": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: remaining_on_board
| rob_vessel required | string (Rob Vessel)
|
| rob_cargo required | string (Rob Cargo)
|
| rob_port required | string (Rob Port)
|
| rob_datetime required | string <date> (Rob Datetime)
|
Array of objects or null (Rob Particulars)
| |
Array of objects or null (Rob Totals)
| |
Array of objects or null (Rob Draft)
| |
| rob_statement | string or null (Rob Statement)
|
| rob_quantity_in_lines | number or null (Rob Quantity In Lines)
|
| rob_lines_to_tank | string or null (Rob Lines To Tank)
|
| rob_sample_tank | string or null (Rob Sample Tank)
|
{- "rob_vessel": "string",
- "rob_cargo": "string",
- "rob_port": "string",
- "rob_datetime": "2019-08-24",
- "rob_particulars": [
- {
- "tank_no": "string",
- "location of reference gauge point": "string",
- "ullage units": 0,
- "ullage_uncorrected": 0,
- "ullage_corrected": 0,
- "ullage_total_observed_volume_non_liquid": 0,
- "total_observed_volume_calib": 0,
- "total_observed_volume_wedge": 0,
- "remarks": "string"
}
], - "rob_totals": [
- {
- "units": "string",
- "non_liquid": 0,
- "liquid": 0,
- "free_water": 0,
- "grand_total": 0
}
], - "rob_draft": [
- {
- "fwd": 0,
- "aft": 0,
- "trim": 0,
- "list": "string"
}
], - "rob_statement": "string",
- "rob_quantity_in_lines": 0,
- "rob_lines_to_tank": "string",
- "rob_sample_tank": "string"
}Data Element ID: tank_levels
| tl_terminal_name required | string (Oil Terminal Name)
|
| tl_effectivedate_time required | string <date-time> (Effective Date and Time)
|
| tl_tank_no required | string (Tank Number/ID)
|
| tl_product_type | string or null (Product Type)
|
| tl_product_grade | string or null (Product Grade)
|
| tl_qty_amt required | number (Quantity Amount)
|
| tl_qty_uom required | string (Unit of Measurement of Goods)
|
| tl_temp_comp_volume | string or null (Temperature Compensated Volume)
|
| tl_ambient_volume | string or null (Ambient Volume)
|
| tl_qty_temperature | string or null (Temperature of Goods)
|
| tl_qty_density | string or null (Density of Goods)
|
| tl_geo_latitude | number or null (Geographic Latitude)
|
| tl_geo_longtitude | number or null (Geographic Longtitude)
|
Array of objects or null (Tank Levels Attachment)
|
{- "tl_terminal_name": "string",
- "tl_effectivedate_time": "2019-08-24T14:15:22Z",
- "tl_tank_no": "string",
- "tl_product_type": "string",
- "tl_product_grade": "string",
- "tl_qty_amt": 0,
- "tl_qty_uom": "string",
- "tl_temp_comp_volume": "string",
- "tl_ambient_volume": "string",
- "tl_qty_temperature": "string",
- "tl_qty_density": "string",
- "tl_geo_latitude": 0,
- "tl_geo_longtitude": 0,
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: tank_movement_discharge
| tmd_terminal_name required | string (Oil Terminal Name)
|
| tmd_discharge_date_time required | string <date-time> (Discharge Start Date & Time)
|
| tmd_end_date_time required | string <date-time> (Discharge End Date and Time)
|
| tmd_destination required | string (Destination)
|
| tmd_origin required | string (Source)
|
| tmd_product_grade | string or null (Product Grade)
|
| tmd_product_type | string or null (Product Type)
|
| tmd_qty_amt required | number (Quantity Amount)
|
| tmd_qty_uom required | string (Unit of Measurement of Goods)
|
| tmd_temp_comp_volume | string or null (Temperature Compensated Volume)
|
| tmd_ambient_volume | string or null (Ambient Volume)
|
| tmd_qty_temperature | string or null (Temperature of Goods)
|
| tmd_qty_density | string or null (Density of Goods)
|
| tmd_geo_latitude | number or null (Geographic Latitude)
|
| tmd_geo_longtitude | number or null (Geographic Longtitude)
|
Array of objects or null (Tank Discharge Attachment)
|
{- "tmd_terminal_name": "string",
- "tmd_discharge_date_time": "2019-08-24T14:15:22Z",
- "tmd_end_date_time": "2019-08-24T14:15:22Z",
- "tmd_destination": "string",
- "tmd_origin": "string",
- "tmd_product_grade": "string",
- "tmd_product_type": "string",
- "tmd_qty_amt": 0,
- "tmd_qty_uom": "string",
- "tmd_temp_comp_volume": "string",
- "tmd_ambient_volume": "string",
- "tmd_qty_temperature": "string",
- "tmd_qty_density": "string",
- "tmd_geo_latitude": 0,
- "tmd_geo_longtitude": 0,
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: tank_movement_inter_tank_transfer
| tmt_terminal_name required | string (Oil Terminal Name)
|
| tmt_transfer_date_time required | string <date-time> (Transfer Start Date & Time)
|
| tmt_end_date_time required | string <date-time> (Transfer End Date & Time)
|
| tmt_destination required | string (Destination)
|
| tmt_origin required | string (Source)
|
| tmt_product_type | string or null (Product Type)
|
| tmt_product_grade | string or null (Product Grade)
|
| tmt_qty_amt required | number (Quantity Amount)
|
| tmt_qty_uom required | string (Unit of Measurement of Goods)
|
| tmt_temp_comp_volume | string or null (Temperature Compensated Volume)
|
| tmt_ambient_volume | string or null (Ambient Volume)
|
| tmt_qty_temperature | string or null (Temperature of Goods)
|
| tmt_qty_density | string or null (Density of Goods)
|
| tmt_geo_latitude | number or null (Geographic Latitude)
|
| tmt_geo_longtitude | number or null (Geographic Longtitude)
|
Array of objects or null (ITT Movement Attachment)
|
{- "tmt_terminal_name": "string",
- "tmt_transfer_date_time": "2019-08-24T14:15:22Z",
- "tmt_end_date_time": "2019-08-24T14:15:22Z",
- "tmt_destination": "string",
- "tmt_origin": "string",
- "tmt_product_type": "string",
- "tmt_product_grade": "string",
- "tmt_qty_amt": 0,
- "tmt_qty_uom": "string",
- "tmt_temp_comp_volume": "string",
- "tmt_ambient_volume": "string",
- "tmt_qty_temperature": "string",
- "tmt_qty_density": "string",
- "tmt_geo_latitude": 0,
- "tmt_geo_longtitude": 0,
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: tank_movement_loading
| tml_terminal_name required | string (Oil Terminal Name)
|
| tml_loading_date_time required | string <date-time> (Loading Start Date and Time)
|
| tml_end_date_time required | string <date-time> (Loading End Date and Time)
|
| tml_destination required | string (Destination)
|
| tml_origin required | string (Source)
|
| tml_product_type | string or null (Product Type)
|
| tml_product_grade | string or null (Product Grade)
|
| tml_qty_amt required | number (Quantity Amount)
|
| tml_qty_uom required | string (Unit of Measurement of Goods)
|
| tml_temp_comp_volume | string or null (Temperature Compensated Volume)
|
| tml_ambient_volume | string or null (Ambient Volume)
|
| tml_qty_temperature | string or null (Temperature of Goods)
|
| tml_qty_density | string or null (Density of Goods)
|
| tml_geo_latitude | number or null (Geographic Latitude)
|
| tml_geo_longtitude | number or null (Geographic Longtitude)
|
Array of objects or null (Tank Loading Attachment)
|
{- "tml_terminal_name": "string",
- "tml_loading_date_time": "2019-08-24T14:15:22Z",
- "tml_end_date_time": "2019-08-24T14:15:22Z",
- "tml_destination": "string",
- "tml_origin": "string",
- "tml_product_type": "string",
- "tml_product_grade": "string",
- "tml_qty_amt": 0,
- "tml_qty_uom": "string",
- "tml_temp_comp_volume": "string",
- "tml_ambient_volume": "string",
- "tml_qty_temperature": "string",
- "tml_qty_density": "string",
- "tml_geo_latitude": 0,
- "tml_geo_longtitude": 0,
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: ullage_report
| ullage_vessel required | string (Ullage Vessel)
|
| ullage_cargo required | string (Ullage Cargo)
|
| ullage_port required | string (Ullage Port)
|
| ullage_date required | string <date-time> (Ullage Date)
|
| ullage_terminal_berth required | string (Ullage Terminal Berth)
|
Array of objects or null (Ullage Draft)
| |
| ullage_before required | string (Ullage Before)
|
| ullage_after required | string (Ullage After)
|
| ullage_loading required | string (Ullage Loading)
|
| ullage_discharging required | string (Ullage Discharging)
|
Array of objects or null (Ullage Particulars)
| |
| ullage_total_observed_volume | number or null (Ullage Total Observed Volume)
|
| ullage_less_free_water | number or null (Ullage Less Free Water)
|
| ullage_free_total_observed_volume required | number (Ullage Free Total Observed Volume)
|
| ullage_avg_temp | number or null (Ullage Avg Temp)
|
| ullage_avg_api_den | number or null (Ullage Avg Api Den)
|
| ullage_gross_standard_volume required | number (Ullage Gross Standard Volume)
|
| ullage_plus_free_water | number or null (Ullage Plus Free Water)
|
| ullage_total_calculated_volume | number or null (Ullage Total Calculated Volume)
|
| ullage_less_OBQ | number or null (Ullage Less OBQ)
|
| ullage_total_received_volume | number or null (Ullage Total Received Volume)
|
| ullage_weight_metric_tonnes required | number (Ullage Weight Metric Tonnes)
|
| ullage_weight_long_tonnes required | number (Ullage Weight Long Tonnes)
|
| ullage_remarks | string or null (Ullage Remarks)
|
| ullage_location of reference gauge point | string or null (Ullage Location of reference gauge point)
|
| ullage_vef | number or null (Ullage Vef)
|
{- "ullage_vessel": "string",
- "ullage_cargo": "string",
- "ullage_port": "string",
- "ullage_date": "2019-08-24T14:15:22Z",
- "ullage_terminal_berth": "string",
- "ullage_draft": [
- {
- "fwd": 0,
- "aft": 0
}
], - "ullage_before": "string",
- "ullage_after": "string",
- "ullage_loading": "string",
- "ullage_discharging": "string",
- "ullage_particulars": [
- {
- "tank_no": "string",
- "ullage_uncorrected": 0,
- "ullage_corrected": 0,
- "ullage_total_observed_volume": 0,
- "free_water_observed_innage": 0,
- "free_water_corrected": 0,
- "free_water_volume": 0,
- "free_total_observed_volume": 0,
- "free_temp": 0,
- "free_api_den": 0,
- "free_vcf": 0,
- "free_gross_standard_volume": 0
}
], - "ullage_total_observed_volume": 0,
- "ullage_less_free_water": 0,
- "ullage_free_total_observed_volume": 0,
- "ullage_avg_temp": 0,
- "ullage_avg_api_den": 0,
- "ullage_gross_standard_volume": 0,
- "ullage_plus_free_water": 0,
- "ullage_total_calculated_volume": 0,
- "ullage_less_OBQ": 0,
- "ullage_total_received_volume": 0,
- "ullage_weight_metric_tonnes": 0,
- "ullage_weight_long_tonnes": 0,
- "ullage_remarks": "string",
- "ullage_location of reference gauge point": "string",
- "ullage_vef": 0
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: certificate_of_quality
| coq_sample_no required | Array of strings (Coq Sample No) Sample Number |
{- "coq_sample_no": [
- "string"
]
}Data Element ID: certificate_of_quantity
| cq_order_no required | Array of strings (Cq Order No) Order Number |
| cq_doc_no required | Array of strings (Cq Doc No) Certificate of Quantity / Document Number |
{- "cq_order_no": [
- "string"
], - "cq_doc_no": [
- "string"
]
}Data Element ID: inter_tank_transfer_certificate
| ittc_certificate_number required | string (Ittc Certificate Number) Certificate Number |
{- "ittc_certificate_number": "string"
}Data Element ID: vessel_event
| vessel_nm required | string (Vessel Nm) Name of vessel |
{- "vessel_nm": "string"
}Data Element ID: letter_of_credit
| lc_dt_of_issue required | string <date> (Lc Doc Lc No) |
{- "lc_dt_of_issue": "2019-08-24"
}Data Element ID: lei_record
| lei_code required | string (LEI Code) A Legal Entity Identifier (LEI) code in the format specified by ISO 17442 |
{- "lei_code": "string"
}Data Element ID: letter_of_credit_application
| lca_date required | string <date> (Date) Date of document |
{- "lca_date": "2019-08-24"
}Data Element ID: nominated_terminal
| requestId | string Optional field. Include if you know the requestId for your resource. |
| sourceSystemId | string (Source System Id) Optional field. Own Source System's Id for Notification. Participant can ignore it when flow is anything other than PUSH or PULL. |
Array of objects (participant) | |
Array of objects |
{- "requestId": "string",
- "sourceSystemId": "string",
- "participants": [
- {
- "request_id": "string",
- "id": "string",
- "name": "string",
- "system": {
- "id": "string",
- "name": "string",
- "sourceSystemId": "string"
}, - "meta": {
- "data_ref_id": "string",
- "consumerOrgId": "string",
- "consumerSysId": "string",
- "providerTransactionStatus": "string"
}
}
], - "on_behalf_of": [
- {
- "id": "string",
- "name": "string"
}
]
}Data Element ID: notice_of_readiness
| nor_vessel_nm required | string (Nor Vessel Nm) Name of Vessel |
| nor_issuance_place required | string (Nor Issuance Place) Issuance Place of NOR |
| nor_issuance_time required | string <date-time> (Nor Issuance Time) Issuance Time of NOR |
| nor_issuance_date required | string <date> (Nor Issuance Date) Issuance Date of NOR |
{- "nor_vessel_nm": "string",
- "nor_issuance_place": "string",
- "nor_issuance_time": "2019-08-24T14:15:22Z",
- "nor_issuance_date": "2019-08-24"
}Data Element ID: bill_of_lading
| bl_doc_no | string or null (Bl Doc No) |
| bl_dt required | string <date> (Bl Doc No) |
{- "bl_doc_no": "string",
- "bl_dt": "2019-08-24"
}Data Element ID: contract
| contract_trade_no required | string (Contract Trade No) Trade Number of contract |
{- "contract_trade_no": "string"
}Data Element ID: discharge_certificate
| discharge_doc_no required | string (Discharge Doc No) Identifier number of discharge cert |
| discharge_order_no required | string (Discharge Order No) Order No. from source system |
{- "discharge_doc_no": "string",
- "discharge_order_no": "string"
}Data Element ID: holding_certificate
| holding_dt required | string <date> (Holding Dt) |
{- "holding_dt": "2019-08-24"
}Data Element ID: invoice
| invoice_trade_no required | string (Invoice Trade No) Trade Number of invoice |
{- "invoice_trade_no": "string"
}Data Element ID: inventory_transaction
| requestId | string Optional field. Include if you know the requestId for your resource. |
| sourceSystemId | string (Source System Id) Optional field. Own Source System's Id for Notification. Participant can ignore it when flow is anything other than PUSH or PULL. |
Array of objects (participant) | |
Array of objects |
{- "requestId": "string",
- "sourceSystemId": "string",
- "participants": [
- {
- "request_id": "string",
- "id": "string",
- "name": "string",
- "system": {
- "id": "string",
- "name": "string",
- "sourceSystemId": "string"
}, - "meta": {
- "data_ref_id": "string",
- "consumerOrgId": "string",
- "consumerSysId": "string",
- "providerTransactionStatus": "string"
}
}
], - "on_behalf_of": [
- {
- "id": "string",
- "name": "string"
}
]
}Data Element ID: on_board_quantity
| requestId | string Optional field. Include if you know the requestId for your resource. |
| sourceSystemId | string (Source System Id) Optional field. Own Source System's Id for Notification. Participant can ignore it when flow is anything other than PUSH or PULL. |
Array of objects (participant) | |
Array of objects |
{- "requestId": "string",
- "sourceSystemId": "string",
- "participants": [
- {
- "request_id": "string",
- "id": "string",
- "name": "string",
- "system": {
- "id": "string",
- "name": "string",
- "sourceSystemId": "string"
}, - "meta": {
- "data_ref_id": "string",
- "consumerOrgId": "string",
- "consumerSysId": "string",
- "providerTransactionStatus": "string"
}
}
], - "on_behalf_of": [
- {
- "id": "string",
- "name": "string"
}
]
}Data Element ID: release_consent
| rc_terminal_nm required | string (Terminal Name) Terminal Name |
| rc_issue_dt | string or null <date> (Issue Date of the Release Consent) Issue Date of the Release Consent |
{- "rc_terminal_nm": "string",
- "rc_issue_dt": "2019-08-24"
}Data Element ID: remaining_on_board
| requestId | string Optional field. Include if you know the requestId for your resource. |
| sourceSystemId | string (Source System Id) Optional field. Own Source System's Id for Notification. Participant can ignore it when flow is anything other than PUSH or PULL. |
Array of objects (participant) | |
Array of objects |
{- "requestId": "string",
- "sourceSystemId": "string",
- "participants": [
- {
- "request_id": "string",
- "id": "string",
- "name": "string",
- "system": {
- "id": "string",
- "name": "string",
- "sourceSystemId": "string"
}, - "meta": {
- "data_ref_id": "string",
- "consumerOrgId": "string",
- "consumerSysId": "string",
- "providerTransactionStatus": "string"
}
}
], - "on_behalf_of": [
- {
- "id": "string",
- "name": "string"
}
]
}Data Element ID: tank_levels
| tl_terminal_name required | string (Oil Terminal Name) |
| tl_effectivedate_time | string or null <date-time> (Effective Date and Time) |
| tl_tank_no required | string (Tank Number/ID) |
{- "tl_terminal_name": "string",
- "tl_effectivedate_time": "2019-08-24T14:15:22Z",
- "tl_tank_no": "string"
}Data Element ID: tank_movement_discharge
| tmd_terminal_name required | string (Oil Terminal Name) |
| tmd_discharge_date_time | string or null <date-time> (Start date and time for discharge of goods) |
| tmd_end_date_time | string or null <date-time> (End date and time for discharge of goods) |
| tmd_destination | string or null (Destination of discharged goods (Tank Number/ID)) |
| tmd_origin | string or null (Source of discharged goods (Tank/Vessel/Barge)) |
{- "tmd_terminal_name": "string",
- "tmd_discharge_date_time": "2019-08-24T14:15:22Z",
- "tmd_end_date_time": "2019-08-24T14:15:22Z",
- "tmd_destination": "string",
- "tmd_origin": "string"
}Data Element ID: tank_movement_inter_tank_transfer
| tmt_terminal_name required | string (Oil Terminal Name) |
| tmt_transfer_date_time | string or null <date-time> (Transfer Start Date & Time) |
| tmt_end_date_time | string or null <date-time> (Transfer End Date & Time) |
| tmt_destination | string or null (Destination ) |
| tmt_origin | string or null (Source) |
{- "tmt_terminal_name": "string",
- "tmt_transfer_date_time": "2019-08-24T14:15:22Z",
- "tmt_end_date_time": "2019-08-24T14:15:22Z",
- "tmt_destination": "string",
- "tmt_origin": "string"
}Data Element ID: tank_movement_loading
| tml_terminal_name required | string (Oil Terminal Name) |
| tml_loading_date_time | string or null <date-time> (Start date and time for loading of goods) |
| tml_end_date_time | string or null <date-time> (End date and time for loading of goods) |
| tml_destination | string or null (Destination of loaded goods (Tank/Vessel/Barge)) |
| tml_origin | string or null (Source of loaded goods (Tank Number/ID)) |
{- "tml_terminal_name": "string",
- "tml_loading_date_time": "2019-08-24T14:15:22Z",
- "tml_end_date_time": "2019-08-24T14:15:22Z",
- "tml_destination": "string",
- "tml_origin": "string"
}Data Element ID: ullage_report
| requestId | string Optional field. Include if you know the requestId for your resource. |
| sourceSystemId | string (Source System Id) Optional field. Own Source System's Id for Notification. Participant can ignore it when flow is anything other than PUSH or PULL. |
Array of objects (participant) | |
Array of objects |
{- "requestId": "string",
- "sourceSystemId": "string",
- "participants": [
- {
- "request_id": "string",
- "id": "string",
- "name": "string",
- "system": {
- "id": "string",
- "name": "string",
- "sourceSystemId": "string"
}, - "meta": {
- "data_ref_id": "string",
- "consumerOrgId": "string",
- "consumerSysId": "string",
- "providerTransactionStatus": "string"
}
}
], - "on_behalf_of": [
- {
- "id": "string",
- "name": "string"
}
]
}Data Element ID: depot_timeslot_booking
| depot_booking_no required | string (Depot Booking No)
|
| depot_booking_type required | string (Depot Booking Type)
|
| depot_booking_ref required | string (Depot Booking Ref)
|
| depot_country_cd required | string (Depot Country Cd)
|
| depot_yard_cd required | string (Depot Yard Cd)
|
| depot_uen | string or null (Depot Uen)
|
| container_operator_cd required | string (Container Operator Cd)
|
| container_operator_uen | string or null (Container Operator Uen)
|
| haulier_nm required | string (Haulier Nm)
|
| haulier_uen | string or null (Haulier Uen)
|
| vehicle_no | string or null (Vehicle No)
|
| container_iso required | string (Container Iso)
|
| booking_window_start_dt required | string <date-time> (Booking Window Start Dt)
|
| booking_window_end_dt required | string <date-time> (Booking Window End Dt)
|
| snapshot_dt required | string <date-time> (Snapshot Dt)
|
{- "depot_booking_no": "string",
- "depot_booking_type": "string",
- "depot_booking_ref": "string",
- "depot_country_cd": "string",
- "depot_yard_cd": "string",
- "depot_uen": "string",
- "container_operator_cd": "string",
- "container_operator_uen": "string",
- "haulier_nm": "string",
- "haulier_uen": "string",
- "vehicle_no": "string",
- "container_iso": "string",
- "booking_window_start_dt": "2019-08-24T14:15:22Z",
- "booking_window_end_dt": "2019-08-24T14:15:22Z",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: electronic_delivery_order
| container_operator_cd required | string (Container Operator Code)
|
| container_operator_uen | string or null (Container Operator Unique Entity Number)
|
| authorization_cd | string or null (Authorization Code)
|
| haulier_nm required | string (Haulier Name)
|
| haulier_cd | string or null (Haulier Code)
|
| process_delivery_dt | string or null <date-time> (Process Delivery Confirm Time)
|
| pregate_status | string or null (Pregate Status)
|
| pregate_dt | string or null <date-time> (Pregate Date-Time)
|
| vehicle_no | string or null (Vehicle Number)
|
| trailer_no | string or null (Trailer Number)
|
| company_reg_no | string or null (Company Registered Number)
|
| company_nm | string or null (Company Name)
|
| lolo_acc | string or null (LOLO Acconut Number)
|
| free_period_days | string or null (Free Period Days)
|
| boxcare_indicator | string or null (Boxcare)
|
| depot_yard_cd | string or null (Depot Yard Code)
|
| conference_cd | string or null (Conference Code)
|
| special_conference | string or null (Special Conference)
|
| creator_user_id | string or null (Creator User ID)
|
| updater_user_id | string or null (Updater User ID)
|
| exit_dt | string or null <date-time> (Exit Date-Time)
|
| discharge_dt | string or null <date-time> (Discharge Date-Time)
|
| haulier_uen required | string (Haulier Unique Entity Number)
|
| bill_lading_no | string or null (Bill of Lading Number)
|
| container_no required | string (Container Number)
|
| edo_created_dt required | string <date-time> (Electronic Delivery Order Created Date-Time)
|
| edo_updated_dt required | string <date-time> (Electronic Delivery Order Updated Date-Time)
|
| edo_deleted_dt | string or null <date-time> (Electronic Delivery Order Deleted Date-Time)
|
| vessel_nm required | string (Vessel Name)
|
| inward_voyage_no required | string (Inward Voyage Number)
|
| delivery_status_cd required | string (Delivery Status Code)
|
| snapshot_dt required | string <date-time> (Snapshot Date-Time)
|
{- "container_operator_cd": "string",
- "container_operator_uen": "string",
- "authorization_cd": "string",
- "haulier_nm": "string",
- "haulier_cd": "string",
- "process_delivery_dt": "2019-08-24T14:15:22Z",
- "pregate_status": "string",
- "pregate_dt": "2019-08-24T14:15:22Z",
- "vehicle_no": "string",
- "trailer_no": "string",
- "company_reg_no": "string",
- "company_nm": "string",
- "lolo_acc": "string",
- "free_period_days": "string",
- "boxcare_indicator": "string",
- "depot_yard_cd": "string",
- "conference_cd": "string",
- "special_conference": "string",
- "creator_user_id": "string",
- "updater_user_id": "string",
- "exit_dt": "2019-08-24T14:15:22Z",
- "discharge_dt": "2019-08-24T14:15:22Z",
- "haulier_uen": "string",
- "bill_lading_no": "string",
- "container_no": "string",
- "edo_created_dt": "2019-08-24T14:15:22Z",
- "edo_updated_dt": "2019-08-24T14:15:22Z",
- "edo_deleted_dt": "2019-08-24T14:15:22Z",
- "vessel_nm": "string",
- "inward_voyage_no": "string",
- "delivery_status_cd": "string",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: haulier_depot_entry_exit
| depot_country_cd required | string (Depot Country Cd)
|
| depot_yard_cd required | string (Depot Yard Cd)
|
| depot_uen | string or null (Depot Uen)
|
| haulier_nm required | string (Haulier Nm)
|
| haulier_uen | string or null (Haulier Uen)
|
| vehicle_no required | string (Vehicle No)
|
| vehicle_depotgate_in_dt | string or null <date-time> (Vehicle Depotgate In Dt)
|
| vehicle_depotgate_out_dt | string or null <date-time> (Vehicle Depotgate Out Dt)
|
required | Array of objects (Depot Booking) |
| snapshot_dt required | string <date-time> (Snapshot Dt) |
{- "depot_country_cd": "string",
- "depot_yard_cd": "string",
- "depot_uen": "string",
- "haulier_nm": "string",
- "haulier_uen": "string",
- "vehicle_no": "string",
- "vehicle_depotgate_in_dt": "2019-08-24T14:15:22Z",
- "vehicle_depotgate_out_dt": "2019-08-24T14:15:22Z",
- "depot_booking": [
- {
- "depot_booking_no": "string",
- "container_sealno": "string",
- "depot_booking_type": "string",
- "depot_booking_ref": "string",
- "container_no": "string"
}
], - "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: haulier_gps
| vehicle_speed | string or null (Vehicle Speed) [ 0 .. 120 ]
|
| haulier_nm required | string (Haulier Name) Abbreviated name of haulier as per Port of Singapore Authority definition. Sample values: ACS, CWT, COGENT. |
| haulier_uen | string or null (Haulier Uen)
|
| vehicle_no | string or null (Vehicle Number)
|
| position_latitude required | number <double> (Position Latitude) Latitude coordinates of vehicle. Additional validation will be performed by Mar 2023 |
| position_longitude required | number <double> (Position Longtitude) [ -180 .. 180 ] Longitude coordinates of vehicle. Additional validation will be performed by Mar 2023 |
| position_altitude | number or null <double> (Position Altitude)
|
| heading required | number <double> (Heading) Direction in which vehicle is pointing. Additional validation will be performed by Mar 2023 |
| snapshot_dt required | string <date-time> (Snapshot Dt)
|
| geofence_of_interest | string or null (Geofence Of Interest)
|
{- "vehicle_speed": "string",
- "haulier_nm": "string",
- "haulier_uen": "string",
- "vehicle_no": "string",
- "position_latitude": 0.1,
- "position_longitude": -180,
- "position_altitude": 0.1,
- "heading": 0.1,
- "snapshot_dt": "2019-08-24T14:15:22Z",
- "geofence_of_interest": "string"
}Data Element ID: haulier_port_entry_exit
| port_country_cd required | string (Port Country Cd)
|
| port_operator_cd required | string (Port Operator Cd)
|
| port_operator_uen required | string (Port Operator Uen)
|
| port_terminal_cd | string or null (Port Terminal Cd)
|
| haulier_nm required | string (Haulier Nm)
|
| haulier_uen required | string (Haulier Uen)
|
| vehicle_no required | string (Vehicle No)
|
| vehicle_portgate_dt required | string <date-time> (Vehicle Portgate Dt)
|
| unique_cargo_ref | string or null (Unique Cargo Ref)
|
| container_movement_type required | string (Container Movement Type)
|
| container_operator_cd required | string (Container Operator Cd)
|
| container_operator_uen required | string (Container Operator Uen)
|
| container_no required | string (Container No)
|
| container_iso required | string (Container Iso)
|
| container_content required | string (Container Content)
|
| snapshot_dt required | string <date-time> (Snapshot Dt)
|
{- "port_country_cd": "string",
- "port_operator_cd": "string",
- "port_operator_uen": "string",
- "port_terminal_cd": "string",
- "haulier_nm": "string",
- "haulier_uen": "string",
- "vehicle_no": "string",
- "vehicle_portgate_dt": "2019-08-24T14:15:22Z",
- "unique_cargo_ref": "string",
- "container_movement_type": "string",
- "container_operator_cd": "string",
- "container_operator_uen": "string",
- "container_no": "string",
- "container_iso": "string",
- "container_content": "string",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: haulier_trip_details
| haulier_nm required | string (Haulier Nm)
|
| haulier_uen | string or null (Haulier Uen)
|
| customer_nm required | string (Customer Nm)
|
| customer_uen | string or null (Customer Uen)
|
| bco_nm | string or null (Bco Nm)
|
| bco_uen | string or null (Bco Uen)
|
| job_booking_ref required | string (Job Booking Ref)
|
| job_no | string or null (Job No)
|
| container_no required | string (Container No)
|
Array of objects or null (Trip Details) | |
| snapshot_dt required | string <date-time> (Snapshot Dt)
|
{- "haulier_nm": "string",
- "haulier_uen": "string",
- "customer_nm": "string",
- "customer_uen": "string",
- "bco_nm": "string",
- "bco_uen": "string",
- "job_booking_ref": "string",
- "job_no": "string",
- "container_no": "string",
- "trip_details": [
- {
- "vehicle_no": "string",
- "trailer_no": "string",
- "pickup_location_type": "string",
- "pickup_location_code": "string",
- "pickup_location_address": "string",
- "pickup_dt": "2019-08-24T14:15:22Z",
- "dropoff_location_type": "string",
- "dropoff_location_code": "string",
- "dropoff_location_address": "string",
- "dropoff_dt": "2019-08-24T14:15:22Z"
}
], - "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: release_depot
| container_operator_cd required | string (Container Operator Code)
|
| container_operator_uen | string or null (Container Operator Unique Entity Number)
|
| depot_uen | string or null (Depot Unique Entity Number)
|
| depot_country_cd required | string (Depot Country Code)
|
| unique_cargo_ref required | string (Unique Cargo Reference)
|
| vessel_nm required | string (Vessel Name)
|
| outward_voyage_no required | string (Outward Voyage Number)
|
| release_created_dt | string or null <date-time> (Release Created Date-Time)
|
| release_updated_dt | string or null <date-time> (Release Updated Date-Tme)
|
| release_cancelled_dt | string or null <date-time> (Release Cancelled Date-Time)
|
| snapshot_dt required | string <date-time> (Snapshot Date-Time)
|
required | Array of objects (Depot Details)
|
| container_total_qty required | string (Container Total Quantity)
|
| container_release_dt required | string <date-time> (Container Release Date-Time)
|
{- "container_operator_cd": "string",
- "container_operator_uen": "string",
- "depot_uen": "string",
- "depot_country_cd": "string",
- "unique_cargo_ref": "string",
- "vessel_nm": "string",
- "outward_voyage_no": "string",
- "release_created_dt": "2019-08-24T14:15:22Z",
- "release_updated_dt": "2019-08-24T14:15:22Z",
- "release_cancelled_dt": "2019-08-24T14:15:22Z",
- "snapshot_dt": "2019-08-24T14:15:22Z",
- "depot_detail": [
- {
- "depot_yard_cd": "string",
- "container_iso": "string",
- "container_grade": "string"
}
], - "container_total_qty": "string",
- "container_release_dt": "2019-08-24T14:15:22Z"
}Data Element ID: release_order
| container_operator_cd required | string (Container Operator Cd) [ 1 .. 8 ] characters
|
| container_operator_uen | string or null (Container Operator Uen)
|
| depot_country_cd required | string (Depot Country Cd)
|
| depot_uen | string or null (Depot Uen)
|
| unique_cargo_ref required | string (Unique Cargo Ref)
|
| vessel_nm required | string (Vessel Nm)
|
| outward_voyage_no required | string (Outward Voyage No)
|
| shipper_nm required | string (Shipper Nm)
|
| shipper_uen | string or null (Shipper Uen)
|
| forwarder_nm | string or null (Forwarder Nm)
|
| forwarder_uen | string or null (Forwarder Uen)
|
| release_created_dt | string or null <date-time> (Release Created Dt)
|
| release_updated_dt | string or null <date-time> (Release Updated Dt)
|
| release_cancelled_dt | string or null <date-time> (Release Cancelled Dt)
|
required | Array of objects (Container Detai)
|
| snapshot_dt required | string <date-time> (Snapshot Dt)
|
{- "container_operator_cd": "string",
- "container_operator_uen": "string",
- "depot_country_cd": "string",
- "depot_uen": "string",
- "unique_cargo_ref": "string",
- "vessel_nm": "string",
- "outward_voyage_no": "string",
- "shipper_nm": "string",
- "shipper_uen": "string",
- "forwarder_nm": "string",
- "forwarder_uen": "string",
- "release_created_dt": "2019-08-24T14:15:22Z",
- "release_updated_dt": "2019-08-24T14:15:22Z",
- "release_cancelled_dt": "2019-08-24T14:15:22Z",
- "container_detail": [
- {
- "depot_yard_cd": "string",
- "container_iso": "string",
- "container_qty": 0,
- "container_grade": "string",
- "container_release_dt": "2019-08-24T14:15:22Z"
}
], - "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: storing_depot
| depot_uen | string or null (Depot Unique Entity Number) Unique Entity Number for depot |
| depot_yard_cd required | string (Depot Yard Code)
|
| bill_lading_no required | string (Bill of Lading Number) Bill of lading number |
| container_operator_cd required | string (Container Operator Code) Container operator code as per Port of Singapore Authority definition. Sample values: CC, OR, PI |
| depot_country_cd required | string (Depot Country Code) Code for country/location of depot facility as per UN/ECE definition. Sample values: SGSIN, INNSA |
| vessel_nm required | string (Vessel Name)
|
| inward_voyage_no required | string (Inward Voyage Number)
|
| container_no required | string (Container Number)
|
| container_iso required | string (Container Size/Type)
|
| storing_created_dt | string or null <date-time> (Storing Created date)
|
| container_operator_uen | string or null (Container Operator Unique Entity Number) Unique Entity Number for container operator |
| storing_updated_dt | string or null <date-time> (Storing Updated date)
|
| storing_cancelled_dt | string or null <date-time> (Storing Cancelled date)
|
| container_must_return_dt | string or null <date-time> (Container Must Return date)
|
| snapshot_dt required | string <date-time> (Snapshot date)
|
{- "depot_uen": "string",
- "depot_yard_cd": "string",
- "bill_lading_no": "string",
- "container_operator_cd": "string",
- "depot_country_cd": "string",
- "vessel_nm": "string",
- "inward_voyage_no": "string",
- "container_no": "string",
- "container_iso": "string",
- "storing_created_dt": "2019-08-24T14:15:22Z",
- "container_operator_uen": "string",
- "storing_updated_dt": "2019-08-24T14:15:22Z",
- "storing_cancelled_dt": "2019-08-24T14:15:22Z",
- "container_must_return_dt": "2019-08-24T14:15:22Z",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: storing_order
| container_operator_cd required | string (Container Operator Cd)
|
| container_operator_uen | string or null (Container Operator Uen)
|
| depot_country_cd required | string (Depot Country Cd)
|
| depot_yard_cd required | string (Depot Yard Cd)
|
| depot_uen | string or null (Depot Uen)
|
| bill_lading_no required | string (Bill Lading No)
|
| vessel_nm required | string (Vessel Nm)
|
| inward_voyage_no required | string (Inward Voyage No)
|
| consignee_nm required | string (Consignee Nm)
|
| consignee_uen | string or null (Consignee Uen)
|
| storing_created_dt | string or null <date-time> (Storing Created Dt)
|
| storing_updated_dt | string or null <date-time> (Storing Updated Dt)
|
| storing_cancelled_dt | string or null <date-time> (Storing Cancelled Dt)
|
| container_no required | string (Container No)
|
| container_iso required | string (Container Iso)
|
| container_must_return_dt | string or null <date-time> (Container Must Return Date-Time) Date that container must be returned to depot by, i.e. last free use date. |
| snapshot_dt required | string <date-time> (Snapshot Dt)
|
{- "container_operator_cd": "string",
- "container_operator_uen": "string",
- "depot_country_cd": "string",
- "depot_yard_cd": "string",
- "depot_uen": "string",
- "bill_lading_no": "string",
- "vessel_nm": "string",
- "inward_voyage_no": "string",
- "consignee_nm": "string",
- "consignee_uen": "string",
- "storing_created_dt": "2019-08-24T14:15:22Z",
- "storing_updated_dt": "2019-08-24T14:15:22Z",
- "storing_cancelled_dt": "2019-08-24T14:15:22Z",
- "container_no": "string",
- "container_iso": "string",
- "container_must_return_dt": "2019-08-24T14:15:22Z",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_journey
| container_no | Array of strings or null or null (Container Number)
|
| bill_lading_no | string or null (Bill of Lading Number)
|
| carrier_no | string or null (Carrier Code)
|
Array of objects or null (Port of Discharge Details)
| |
Array of objects or null (Port of Loading Details)
| |
Array of objects or null (Container Event List)
| |
Array of objects or null (Carbon Dioxide Emissions)
| |
Array of objects or null (Delay Lists)
| |
Array of objects or null (Sailing Info Tracking)
| |
| error_code | string or null (Error Code)
|
| shipment_tracking | string or null (Shipment Tracking)
|
| update_timestamp required | string or null <date-time> (Snapshot Date-Time)
|
{- "container_no": [
- "string"
], - "bill_lading_no": "string",
- "carrier_no": "string",
- "port_of_discharge": [
- {
- "port_code": "string",
- "port_name": "string",
- "port_terminal_name": "string",
- "actual_arrival_lt": "2019-08-24T14:15:22Z",
- "actual_arrival_lt_from_ais": "2019-08-24T14:15:22Z",
- "actual_departure_lt_from_ais": "2019-08-24T14:15:22Z",
- "actual_discharge_lt": "2019-08-24T14:15:22Z",
- "scheduled_arrival_lt": "2019-08-24T14:15:22Z",
- "scheduled_arrival_lt_from_schedule": "2019-08-24T14:15:22Z",
- "scheduled_departure_lt_from_schedule": "2019-08-24T14:15:22Z",
- "scheduled_discharge_lt": "2019-08-24T14:15:22Z"
}
], - "port_of_loading": [
- {
- "port_code": "string",
- "port_name": "string",
- "terminal_name": "string",
- "actual_arrival_lt_from_ais": "2019-08-24T14:15:22Z",
- "actual_departure_lt": "2019-08-24T14:15:22Z",
- "actual_departure_lt_from_ais": "2019-08-24T14:15:22Z",
- "actual_loading_lt": "2019-08-24T14:15:22Z",
- "scheduled_arrival_lt_from_schedule": "2019-08-24T14:15:22Z",
- "scheduled_departure_lt": "2019-08-24T14:15:22Z",
- "scheduled_departure_lt_from_schedule": "2019-08-24T14:15:22Z",
- "scheduled_loading_lt": "2019-08-24T14:15:22Z"
}
], - "container_event": [
- {
- "description": "string",
- "updated_dt": "2019-08-24T14:15:22Z",
- "created_dt": "2019-08-24T14:15:22Z",
- "latest_actual_dt": "2019-08-24T14:15:22Z",
- "latest_est_dt": "2019-08-24T14:15:22Z",
- "type_cd": "string",
- "type_nm": "string",
- "location": "string",
- "location_type_cd": "string",
- "location_type_nm": "string",
- "transport_mode": "string",
- "port_cd": "string",
- "port_nm": "string",
- "terminal_details": [
- {
- "code": "string",
- "standard": "string",
- "name": "string"
}
], - "vessel_imo": "string",
- "vessel_nm": "string"
}
], - "co2_emissions": [
- {
- "total": "string",
- "wtt": "string",
- "ttw": "string",
- "intensity": "string"
}
], - "delay_list": [
- {
- "created": "2019-08-24T14:15:22Z",
- "delay_description": "string",
- "location_type_code": "string",
- "port_code": "string",
- "port_name": "string",
- "reason_code": "string",
- "rotation_change": [
- {
- "comparison_schedule": "string",
- "updated_schedule": "string"
}
], - "schedule_change": [
- {
- "event_type_code": "string",
- "location_type_code": "string",
- "new_date": "2019-08-24T14:15:22Z",
- "old_date": "2019-08-24T14:15:22Z"
}
], - "vessel_change": [
- {
- "comparison_vessel": "string",
- "updated_vessel": "string"
}
]
}
], - "sailing_info_tracking": [
- {
- "ais": [
- {
- "course": 0,
- "imo": "string",
- "lat": 0.1,
- "lon": 0.1,
- "speed_nm": 0.1,
- "status": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
], - "sailing_info": [
- {
- "carrier_no": "string",
- "created": "2019-08-24T14:15:22Z",
- "imo": "string",
- "is_active": true,
- "pod": "string",
- "pod_actual_arrival_lt": "2019-08-24T14:15:22Z",
- "pod_actual_arrival_lt_from_ais": "2019-08-24T14:15:22Z",
- "pod_actual_departure_lt_from_ais": "2019-08-24T14:15:22Z",
- "pod_actual_discharge_lt": "2019-08-24T14:15:22Z",
- "pod_name": "string",
- "pod_scheduled_arrival_lt": "2019-08-24T14:15:22Z",
- "pod_scheduled_arrival_lt_from_schedule": "2019-08-24T14:15:22Z",
- "pod_scheduled_departure_lt_from_schedule": "2019-08-24T14:15:22Z",
- "pod_scheduled_discharge_lt": "2019-08-24T14:15:22Z",
- "pod_terminal_name": "string",
- "pol": "string",
- "pol_actual_arrival_lt_from_ais": "2019-08-24T14:15:22Z",
- "pol_actual_departure_lt": "2019-08-24T14:15:22Z",
- "pol_actual_departure_lt_from_ais": "2019-08-24T14:15:22Z",
- "pol_actual_loading_lt": "2019-08-24T14:15:22Z",
- "pol_name": "string",
- "pol_scheduled_arrival_lt_from_schedule": "2019-08-24T14:15:22Z",
- "pol_scheduled_departure_lt": "2019-08-24T14:15:22Z",
- "pol_scheduled_departure_lt_from_schedule": "2019-08-24T14:15:22Z",
- "pol_scheduled_loading_lt": "2019-08-24T14:15:22Z",
- "pol_terminal_name": "string",
- "updated": "2019-08-24T14:15:22Z",
- "vessel_flag": "string",
- "vessel_leg": "string",
- "vessel_name": "string",
- "voyage_no": "string"
}
], - "voyage_details": [
- {
- "active_scac": "string",
- "actual_arrival": "2019-08-24T14:15:22Z",
- "actual_departure": "2019-08-24T14:15:22Z",
- "delay_reasons": [
- "string"
], - "port_code": "string",
- "port_name": "string",
- "scheduled_arrival": "2019-08-24T14:15:22Z",
- "scheduled_departure": "2019-08-24T14:15:22Z",
- "voyage_no_list": [
- "string"
]
}
]
}
], - "error_code": "string",
- "shipment_tracking": "string",
- "update_timestamp": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_activity
| container_no | string or null (Container Number)
|
| unique_cargo_ref | string or null (Unique Cargo Reference)
|
| vessel_imo | string or null (IMO Number)
|
| abbr_vessel_nm | string or null (Abbreviated Vessel Name)
|
| vessel_nm required | string (Full Vessel Name)
|
| abbr_inward_voy | string or null (Abbreviated Inward Voyage Number)
|
| inward_voyage_no required | string (Inward Voyage Number)
|
| abbr_outward_voy | string or null (Abbreviated Outward Voyage Number)
|
| outward_voyage_no required | string (Outward Voyage Number)
|
| vessel_btr_dt required | string <date-time> (Berthing Time Request Date-Time)
|
| vessel_etb_dt | string or null <date-time> (Vessel Estimated Time of Berthing Date-Time)
|
| vessel_etu_dt | string or null <date-time> (Vessel Estimated Time of Unberthing Date-Time)
|
| abbr_terminal_nm | string or null (Abbreviated Terminal Name)
|
| vessel_etd_dt | string or null <date-time> (Vessel Estimated Time of Departure Date-Time)
|
| terminal_berth required | string (Terminal and Berth)
|
| vessel_consortium_nm | string or null (Consortium Name)
|
| vessel_consortium_cd | string or null (Consortium Code)
|
| vessel_operator_cd required | string (Vessel Operator Code)
|
| vessel_operator_uen | string or null (Vessel Operator Unique Entity Number)
|
| vessel_operator_nm | string or null (Vessel Operator Name)
|
| vessel_psa_service | string or null (PSA Service Code)
|
| vessel_psa_service_desc | string or null (PSA Service Description)
|
| vessel_cust_service | string or null (Customer Service Code)
|
| vessel_cust_service_desc | string or null (Customer Service Description)
|
| vessel_status required | string (Vessel Status)
|
| vessel_shift_seq | string or null (Shift Sequence Number)
|
| vessel_atb_dt | string or null <date-time> (Vessel Actual Time of Berthing Date-Time)
|
| vessel_atu_dt | string or null <date-time> (Vessel Actual Time of Unberthing Date-Time)
|
| vessel_cod_dt | string or null <date-time> (Vessel Completion Of Discharge Date-Time)
|
| vessel_col_dt | string or null <date-time> (Vessel Completion Of Loading Date-Time)
|
| vessel_cob_dt | string or null <date-time> (Vessel Completion Of Bunker Date-Time)
|
| snapshot_dt required | string <date-time> (Snapshot Date-Time)
|
{- "container_no": "string",
- "unique_cargo_ref": "string",
- "vessel_imo": "string",
- "abbr_vessel_nm": "string",
- "vessel_nm": "string",
- "abbr_inward_voy": "string",
- "inward_voyage_no": "string",
- "abbr_outward_voy": "string",
- "outward_voyage_no": "string",
- "vessel_btr_dt": "2019-08-24T14:15:22Z",
- "vessel_etb_dt": "2019-08-24T14:15:22Z",
- "vessel_etu_dt": "2019-08-24T14:15:22Z",
- "abbr_terminal_nm": "string",
- "vessel_etd_dt": "2019-08-24T14:15:22Z",
- "terminal_berth": "string",
- "vessel_consortium_nm": "string",
- "vessel_consortium_cd": "string",
- "vessel_operator_cd": "string",
- "vessel_operator_uen": "string",
- "vessel_operator_nm": "string",
- "vessel_psa_service": "string",
- "vessel_psa_service_desc": "string",
- "vessel_cust_service": "string",
- "vessel_cust_service_desc": "string",
- "vessel_status": "string",
- "vessel_shift_seq": "string",
- "vessel_atb_dt": "2019-08-24T14:15:22Z",
- "vessel_atu_dt": "2019-08-24T14:15:22Z",
- "vessel_cod_dt": "2019-08-24T14:15:22Z",
- "vessel_col_dt": "2019-08-24T14:15:22Z",
- "vessel_cob_dt": "2019-08-24T14:15:22Z",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: depot_timeslot_booking
| depot_booking_ref required | Array of strings (Depot Booking Ref) Provide list of booking references |
| depot_booking_type required | string (Depot Booking Type) Container Return (R) / Collection (C) / Import (I) / Export (E) |
required | object (Snapshot Dt) |
{- "depot_booking_ref": [
- "string"
], - "depot_booking_type": "string",
- "snapshot_dt": {
- "from": "2019-08-24",
- "to": "2019-08-24"
}
}Data Element ID: electronic_delivery_order
| haulier_nm | string or null (Haulier Name) Name of haulier as per Port of Singapore Authority definition. |
| haulier_cd | string or null (Haulier Code) Code of haulier as per Port of Singapore Authority definition. |
| delivery_type_cd | string or null (Delivery Type Code) Delivery Type (Blank, I or M). Where I is FCL & Commercial Empty and M is Nominated Empty. No imput will default to blank and return both FCL and Nominated Empty |
{- "haulier_nm": "string",
- "haulier_cd": "string",
- "delivery_type_cd": "string"
}Data Element ID: haulier_depot_entry_exit
| depot_booking_ref required | Array of strings (Depot Booking Ref) Provide list of booking references (comma delimited) |
| depot_booking_type required | string (Depot Booking Type) Container Return (R) / Collection (C) / Import (I) / Export (E) |
required | object (Snapshot Dt) |
{- "depot_booking_ref": [
- "string"
], - "depot_booking_type": "string",
- "snapshot_dt": {
- "from": "2019-08-24",
- "to": "2019-08-24"
}
}Data Element ID: haulier_gps
| position_latitude required | number <double> (Position Latitude) Latitude coordinates of vehicle |
| position_longitude required | number <double> (Position Longtitude) Longitude coordinates of vehicle |
| position_radius_metres required | string (Position Radius Metres) Range of geofence |
{- "position_latitude": 0.1,
- "position_longitude": 0.1,
- "position_radius_metres": "string"
}Data Element ID: haulier_port_entry_exit
| unique_cargo_ref required | Array of strings (Unique Cargo Ref) Provide list of UCR |
{- "unique_cargo_ref": [
- "string"
]
}Data Element ID: haulier_trip_details
| job_booking_ref required | Array of strings (Job Booking Ref) Job Booking Reference / Booking Confirmation number |
{- "job_booking_ref": [
- "string"
]
}Data Element ID: release_depot
| unique_cargo_ref required | Array of strings (Unique Cargo Reference) Unique Cargo Reference / Booking Confirmation number |
{- "unique_cargo_ref": [
- "string"
]
}Data Element ID: release_order
| unique_cargo_ref required | Array of strings (Unique Cargo Ref) Provide list of UCR (comma delimited) |
{- "unique_cargo_ref": [
- "string"
]
}Data Element ID: storing_depot
| container_no required | Array of strings (Container Number) Identification number of container (ISO6346) - Example: CBHU4398907 |
required | object (Snapshot Dt) |
{- "container_no": [
- "string"
], - "snapshot_dt": {
- "from": "2019-08-24",
- "to": "2019-08-24"
}
}Data Element ID: storing_order
| container_no required | Array of strings (Container No) Provide list of container numbers |
required | object (Snapshot Dt) |
{- "container_no": [
- "string"
], - "snapshot_dt": {
- "from": "2019-08-24",
- "to": "2019-08-24"
}
}Data Element ID: vessel_journey_in
| container_no | string or null (Container Number) Identification number of container. Sample value: CBHU4398907 |
| bill_lading_no required | string (Bill of Lading Number) Bill of lading number / booking number |
| carrier_no | string or null (Carrier Code) Code of the carrier issued the booking confirmation to shipper/consignee/ 3PL/4PL for their shipment as per SCAC definition. |
{- "container_no": "string",
- "bill_lading_no": "string",
- "carrier_no": "string"
}Data Element ID: vessel_activity
| vessel_nm required | string (Full Vessel Name) Full name of the vessel |
| voyage_no required | string (Voyage Number) Full inward/ outward voyage number |
{- "vessel_nm": "string",
- "voyage_no": "string"
}Data Element ID: barge_event_data
| barge_bunker_barge_actual_arrival_dt required | string <date-time> (Barge Bunker Barge Actual Arrival Dt)
|
| barge_bunkering_hose_connect_dt required | string <date-time> (Barge Bunkering Hose Connect Dt)
|
| barge_bunkering_hose_disconnect_dt required | string <date-time> (Barge Bunkering Hose Disconnect Dt)
|
| barge_bunker_barge_actual_departure_dt required | string <date-time> (Barge Bunker Barge Actual Departure Dt)
|
| barge_bdn_no required | string (Barge Bdn No)
|
| barge_bunker_supplier_company_nm required | string (Barge Bunker Supplier Company Nm)
|
| barge_bunker_supplier_contact_no required | string (Barge Bunker Supplier Contact No)
|
Array of objects or null (Attachments)
|
{- "barge_bunker_barge_actual_arrival_dt": "2019-08-24T14:15:22Z",
- "barge_bunkering_hose_connect_dt": "2019-08-24T14:15:22Z",
- "barge_bunkering_hose_disconnect_dt": "2019-08-24T14:15:22Z",
- "barge_bunker_barge_actual_departure_dt": "2019-08-24T14:15:22Z",
- "barge_bdn_no": "string",
- "barge_bunker_supplier_company_nm": "string",
- "barge_bunker_supplier_contact_no": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bunker_delivery_note
| bdn_bunker_tanker_seal_no required | string (Master's/Chief Engineer's Acknowledgement - Seal No (Bunker Tanker))
|
| bdn_surveyor_seal_no required | string (Master's/Chief Engineer's Acknowledgement - Seal No (Surveyor))
|
| bdn_delivery_port required | string (Port of Delivery)
|
| bdn_delivery_location required | string (Delivery Location)
|
| bdn_bunker_tanker_nm required | string (Bunker Tanker Name)
|
| bdn_sb_no required | string (Bunker Tanker License Number)
|
| bdn_alongside_vessel_dt required | string <date-time> (Time of Alongside Receiving Vessel )
|
| bdn_commenced_pumping_dt required | string <date-time> (Commencement of Pumping)
|
| bdn_completed_pumping_dt required | string <date-time> (Completion of Pumping)
|
| bdn_no required | string (Bunker Delivery Note Number)
|
| bdn_bunker_metering_ticket_no | integer or null <int64> (Bunker Metering Ticket Number (BTN))
|
| bdn_dt required | string <date> (Date of Operation)
|
| bdn_vessel_nm required | string (Vessel Name)
|
| bdn_vessel_imo_no required | string (Vessel International Maritime Organisation Number)
|
| bdn_gross_tonnage required | integer <int64> (Gross Tonnage )
|
| bdn_owner_operator_nm required | string (Owner/Operator)
|
| bdn_etd_dt required | string <date> (Estimated Date of Departure)
|
| bdn_next_port required | string (Next Port of Call)
|
| bdn_supplied_product_nm required | string (Supplied Product Name)
|
| bdn_supplied_product_viscosity required | number <double> (Product Viscosity)
|
| bdn_supplied_product_coq_density required | number <double> (Product Density)
|
| bdn_supplied_product_water_content required | number <double> (Product Water Content)
|
| bdn_supplied_product_flash_point required | number <double> (Product Flash Point)
|
| bdn_supplied_product_sulphur_content required | number <double> (Product Sulphur Content)
|
| bdn_supplied_product_metric_tons_delivered required | number <double> (Product Metric Tons Delivered )
|
| bdn_declaration_reg_14_1_of_annex required | boolean (Supplier's Declaration Reg14.1 of Annex)
|
| bdn_declaration_reg_14_4_of_annex required | boolean (Supplier's Declaration Reg14.4 of Annex)
|
| bdn_declaration_specified_limit_value_of_annex required | boolean (Supplier's Declaration Specified Limit Value of Annex)
|
| bdn_supplier_confirmation_company_nm required | string (Bunker Supplier Company Name)
|
| bdn_cargo_officer_nm required | string (Cargo Officer's Full Name in Block Letters)
|
| bdn_remarks | string or null (Additional Remarks)
|
| bdn_vessel_seal_no required | string (Master's/Chief Engineer's Acknowledgement - Seal No. (Vessel))
|
| bdn_marpol_seal_no required | string (Master's/Chief Engineer's Acknowledgement - Seal No. (MARPOL))
|
| bdn_others_seal_no required | string (Master's/Chief Engineer's Acknowledgement - Seal No. (Others))
|
| bdn_vessel_counter_seal_no | string or null (Master's/Chief Engineer's Acknowledgement - Counter Seal No. (Vessel))
|
| bdn_marpol_counter_seal_no | string or null (Master's/Chief Engineer's Acknowledgement - Counter Seal No. (MARPOL))
|
| bdn_bunker_tanker_counter_seal_no | string or null (Master's/Chief Engineer's Acknowledgement - Counter Seal No. (Bunker Tanker))
|
| bdn_surveyor_counter_seal_no | string or null (Master's/Chief Engineer's Acknowledgement - Counter Seal No. (Surveyor))
|
| bdn_others_counter_seal_no | string or null (Master's/Chief Engineer's Acknowledgement - Counter Seal No. (Others))
|
| bdn_protest_issued_note required | boolean (Note of Protest Issued)
|
| bdn_customer_feedback required | integer <int64> (Customer Rating )
|
| bdn_master_or_chief_enginer_nm required | string (Full Name of Master/Chief Engineer)
|
required | Array of objects (Attachments) non-empty
|
| bdn_specified_limit_value | number or null <double> (Supplier's Declaration (if declarationSpecifiedLimitValueofAnnex is TRUE))
|
| bdn_sds_copy | boolean or null (Was a copy of SDS received)
|
| bdn_license_no required | string (Bunker Supplier License Number)
|
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket (BMT) No.)
|
{- "bdn_bunker_tanker_seal_no": "string",
- "bdn_surveyor_seal_no": "string",
- "bdn_delivery_port": "string",
- "bdn_delivery_location": "string",
- "bdn_bunker_tanker_nm": "string",
- "bdn_sb_no": "string",
- "bdn_alongside_vessel_dt": "2019-08-24T14:15:22Z",
- "bdn_commenced_pumping_dt": "2019-08-24T14:15:22Z",
- "bdn_completed_pumping_dt": "2019-08-24T14:15:22Z",
- "bdn_no": "string",
- "bdn_bunker_metering_ticket_no": 0,
- "bdn_dt": "2019-08-24",
- "bdn_vessel_nm": "string",
- "bdn_vessel_imo_no": "string",
- "bdn_gross_tonnage": 0,
- "bdn_owner_operator_nm": "string",
- "bdn_etd_dt": "2019-08-24",
- "bdn_next_port": "string",
- "bdn_supplied_product_nm": "string",
- "bdn_supplied_product_viscosity": 0.1,
- "bdn_supplied_product_coq_density": 0.1,
- "bdn_supplied_product_water_content": 0.1,
- "bdn_supplied_product_flash_point": 0.1,
- "bdn_supplied_product_sulphur_content": 0.1,
- "bdn_supplied_product_metric_tons_delivered": 0.1,
- "bdn_declaration_reg_14_1_of_annex": true,
- "bdn_declaration_reg_14_4_of_annex": true,
- "bdn_declaration_specified_limit_value_of_annex": true,
- "bdn_supplier_confirmation_company_nm": "string",
- "bdn_cargo_officer_nm": "string",
- "bdn_remarks": "string",
- "bdn_vessel_seal_no": "string",
- "bdn_marpol_seal_no": "string",
- "bdn_others_seal_no": "string",
- "bdn_vessel_counter_seal_no": "string",
- "bdn_marpol_counter_seal_no": "string",
- "bdn_bunker_tanker_counter_seal_no": "string",
- "bdn_surveyor_counter_seal_no": "string",
- "bdn_others_counter_seal_no": "string",
- "bdn_protest_issued_note": true,
- "bdn_customer_feedback": 0,
- "bdn_master_or_chief_enginer_nm": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "bdn_specified_limit_value": 0.1,
- "bdn_sds_copy": true,
- "bdn_license_no": "string",
- "bunkerMeteringTicketNo": "string"
}Data Element ID: scic_bunker_delivery_note
| bunkerSupplierName | string or null (supplierCompanyName)
|
| supplierLicenceNumber | string or null (supplierLicenceNumber)
|
| port | string or null (Port)
|
| deliveryLocationName | string or null (deliveryLocation)
|
| bunkerTankerName | string or null (bunkerTankerName)
|
| bunkerTankerLicenceNo | string or null (SB No.)
|
| bdnNo | integer or null (BDN NO.)
|
| operationDate | string or null (Date)
|
| receivingVesselName | string or null (Vessel's Name)
|
| receiveVesselImoNo | string or null (Vessel's IMO No.)
|
| receiveVesselGST | string or null (grossTonnage)
|
| ownerOperator | string or null (Owner/Operator)
|
| nextPort | string or null (Next Port)
|
| alongsideTime | string or null (Along Vessel)
|
| pumpingCommencedDatetime | string or null (Commence Pumping)
|
| pumpingCompletedDatetime | string or null (Completed Pumping)
|
| expectedReceivingVesselDepartureDatetime | string or null (ETD)
|
| productNameQTR | string or null (productName)
|
| productType | string or null (productType)
|
| flashPoint | number or null (flashPoint)
|
| density15Degc | number or null (density15Degc)
|
| viscosity40Degc50Degc | number or null (viscosity40Degc50Degc)
|
| waterContent | number or null (waterContent)
|
| sulfurContent | number or null (date)
|
| sulphurDoesNotExceedPurchaserLimit | boolean or null (sulphurDoesNotExceedPurchaserLimit)
|
| sulphurPurchaserLimit | number or null (sulphurPurchaserLimit)
|
| bunkerMeteringTicketNo | string or null (bunkerMeteringTicketNo)
|
| quantityDelivered | number or null (Metric Tons Delivered)
|
| bunkerTanker RetainedSampleCounterSeal | string or null (bunkerTanker RetainedSampleCounterSeal)
|
| bunkerTankerRetainedSampleSeal | string or null (bunkerTankerRetainedSampleSeal)
|
| otherRetainedSampleCounterSeal | string or null (otherRetainedSampleCounterSeal)
|
| otherRetainedSampleSeal | string or null (otherRetainedSampleSeal)
|
| nameParty | string or null (nameParty)
|
| surveyorRetainedSampleCounterSeal | string or null (surveyorRetainedSampleCounterSeal)
|
| surveyorRetainedSampleSeal | string or null (surveyorRetainedSampleSeal)
|
| vesselRetainedSampleCounterSeal | string or null (vesselRetainedSampleCounterSeal)
|
| vesselRetainedSampleSeal | string or null (vesselRetainedSampleSeal)
|
| marpolSampleCounterSealNo | string or null (marpolSampleCounterSealNo)
|
| marpolSampleSealNo | string or null (marpolSampleSealNo)
|
| cargoOfficerNameEnd | string or null (cargoOfficerName)
|
| signatureOfCargoOfficerEnd | string or null (signatureOfCargoOfficer)
|
| bunkerTanker''SStamp | string or null (bunkerTanker'SStamp)
|
| chiefEngineerNameEnd | string or null (masterOrChiefEnginerName)
|
| signatureOfMasterChiefEngineerEnd | string or null (signatureOfMasterChiefEngineer)
|
| ChiefEngineerDateTimeEnd | string or null (dateAndTimeOfSignature)
|
| vesselStamp | string or null (vessel'SStamp)
|
| remarks | string or null (remarks)
|
| customerRating | string or null (customerFeedback)
|
| sdsCopyReceived | boolean or null (SDS)
|
| protestNote | boolean or null (protestNote)
|
Array of objects or null (Attachments)
|
{- "bunkerSupplierName": "string",
- "supplierLicenceNumber": "string",
- "port": "string",
- "deliveryLocationName": "string",
- "bunkerTankerName": "string",
- "bunkerTankerLicenceNo": "string",
- "bdnNo": 0,
- "operationDate": "string",
- "receivingVesselName": "string",
- "receiveVesselImoNo": "string",
- "receiveVesselGST": "string",
- "ownerOperator": "string",
- "nextPort": "string",
- "alongsideTime": "string",
- "pumpingCommencedDatetime": "string",
- "pumpingCompletedDatetime": "string",
- "expectedReceivingVesselDepartureDatetime": "string",
- "productNameQTR": "string",
- "productType": "string",
- "flashPoint": 0,
- "density15Degc": 0,
- "viscosity40Degc50Degc": 0,
- "waterContent": 0,
- "sulfurContent": 0,
- "sulphurDoesNotExceedPurchaserLimit": true,
- "sulphurPurchaserLimit": 0,
- "bunkerMeteringTicketNo": "string",
- "quantityDelivered": 0,
- "bunkerTanker RetainedSampleCounterSeal": "string",
- "bunkerTankerRetainedSampleSeal": "string",
- "otherRetainedSampleCounterSeal": "string",
- "otherRetainedSampleSeal": "string",
- "nameParty": "string",
- "surveyorRetainedSampleCounterSeal": "string",
- "surveyorRetainedSampleSeal": "string",
- "vesselRetainedSampleCounterSeal": "string",
- "vesselRetainedSampleSeal": "string",
- "marpolSampleCounterSealNo": "string",
- "marpolSampleSealNo": "string",
- "cargoOfficerNameEnd": "string",
- "signatureOfCargoOfficerEnd": "string",
- "bunkerTanker''SStamp": "string",
- "chiefEngineerNameEnd": "string",
- "signatureOfMasterChiefEngineerEnd": "string",
- "ChiefEngineerDateTimeEnd": "string",
- "vesselStamp": "string",
- "remarks": "string",
- "customerRating": "string",
- "sdsCopyReceived": true,
- "protestNote": true,
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bunker_delivery_report
| vendorUen required | string (Vendor UEN)
|
| bunkerTankerLicenceNo required | string (Bunker Tanker Licence Number)
|
| bunkerTankerName required | string (Bunker Tanker Name)
|
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket Number)
|
| bunkerSupplierName required | string (Bunker Supplier Name)
|
| bunkerSupplierUEN required | string (Bunker Supplier UEN)
|
| bdnNo required | string (Bunker Delivery Note Number)
|
| receiveVesselName required | string (Receiving Vessel Name)
|
| receiveVesselImoNo | string or null (Receiving Vessel IMO Number)
|
| receiveVesselHarbourcraftNo | string or null (Receiving Vessel Harbourcraft License Number)
|
| receiveVesselGst required | number <double> (Receiving Vessel GST)
|
| deliveryLocationCode required | string (Delivery Location Code)
|
| deliveryLocationName required | string (Delivery Location Name)
|
| deliveryType required | number <double> (Delivery Type (SS648 or SS600))
|
| supplyType required | string (Supply Type)
|
| fuelTypeCode required | string (Fuel Type Code)
|
| startDeliveryMeterTotaliser | number or null <double> (Start Delivery Meter Totaliser)
|
| startLoadingMeterTotaliser | number or null <double> (Start Loading Meter Totaliser)
|
| endDeliveryMeterTotaliser | number or null <double> (End Delivery Meter Totaliser)
|
| endLoadingMeterTotaliser | number or null <double> (End Loading Meter Totaliser)
|
| suppliedQuantityMFM | number or null <double> (Supplied Quantity from MFM)
|
| suppliedQuantityBDN required | number <double> (Supplied Quantity from BDN)
|
| operationDate required | string <date> (Operation Date)
|
| commencePumpingTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Commence Pumping Time)
|
| completePumpingTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Complete Pumping Time)
|
| alongsideTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Alongside Time)
|
| castOffTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Castoff Time)
|
| durationOfDelivery required | string (Duration of Delivery (HH:mm:ss))
|
| customerRating | integer or null <int64> (Customer Rating)
|
| protestNote | string or null (Protest Note)
|
| totalisersAutoPopulated required | string (Totalisers Auto Populated)
|
| reasonNotAutoPopulated | string or null (Reason for totaliser not auto populated)
|
required | Array of objects (Bunker Delivery Note Attachment) non-empty
|
{- "vendorUen": "string",
- "bunkerTankerLicenceNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string",
- "bunkerSupplierName": "string",
- "bunkerSupplierUEN": "string",
- "bdnNo": "string",
- "receiveVesselName": "string",
- "receiveVesselImoNo": "string",
- "receiveVesselHarbourcraftNo": "string",
- "receiveVesselGst": 0.1,
- "deliveryLocationCode": "string",
- "deliveryLocationName": "string",
- "deliveryType": 0.1,
- "supplyType": "string",
- "fuelTypeCode": "string",
- "startDeliveryMeterTotaliser": 0.1,
- "startLoadingMeterTotaliser": 0.1,
- "endDeliveryMeterTotaliser": 0.1,
- "endLoadingMeterTotaliser": 0.1,
- "suppliedQuantityMFM": 0.1,
- "suppliedQuantityBDN": 0.1,
- "operationDate": "2019-08-24",
- "commencePumpingTime": "2023-01-01 13:00:00",
- "completePumpingTime": "2023-01-01 13:00:00",
- "alongsideTime": "2023-01-01 13:00:00",
- "castOffTime": "2023-01-01 13:00:00",
- "durationOfDelivery": "string",
- "customerRating": 0,
- "protestNote": "string",
- "totalisersAutoPopulated": "string",
- "reasonNotAutoPopulated": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bunker_loading_report
| vendorUen required | string (Vendor UEN)
|
| bunkerTankerLicenceNo required | string (Bunker Tanker Licence Number)
|
| bunkerTankerName required | string (Bunker Tanker Name)
|
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket Number)
|
| loadNo required | string (Load No)
|
| terminalOplCode required | string (Terminal Opl Code)
|
| terminalOplName required | string (Terminal Opl Name)
|
| loadType required | number (Load Type)
|
| fuelTypeCode required | string (Fuel Type Code)
|
| terminalLoadQuantity required | number <double> (Terminal Load Quantity)
|
| startDeliveryMeterTotaliser | number or null <double> (Start Delivery Meter Totaliser)
|
| startLoadingMeterTotaliser | number or null <double> (Start Loading Meter Totaliser)
|
| endDeliveryMeterTotaliser | number or null <double> (End Delivery Meter Totaliser)
|
| endLoadingMeterTotaliser | number or null <double> (End Loading Meter Totaliser)
|
| bmtLoadQuantity required | number <double> (BMT Load Quantity)
|
| operationDate required | string <date> (Operation Date)
|
| berthingTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Berthing Time)
|
| loadingTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Loading Time)
|
| completionTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Completion Time)
|
| departureTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Departure Time)
|
| durationAlongsideBerth required | string (Duration Alongside Berth)
|
| totalisersAutoPopulated required | string (Totalisers Auto Populated)
|
| reasonNotAutoPopulated | string or null (Reason Not Auto Populated)
|
Array of objects (Bunker Loading Attachment) non-empty
|
{- "vendorUen": "string",
- "bunkerTankerLicenceNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string",
- "loadNo": "string",
- "terminalOplCode": "string",
- "terminalOplName": "string",
- "loadType": 0,
- "fuelTypeCode": "string",
- "terminalLoadQuantity": 0.1,
- "startDeliveryMeterTotaliser": 0.1,
- "startLoadingMeterTotaliser": 0.1,
- "endDeliveryMeterTotaliser": 0.1,
- "endLoadingMeterTotaliser": 0.1,
- "bmtLoadQuantity": 0.1,
- "operationDate": "2019-08-24",
- "berthingTime": "2023-01-01 13:00:00",
- "loadingTime": "2023-01-01 13:00:00",
- "completionTime": "2023-01-01 13:00:00",
- "departureTime": "2023-01-01 13:00:00",
- "durationAlongsideBerth": "string",
- "totalisersAutoPopulated": "string",
- "reasonNotAutoPopulated": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bunker_quantity_survey
| bqs_dt required | string <date> (Bqs Dt)
|
| bqs_rp_dt | string or null <date> (Bqs Rp Dt)
|
| bqs_job_no required | string (Bqs Job No)
|
| bqs_client_nm required | string (Bqs Client Nm)
|
| bqs_client_rf_no | string or null (Bqs Client Rf No)
|
| bqs_surveyor_company_nm required | string (Bqs Surveyor Company Nm)
|
| bqs_vessel required | string (Bqs Vessel)
|
| bqs_total_hrs | string or null (Bqs Total Hrs)
|
| bqs_chief_engineer | string or null (Bqs Chief Engineer)
|
| bqs_capt | string or null (Bqs Capt)
|
| bqs_po_no | string or null (Bqs Po No)
|
| bqs_attending_surveyor required | string (Bqs Attending Surveyor)
|
| bqs_surveyor_license_no | string or null (Bqs Surveyor License No)
|
required | Array of objects (Bqs Results)
|
Array of objects or null (Bqs Logbook Comparison)
| |
required | Array of objects (Attachments)
|
| bqs_svy_comment | string or null (Bqs Svy Comment)
|
| bqs_terms_and_condition_and_other_text | string or null (Bqs Terms And Condition And Other Text)
|
{- "bqs_dt": "2019-08-24",
- "bqs_rp_dt": "2019-08-24",
- "bqs_job_no": "string",
- "bqs_client_nm": "string",
- "bqs_client_rf_no": "string",
- "bqs_surveyor_company_nm": "string",
- "bqs_vessel": "string",
- "bqs_total_hrs": "string",
- "bqs_chief_engineer": "string",
- "bqs_capt": "string",
- "bqs_po_no": "string",
- "bqs_attending_surveyor": "string",
- "bqs_surveyor_license_no": "string",
- "bqs_results": [
- {
- "grade": "string",
- "supplier": "string",
- "cargo_officer": "string",
- "location_or_terminal": "string",
- "port_nm": "string",
- "berth_at": "string",
- "bdn_no": "string",
- "pump_rt": "string",
- "bunker_tanker_nm": "string",
- "sb_no": "string",
- "bdn_based_on": "string",
- "bdn_date": "2019-08-24",
- "uom_1": "string",
- "nominated_qty_uom_1": 0.1,
- "bdn_qty_uom_1": 0.1,
- "vessel_meas_before_uom_1": 0.1,
- "vessel_meas_after_uom_1": 0.1,
- "vessel_received_qty_uom_1": 0.1,
- "tanker_delivery_totalizer_opening_uom_1": 0.1,
- "tanker_delivery_totalizer_closing_uom_1": 0.1,
- "tanker_loading_totalizer_opening_uom_1": 0.1,
- "tanker_loading_totalizer_closing_uom_1": 0.1,
- "tanker_received_qty_uom_1": 0.1,
- "qty_diff_bdn_vessel_uom_1": 0.1,
- "qty_diff_vessel_tanker_uom_1": 0.1,
- "pct_qty_diff_bdn_vessel_uom_1": 0.1,
- "pct_qty_diff_vessel_tanker_uom_1": 0.1,
- "density_supplier": 0.1,
- "viscosity_supplier": 0.1,
- "wt_content_supplier": 0.1,
- "sulphur_supplier": 0.1,
- "flash_pt_supplier": 0.1,
- "density_lab": 0.1,
- "viscosity_lab": 0.1,
- "wt_content_lab": 0.1,
- "sulphur_lab": 0.1,
- "flash_pt_lab": 0.1,
- "bdn_qty_rvs_uom_1": 0.1,
- "vessel_qty_rvs_uom_1": 0.1,
- "tanker_qty_rvs_uom_1": 0.1,
- "qty_diff_bdn_rvs_uom_1": 0.1,
- "uom_2": "string",
- "nominated_qty_uom_2": 0.1,
- "bdn_qty_uom_2": 0.1,
- "vessel_meas_before_uom_2": 0.1,
- "vessel_meas_after_uom_2": 0.1,
- "vessel_received_qty_uom_2": 0.1,
- "qty_diff_bdn_vessel_uom_2": 0.1,
- "pct_qty_diff_bdn_vessel_uom_2": 0.1,
- "uom_3": "string",
- "nominated_qty_uom_3": 0.1,
- "bdn_qty_uom_3": 0.1,
- "vessel_meas_before_uom_3": 0.1,
- "vessel_meas_after_uom_3": 0.1,
- "vessel_received_qty_uom_3": 0.1,
- "qty_diff_bdn_vessel_uom_3": 0.1,
- "pct_qty_diff_bdn_vessel_uom_3": 0.1
}
], - "bqs_logbook_comparison": [
- {
- "type": "string",
- "uom": "string",
- "logbk_qty": 0.1,
- "surveyor_qty": 0.1,
- "qty_diff_logbk_surveyor": 0.1,
- "pct_qty_diff_logbk": 0.1
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "bqs_svy_comment": "string",
- "bqs_terms_and_condition_and_other_text": "string"
}Data Element ID: bunker_sts_delivery_report
| vendorUen required | string (Vendor UEN)
|
| bunkerTankerLicenceNo required | string (Bunker Tanker Licence Number)
|
| bunkerTankerName required | string (Bunker Tanker Name)
|
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket Number)
|
| receiveBunkerTankerLicenceNo required | string (Receiving Bunker Tanker License Number)
|
| deliveryLocationCode required | string (Delivery Location Code)
|
| deliveryLocationName required | string (Delivery Location Name)
|
| transferType required | number (Transfer Type)
|
| fuelTypeCode required | string (Fuel Type Code)
|
| startDeliveryMeterTotaliser | number or null <double> (Start Delivery Meter Totaliser)
|
| startLoadingMeterTotaliser | number or null <double> (Start Loading Meter Totaliser)
|
| endDeliveryMeterTotaliser | number or null <double> (End Delivery Meter Totaliser)
|
| endLoadingMeterTotaliser | number or null <double> (End Loading Meter Totaliser)
|
| transferredQuantity required | number <double> (Transferred Quantity)
|
| operationDate required | string <date> (Operation Date)
|
| alongsideTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Alongside Date/Time)
|
| loadingTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Loading Date/Time)
|
| completionTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Completion Date/Time)
|
| departureTime required | string <custom:date-time:YYYY-MM-DD HH:mm:ss> (Departure Date/Time)
|
| durationAlongside required | string (Duration Alongside)
|
| totalisersAutoPopulated required | string (Totalisers Auto Populated)
|
| reasonNotAutoPopulated | string or null (Reason Not Auto Populated)
|
Array of objects or null (Bunker Delivery Note Attachment) non-empty
|
{- "vendorUen": "string",
- "bunkerTankerLicenceNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string",
- "receiveBunkerTankerLicenceNo": "string",
- "deliveryLocationCode": "string",
- "deliveryLocationName": "string",
- "transferType": 0,
- "fuelTypeCode": "string",
- "startDeliveryMeterTotaliser": 0.1,
- "startLoadingMeterTotaliser": 0.1,
- "endDeliveryMeterTotaliser": 0.1,
- "endLoadingMeterTotaliser": 0.1,
- "transferredQuantity": 0.1,
- "operationDate": "2019-08-24",
- "alongsideTime": "2023-01-01 13:00:00",
- "loadingTime": "2023-01-01 13:00:00",
- "completionTime": "2023-01-01 13:00:00",
- "departureTime": "2023-01-01 13:00:00",
- "durationAlongside": "string",
- "totalisersAutoPopulated": "string",
- "reasonNotAutoPopulated": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bunkering_sales_confirmation
| bsc_vessel_nm required | string (Bsc Vessel Nm)
|
| bsc_confirmation_no required | string (Bsc Confirmation No)
|
| bsc_contract_ref | string or null (Bsc Contract Ref)
|
| bsc_imo_no | number or null (Bsc Imo No)
|
| bsc_buyer_nm required | string (Bsc Buyer Nm)
|
| bsc_buyer_address | string or null (Bsc Buyer Address)
|
| bsc_seller_nm required | string (Bsc Seller Nm)
|
| bsc_seller_address | string or null (Bsc Seller Address)
|
| bsc_physical_supplier | string or null (Bsc Physical Supplier)
|
| bsc_port required | string (Bsc Port)
|
| bsc_supply_dt_from required | string <date> (Bsc Supply Dt From)
|
| bsc_supply_dt_to | string or null <date> (Bsc Supply Dt To)
|
| bsc_agent | string or null (Bsc Agent)
|
| bsc_surveyor | string or null (Bsc Surveyor)
|
| bsc_op_notes | string or null (Bsc Op Notes)
|
required | Array of objects (Bsc Grade Quantities)
|
| bsc_qty_notes | string or null (Bsc Qty Notes)
|
| bsc_barging_fee required | number (Bsc Barging Fee)
|
| bsc_payment_terms required | string (Bsc Payment Terms)
|
| bsc_stem_dt | string or null <date> (Bsc Stem Dt)
|
| bsc_contact | string or null (Bsc Contact)
|
| bsc_buyer_terms_conditions | string or null (Bsc Buyer Terms Conditions)
|
| bsc_assignment_clause | string or null (Bsc Assignment Clause)
|
| bsc_sanctioned_countries_clause | string or null (Bsc Sanctioned Countries Clause)
|
| bsc_antibribery_corruption_clause | string or null (Bsc Antibribery Corruption Clause)
|
| bsc_tax_tariffs_clause | string or null (Bsc Tax Tariffs Clause)
|
| bsc_covid19_clause | string or null (Bsc Covid19 Clause)
|
| bsc_others_clause | string or null (Bsc Others Clause)
|
| bsc_bimco_bunker_terms | string or null (Bsc Bimco Bunker Terms)
|
| bsc_delivery_notice | string or null (Bsc Delivery Notice)
|
| bsc_payment_clause | string or null (Bsc Payment Clause)
|
| bsc_gst_rate | string or null (Bsc Gst Rate)
|
| bsc_commission | number or null (Bsc Commission)
|
| bsc_cancellation | string or null (Bsc Cancellation)
|
| bsc_confidentiality_statement | string or null (Bsc Confidentiality Statement)
|
| bsc_surcharge | string or null (Bsc Surcharge)
|
| bsc_delivery_terms | string or null (Bsc Delivery Terms)
|
| bsc_delivery_mode | string or null (Bsc Delivery Mode)
|
| bsc_delivery_org | string or null (Bsc Delivery Org)
|
Array of objects or null (Attachments) non-empty
|
{- "bsc_vessel_nm": "string",
- "bsc_confirmation_no": "string",
- "bsc_contract_ref": "string",
- "bsc_imo_no": 0,
- "bsc_buyer_nm": "string",
- "bsc_buyer_address": "string",
- "bsc_seller_nm": "string",
- "bsc_seller_address": "string",
- "bsc_physical_supplier": "string",
- "bsc_port": "string",
- "bsc_supply_dt_from": "2019-08-24",
- "bsc_supply_dt_to": "2019-08-24",
- "bsc_agent": "string",
- "bsc_surveyor": "string",
- "bsc_op_notes": "string",
- "bsc_grade_quantities": [
- {
- "bsc_goods_nm": "string",
- "bsc_goods_specs": "string",
- "bsc_goods_qty": 0,
- "bsc_goods_unit_price": 0,
- "bsc_goods_uom": "string",
- "bsc_goods_currency": "string"
}
], - "bsc_qty_notes": "string",
- "bsc_barging_fee": 0,
- "bsc_payment_terms": "string",
- "bsc_stem_dt": "2019-08-24",
- "bsc_contact": "string",
- "bsc_buyer_terms_conditions": "string",
- "bsc_assignment_clause": "string",
- "bsc_sanctioned_countries_clause": "string",
- "bsc_antibribery_corruption_clause": "string",
- "bsc_tax_tariffs_clause": "string",
- "bsc_covid19_clause": "string",
- "bsc_others_clause": "string",
- "bsc_bimco_bunker_terms": "string",
- "bsc_delivery_notice": "string",
- "bsc_payment_clause": "string",
- "bsc_gst_rate": "string",
- "bsc_commission": 0,
- "bsc_cancellation": "string",
- "bsc_confidentiality_statement": "string",
- "bsc_surcharge": "string",
- "bsc_delivery_terms": "string",
- "bsc_delivery_mode": "string",
- "bsc_delivery_org": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: sales_contract_lbs_bunkerbuyer
| contract_lbsbb_contract_no required | string (Contract Lbsbb Contract No)
|
| contract_lbsbb_dt_of_contract required | string <date> (Contract Lbsbb Dt Of Contract)
|
| contract_lbsbb_seller_name required | string (Contract Lbsbb Seller Name)
|
| contract_lbsbb_seller_address required | string (Contract Lbsbb Seller Address)
|
| contract_lbsbb_buyer_name required | string (Contract Lbsbb Buyer Name)
|
| contract_lbsbb_buyer_address required | string (Contract Lbsbb Buyer Address)
|
| contract_lbsbb_ship_agent | string or null (Contract Lbsbb Ship Agent)
|
| contract_lbsbb_credit_terms required | string (Contract Lbsbb Credit Terms)
|
| contract_lbsbb_payment_details required | string (Contract Lbsbb Payment Details)
|
required | Array of objects (Contract Lbsbb Goods Particulars)
|
Array of objects or null (Attachments)
| |
| contract_lbsbb_contact_details required | string (Contract Lbsbb Contact Details)
|
| contract_lbsbb_vessel_nm required | string (Contract Lbsbb Vessel Nm)
|
| contract_lbsbb_port | string or null (Contract Lbsbb Port)
|
| contract_lbsbb_eta | string or null <date> (Contract Lbsbb Eta)
|
| contract_lbsbb_etd | string or null <date> (Contract Lbsbb Etd)
|
| contract_lbsbb_trade_no | string or null (Contract Lbsbb Trade No)
|
{- "contract_lbsbb_contract_no": "string",
- "contract_lbsbb_dt_of_contract": "2019-08-24",
- "contract_lbsbb_seller_name": "string",
- "contract_lbsbb_seller_address": "string",
- "contract_lbsbb_buyer_name": "string",
- "contract_lbsbb_buyer_address": "string",
- "contract_lbsbb_ship_agent": "string",
- "contract_lbsbb_credit_terms": "string",
- "contract_lbsbb_payment_details": "string",
- "contract_lbsbb_goods_particulars": [
- {
- "contract_goods_nm": "string",
- "contract_goods_quality": "string",
- "contract_goods_qty": 0.1,
- "contract_goods_uom": "string",
- "contract_goods_unit_price": 0.1,
- "contract_goods_product_delivery": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "contract_lbsbb_contact_details": "string",
- "contract_lbsbb_vessel_nm": "string",
- "contract_lbsbb_port": "string",
- "contract_lbsbb_eta": "2019-08-24",
- "contract_lbsbb_etd": "2019-08-24",
- "contract_lbsbb_trade_no": "string"
}Data Element ID: sales_contract_cargotrader_lbs
| contract_ctlbs_dt_of_contract required | string <date> (Contract Ctlbs Dt Of Contract)
|
| contract_ctlbs_contract_no required | string (Contract Ctlbs Contract No)
|
| contract_ctlbs_seller_name required | string (Contract Ctlbs Seller Name)
|
| contract_ctlbs_seller_address required | string (Contract Ctlbs Seller Address)
|
| contract_ctlbs_buyer_name required | string (Contract Ctlbs Buyer Name)
|
| contract_ctlbs_buyer_address required | string (Contract Ctlbs Buyer Address)
|
required | Array of objects (Contract Ctlbs Goods Particulars) non-empty
|
| contract_ctlbs_payment_details required | string (Contract Ctlbs Payment Details)
|
Array of objects or null (Attachments)
| |
| contract_ctlbs_determination_of_qty_and_quality_details | string or null (Contract Ctlbs Determination Of Qty And Quality Details)
|
| contract_ctlbs_sanctions | string or null (Contract Ctlbs Sanctions)
|
| contract_ctlbs_contract_start required | string <date> (Contract Ctlbs Contract Start)
|
| contract_ctlbs_contract_through | string or null <date> (Contract Ctlbs Contract Through)
|
| contract_ctlbs_trade_no | string or null (Contract Ctlbs Trade No)
|
{- "contract_ctlbs_dt_of_contract": "2019-08-24",
- "contract_ctlbs_contract_no": "string",
- "contract_ctlbs_seller_name": "string",
- "contract_ctlbs_seller_address": "string",
- "contract_ctlbs_buyer_name": "string",
- "contract_ctlbs_buyer_address": "string",
- "contract_ctlbs_goods_particulars": [
- {
- "contract_goods_nm": "string",
- "contract_goods_quality": "string",
- "contract_goods_qty": 0.1,
- "contract_goods_qty_tolerance": "string",
- "contract_goods_uom": "string",
- "contract_goods_unit_price": 0.1,
- "contract_goods_product_delivery": "string"
}
], - "contract_ctlbs_payment_details": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "contract_ctlbs_determination_of_qty_and_quality_details": "string",
- "contract_ctlbs_sanctions": "string",
- "contract_ctlbs_contract_start": "2019-08-24",
- "contract_ctlbs_contract_through": "2019-08-24",
- "contract_ctlbs_trade_no": "string"
}Data Element ID: sales_invoice_lbs_bunkerbuyer
| invoice_lbsbb_invoice_dt required | string <date> (Invoice Lbsbb Invoice Dt)
|
| invoice_lbsbb_invoice_no required | string (Invoice Lbsbb Invoice No)
|
| invoice_lbsbb_sales_contract_no required | string (Invoice Lbsbb Sales Contract No)
|
| invoice_lbsbb_delivered_dt required | string <date> (Invoice Lbsbb Delivered Dt)
|
| invoice_lbsbb_buyer_nm required | string (Invoice Lbsbb Buyer Nm)
|
| invoice_lbsbb_seller_nm required | string (Invoice Lbsbb Seller Nm)
|
| invoice_lbsbb_trade_no | string or null (Invoice Lbsbb Trade No)
|
required | Array of objects (Invoice Lbsbb Goods Particulars)
|
| invoice_lbsbb_invoice_currency | string or null (Invoice Lbsbb Invoice Currency)
|
| invoice_lbsbb_invoice_amount | string or null (Invoice Lbsbb Invoice Amount)
|
| invoice_lbsbb_payment_terms | string or null (Invoice Lbsbb Payment Terms)
|
| invoice_lbsbb_due_dt required | string <date> (Invoice Lbsbb Due Dt)
|
| invoice_lbsbb_bdn_no | string or null (Invoice Lbsbb Bdn No)
|
Array of objects or null (Attachments)
| |
| invoice_lbsbb_load_port | string or null (Invoice Lbsbb Load Port)
|
| invoice_lbsbb_discharge_port | string or null (Invoice Lbsbb Discharge Port)
|
| invoice_lbsbb_account_no required | string (Invoice Lbsbb Account No)
|
| invoice_lbsbb_beneficiary_bank required | string (Invoice Lbsbb Beneficiary Bank)
|
| invoice_lbsbb_beneficiary_bank_swift required | string (Invoice Lbsbb Beneficiary Bank Swift)
|
{- "invoice_lbsbb_invoice_dt": "2019-08-24",
- "invoice_lbsbb_invoice_no": "string",
- "invoice_lbsbb_sales_contract_no": "string",
- "invoice_lbsbb_delivered_dt": "2019-08-24",
- "invoice_lbsbb_buyer_nm": "string",
- "invoice_lbsbb_seller_nm": "string",
- "invoice_lbsbb_trade_no": "string",
- "invoice_lbsbb_goods_particulars": [
- {
- "invoice_goods_nm": "string",
- "invoice_goods_quality": "string",
- "invoice_goods_qty": 0.1,
- "invoice_goods_uom": "string",
- "invoice_delivery_location": "string",
- "invoice_vessel_nm": "string",
- "invoice_goods_unit_price": 0.1
}
], - "invoice_lbsbb_invoice_currency": "string",
- "invoice_lbsbb_invoice_amount": "string",
- "invoice_lbsbb_payment_terms": "string",
- "invoice_lbsbb_due_dt": "2019-08-24",
- "invoice_lbsbb_bdn_no": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "invoice_lbsbb_load_port": "string",
- "invoice_lbsbb_discharge_port": "string",
- "invoice_lbsbb_account_no": "string",
- "invoice_lbsbb_beneficiary_bank": "string",
- "invoice_lbsbb_beneficiary_bank_swift": "string"
}Data Element ID: sales_invoice_cargotrader_lbs
| invoice_ctlbs_dt_of_invoice required | string <date> (Invoice Ctlbs Dt Of Invoice)
|
| invoice_ctlbs_invoice_no required | string (Invoice Ctlbs Invoice No)
|
| invoice_ctlbs_sales_contract_no required | string (Invoice Ctlbs Sales Contract No)
|
| invoice_ctlbs_buyer required | string (Invoice Ctlbs Buyer)
|
| invoice_ctlbs_seller required | string (Invoice Ctlbs Seller)
|
| invoice_ctlbs_delivered_or_bl_dt required | string <date> (Invoice Ctlbs Delivered Or Bl Dt)
|
required | Array of objects (Invoice Ctlbs Invoice Goods Particulars) non-empty
|
| invoice_ctlbs_invoice_currency | string or null (Invoice Ctlbs Invoice Currency)
|
| invoice_ctlbs_invoice_amount | string or null (Invoice Ctlbs Invoice Amount)
|
| invoice_ctlbs_payment_terms required | string (Invoice Ctlbs Payment Terms)
|
| invoice_ctlbs_due_dt required | string <date> (Invoice Ctlbs Due Dt)
|
Array of objects or null (Attachments)
| |
| invoice_ctlbs_gst_amount_usd | string or null (Invoice Ctlbs Gst Amount Usd)
|
| invoice_ctlbs_total_amount_usd | string or null (Invoice Ctlbs Total Amount Usd)
|
| invoice_ctlbs_account_no required | string (Invoice Ctlbs Account No)
|
| invoice_ctlbs_favour_of_bank_nm | string or null (Invoice Ctlbs Favour Of Bank Nm)
|
| invoice_ctlbs_intermediary_bank_swift | string or null (Invoice Ctlbs Intermediary Bank Swift)
|
| invoice_ctlbs_ref_data required | string (Invoice Ctlbs Ref Data)
|
| invoice_ctlbs_total_amount_sgd | string or null (Invoice Ctlbs Total Amount Sgd)
|
| invoice_ctlbs_exchange_rate_sgd_to_usd | string or null (Invoice Ctlbs Exchange Rate Sgd To Usd)
|
| invoice_ctlbs_seller_vat_no required | string (Invoice Ctlbs Seller Vat No)
|
| invoice_ctlbs_load_port required | string (Invoice Ctlbs Load Port)
|
| invoice_ctlbs_discharge_port required | string (Invoice Ctlbs Discharge Port)
|
| invoice_ctlbs_seller_tax_cd required | string (Invoice Ctlbs Seller Tax Cd)
|
| invoice_ctlbs_tax_rate | string or null (Invoice Ctlbs Tax Rate)
|
| invoice_ctlbs_beneficiary_nm | string or null (Invoice Ctlbs Beneficiary Nm)
|
| invoice_ctlbs_beneficiary_bank required | string (Invoice Ctlbs Beneficiary Bank)
|
| invoice_ctlbs_beneficiary_bank_swift required | string (Invoice Ctlbs Beneficiary Bank Swift)
|
| invoice_ctlbs_trade_no | string or null (Invoice Ctlbs Trade No)
|
{- "invoice_ctlbs_dt_of_invoice": "2019-08-24",
- "invoice_ctlbs_invoice_no": "string",
- "invoice_ctlbs_sales_contract_no": "string",
- "invoice_ctlbs_buyer": "string",
- "invoice_ctlbs_seller": "string",
- "invoice_ctlbs_delivered_or_bl_dt": "2019-08-24",
- "invoice_ctlbs_invoice_goods_particulars": [
- {
- "invoice_goods_nm": "string",
- "invoice_goods_qty_amt": 0.1,
- "invoice_goods_qty_uom": "string",
- "invoice_goods_unit_price": 0.1
}
], - "invoice_ctlbs_invoice_currency": "string",
- "invoice_ctlbs_invoice_amount": "string",
- "invoice_ctlbs_payment_terms": "string",
- "invoice_ctlbs_due_dt": "2019-08-24",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "invoice_ctlbs_gst_amount_usd": "string",
- "invoice_ctlbs_total_amount_usd": "string",
- "invoice_ctlbs_account_no": "string",
- "invoice_ctlbs_favour_of_bank_nm": "string",
- "invoice_ctlbs_intermediary_bank_swift": "string",
- "invoice_ctlbs_ref_data": "string",
- "invoice_ctlbs_total_amount_sgd": "string",
- "invoice_ctlbs_exchange_rate_sgd_to_usd": "string",
- "invoice_ctlbs_seller_vat_no": "string",
- "invoice_ctlbs_load_port": "string",
- "invoice_ctlbs_discharge_port": "string",
- "invoice_ctlbs_seller_tax_cd": "string",
- "invoice_ctlbs_tax_rate": "string",
- "invoice_ctlbs_beneficiary_nm": "string",
- "invoice_ctlbs_beneficiary_bank": "string",
- "invoice_ctlbs_beneficiary_bank_swift": "string",
- "invoice_ctlbs_trade_no": "string"
}Data Element ID: certificate_of_quality
| coq_job_no | string or null (Coq Job No)
|
| coq_sample_no required | string (Coq Sample No)
|
| coq_location_or_terminal | string or null (Coq Location Or Terminal)
|
| coq_sample_product_nm | string or null (Coq Sample Product Nm)
|
| coq_source_of_sample | string or null (Coq Source Of Sample)
|
| coq_type_of_sample | string or null (Coq Type Of Sample)
|
| coq_summary_of_sample | string or null (Coq Summary Of Sample)
|
| coq_sample_sampled_dt | string or null <date> (Coq Sample Sampled Dt)
|
| coq_sample_received_dt | string or null <date> (Coq Sample Received Dt)
|
| coq_sample_tested_dt | string or null <date> (Coq Sample Tested Dt)
|
| coq_sample_reported_dt | string or null <date> (Coq Sample Reported Dt)
|
Array of objects or null (Coq Results)
| |
| coq_surveyor_company_nm | string or null (Coq Surveyor Company Nm)
|
Array of objects or null (Attachments) non-empty
|
{- "coq_job_no": "string",
- "coq_sample_no": "string",
- "coq_location_or_terminal": "string",
- "coq_sample_product_nm": "string",
- "coq_source_of_sample": "string",
- "coq_type_of_sample": "string",
- "coq_summary_of_sample": "string",
- "coq_sample_sampled_dt": "2019-08-24",
- "coq_sample_received_dt": "2019-08-24",
- "coq_sample_tested_dt": "2019-08-24",
- "coq_sample_reported_dt": "2019-08-24",
- "coq_results": [
- {
- "test": "string",
- "method": "string",
- "unit": "string",
- "spec_max": "string",
- "spec_min": "string",
- "results": "string"
}
], - "coq_surveyor_company_nm": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: certificate_of_quantity
| cq_dt | string or null <date> (Cq Dt)
|
| cq_doc_no required | string (Cq Doc No)
|
| cq_seller_nm | string or null (Cq Seller Nm)
|
| cq_source | string or null (Source (Vessel/Barge/Tank Name))
|
| cq_destination | string or null (Destination (Vessel/Barge/Tank Name))
|
| cq_buyer_nm | string or null (Cq Buyer Nm)
|
| cq_port_of_loading | string or null (Cq Port Of Loading)
|
| cq_port_of_discharge | string or null (Cq Port Of Discharge)
|
| cq_country_of_origin | string or null (Cq Country Of Origin)
|
| cq_country_of_destination | string or null (Cq Country Of Destination)
|
Array of objects or null (Attachments)
| |
| cq_terminal_nm | string or null (Cq Terminal Nm)
|
Array of objects or null (Cq Goods Particulars)
| |
| cq_order_no | string or null (Cq Order No)
|
| cq_start_pump_dt | string or null <date-time> (Cq Start Pump Dt)
|
| cq_end_pump_dt | string or null <date-time> (Cq End Pump Dt)
|
| cq_terminal_rep_nm | string or null (Cq Terminal Rep Nm)
|
| cq_vessel_flag | string or null (Cq Vessel Flag)
|
| cq_surveyor_nm | string or null (Cq Surveyor Nm)
|
| cq_terms_and_condition_and_other_text | string or null (Cq Terms And Condition And Other Text)
|
{- "cq_dt": "2019-08-24",
- "cq_doc_no": "string",
- "cq_seller_nm": "string",
- "cq_source": "string",
- "cq_destination": "string",
- "cq_buyer_nm": "string",
- "cq_port_of_loading": "string",
- "cq_port_of_discharge": "string",
- "cq_country_of_origin": "string",
- "cq_country_of_destination": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "cq_terminal_nm": "string",
- "cq_goods_particulars": [
- {
- "goods_description": "string",
- "goods_qty": "string",
- "goods_uom": "string",
- "matching_nom": "string"
}
], - "cq_order_no": "string",
- "cq_start_pump_dt": "2019-08-24T14:15:22Z",
- "cq_end_pump_dt": "2019-08-24T14:15:22Z",
- "cq_terminal_rep_nm": "string",
- "cq_vessel_flag": "string",
- "cq_surveyor_nm": "string",
- "cq_terms_and_condition_and_other_text": "string"
}Data Element ID: delivery_nomination
| dn_bunker_tanker_nm required | string (Bunker Tanker Name)
|
| dn_sb_no required | string (Bunker Tanker License Number)
|
| dn_vessel_nm required | string (Vessel Name)
|
| dn_imo_no required | string (International Maritime Organisation Number)
|
| dn_confirmation_no required | string (Bunkering Sales Confirmation Number)
|
| dn_physical_supplier required | string (Physical Supplier's Name)
|
| dn_delivery_dt required | string <date> (Delivery Date)
|
| dn_delivery_time | string or null (Estimated Time of Bunker Delivery)
|
| dn_product_name required | string (Product Name)
|
| dn_product_quantity required | number <double> (Product Quantity)
|
| dn_uom required | string (Unit of Measurement)
|
| dn_bunker_confirmation_dt | string or null <date> (Date of Confirmation)
|
| dn_port_name | string or null (Port Name)
|
| dn_delivery_nomination_no required | string (Delivery nomination number)
|
| dn_owner_operator_nm | string or null (Owner/Operator)
|
| dn_ship_agent | string or null (Ship Agent Details)
|
| dn_delete_delivery_nomination required | boolean (Delete delivery nomination)
|
{- "dn_bunker_tanker_nm": "string",
- "dn_sb_no": "string",
- "dn_vessel_nm": "string",
- "dn_imo_no": "string",
- "dn_confirmation_no": "string",
- "dn_physical_supplier": "string",
- "dn_delivery_dt": "2019-08-24",
- "dn_delivery_time": "string",
- "dn_product_name": "string",
- "dn_product_quantity": 0.1,
- "dn_uom": "string",
- "dn_bunker_confirmation_dt": "2019-08-24",
- "dn_port_name": "string",
- "dn_delivery_nomination_no": "string",
- "dn_owner_operator_nm": "string",
- "dn_ship_agent": "string",
- "dn_delete_delivery_nomination": true
}Data Element ID: scic_dlvd_sales_contract
| salesConfirmationNumber | string or null (Sales Confirmation Number)
|
| typeOfContract | string or null (Type of Contract)
|
| contractStartDate | string or null (Contract Start Date)
|
| tradeDate | string or null (Trade Date)
|
| sellerName | string or null (Seller Name)
|
| sellerAddress | string or null (Seller Address)
|
| buyerName | string or null (Buyer Name (Bunker Buyer))
|
| buyerAddress | string or null (Buyer Address (Bunker Buyer))
|
| shipAgentDetails | string or null (Ship Agent Details)
|
| paymentTerms | string or null (Payment Terms)
|
| productName | string or null (Product Name)
|
| productType | string or null (Product Type)
|
| productQuality | string or null (Product Quality)
|
| stemmedSuppliedQuantity | string or null (Stemmed Product Quantity)
|
| unitOfMeasurement | string or null (Unit of Measurement)
|
| conversionFormulaForUnitOfMeasurement | string or null (Conversion Formula for Unit of Measurement)
|
| productUnitPrice | number or null (Product Unit Price)
|
| pricingFormula | string or null (Pricing Forumla)
|
| additionalFees | number or null (Additional Fees)
|
| deliveryLocationName | string or null (Location of Bunker Delivery)
|
| contactDetails | string or null (Contact Details)
|
| receivingVesselName | string or null (Vessel Name)
|
| receiveVesselImoNo | string or null (Vessel IMO Number)
|
| port | string or null (Port)
|
| estimatedDateOfArrival | string or null (Estimated Date of Arrival)
|
| estimatedDateOfDeparture | string or null (Estimated Date of Departure)
|
Array of objects or null (Attachments)
|
{- "salesConfirmationNumber": "string",
- "typeOfContract": "string",
- "contractStartDate": "string",
- "tradeDate": "string",
- "sellerName": "string",
- "sellerAddress": "string",
- "buyerName": "string",
- "buyerAddress": "string",
- "shipAgentDetails": "string",
- "paymentTerms": "string",
- "productName": "string",
- "productType": "string",
- "productQuality": "string",
- "stemmedSuppliedQuantity": "string",
- "unitOfMeasurement": "string",
- "conversionFormulaForUnitOfMeasurement": "string",
- "productUnitPrice": 0,
- "pricingFormula": "string",
- "additionalFees": 0,
- "deliveryLocationName": "string",
- "contactDetails": "string",
- "receivingVesselName": "string",
- "receiveVesselImoNo": "string",
- "port": "string",
- "estimatedDateOfArrival": "string",
- "estimatedDateOfDeparture": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: scic_dlvd_sales_invoice
| dateOfInvoice | string or null (Date of Invoice)
|
| invoiceNumber | string or null (Invoice Number)
|
| salesConfirmationNumber | string or null (Sales Confirmation Number)
|
| typeOfContract | string or null (Type of Contract)
|
| bdnNo | string or null (Bunker Delivery Note (BDN) Number)
|
| operationDate | string or null (Bunker Delivery Note Date)
|
| buyerName | string or null (Buyer Name)
|
| sellerName | string or null (Seller Name)
|
| productName | string or null (Product Name)
|
| productType | string or null (Product Type)
|
| productQuality | string or null (Product Quality)
|
| suppliedQuantityBDN | number or null <double> (Product Quantity)
|
| unitOfMeasurement | string or null (Unit of Measurement)
|
| deliveryLocationName | string or null (Location of Bunker Delivery)
|
| receiveVesselName | string or null (Vessel Name)
|
| receiveVesselImoNo | string or null (Vessel IMO Number)
|
| invoiceDocumentCurrency | string or null (Invoice Document Currency)
|
| invoiceDocumentAmount | number or null (Invoice Document Amount)
|
| paymentTerms | string or null (Payment Terms)
|
| paymentDueDate | string or null (Payment Due Date)
|
| exchangeRate | number or null (Exchange Rate)
|
| bankAccountNumberPayable | string or null (Bank Account Number Payable)
|
| beneficiaryName | string or null (Beneficiary Name)
|
| beneficiaryBank | string or null (Beneficiary Bank)
|
| beneficiaryBankSwiftNumber | string or null (Beneficiary Bank Swift Number)
|
| productUnitPrice | number or null <double> (Product Unit Price)
|
Array of objects or null (Attachments)
|
{- "dateOfInvoice": "string",
- "invoiceNumber": "string",
- "salesConfirmationNumber": "string",
- "typeOfContract": "string",
- "bdnNo": "string",
- "operationDate": "string",
- "buyerName": "string",
- "sellerName": "string",
- "productName": "string",
- "productType": "string",
- "productQuality": "string",
- "suppliedQuantityBDN": 0.1,
- "unitOfMeasurement": "string",
- "deliveryLocationName": "string",
- "receiveVesselName": "string",
- "receiveVesselImoNo": "string",
- "invoiceDocumentCurrency": "string",
- "invoiceDocumentAmount": 0,
- "paymentTerms": "string",
- "paymentDueDate": "string",
- "exchangeRate": 0,
- "bankAccountNumberPayable": "string",
- "beneficiaryName": "string",
- "beneficiaryBank": "string",
- "beneficiaryBankSwiftNumber": "string",
- "productUnitPrice": 0.1,
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: scic_exwharf_sales_contract
| contractStartDate | string or null (Contract Start Date)
|
| contractThroughDate | string or null (Contract Through Date)
|
| salesAgreementNumber | string or null (Sales agreement Number)
|
| sellerName | string or null (Seller Name)
|
| sellerAddress | string or null (Seller Address)
|
| buyerName | string or null (Buyer Name)
|
| buyerAddress | string or null (Buyer Address)
|
| productName | string or null (Product Name)
|
| productType | string or null (Product Type)
|
| productQuality | string or null (Product Quality)
|
| stemmedLoadProductQuantity | number or null <double> (Product Quantity)
|
| productTolerance | string or null (Product Tolerance)
|
| unitOfMeasurement | string or null (Unit of Measurement)
|
| productUnitPrice | number or null (Product Unit Price)
|
| terminalOplName | string or null (Terminal/Floating Storage/Tanker Name)
|
| port | string or null (Port)
|
| countryEWSC | string or null (Country)
|
| paymentTerms | string or null (Payment Terms)
|
| determinationOfQuantityAndQuality | string or null (Determination of Quantity and Quality Details)
|
| detailsOfSanctions | string or null (Details of Sanctions)
|
Array of objects or null (Attachments)
|
{- "contractStartDate": "string",
- "contractThroughDate": "string",
- "salesAgreementNumber": "string",
- "sellerName": "string",
- "sellerAddress": "string",
- "buyerName": "string",
- "buyerAddress": "string",
- "productName": "string",
- "productType": "string",
- "productQuality": "string",
- "stemmedLoadProductQuantity": 0.1,
- "productTolerance": "string",
- "unitOfMeasurement": "string",
- "productUnitPrice": 0,
- "terminalOplName": "string",
- "port": "string",
- "countryEWSC": "string",
- "paymentTerms": "string",
- "determinationOfQuantityAndQuality": "string",
- "detailsOfSanctions": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: scic_exwharf_sales_invoice
| salesAgreementNumber | string or null (Sales Agreement Number)
|
| dateOfInvoice | string or null (Date of Invoice)
|
| invoiceNumber | string or null (Invoice Number)
|
| buyerName | string or null (Buyer Name)
|
| sellerName | string or null (Seller Name)
|
| operationDate | string or null (Delivery Date)
|
| productName | string or null (Product Name)
|
| productType | string or null (Product Type)
|
| acutalLoadProductQuantity | number or null <double> (Product Quantity of Certificate of Quantity (CQ))
|
| unitOfMeasurement | string or null (Unit of Measurement)
|
| terminalOplName | string or null (Terminal/Floating Storage/Tanker Name)
|
| port | string or null (Port)
|
| countryEWSI | string or null (Country)
|
| bunkerTankerName | string or null (Vessel Name)
|
| bunkerTankerIMO | string or null (Bunker Tanker IMO Number)
|
| productUnitPrice | number or null (Product Unit Price)
|
| invoiceDocumentCurrency | string or null (Invoice Document Currency)
|
| invoiceDocumentAmount | number or null (Invoice Document Amount)
|
| totalAmount | number or null (Total Amount)
|
| totalGstPrice | number or null (Total GST Price (in applicable currency))
|
| exchangeRate | number or null (Exchange Rate)
|
| paymentTerms | string or null (Payment Terms)
|
| paymentDueDate | string or null (Payment Due Date)
|
| accountNumber | string or null (Account Number)
|
| intermediaryBankCompanyName | string or null (Intermediary Bank Company Name)
|
| intermediaryBankSwiftNumber | string or null (Intermediary Bank Swift Number)
|
| referenceData | string or null (Reference Data to be included in payment instruction)
|
| sellerVatNumber | string or null (Seller's VAT Number)
|
| portOfLoading | string or null (Port of Loading)
|
| portOfDischarge | string or null (Port of Discharge)
|
| sellerTaxCode | string or null (Seller's Tax Code)
|
| percentageOfTax | number or null (Percentage of Tax Applicable)
|
| beneficiaryName | string or null (Beneficiary Name)
|
| beneficiaryBank | string or null (Beneficiary Bank)
|
| beneficiaryBankSwiftNumber | string or null (Beneficiary Bank Swift Number)
|
Array of objects or null (Attachments)
|
{- "salesAgreementNumber": "string",
- "dateOfInvoice": "string",
- "invoiceNumber": "string",
- "buyerName": "string",
- "sellerName": "string",
- "operationDate": "string",
- "productName": "string",
- "productType": "string",
- "acutalLoadProductQuantity": 0.1,
- "unitOfMeasurement": "string",
- "terminalOplName": "string",
- "port": "string",
- "countryEWSI": "string",
- "bunkerTankerName": "string",
- "bunkerTankerIMO": "string",
- "productUnitPrice": 0,
- "invoiceDocumentCurrency": "string",
- "invoiceDocumentAmount": 0,
- "totalAmount": 0,
- "totalGstPrice": 0,
- "exchangeRate": 0,
- "paymentTerms": "string",
- "paymentDueDate": "string",
- "accountNumber": "string",
- "intermediaryBankCompanyName": "string",
- "intermediaryBankSwiftNumber": "string",
- "referenceData": "string",
- "sellerVatNumber": "string",
- "portOfLoading": "string",
- "portOfDischarge": "string",
- "sellerTaxCode": "string",
- "percentageOfTax": 0,
- "beneficiaryName": "string",
- "beneficiaryBank": "string",
- "beneficiaryBankSwiftNumber": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: letter_of_credit
| lc_doc_lc_form | string or null (Form of Documentary Credit)
|
| lc_dt_of_issue required | string <date> (Date Of Issue)
|
| lc_doc_lc_no | string or null (Documentary Credit Number)
|
| lc_dt_and_place_of_expiry | string or null (Date and Place of Expiry)
|
| lc_applicant | string or null (Applicant)
|
| lc_beneficiary_nm_and_address | string or null (Beneficiary)
|
| lc_doc_lc_currency_cd_and_amount | string or null (Currency Code, Amount)
|
| lc_available_with_by | string or null (Available with and by)
|
| lc_negotiation_deferred_payment_details | string or null (Negotiation/Deferred Payment Details)
|
| lc_partial_shipments | string or null (Partial Shipments)
|
| lc_transhipment | string or null (Transhipment)
|
| lc_latest_dt_of_shipment | string or null <date> (Latest Date of Shipment)
|
| lc_confirmation_instructions | string or null (Confirmation Instructions)
|
| lc_percentage_credit_amt_tolerance | string or null (Percentage Credit Amount Tolerance)
|
| lc_mixed_payment_details | string or null (Mixed Payment Details)
|
| lc_period_for_presentation_in_days | string or null (Period for Presentaton in Days)
|
Array of objects or null (Letter of Credit Attachment)
|
{- "lc_doc_lc_form": "string",
- "lc_dt_of_issue": "2019-08-24",
- "lc_doc_lc_no": "string",
- "lc_dt_and_place_of_expiry": "string",
- "lc_applicant": "string",
- "lc_beneficiary_nm_and_address": "string",
- "lc_doc_lc_currency_cd_and_amount": "string",
- "lc_available_with_by": "string",
- "lc_negotiation_deferred_payment_details": "string",
- "lc_partial_shipments": "string",
- "lc_transhipment": "string",
- "lc_latest_dt_of_shipment": "2019-08-24",
- "lc_confirmation_instructions": "string",
- "lc_percentage_credit_amt_tolerance": "string",
- "lc_mixed_payment_details": "string",
- "lc_period_for_presentation_in_days": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: mfm
| mfm_vessel_id required | string (Mfm Vessel Id)
|
| mfm_system_id required | string (Mfm System Id)
|
| mfm_btn_no required | number (Mfm Btn No)
|
| mfm_print_out_dt required | string <date-time> (Mfm Print Out Dt)
|
| mfm_start_dt required | string <date-time> (Mfm Start Dt)
|
| mfm_end_dt required | string <date-time> (Mfm End Dt)
|
| mfm_totalizer_loading_at_operation_start required | string (Mfm Totalizer Loading At Operation Start)
|
| mfm_totalizer_loading_at_operation_end required | string (Mfm Totalizer Loading At Operation End)
|
| mfm_totalizer_delivery_at_operation_start required | string (Mfm Totalizer Delivery At Operation Start)
|
| mfm_totalizer_delivery_at_operation_end required | string (Mfm Totalizer Delivery At Operation End)
|
required | Array of objects (Attachments) non-empty
|
| mfm_time_zone | string or null (Mfm Time Zone)
|
| mfm_reset_dt | string or null <date-time> (Mfm Reset Dt)
|
| mfm_mass_delivered | string or null (Mfm Mass Delivered)
|
| mfm_mass_in_air | string or null (Mfm Mass In Air)
|
| mfm_sb_no | string or null (Mfm Sb No)
|
{- "mfm_vessel_id": "string",
- "mfm_system_id": "string",
- "mfm_btn_no": 0,
- "mfm_print_out_dt": "2019-08-24T14:15:22Z",
- "mfm_start_dt": "2019-08-24T14:15:22Z",
- "mfm_end_dt": "2019-08-24T14:15:22Z",
- "mfm_totalizer_loading_at_operation_start": "string",
- "mfm_totalizer_loading_at_operation_end": "string",
- "mfm_totalizer_delivery_at_operation_start": "string",
- "mfm_totalizer_delivery_at_operation_end": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "mfm_time_zone": "string",
- "mfm_reset_dt": "2019-08-24T14:15:22Z",
- "mfm_mass_delivered": "string",
- "mfm_mass_in_air": "string",
- "mfm_sb_no": "string"
}Data Element ID: bill_of_lading
| bl_doc_no | string or null (Bl Doc No)
|
| bl_dt required | string <date> (Bl Dt)
|
| bl_shipper_nm | string or null (Bl Shipper Nm)
|
| bl_consignee_nm | string or null (Bl Consignee Nm)
|
| bl_terminal_nm | string or null (Bl Terminal Nm)
|
| bl_port_of_loading | string or null (Bl Port Of Loading)
|
| bl_port_of_discharge | string or null (Bl Port Of Discharge)
|
| bl_vessel_nm | string or null (Bl Vessel Nm)
|
| bl_country_of_origin | string or null (Bl Country Of Origin)
|
| bl_country_of_destination | string or null (Bl Country Of Destination)
|
Array of objects or null (Bl Goods Particulars)
| |
Array of objects or null (Attachments) non-empty
| |
| bl_order_no | string or null (Bl Order No)
|
| bl_vessel_flag | string or null (Bl Vessel Flag)
|
| bl_master_nm | string or null (Bl Master Nm)
|
| bl_terms_and_condition_and_other_text | string or null (Bl Terms And Condition And Other Text)
|
| bl_vessel_imo_no | string or null (Bl Vessel Imo No)
|
| bl_notify_party_nm | string or null (Bl Notify Party Nm)
|
{- "bl_doc_no": "string",
- "bl_dt": "2019-08-24",
- "bl_shipper_nm": "string",
- "bl_consignee_nm": "string",
- "bl_terminal_nm": "string",
- "bl_port_of_loading": "string",
- "bl_port_of_discharge": "string",
- "bl_vessel_nm": "string",
- "bl_country_of_origin": "string",
- "bl_country_of_destination": "string",
- "bl_goods_particulars": [
- {
- "bl_goods_nm": "string",
- "bl_goods_qty_amt": "string",
- "bl_goods_qty_uom": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "bl_order_no": "string",
- "bl_vessel_flag": "string",
- "bl_master_nm": "string",
- "bl_terms_and_condition_and_other_text": "string",
- "bl_vessel_imo_no": "string",
- "bl_notify_party_nm": "string"
}Data Element ID: proof_of_sustainability
| pos_unique_number_of_the_pos required | string (Unique Number of the PoS)
|
| pos_date_of_issuance_of_the_pos required | string <date> (Date of Issuance of the PoS)
|
| pos_supplier_name required | string (Supplier Name)
|
| pos_supplier_address required | string (Supplier Address)
|
| pos_certification_system required | string (Certification System) Value: "ISCC EU"
|
| pos_certificate_number required | string (Certificate Number)
|
| pos_recipient_name required | string (Recipient Name)
|
| pos_recipient_address required | string (Recipient Address)
|
| pos_contract_number required | string (Contract Number)
|
| pos_address_of_dispatch_shipping_point_of_the_sustainable_material required | string (Address of dispatch/shipping point of the sustainable material)
|
| pos_address_of_receipt_receiving_point_of_the_sustainable_material required | string (Address of receipt/receiving point of the sustainable material)
|
| pos_date_of_dispatch_of_the_sustainable_material required | string <date> (Date of dispatch of the sustainable material)
|
| pos_type_of_product required | string (Type of Product)
|
| pos_type_of_raw_material required | string (Type of Raw Material)
|
| pos_additional_information | string or null (Additional Information)
|
| pos_country_of_origin_of_the_raw_material required | string (Country of Origin (of the raw material))
|
| pos_quantity required | number <double> (Quantity)
|
| pos_quantity_unit required | string (Quantity Unit (m3/mt)) Enum: "m3" "mt"
|
| pos_energy_content required | number <double> (Energy content (MJ))
|
| pos_eu_red_compliant_material required | boolean (EU RED Compliant Material)
|
| pos_iscc_compliant_material required | boolean (ISCC Compliant Material)
|
| pos_chain_of_custody_option required | string (Chain of Custody Option (Mass Balance/Physical Segregation)) Enum: "Mass Balance" "Physical Segregation"
|
| pos_the_raw_material_complies_with_the_relevant_sustainability_criteria required | boolean (The raw material complies with the relevant sustainability criteria according to Art. 29 (2) - (7) RED II)
|
| pos_the_agricultural_biomass_was_cultivated_as_intermediate_crop required | boolean (The agricultural biomass was cultivated as intermediate crop (if applicable))
|
| pos_the_agricultural_biomass_additionally_fulfills_the_measures_for_low_iluc_risk_feedstocks required | boolean (The agricultural biomass additionally fulfills the measures for low ILUC risk feedstocks (if applicable))
|
| pos_the_raw_material_meets_the_definition_of_waste_or_residue_according_to_the_red_ii required | boolean (The raw material meets the definition of waste or residue according to the RED II)
|
| pos_total_default_value_according_to_red_ii_applied required | boolean (Total default value according to RED II applied)
|
| pos_e required | number <double> (E (gCO2eq/MJ))
|
| pos_eec | number or null <double> (Eec (gCO2eq/MJ))
|
| pos_ei | number or null <double> (EI (gCO2eq/MJ))
|
| pos_ep | number or null <double> (Ep (gCO2eq/MJ))
|
| pos_etd | number or null <double> (Etd (gCO2eq/MJ))
|
| pos_eu | number or null <double> (Eu (gCO2eq/MJ))
|
| pos_esca | number or null <double> (Esca (gCO2eq/MJ))
|
| pos_eccs | number or null <double> (Eccs (gCO2eq/MJ))
|
| pos_eccr | number or null <double> (Eccr (gCO2eq/MJ))
|
| pos_date_when_the_final_biofuel_bioliquid_or_biomass_producer_started_operation required | string <date> (Date when the final biofuel, bioliquid or biomass producer started operation)
|
| pos_for_biogas_supply_chains_were_incentives_subsidies_received_for_the_production_of_the_biogas | boolean or null (For biogas supply chains: Were incentives/subsidies received for the production of the biogas?)
|
| pos_for_biogas_supply_chains_if_subsidies_incentives_were_received_please_specify | string or null (For biogas supply chains: If subsidies/incentives were received, please specify)
|
required | Array of objects (Attachments) |
{- "pos_unique_number_of_the_pos": "string",
- "pos_date_of_issuance_of_the_pos": "2019-08-24",
- "pos_supplier_name": "string",
- "pos_supplier_address": "string",
- "pos_certification_system": "ISCC EU",
- "pos_certificate_number": "string",
- "pos_recipient_name": "string",
- "pos_recipient_address": "string",
- "pos_contract_number": "string",
- "pos_address_of_dispatch_shipping_point_of_the_sustainable_material": "string",
- "pos_address_of_receipt_receiving_point_of_the_sustainable_material": "string",
- "pos_date_of_dispatch_of_the_sustainable_material": "2019-08-24",
- "pos_type_of_product": "string",
- "pos_type_of_raw_material": "string",
- "pos_additional_information": "string",
- "pos_country_of_origin_of_the_raw_material": "string",
- "pos_quantity": 0.1,
- "pos_quantity_unit": "m3",
- "pos_energy_content": 0.1,
- "pos_eu_red_compliant_material": true,
- "pos_iscc_compliant_material": true,
- "pos_chain_of_custody_option": "Mass Balance",
- "pos_the_raw_material_complies_with_the_relevant_sustainability_criteria": true,
- "pos_the_agricultural_biomass_was_cultivated_as_intermediate_crop": true,
- "pos_the_agricultural_biomass_additionally_fulfills_the_measures_for_low_iluc_risk_feedstocks": true,
- "pos_the_raw_material_meets_the_definition_of_waste_or_residue_according_to_the_red_ii": true,
- "pos_total_default_value_according_to_red_ii_applied": true,
- "pos_e": 0.1,
- "pos_eec": 0.1,
- "pos_ei": 0.1,
- "pos_ep": 0.1,
- "pos_etd": 0.1,
- "pos_eu": 0.1,
- "pos_esca": 0.1,
- "pos_eccs": 0.1,
- "pos_eccr": 0.1,
- "pos_date_when_the_final_biofuel_bioliquid_or_biomass_producer_started_operation": "2019-08-24",
- "pos_for_biogas_supply_chains_were_incentives_subsidies_received_for_the_production_of_the_biogas": true,
- "pos_for_biogas_supply_chains_if_subsidies_incentives_were_received_please_specify": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: purchase_order_po
| po_no required | string (PO Number)
|
| po_vessel_nm required | string (Vessel Name)
|
| po_vessel_imo | string or null (Vessel IMO)
|
| po_req_delivery_dt | string or null <date-time> (Requested Delivery Date)
|
| po_vessel_eta | string or null <date-time> (Vessel ETA)
|
| po_job_coordinator | string or null (Job Coordinator)
|
| po_job_coordinator_contact | string or null (Job Coordinator Contact)
|
| po_supplier_nm required | string (Supplier Name)
|
| po_supplier_contact | string or null (Supplier Contact)
|
Array of objects or null (Line Item)
| |
| po_dt | string or null <date-time> (PO Date)
|
| po_total_price | number or null <double> (Total Price)
|
| po_payment_terms | number or null <double> (Payment Terms)
|
| po_delivery_instructions | string or null (Delivery Instructions)
|
| po_req_delivery_port | string or null (Requested Delivery Port)
|
Array of objects or null (Purchase Order (PO) Attachment)
|
{- "po_no": "string",
- "po_vessel_nm": "string",
- "po_vessel_imo": "string",
- "po_req_delivery_dt": "2019-08-24T14:15:22Z",
- "po_vessel_eta": "2019-08-24T14:15:22Z",
- "po_job_coordinator": "string",
- "po_job_coordinator_contact": "string",
- "po_supplier_nm": "string",
- "po_supplier_contact": "string",
- "po_lineitem": [
- {
- "type": "string",
- "no": "string",
- "catalog_ref": "string",
- "quant": 0,
- "unit": "string",
- "desc": "string",
- "unit_price": 0.1,
- "discount_amount": 0.1,
- "amount": 0.1
}
], - "po_dt": "2019-08-24T14:15:22Z",
- "po_total_price": 0.1,
- "po_payment_terms": 0.1,
- "po_delivery_instructions": "string",
- "po_req_delivery_port": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: standby_letter_of_credit
| sblc_transaction_ref_no required | string (Sblc Transaction Ref No)
|
| sblc_further_identification required | string (Sblc Further Identification)
|
| sblc_dt | string or null <date> (Sblc Dt)
|
required | Array of objects (Attachments) non-empty
|
{- "sblc_transaction_ref_no": "string",
- "sblc_further_identification": "string",
- "sblc_dt": "2019-08-24",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: test_certificate
| tc_job_no required | string (Tc Job No)
|
| tc_sample_no required | string (Tc Sample No)
|
| tc_location_or_terminal required | string (Tc Location Or Terminal)
|
| tc_sample_product_nm required | string (Tc Sample Product Nm)
|
| tc_source_of_sample required | string (Tc Source Of Sample)
|
| tc_type_of_sample required | string (Tc Type Of Sample)
|
| tc_summary_of_sample required | string (Tc Summary Of Sample)
|
| tc_sample_sampled_dt required | string <date> (Tc Sample Sampled Dt)
|
| tc_sample_received_dt required | string <date> (Tc Sample Received Dt)
|
| tc_sample_tested_dt required | string <date> (Tc Sample Tested Dt)
|
| tc_sample_reported_dt required | string <date> (Tc Sample Reported Dt)
|
required | Array of objects (Tc Results) non-empty
|
| tc_surveyor_company_nm required | string (Tc Surveyor Company Nm)
|
required | Array of objects (Attachments) non-empty
|
{- "tc_job_no": "string",
- "tc_sample_no": "string",
- "tc_location_or_terminal": "string",
- "tc_sample_product_nm": "string",
- "tc_source_of_sample": "string",
- "tc_type_of_sample": "string",
- "tc_summary_of_sample": "string",
- "tc_sample_sampled_dt": "2019-08-24",
- "tc_sample_received_dt": "2019-08-24",
- "tc_sample_tested_dt": "2019-08-24",
- "tc_sample_reported_dt": "2019-08-24",
- "tc_results": [
- {
- "test": "string",
- "method": "string",
- "unit": "string",
- "spec_max": "string",
- "spec_min": "string",
- "results": "string"
}
], - "tc_surveyor_company_nm": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: vessel_current_position
Array of objects or null (Vessel Particulars Information)
| |
| vessel_source | string or null (Source)
|
| vessel_destination_code | string or null (Destination Code)
|
| vessel_destination | string or null (Destination)
|
| vessel_standardised_destination | string or null (Standardised Destination)
|
| vessel_eta_dt | string or null <date-time> (Vessel ETA)
|
| vessel_length | integer or null <int64> (Length of the Vessel)
|
| vessel_depth | integer or null <int64> (Depth of the Vessel)
|
| vessel_draught | integer or null <int64> (Draught of the Vessel)
|
| vessel_type | string or null (Type of the Vessel)
|
| vessel_grosstonnage | integer or null <int64> (Gross Tonnage of the Vessel)
|
| vessel_nettonnage | integer or null <int64> (Net Tonnage of the Vessel)
|
| vessel_deadweight | integer or null <int64> (Dead Weight of the Vessel)
|
| vessel_mmsi_number | integer or null <int64> (MMSI Number of the Vessel)
|
| vessel_year_built | integer or null <int64> (The year in which the vessel has been built)
|
| vessel_latitude | number or null <double> (Latitude)
|
| vessel_longitude | number or null <double> (Longitude)
|
| vessel_latitude_degrees | number or null <double> (Latitude Degrees)
|
| vessel_longitude_degrees | number or null <double> (Longitude Degrees)
|
| vessel_speed | number or null <double> (Speed)
|
| vessel_course | number or null <double> (Course)
|
| vessel_heading | number or null <double> (Heading)
|
| vessel_navigation_status | string or null (Navigation Status)
|
| vessel_time_stamp | string or null <date-time> (Last Update Time)
|
{- "vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string"
}
], - "vessel_source": "string",
- "vessel_destination_code": "string",
- "vessel_destination": "string",
- "vessel_standardised_destination": "string",
- "vessel_eta_dt": "2019-08-24T14:15:22Z",
- "vessel_length": 0,
- "vessel_depth": 0,
- "vessel_draught": 0,
- "vessel_type": "string",
- "vessel_grosstonnage": 0,
- "vessel_nettonnage": 0,
- "vessel_deadweight": 0,
- "vessel_mmsi_number": 0,
- "vessel_year_built": 0,
- "vessel_latitude": 0.1,
- "vessel_longitude": 0.1,
- "vessel_latitude_degrees": 0.1,
- "vessel_longitude_degrees": 0.1,
- "vessel_speed": 0.1,
- "vessel_course": 0.1,
- "vessel_heading": 0.1,
- "vessel_navigation_status": "string",
- "vessel_time_stamp": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_information
required | Array of objects (Vessel Particulars Information) non-empty
|
| vessel_ism_manager | string or null (ISM Manager (If vessel flag is 'SG'))
|
| vessel_ship_manager | string or null (Ship Manager (if vessel flag is 'SG'))
|
| vessel_registered_ownership | string or null (Registered Ownership (if vessel flag is 'SG'))
|
| vessel_classification_society | string or null (Classification Society (if vessel flag is 'SG'))
|
| vessel_registration_status | string or null (Registration Status)
|
| vessel_registration_dt | string or null <date-time> (Registration Date)
|
| vessel_validity_dt | string or null <date-time> (Validity Date)
|
| vessel_date_of_closure | string or null <date-time> (Date of Closure)
|
| vessel_vessel_certificate_no | string or null (Certificate Number)
|
| vessel_issue_dt | string or null <date-time> (Issue Date)
|
| vessel_movement_start_dt | string or null <date-time> (Movement Start Date and Time)
|
| vessel_movement_end_dt | string or null <date-time> (Movement End Date and Time)
|
| vessel_movement_status | string or null (Movement Status)
|
| vessel_movement_type | string or null (Movement Type)
|
| vessel_location_from_cd required | string (Location From Code)
|
| vessel_location_to_cd | string or null (Location To Code)
|
| vessel_location_from required | string (Location From)
|
| vessel_location_to | string or null (Location To)
|
| vessel_movement_draft | number or null (Movement Draft)
|
| vessel_movement_height | number or null (Movement Height)
|
| vessel_arrived_dt | string or null <date-time> (Vessel Arrived Time)
|
| vessel_purpose | string or null (Vessel Purpose)
|
| vessel_location_cd | string or null (Location Code)
|
| vessel_location | string or null (Vessel Location)
|
| vessel_grid | string or null (Vessel Grid)
|
| vessel_arrival_agent | string or null (Agent of the Arrival Vessel)
|
| vessel_due_to_arrive_dt | string or null <date-time> (Vessel Due to Arrive Time)
|
| vessel_departed_dt | string or null <date-time> (Vessel Departed Time)
|
| vessel_departure_agent | string or null (Agent of the Departure Vessel)
|
| vessel_due_to_depart_dt | string or null <date-time> (Vessel Due to Depart)
|
| vessel_next_port | string or null (Next Port)
|
| vessel_next_port_of_call_country | string or null (Next Port of Call Country)
|
| vessel_cargo | number or null (Cargo)
|
| vessel_cert_issue_dt | string or null <date-time> (Date and Time of Certificate Issue)
|
| vessel_expiry_dt_of_port_certificate | string or null <date-time> (Expiry Date and Time of Port Certificate)
|
| vessel_master_nm | string or null (Master Name)
|
| vessel_datetime_of_querying required | string <date-time> (Querying Date Time)
|
{- "vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string",
- "vessel_length": 0,
- "vessel_breadth": 0,
- "vessel_depth": 0,
- "vessel_type": "string",
- "vessel_grosstonnage": 0,
- "vessel_nettonnage": 0,
- "vessel_deadweight": 0,
- "vessel_mmsi_number": 0,
- "vessel_year_built": 0
}
], - "vessel_ism_manager": "string",
- "vessel_ship_manager": "string",
- "vessel_registered_ownership": "string",
- "vessel_classification_society": "string",
- "vessel_registration_status": "string",
- "vessel_registration_dt": "2019-08-24T14:15:22Z",
- "vessel_validity_dt": "2019-08-24T14:15:22Z",
- "vessel_date_of_closure": "2019-08-24T14:15:22Z",
- "vessel_vessel_certificate_no": "string",
- "vessel_issue_dt": "2019-08-24T14:15:22Z",
- "vessel_movement_start_dt": "2019-08-24T14:15:22Z",
- "vessel_movement_end_dt": "2019-08-24T14:15:22Z",
- "vessel_movement_status": "string",
- "vessel_movement_type": "string",
- "vessel_location_from_cd": "string",
- "vessel_location_to_cd": "string",
- "vessel_location_from": "string",
- "vessel_location_to": "string",
- "vessel_movement_draft": 0,
- "vessel_movement_height": 0,
- "vessel_arrived_dt": "2019-08-24T14:15:22Z",
- "vessel_purpose": "string",
- "vessel_location_cd": "string",
- "vessel_location": "string",
- "vessel_grid": "string",
- "vessel_arrival_agent": "string",
- "vessel_due_to_arrive_dt": "2019-08-24T14:15:22Z",
- "vessel_departed_dt": "2019-08-24T14:15:22Z",
- "vessel_departure_agent": "string",
- "vessel_due_to_depart_dt": "2019-08-24T14:15:22Z",
- "vessel_next_port": "string",
- "vessel_next_port_of_call_country": "string",
- "vessel_cargo": 0,
- "vessel_cert_issue_dt": "2019-08-24T14:15:22Z",
- "vessel_expiry_dt_of_port_certificate": "2019-08-24T14:15:22Z",
- "vessel_master_nm": "string",
- "vessel_datetime_of_querying": "2019-08-24T14:15:22Z"
}Data Element ID: meter_reading_record_form
| bunkerMeteringTicketNo required | string (Bunker Metering Ticket (BMT) No.)
|
| meterSerialNumber required | integer <int64> (Meter Serial No.)
|
| bunkerTankerName required | string (Bunker Tanker Name)
|
| receiveVesselName required | string (Receiving Vessel Name)
|
| vesselSufficientTankSpaceForPurging required | boolean (Vessel sufficient tank space for purging)
|
required | object (Section A - Before Delivery)
|
required | object (Section B - After Delivery)
|
Array of objects (Attachments) |
{- "bunkerMeteringTicketNo": "string",
- "meterSerialNumber": 0,
- "bunkerTankerName": "string",
- "receiveVesselName": "string",
- "vesselSufficientTankSpaceForPurging": true,
- "sectionA-BeforeDelivery": {
- "deliveryMeterTotaliser": 0.1,
- "loadingMeterTotaliser": 0.1,
- "needleValveSealNo": 0,
- "remarks": "string",
- "samplingContainerSealNo": 0,
- "bunkerTankerLicenceNo": "string",
- "chiefEngineerSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}, - "cargoOfficerSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}, - "surveyorSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}
}, - "sectionB-AfterDelivery": {
- "deliveryMeterTotaliser": 0.1,
- "loadingMeterTotaliser": 0.1,
- "suppliedQuantity": 0.1,
- "chiefEngineerSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}, - "cargoOfficerSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}, - "surveyorSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}
}, - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: meter_totaliser_log
required | Array of objects (Meter Totaliser Log) non-empty
|
Array of objects (Attachments) |
{- "mtl": [
- {
- "bdnNoCqNo": 0,
- "bunkerMeteringTicketNo": "string",
- "bunkerTankerName": "string",
- "cargoOfficerSigInfo": {
- "signorName": "string",
- "signDateTime": "2019-08-24T14:15:22Z",
- "signorCapacity": "string"
}, - "cargoTankSequence": "string",
- "operationDate": "2019-08-24T14:15:22Z",
- "endDeliveryMeterTotaliser": 0.1,
- "startDeliveryMeterTotaliser": 0.1,
- "endLoadingMeterTotaliser": 0.1,
- "startLoadingMeterTotaliser": 0.1,
- "meterQuantityLoadedDelivered": 0.1,
- "month": "string",
- "productGrade": "string",
- "remarks": "string",
- "bunkerTankerLicenceNo": 0,
- "meterSerialNumber": 0,
- "sn": 0,
- "terminalLoadedVesselDelivered": "string",
- "year": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: barge_event_data
| barge_bdn_no required | Array of strings (Barge Bdn No) BDN Number |
| barge_bunker_supplier_company_nm required | Array of strings (Barge Bunker Supplier Company Nm) Bunker Supplier Company Name |
{- "barge_bdn_no": [
- "string"
], - "barge_bunker_supplier_company_nm": [
- "string"
]
}Data Element ID: bunker_delivery_note
| bdn_sb_no required | string (Bunker Tanker License Number) Bunker Tanker License Number. The format for license number should be SB NNNNA |
| bdn_no required | string (Bunker Delivery Note Number) Bunker Delivery Note Number |
| bdn_bunker_metering_ticket_no | integer or null <int64> (Bunker Metering Ticket Number (BTN)) Bunker Metering Ticket Number (BTN) |
| bdn_dt required | string <date> (Date of Operation) Date of Operation |
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket (BMT) No.) Mass flow metering ticket number for each bunker delivery |
{- "bdn_sb_no": "string",
- "bdn_no": "string",
- "bdn_bunker_metering_ticket_no": 0,
- "bdn_dt": "2019-08-24",
- "bunkerMeteringTicketNo": "string"
}Data Element ID: bunker_delivery_report
| vendorUen | string or null (Vendor UEN) Unique Entity Number (UEN) of the vendor registered with ACRA. Mandatory if interface is via Service Agent |
| bunkerTankerLicenceNo | string or null (Bunker Tanker Licence Number) Bunker barge licence number in "SB NNNNA" format from MFM |
| bunkerTankerName required | string (Bunker Tanker Name) Bunker barge name returned from the Bunker Barge Information API |
| bunkerMeteringTicketNo required | string (Bunker Metering Ticket Number) Bunker metering ticket number from the MFM. Mandatory if the delivery type is "1" |
| bunkerSupplierName | string or null (Bunker Supplier Name) Bunker Supplier Company name |
| bdnNo | string or null (Bunker Delivery Note Number) Bunker Supplier BDN No |
| operationDate required | string <date> (Operation Date) Date of operation in "YYYY-MM-DD" format from MFM |
{- "vendorUen": "string",
- "bunkerTankerLicenceNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string",
- "bunkerSupplierName": "string",
- "bdnNo": "string",
- "operationDate": "2019-08-24"
}Data Element ID: bunker_loading_report
| vendorUen | string or null (Vendor UEN) Unique Entity Number (UEN) of the vendor registered with ACRA. Mandatory if interface is via Service Agent |
| bunkerTankerLicenceNo | string or null (Bunker Tanker Licence Number) Bunker barge licence number in "SB NNNNA" format from MFM |
| bunkerTankerName | string or null (Bunker Tanker Name) Bunker barge name returned from the Bunker Barge Information API |
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket Number) Bunker metering ticket number from the MFM. Mandatory if the load type is "1" |
| operationDate required | string <date> (Operation Date) Date of operation in "YYYY-MM-DD" format |
{- "vendorUen": "string",
- "bunkerTankerLicenceNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string",
- "operationDate": "2019-08-24"
}Data Element ID: bunker_quantity_survey
| bqs_job_no required | string (Bqs Job No) Unique report/ job number for the survey |
| bqs_dt | string or null (Bqs Dt) Date the survey is being conducted |
{- "bqs_job_no": "string",
- "bqs_dt": "string"
}Data Element ID: bunker_sts_delivery_report
| vendorUen | string or null (Vendor UEN) Unique Entity Number (UEN) of the vendor registered with ACRA. Mandatory if interface is via Service Agent |
| bunkerTankerLicenceNo | string or null (Bunker Tanker Licence Number) Bunker barge licence number in "SB NNNNA" format from the MFM |
| bunkerTankerName | string or null (Bunker Tanker Name) Bunker barge name returned from the Bunker Barge Information API |
| bunkerMeteringTicketNo | string or null (Bunker Metering Ticket Number) Bunker metering ticket number from the MFM. Mandatory if the transfer type is "1" |
| operationDate required | string <date> (Operation Date) Date of operation in "YYYY-MM-DD" format |
{- "vendorUen": "string",
- "bunkerTankerLicenceNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string",
- "operationDate": "2019-08-24"
}Data Element ID: bunkering_sales_confirmation
| bsc_confirmation_no required | string (Bsc Confirmation No) Bunkering Sales Confirmation Number |
{- "bsc_confirmation_no": "string"
}Data Element ID: sales_contract_lbs_bunkerbuyer
| contract_lbsbb_contract_no required | string (Contract Lbsbb Contract No) Bunkering Sales Contract Number/Agreement Number (Delivered) |
| contract_lbsbb_trade_no | string or null (Contract Lbsbb Trade No) Trade Number/Trade ID of Bunkering Sales Contract (Delivered) |
{- "contract_lbsbb_contract_no": "string",
- "contract_lbsbb_trade_no": "string"
}Data Element ID: sales_contract_cargotrader_lbs
| contract_ctlbs_contract_no required | Array of strings (Contract Ctlbs Contract No) Sales Contract Number/ Agreement Number |
{- "contract_ctlbs_contract_no": [
- "string"
]
}Data Element ID: sales_invoice_lbs_bunkerbuyer
| invoice_lbsbb_sales_contract_no required | string (Invoice Lbsbb Sales Contract No) Bunkering Sales Contract Number/Agreement Number (Delivered) |
| invoice_lbsbb_trade_no | string or null (Invoice Lbsbb Trade No) Trade Number/Trade ID of Bunkering Sales Invoice (Delivered) |
{- "invoice_lbsbb_sales_contract_no": "string",
- "invoice_lbsbb_trade_no": "string"
}Data Element ID: sales_invoice_cargotrader_lbs
| invoice_ctlbs_invoice_no required | Array of strings (Invoice Ctlbs Invoice No) Invoice Number |
| invoice_ctlbs_trade_no required | Array of strings (Invoice Ctlbs Trade No) Trade Number/ Trade ID |
{- "invoice_ctlbs_invoice_no": [
- "string"
], - "invoice_ctlbs_trade_no": [
- "string"
]
}Data Element ID: certificate_of_quality
| coq_sample_no required | Array of strings (Coq Sample No) Sample Number |
{- "coq_sample_no": [
- "string"
]
}Data Element ID: certificate_of_quantity
| cq_order_no required | Array of strings (Cq Order No) Order Number |
| cq_doc_no required | Array of strings (Cq Doc No) Certificate of Quantity / Document Number |
{- "cq_order_no": [
- "string"
], - "cq_doc_no": [
- "string"
]
}Data Element ID: delivery_nomination
| dn_bunker_tanker_nm required | string (Bunker Tanker Name) Bunker Tanker Name |
| dn_sb_no | string or null (Bunker Tanker License Number) Bunker Tanker License Number. The format for license number should be SB NNNNA |
| dn_delivery_dt | string or null <date> (Delivery Date) Expected Delivery Date |
{- "dn_bunker_tanker_nm": "string",
- "dn_sb_no": "string",
- "dn_delivery_dt": "2019-08-24"
}Data Element ID: letter_of_credit
| lc_dt_of_issue required | string <date> (Lc Doc Lc No) |
{- "lc_dt_of_issue": "2019-08-24"
}Data Element ID: mfm
| mfm_sb_no required | string (Mfm Sb No) Bunker Tanker License Number. The format for license number should be SB NNNNA |
| mfm_btn_no required | number (Mfm Btn No) Bunker Metering Ticket Number (BTN) |
| mfm_print_out_dt required | string <date-time> (Mfm Print Out Dt) Printout Time |
{- "mfm_sb_no": "string",
- "mfm_btn_no": 0,
- "mfm_print_out_dt": "2019-08-24T14:15:22Z"
}Data Element ID: bill_of_lading
| bl_doc_no | string or null (Bl Doc No) |
| bl_dt required | string <date> (Bl Doc No) |
{- "bl_doc_no": "string",
- "bl_dt": "2019-08-24"
}Data Element ID: proof_of_sustainability
| pos_supplier_name required | string (Supplier Name) Supplier - Name |
{- "pos_supplier_name": "string"
}Data Element ID: purchase_order_po
| po_no required | string (PO Number) PO Number |
{- "po_no": "string"
}Data Element ID: test_certificate
| tc_sample_no required | Array of strings (Tc Sample No) Sample Number |
{- "tc_sample_no": [
- "string"
]
}Data Element ID: vessel_current_position
| vessel_nm required | string (Receiving Vessel Name) Name of the Vessel Note: Only latest data is available where applicable. |
{- "vessel_nm": "string"
}Data Element ID: vessel_information
| vessel_imo_no required | string (International Maritime Organisation Number) International Maritime Organisation (IMO) Vessel Identification Number, Note: For push, only latest data is available where applicable. For pull, this field will return results as at the query date and time supplied in "vessel_datetime_of_querying" (part of the parameter for this API). |
| vessel_datetime_of_querying required | string <date-time> (Querying Date Time) This field is used only for querying of vessel event data |
{- "vessel_imo_no": "string",
- "vessel_datetime_of_querying": "2019-08-24T14:15:22Z"
}Data Element ID: meter_reading_record_form
| bdnNo | string (Bunker Delivery Note (BDN) Number) Bunker Supplier BDN No |
| bunkerTankerName required | string (Bunker Tanker Name) Name of the bunker tanker |
| bunkerMeteringTicketNo | string (Bunker Metering Ticket (BMT) No.) Mass flow metering ticket number for each bunker delivery |
{- "bdnNo": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string"
}Data Element ID: meter_totaliser_log
| month | string (month) month |
| bunkerTankerName required | string (Bunker Tanker Name) Name of the bunker tanker |
| bunkerMeteringTicketNo | string (Bunker Metering Ticket (BMT) No.) Mass flow metering ticket number for each bunker delivery |
{- "month": "string",
- "bunkerTankerName": "string",
- "bunkerMeteringTicketNo": "string"
}Data Element ID: agrifood_purchase_order
| apo_id required | number (ID) ID |
| apo_role | string or null (Role) Role |
| apo_user_id | number or null (User ID) User ID |
| apo_currency | string or null (Currency) Currency |
| apo_buyer | number or null (Buyer) Buyer |
| apo_buyer_reference_number | string or null (Buyer Reference Number) Buyer Reference Number |
| apo_po_number_buyer | string or null (Purchase Order Number- Buyer) Purchase Order Number- Buyer |
| apo_supplier | number or null (Supplier) Supplier |
| apo_supplier_reference_number | string or null (Supplier Reference Number) Supplier Reference Number |
| apo_po_number_supplier | string or null (Purchase Order Number- Supplier) Purchase Order Number- Supplier |
| apo_trade_contract_number | string or null (Trade Contract Number) Trade Contract Number |
| apo_pack_plan_name | string or null (Pack Plan Name) Pack Plan Name |
| apo_payment_supplier | string or null (Payment-Supplier) Payment-Supplier |
| apo_incoterms_supplier | string or null (Incoterms-Supplier) Incoterms-Supplier |
| apo_payment_buyer | string or null (Payment-Buyer) Payment-Buyer |
| apo_incoterms_buyer | string or null (Incoterms- Buyer) Incoterms- Buyer |
| apo_status required | string (Status) Status |
| apo_serial_id | number or null (Serial ID) Serial ID |
| apo_created_at | string or null <date-time> (Created At) Created At |
| apo_updated_at | string or null <date-time> (Updated At) Updated At |
| apo_company_id | number or null (Company ID) Company ID |
| apo_notes | string or null (Notes) Notes |
| apo_active required | number (Active) Active, 1= Active 0= Not Active |
| apo_usd_exchange_rate | number or null <double> (Exchange Rate to USD) Exchange Rate to USD |
| apo_related_contract_id | number or null (Related Trade Contract ID) Related Trade Contract ID |
| apo_group_id | number or null (Group ID) Group ID |
| apo_trader_group_id | number or null (Trader Group ID) Trader Group ID |
| apo_supplier_group_id | number or null (Supplier Group ID) Supplier Group ID |
| apo_buyer_group_id | string or null (Buyer Group ID) Buyer Group ID |
| apo_counterparty_email_buyer | string or null (Counterparty Email Buyer) Counterparty Email Buyer |
| apo_counterparty_email_supplier | string or null (Counterparty Email Supplier) Counterparty Email Supplier |
Array of objects or null (Attachments) |
{- "apo_id": 0,
- "apo_role": "string",
- "apo_user_id": 0,
- "apo_currency": "string",
- "apo_buyer": 0,
- "apo_buyer_reference_number": "string",
- "apo_po_number_buyer": "string",
- "apo_supplier": 0,
- "apo_supplier_reference_number": "string",
- "apo_po_number_supplier": "string",
- "apo_trade_contract_number": "string",
- "apo_pack_plan_name": "string",
- "apo_payment_supplier": "string",
- "apo_incoterms_supplier": "string",
- "apo_payment_buyer": "string",
- "apo_incoterms_buyer": "string",
- "apo_status": "string",
- "apo_serial_id": 0,
- "apo_created_at": "2019-08-24T14:15:22Z",
- "apo_updated_at": "2019-08-24T14:15:22Z",
- "apo_company_id": 0,
- "apo_notes": "string",
- "apo_active": 0,
- "apo_usd_exchange_rate": 0.1,
- "apo_related_contract_id": 0,
- "apo_group_id": 0,
- "apo_trader_group_id": 0,
- "apo_supplier_group_id": 0,
- "apo_buyer_group_id": "string",
- "apo_counterparty_email_buyer": "string",
- "apo_counterparty_email_supplier": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: delivery_order
| do_buyer_company_address required | string (Buyer Company Address )
|
| do_buyer_company_name required | string (Buyer Company Name )
|
| do_date required | string <date> (Date )
|
| do_delivery_address required | string (Delivery Address )
|
required | Array of objects (Item Details)
|
| do_number required | string (Delivery Order Number)
|
| do_seller_company_address required | string (Seller’s Company Address )
|
| do_seller_company_name required | string (Seller’s Company Name )
|
| do_seller_registration_number required | string (Seller Registration)
|
| do_delivery_from | string or null (Deliver From )
|
| do_invoice_number | string or null (Invoice Number )
|
| do_lc_number | string or null (Letter Of Credit Number )
|
Array of objects or null (Delivery Order Attachment)
|
{- "do_buyer_company_address": "string",
- "do_buyer_company_name": "string",
- "do_date": "2019-08-24",
- "do_delivery_address": "string",
- "do_item_details": [
- {
- "description": "string",
- "quantity": "string",
- "serial_number": "string"
}
], - "do_number": "string",
- "do_seller_company_address": "string",
- "do_seller_company_name": "string",
- "do_seller_registration_number": "string",
- "do_delivery_from": "string",
- "do_invoice_number": "string",
- "do_lc_number": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: goods_receipt
| gr_seller_company_name required | string (Seller Company Name )
|
| gr_seller_company_address required | string (Seller Company Address )
|
| gr_buyer_company_name required | string (Buyer Company Name )
|
| gr_procurement_type required | string (Procurement Type )
|
| gr_number required | string (Goods Receipt No. )
|
| gr_delivery_address required | string (Delivery Address )
|
| gr_delivery_date required | string <date> (Delivery Date )
|
required | Array of objects (Item Details)
|
Array of objects or null (Goods Receipt Attachment)
|
{- "gr_seller_company_name": "string",
- "gr_seller_company_address": "string",
- "gr_buyer_company_name": "string",
- "gr_procurement_type": "string",
- "gr_number": "string",
- "gr_delivery_address": "string",
- "gr_delivery_date": "2019-08-24",
- "gr_item_details": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: green_building_certification
| gbc_name_certificate_issuer required | string (Registered Name of Certification Issuer )
|
| gbc_name_certified_company required | string (Registered Name of Certified Company )
|
| gbc_certified_project required | string (Registered Name of Certified Project )
|
| gbc_address_certified_location required | string (Registered Address of Certified Location )
|
| gbc_postcode_certified_location | string or null (Postcode of Certified Location)
|
| gbc_application_stage required | string (Status of the application for certification)
|
| gbc_application_status required | string (Status of the application for certification)
|
| gbc_certification_provisional_rating required | string (Certification Provisional Rating / Rating )
|
| gbc_green_mark_sle_rating | string or null (Green Mark SLE Rating)
|
| gbc_certification_score | string or null (Certification Score )
|
| gbc_certification_number | string or null (Certification Number )
|
| gbc_certification_issue_date | string or null (Certification Issue Date )
|
| gbc_certification_expiration_date | string or null <date> (Certification Expiration Date )
|
| gbc_date_document_issue | string or null (Document Issue Date )
|
| gbc_date_document_expiration | string or null (Document Expiration Date )
|
| gbc_certification_scheme | string or null (Certification Scheme )
|
| gbc_project_description | string or null (Project Description )
|
| gbc_project_gross_floor_area | string or null (Project Gross Floor Area )
|
| gbc_building_type | string or null (Building Type )
|
| gbc_total_property_area | string or null (Total Property Area )
|
| gbc_name_developer | string or null (Name of Developer )
|
| gbc_name_main_contractor | string or null (Name of Main Contractor )
|
| gbc_additional_detail | string or null (Additional Details)
|
Array of objects or null (Green Building Certification Attachment)
|
{- "gbc_name_certificate_issuer": "string",
- "gbc_name_certified_company": "string",
- "gbc_certified_project": "string",
- "gbc_address_certified_location": "string",
- "gbc_postcode_certified_location": "string",
- "gbc_application_stage": "string",
- "gbc_application_status": "string",
- "gbc_certification_provisional_rating": "string",
- "gbc_green_mark_sle_rating": "string",
- "gbc_certification_score": "string",
- "gbc_certification_number": "string",
- "gbc_certification_issue_date": "string",
- "gbc_certification_expiration_date": "2019-08-24",
- "gbc_date_document_issue": "string",
- "gbc_date_document_expiration": "string",
- "gbc_certification_scheme": "string",
- "gbc_project_description": "string",
- "gbc_project_gross_floor_area": "string",
- "gbc_building_type": "string",
- "gbc_total_property_area": "string",
- "gbc_name_developer": "string",
- "gbc_name_main_contractor": "string",
- "gbc_additional_detail": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: green_product_certification
| gpc_name_certificate_issuer required | string (Name Of Certification Issuer )
|
| gpc_name_certified_company required | string (Name Of Certified Company )
|
| gpc_address_certified_location required | string (Address Of Certified Location )
|
| gpc_product_category required | string (Product Category/Type )
|
| gpc_certification_number required | string (Certification Number )
|
| gpc_date_certification_start_date required | string <date> (Certification Start Date )
|
| gpc_date_certification_expiration required | string <date> (Certification Expiration Date )
|
| cs_certification_standards required | string (Certification Standards )
|
| cs_name_certification_body required | string (Name Of Certification Body )
|
| gpc_product_model | string or null (Product Model )
|
| gpc_brand_name | string or null (Product Brand Name )
|
| gpc_product_certificate_label | string or null (Product Certificate Label)
|
| gpc_certification_rating | string or null (Certification Rating )
|
| gpc_date_certification_first_issue | string or null <date> (Certification First Issue Date )
|
| gpc_licence_number | string or null (License Number )
|
| gpc_certification_scheme | string or null (Certification Scheme )
|
| gpc_applicable_standards | string or null (Applicable Standards )
|
| gpc_additional_detail | string or null (Additional Detail 1 – X )
|
Array of objects or null (Green Product Certification Attachment)
|
{- "gpc_name_certificate_issuer": "string",
- "gpc_name_certified_company": "string",
- "gpc_address_certified_location": "string",
- "gpc_product_category": "string",
- "gpc_certification_number": "string",
- "gpc_date_certification_start_date": "2019-08-24",
- "gpc_date_certification_expiration": "2019-08-24",
- "cs_certification_standards": "string",
- "cs_name_certification_body": "string",
- "gpc_product_model": "string",
- "gpc_brand_name": "string",
- "gpc_product_certificate_label": "string",
- "gpc_certification_rating": "string",
- "gpc_date_certification_first_issue": "2019-08-24",
- "gpc_licence_number": "string",
- "gpc_certification_scheme": "string",
- "gpc_applicable_standards": "string",
- "gpc_additional_detail": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: interim_certificate
| ic_project required | string (Project )
|
| ic_project_reference required | string (Project Reference )
|
| ic_certificate_no required | string (Certificate No )
|
| ic_contractor required | string (Contractor )
|
| ic_original_main_contract_sum required | string (Original Main Contract Sum )
|
| ic_date_commencement required | string <date> (Date Of Commencement )
|
| ic_date_completion required | string <date> (Date Of Completion )
|
| ic_value_work_done required | string (Value Of Work Done )
|
| ic_amount_due required | number <double> (Amount Due )
|
| ic_date_certificate | string or null <date> (Date Of Certificate )
|
| ic_date_valuation | string or null <date> (Date Of Valuation )
|
| ic_retention_limit | string or null (Limit Of Retention )
|
| ic_date_revised_completion | string or null <date> (Revised Completion Date )
|
| ic_retention_sum | string or null (Retention Sum )
|
| ic_release_first_half_retention_monies | string or null (Release Of The First Half Retention Monies )
|
| ic_sums_previously_deducted | string or null (Sums Previously Deducted )
|
Array of objects or null (Interim Certificate Attachment)
|
{- "ic_project": "string",
- "ic_project_reference": "string",
- "ic_certificate_no": "string",
- "ic_contractor": "string",
- "ic_original_main_contract_sum": "string",
- "ic_date_commencement": "2019-08-24",
- "ic_date_completion": "2019-08-24",
- "ic_value_work_done": "string",
- "ic_amount_due": 0.1,
- "ic_date_certificate": "2019-08-24",
- "ic_date_valuation": "2019-08-24",
- "ic_retention_limit": "string",
- "ic_date_revised_completion": "2019-08-24",
- "ic_retention_sum": "string",
- "ic_release_first_half_retention_monies": "string",
- "ic_sums_previously_deducted": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: invoice_finance_application
| ifa_bank_name | string (Bank )
|
| ifa_date | string <date> (Date )
|
| ifa_applicant_name | string (Applicant )
|
| ifa_applicant_contact_person | string (Contact Person )
|
| ifa_applicant_telephone_no | string (Telephone )
|
| ifa_product | string (Trade Financing Product Name )
|
| ifa_application_id | string (Trade Financing Application Id)
|
| ifa_invoice_currency | string (Invoice Currency ) Currency unit in Invoice |
| ifa_tenor | string (Tenor )
|
| ifa_finance_date_start | string <date> (Finance Start Date)
|
| ifa_finance_date_due | string <date> (Finance Due Date )
|
| ifa_percentage_financing | number <double> (Percentage Of Financing)
|
| ifa_instruction_proceed | string (Instruction On Proceeds)
|
| ifa_payment_type | string (Payment Type )
|
| ifa_bearer_charges | string (Bearer Of Charges)
|
| ifa_counterparty_name | string (Name Of Counterparty)
|
| ifa_tt_remmitance_currency | string (Remittance Currency (Tt) )
|
| ifa_tt_amount | number <double> (Amount (Tt) )
|
| ifa_tt_beneficiary_account_no | string (Beneficiary Account Number (Tt) )
|
| ifa_tt_beneficiary_bank_name | string (Name Of Beneficiary Bank (Tt) )
|
| ifa_tt_beneficiary_bank_address | string (Address Of Beneficiary Bank (Tt) )
|
| ifa_tt_beneficiary_receiving_agent | string (Receiving Agent Of Beneficiary Bank (Tt) )
|
| ifa_co_beneficiary_name | string (Beneficiary Name (Co) )
|
| ifa_financing_currency | string or null (Financing Currency )
|
| ifa_port_loading | string or null (Port Of Loading )
|
| ifa_port_discharge | string or null (Port Of Discharge )
|
| ifa_vessel_number | string or null (Vessel Imo Number )
|
| ifa_fx_contract_number | string or null (Fx Contract Number )
|
| ifa_fx_rate | string or null (Fx Rate )
|
| ifa_counterparty_address | string or null (Address Of Counterparty)
|
| ifa_co_beneficiary_account_name | string or null (Account Name (Co) )
|
| ifa_co_beneficiary_account_number | string or null (Account Number (Co) )
|
| ifa_co_other_instructions | string or null (Other Instructions (Co) )
|
| ifa_tt_beneficiary_bank_swift_code | string or null (Swift Code- Beneficiary Bank (Tt))
|
| ifa_co_beneficiary_bank_swift_code | string or null Swift Code- Beneficiary Bank (Co) |
{- "ifa_bank_name": "string",
- "ifa_date": "2019-08-24",
- "ifa_applicant_name": "string",
- "ifa_applicant_contact_person": "string",
- "ifa_applicant_telephone_no": "string",
- "ifa_product": "string",
- "ifa_application_id": "string",
- "ifa_invoice_currency": "string",
- "ifa_tenor": "string",
- "ifa_finance_date_start": "2019-08-24",
- "ifa_finance_date_due": "2019-08-24",
- "ifa_percentage_financing": 0.1,
- "ifa_instruction_proceed": "string",
- "ifa_payment_type": "string",
- "ifa_bearer_charges": "string",
- "ifa_counterparty_name": "string",
- "ifa_tt_remmitance_currency": "string",
- "ifa_tt_amount": 0.1,
- "ifa_tt_beneficiary_account_no": "string",
- "ifa_tt_beneficiary_bank_name": "string",
- "ifa_tt_beneficiary_bank_address": "string",
- "ifa_tt_beneficiary_receiving_agent": "string",
- "ifa_co_beneficiary_name": "string",
- "ifa_financing_currency": "string",
- "ifa_port_loading": "string",
- "ifa_port_discharge": "string",
- "ifa_vessel_number": "string",
- "ifa_fx_contract_number": "string",
- "ifa_fx_rate": "string",
- "ifa_counterparty_address": "string",
- "ifa_co_beneficiary_account_name": "string",
- "ifa_co_beneficiary_account_number": "string",
- "ifa_co_other_instructions": "string",
- "ifa_tt_beneficiary_bank_swift_code": "string",
- "ifa_co_beneficiary_bank_swift_code": "string"
}Data Element ID: invoice_finance_response
| ifr_transaction_reference_number required | string (Transaction Reference Number )
|
| ifr_finance_approved_date | string or null <date> (Finance Approved Date)
|
| ifr_financing_start_date | string or null <date> (Financing Start Date)
|
| ifr_financing_maturity_date | string or null <date> (Financing Maturity Date)
|
| ifr_disbursement_date | string or null <date> (Disbursement Date)
|
| ifr_finance_status required | string <date> (Finance Status)
|
Array of objects or null (Invoice Finance Response Attachment)
|
{- "ifr_transaction_reference_number": "string",
- "ifr_finance_approved_date": "2019-08-24",
- "ifr_financing_start_date": "2019-08-24",
- "ifr_financing_maturity_date": "2019-08-24",
- "ifr_disbursement_date": "2019-08-24",
- "ifr_finance_status": "2019-08-24",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: palm_oil_entity_certification
| poec_name_certified_entity required | string (Name Of Certified Entity)
|
| poec_address_certified_entity required | string (Address Of Certified Entity )
|
| poec_certification_number required | string (Certification Number )
|
| poec_certificate_start_date required | string (Certification Start Date )
|
| poec_certificate_expiration_date required | string (Certification Expiration Date )
|
| poec_scope_certification required | string (Scope Of Certification)
|
| poec_certification_standards required | string (Certification Standards )
|
| poec_license_expiration_date | string or null <date> (License Expiration Date)
|
| poec_certificate_issue_date | string or null <date> (Certificate Issue Date)
|
| poec_license_number | string or null (License Number )
|
| poec_gps | string or null (Gps)
|
| poec_certified_area | string or null (Certified Area)
|
| poec_name_parent_company | string or null (Parent Company)
|
| poec_production_area | string or null (Production Area)
|
| poec_date_first_certification | string or null <date> (Date Of First Certification)
|
| poec_membership_number | string or null (Membership Number Of Certified Entity / Parent Company)
|
| poec_license_start_date | string or null <date> (License Start Date)
|
| poec_standards_process | string or null (Standards Process)
|
| poec_address_certified_site | string or null (Address Of Certified Site/ Facility)
|
| poec_name_certified_site | string or null (Name Of Certified Site/ Facility)
|
| poec_set_classification | string or null (Set(S) Classification)
|
| poec_certificate_place_issue | string or null (Certificate Place Of Issue)
|
| poec_supply_chain_model | string or null (Supply Chain Model)
|
| poec_other_sites_certified | string or null (Whether Other Sites Are Certified)
|
| poec_capacity | string or null (Capacity)
|
| poec_status | string or null (Status)
|
| poec_annual_tonnages | string or null (Annual Tonnages (Mt))
|
Array of objects or null (Palm Oil Entity Certification Attachment)
|
{- "poec_name_certified_entity": "string",
- "poec_address_certified_entity": "string",
- "poec_certification_number": "string",
- "poec_certificate_start_date": "string",
- "poec_certificate_expiration_date": "string",
- "poec_scope_certification": "string",
- "poec_certification_standards": "string",
- "poec_license_expiration_date": "2019-08-24",
- "poec_certificate_issue_date": "2019-08-24",
- "poec_license_number": "string",
- "poec_gps": "string",
- "poec_certified_area": "string",
- "poec_name_parent_company": "string",
- "poec_production_area": "string",
- "poec_date_first_certification": "2019-08-24",
- "poec_membership_number": "string",
- "poec_license_start_date": "2019-08-24",
- "poec_standards_process": "string",
- "poec_address_certified_site": "string",
- "poec_name_certified_site": "string",
- "poec_set_classification": "string",
- "poec_certificate_place_issue": "string",
- "poec_supply_chain_model": "string",
- "poec_other_sites_certified": "string",
- "poec_capacity": "string",
- "poec_status": "string",
- "poec_annual_tonnages": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: payment_progress_certificate
| ppc_company_name required | string (Company Name)
|
| ppc_company_address required | string (Company Address)
|
| ppc_number required | string (Document No.)
|
| ppc_date required | string <date> (Date)
|
| ppc_customer_number | string or null (Customer No.)
|
| ppc_gst_registration_number | string or null (Gst Registration No.)
|
| ppc_payment_number | string or null (Payment No.)
|
| ppc_project_number required | string (Project No.)
|
| ppc_contract_ref_or_work_order_no | string or null (Contract Ref. / Work Order No.)
|
| ppc_contractor_company_name required | string (Contractor Company Name)
|
| ppc_contractor_company_address required | string (Contractor Company Address)
|
| ppc_contractor_gst_no | string or null (Contractor Gst No.)
|
| ppc_project_title required | string (Project Title)
|
| ppc_contractor_sum | string or null (Contractor Sum)
|
| ppc_variation_order_number | string or null (Variation Order No.)
|
| ppc_contract_title required | string (Contract Title)
|
Array of objects or null or null (Item Details) | |
| ppc_item_reference | string or null (Reference)
|
| ppc_certified_amount required | number <double> (Certified Amount)
|
| ppc_amount_previously_certified required | number <double> (Amount Previously Certified)
|
| ppc_variation_amount required | number <double> (Variation Amount)
|
| ppc_retention_sum | string or null (Retention Sum)
|
| ppc_amount_gross required | number <double> (Amount Due (Gross))
|
| ppc_tax_amount | number or null <double> (Tax Amount)
|
| ppc_back_charge_deduct | number or null <double> (Back Charge Deduction)
|
| ppc_back_charge_refund | number or null <double> (Bank Charge Refund)
|
| ppc_total_amount_excl_gst | number or null <double> (Total Amount Due (Nett) (excl GST))
|
| ppc_amount_net_incl_gst | number or null <double> (Amount Due (Nett) (incl GST))
|
| ppc_debit_note_number | string or null (Debit Note No.)
|
| ppc_debit_note_amount | number or null <double> (Debit Note Amount)
|
| ppc_debit_note_remarks | string or null (Debit Note Remarks)
|
| ppc_payment_work_done_this_period required | string (Payment Of Work Done This Period)
|
| ppc_payment_terms | string or null (Payment Terms)
|
| ppc_beneficiary_name | string or null (Beneficiary)
|
| ppc_beneficiary_bank_name | string or null (Bank Name)
|
| ppc_beneficiary_bank_branch | string or null (Branch)
|
| ppc_beneficiary_bank_swift_code | string or null (Swift Code)
|
| ppc_beneficiary_bank_code | string or null (Bank Code)
|
| ppc_beneficiary_bank_account_number | string or null (Bank Account Number)
|
Array of objects or null (Attachments) |
{- "ppc_company_name": "string",
- "ppc_company_address": "string",
- "ppc_number": "string",
- "ppc_date": "2019-08-24",
- "ppc_customer_number": "string",
- "ppc_gst_registration_number": "string",
- "ppc_payment_number": "string",
- "ppc_project_number": "string",
- "ppc_contract_ref_or_work_order_no": "string",
- "ppc_contractor_company_name": "string",
- "ppc_contractor_company_address": "string",
- "ppc_contractor_gst_no": "string",
- "ppc_project_title": "string",
- "ppc_contractor_sum": "string",
- "ppc_variation_order_number": "string",
- "ppc_contract_title": "string",
- "ppc_item_details": [
- {
- "item": "string"
}
], - "ppc_item_reference": "string",
- "ppc_certified_amount": 0.1,
- "ppc_amount_previously_certified": 0.1,
- "ppc_variation_amount": 0.1,
- "ppc_retention_sum": "string",
- "ppc_amount_gross": 0.1,
- "ppc_tax_amount": 0.1,
- "ppc_back_charge_deduct": 0.1,
- "ppc_back_charge_refund": 0.1,
- "ppc_total_amount_excl_gst": 0.1,
- "ppc_amount_net_incl_gst": 0.1,
- "ppc_debit_note_number": "string",
- "ppc_debit_note_amount": 0.1,
- "ppc_debit_note_remarks": "string",
- "ppc_payment_work_done_this_period": "string",
- "ppc_payment_terms": "string",
- "ppc_beneficiary_name": "string",
- "ppc_beneficiary_bank_name": "string",
- "ppc_beneficiary_bank_branch": "string",
- "ppc_beneficiary_bank_swift_code": "string",
- "ppc_beneficiary_bank_code": "string",
- "ppc_beneficiary_bank_account_number": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: payment_response
| pr_company_name required | string (Company Name)
|
| pr_company_address required | string (Company Address)
|
| pr_reference required | string (Payment Response Reference)
|
| pr_date required | string <date> (Date)
|
| pr_customer_number | string or null (Customer No.)
|
| pr_gst_registration_number | string or null (Gst Registration No.)
|
| pr_claim_ref required | string (Payment Claim Reference)
|
| pr_project_number required | string (Project No.)
|
| pr_contract_ref | string or null (Contract Ref. / Work Order No.)
|
| pr_contractor_company required | string (Contractor Company Name)
|
| pr_contractor_company_address required | string (Contractor Company Address)
|
| pr_project_title required | string (Project Title)
|
| pr_contract_details required | string (Contract Details)
|
| pr_certified_amount required | number <double> (Certified Amount)
|
| pr_amount_previously_certified required | number <double> (Amount Previously Certified)
|
| pr_variation_amount required | number <double> (Variation Amount)
|
| pr_amount_gross required | number <double> (Amount Due (Gross))
|
| pr_back_charge_deduct | number or null <double> (Back Charge Deduction)
|
| pr_back_charge_refund | number or null <double> (Bank Charge Refund)
|
| pr_total_amount_excl_gst | number or null <double> (Total Amount Due (Nett) (excl GST))
|
| pr_total_amount_incl_gst | number or null <double> (Total Amount Due (Nett) (incl GST))
|
| pr_payment_work_done_this_period required | string (Payment Of Work Done This Period)
|
Array of objects or null (Attachments) |
{- "pr_company_name": "string",
- "pr_company_address": "string",
- "pr_reference": "string",
- "pr_date": "2019-08-24",
- "pr_customer_number": "string",
- "pr_gst_registration_number": "string",
- "pr_claim_ref": "string",
- "pr_project_number": "string",
- "pr_contract_ref": "string",
- "pr_contractor_company": "string",
- "pr_contractor_company_address": "string",
- "pr_project_title": "string",
- "pr_contract_details": "string",
- "pr_certified_amount": 0.1,
- "pr_amount_previously_certified": 0.1,
- "pr_variation_amount": 0.1,
- "pr_amount_gross": 0.1,
- "pr_back_charge_deduct": 0.1,
- "pr_back_charge_refund": 0.1,
- "pr_total_amount_excl_gst": 0.1,
- "pr_total_amount_incl_gst": 0.1,
- "pr_payment_work_done_this_period": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: purchase_order
| po_additional_document_reference | string or null (Additional Document Reference)
|
| po_allowance_and_charge | string or null (Allowance And Charge)
|
| po_assets_expense_account | string or null (Assets Or Expenses Account)
|
| po_blanket_order_reference | string or null (Blanket Order Reference)
|
| po_buyer required | string (Buyer)
|
| po_carrier | string or null (Carrier)
|
| po_confirmed_earliest_schedule_date | string or null <date> (Confirmed Earliest Schedule Date)
|
| po_confirmed_latest_schedule_date | string or null <date> (Confirmed Latest Schedule Date)
|
| po_confirmed_schedule_date | string or null <date> (Confirmed Schedule Date)
|
| po_consignee | string or null (Consignee)
|
| po_consignee_agent | string or null (Consignee Agent)
|
| po_consignee_order_reference | string or null (Consignee Order Reference)
|
| po_cost_assignment_reference | string or null (Cost Assignment Reference)
|
| po_country_final_destination | string or null (Country Of Final Destination)
|
| po_customer_accountant | string or null (Customer Accountant)
|
| po_customer_reference | string or null (Customer Reference)
|
| po_customs_certificate_reference | string or null (Customs Certificate Reference)
|
| po_delivery_document_reference | string or null (Delivery Document Reference)
|
| po_delivery_instruction | string or null (Delivery Instruction)
|
| po_delivery_instruction_description | string or null (Delivery Instruction Description)
|
| po_despatch_document_note | string or null (Despatch Document Note)
|
| po_despatch_period | string or null (Despatch Period)
|
| po_document_information | string or null (Document Information)
|
| po_document_purpose | string or null (Document Purpose/Function)
|
| po_earliest_schedule_date | string or null <date> (Earliest Schedule Date)
|
| po_engineering_change_reference | string or null (Engineering Change Reference)
|
| po_export_license_reference | string or null (Export License Reference)
|
| po_import_license_reference | string or null (Import License Reference)
|
| po_invoice_currency | string or null (Invoice Currency)
|
| po_invoice_currency_exchange | string or null (Invoice Currency Exchange)
|
| po_invoicee | string or null (Invoicee)
|
| po_latest_schedule_date | string or null <date> (Latest Schedule Date)
|
| po_letter_of_credit_reference | string or null (Letter Of Credit Reference)
|
| po_minus_delivery_quantity | string or null (Minus Delivery Quantity)
|
| po_no_partial_delivery_allowed | string or null (No Partial Delivery Allowed)
|
| po_order_change_header | string or null (Order Change Header)
|
| po_order_currency | string or null (Order Currency)
|
| po_order_currency_exchange | string or null (Order Currency Exchange)
|
Array of objects or null (Order Details)
| |
| po_order_number_marketplace | string or null (Order Number Marketplace)
|
| po_order_response_header | string or null (Order Response Header)
|
| po_original_order_reference | string or null (Original Order Reference)
|
| po_payable_account | string or null (Payable Account)
|
| po_payee | string or null (Payee)
|
| po_payer | string or null (Payer)
|
| po_payment_instructions | string or null (Payment Instructions)
|
| po_payment_terms | string or null (Payment Terms)
|
| po_place_destination | string or null (Place Of Destination)
|
| po_place_discharge | string or null (Place Of Discharge)
|
| po_plus_delivery_quantity | string or null (Plus Delivery Quantity)
|
| po_price | string or null (Price)
|
| po_price_list_reference | string or null (Price List Reference)
|
| po_pricing_currency | string or null (Pricing Currency)
|
| po_pricing_currency_exchange | string or null (Pricing Currency Exchange)
|
| po_prior_order_change_reference | string or null (Prior Order Change Reference)
|
| po_prior_order_reference | string or null (Prior Order Reference)
|
| po_prior_order_response_reference | string or null (Prior Order Response Reference)
|
| po_quote_reference | string or null (Quote Reference (Offer))
|
| po_release_period | string or null (Release Period)
|
| po_report_reference | string or null (Sales Report Reference)
|
| po_request_for_quote_reference | string or null (Request For Quote Reference)
|
| po_requisition_reference | string or null (Requisition Reference)
|
| po_requisitioner | string or null (Requisitioner)
|
| po_response_reason_code | string or null (Response Reason Code)
|
| po_rounding_amount | string or null (Rounding Amount)
|
| po_scedule_period | string or null (Schedule Period)
|
| po_schedule_date | string or null <date> (Schedule Date)
|
| po_seller | string or null (Seller)
|
| po_ship_from | string or null (Ship From)
|
| po_ship_from_location | string or null (Ship From Location)
|
| po_ship_to | string or null (Ship To)
|
| po_ship_to_location | string or null (Ship To Location Or Address)
|
| po_shipping_grouping_identifier | string or null (Shipping Grouping Identifier)
|
| po_supplier_order_identifier | string or null (Supplier Order Identifier)
|
| po_tax_currency | string or null (Tax Currency)
|
| po_tax_currency_exchange | string or null (Tax Currency Exchange)
|
| po_tax_fee_totals | string or null (Tax Fee Totals)
|
| po_to_be_paid_amount | string or null (To Be Paid Amount)
|
| po_total_order_additional_allowance_amount | string or null (Total Order Additional Allowance Amount)
|
| po_total_order_additional_charge_amount | string or null (Total Order Additional Charge Amount)
|
| po_total_order_amount | string or null (Total Order Amount)
|
| po_total_amount | string or null (Total Amount)
|
| po_total_quantity | string or null (Total Quantity)
|
| po_total_tax_fee_amount | string or null (Total Tax Fee Amount)
|
| po_total_taxable_amount | string or null (Total Taxable Amount)
|
| po_transport_mode | string or null (Transport Mode)
|
Array of objects or null (Purchase Order Attachment)
|
{- "po_additional_document_reference": "string",
- "po_allowance_and_charge": "string",
- "po_assets_expense_account": "string",
- "po_blanket_order_reference": "string",
- "po_buyer": "string",
- "po_carrier": "string",
- "po_confirmed_earliest_schedule_date": "2019-08-24",
- "po_confirmed_latest_schedule_date": "2019-08-24",
- "po_confirmed_schedule_date": "2019-08-24",
- "po_consignee": "string",
- "po_consignee_agent": "string",
- "po_consignee_order_reference": "string",
- "po_cost_assignment_reference": "string",
- "po_country_final_destination": "string",
- "po_customer_accountant": "string",
- "po_customer_reference": "string",
- "po_customs_certificate_reference": "string",
- "po_delivery_document_reference": "string",
- "po_delivery_instruction": "string",
- "po_delivery_instruction_description": "string",
- "po_despatch_document_note": "string",
- "po_despatch_period": "string",
- "po_document_information": "string",
- "po_document_purpose": "string",
- "po_earliest_schedule_date": "2019-08-24",
- "po_engineering_change_reference": "string",
- "po_export_license_reference": "string",
- "po_import_license_reference": "string",
- "po_invoice_currency": "string",
- "po_invoice_currency_exchange": "string",
- "po_invoicee": "string",
- "po_latest_schedule_date": "2019-08-24",
- "po_letter_of_credit_reference": "string",
- "po_minus_delivery_quantity": "string",
- "po_no_partial_delivery_allowed": "string",
- "po_order_change_header": "string",
- "po_order_currency": "string",
- "po_order_currency_exchange": "string",
- "po_order_details": [
- {
- "contract_reference": "string",
- "order_change": "string",
- "delivery_quantity": "string",
- "marketplace": "string",
- "note": "string",
- "number": "string",
- "substituted_product": "string",
- "status": "string",
- "status_reason_code": "string",
- "supplier_identification": "string",
- "uuid": "string",
- "additional_allowance_amount": "string",
- "amount": "string",
- "response": "string",
- "sales_catalogue_reference": "string",
- "product": "string",
- "supplier": "string",
- "additional charge_amount": "string"
}
], - "po_order_number_marketplace": "string",
- "po_order_response_header": "string",
- "po_original_order_reference": "string",
- "po_payable_account": "string",
- "po_payee": "string",
- "po_payer": "string",
- "po_payment_instructions": "string",
- "po_payment_terms": "string",
- "po_place_destination": "string",
- "po_place_discharge": "string",
- "po_plus_delivery_quantity": "string",
- "po_price": "string",
- "po_price_list_reference": "string",
- "po_pricing_currency": "string",
- "po_pricing_currency_exchange": "string",
- "po_prior_order_change_reference": "string",
- "po_prior_order_reference": "string",
- "po_prior_order_response_reference": "string",
- "po_quote_reference": "string",
- "po_release_period": "string",
- "po_report_reference": "string",
- "po_request_for_quote_reference": "string",
- "po_requisition_reference": "string",
- "po_requisitioner": "string",
- "po_response_reason_code": "string",
- "po_rounding_amount": "string",
- "po_scedule_period": "string",
- "po_schedule_date": "2019-08-24",
- "po_seller": "string",
- "po_ship_from": "string",
- "po_ship_from_location": "string",
- "po_ship_to": "string",
- "po_ship_to_location": "string",
- "po_shipping_grouping_identifier": "string",
- "po_supplier_order_identifier": "string",
- "po_tax_currency": "string",
- "po_tax_currency_exchange": "string",
- "po_tax_fee_totals": "string",
- "po_to_be_paid_amount": "string",
- "po_total_order_additional_allowance_amount": "string",
- "po_total_order_additional_charge_amount": "string",
- "po_total_order_amount": "string",
- "po_total_amount": "string",
- "po_total_quantity": "string",
- "po_total_tax_fee_amount": "string",
- "po_total_taxable_amount": "string",
- "po_transport_mode": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: sales_invoice
| invoice_number required | string (Invoice Number)
|
| invoice_currency required | string (Invoice Currency Code)
|
| invoice_unit_currency required | string (Currency Unit)
|
| invoice_date | string or null <date> (Invoice Issue Date)
|
| invoice_terms | string or null (Payment Terms)
|
| invoice_date_due | string or null <date> (Payment Due Date)
|
| invoice_seller_company_name | string or null (Seller Trading Name)
|
| invoice_seller_company_address | string or null (Seller Postal Address)
|
| invoice_buyer_company_name | string or null (Buyer Trading Name)
|
| invoice_buyer_company_address | string or null (Buyer Postal Address)
|
| invoice_project_name | string or null (Project Name)
|
| invoice_project_description | string or null (Project Description)
|
| invoice_customer_no | string or null (Buyer Identifier)
|
| invoice_gross_amount | number or null <double> (Sum Of Charges On Document Level)
|
| invoice_discount_amount | number or null <double> (Sum Of Allowances On Document Level)
|
| invoice_tax_amount | number or null <double> (Invoice Total Vat Amount In Accounting Currency)
|
| invoice_net_amount | number or null <double> (Amount Due For Payment)
|
Array of objects or null (Item Details)
| |
| invoice_transport_details | string or null (Item Description)
|
| invoice_transport_number | string or null (Despatch Advice Reference)
|
| invoice_transportation_date | string or null <date> (Actual Delivery Date)
|
| invoice_delivery_from | string or null (Item Country Of Origin)
|
| invoice_delivery_to | string or null (Deliver To Address)
|
| invoice_fda_registration_number | string or null (Fda Registration Number )
|
| invoice_certification_number | string or null (Certification Number )
|
| invoice_supplier_name | string or null (Seller Trading Name)
|
| invoice_supplier_address | string or null (Seller Postal Address)
|
| invoice_tt_beneficiary_name | string or null (Payee Name)
|
| invoice_tt_beneficiary_address | string or null (Address Of Beneficiary / Supplier (Tt) )
|
| invoice_tt_beneficiary_account_number | string or null (Payment Account Identifier)
|
| invoice_tt_beneficiary_bank_name | string or null (Payment Account Name)
|
| invoice_tt_beneficiary_bank_address | string or null (Address Of Beneficiary Bank (TT) )
|
| invoice_tt_beneficiary_receiving_agent | string or null (Receiving Agent Of Beneficiary Bank (TT) )
|
| invoice_co_beneficiary_name | string or null (Payee Name)
|
| invoice_co_beneficiary_account_name | string or null (Payment Account Identifier)
|
| invoice_co_beneficiary_account_number | string or null (Payment Account Name)
|
| invoice_co_other_instructions | string or null (Payment Means Text)
|
Array of objects or null (Sales Invoice Attachment)
|
{- "invoice_number": "string",
- "invoice_currency": "string",
- "invoice_unit_currency": "string",
- "invoice_date": "2019-08-24",
- "invoice_terms": "string",
- "invoice_date_due": "2019-08-24",
- "invoice_seller_company_name": "string",
- "invoice_seller_company_address": "string",
- "invoice_buyer_company_name": "string",
- "invoice_buyer_company_address": "string",
- "invoice_project_name": "string",
- "invoice_project_description": "string",
- "invoice_customer_no": "string",
- "invoice_gross_amount": 0.1,
- "invoice_discount_amount": 0.1,
- "invoice_tax_amount": 0.1,
- "invoice_net_amount": 0.1,
- "invoice_item_details": [
- {
- "contract_reference": "string",
- "description_of_goods": "string",
- "quantity": "string",
- "unit_measurement": "string",
- "unit_price": "string",
- "note": "string"
}
], - "invoice_transport_details": "string",
- "invoice_transport_number": "string",
- "invoice_transportation_date": "2019-08-24",
- "invoice_delivery_from": "string",
- "invoice_delivery_to": "string",
- "invoice_fda_registration_number": "string",
- "invoice_certification_number": "string",
- "invoice_supplier_name": "string",
- "invoice_supplier_address": "string",
- "invoice_tt_beneficiary_name": "string",
- "invoice_tt_beneficiary_address": "string",
- "invoice_tt_beneficiary_account_number": "string",
- "invoice_tt_beneficiary_bank_name": "string",
- "invoice_tt_beneficiary_bank_address": "string",
- "invoice_tt_beneficiary_receiving_agent": "string",
- "invoice_co_beneficiary_name": "string",
- "invoice_co_beneficiary_account_name": "string",
- "invoice_co_beneficiary_account_number": "string",
- "invoice_co_other_instructions": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: agrifood_purchase_order
| apo_user_id | number or null (User ID) User ID |
| apo_buyer | number or null (Buyer) Buyer |
| apo_supplier | number or null (Supplier) Supplier |
| apo_trade_contract_number | string or null (Trade Contract Number) Trade Contract Number |
| apo_status | string (Status) Status |
| apo_company_id | number or null (Company ID) Company ID |
{- "apo_user_id": 0,
- "apo_buyer": 0,
- "apo_supplier": 0,
- "apo_trade_contract_number": "string",
- "apo_status": "string",
- "apo_company_id": 0
}Data Element ID: delivery_order
| do_number required | string (Delivery Order Number) Unique identifier for invoice referred in delivery order |
| do_invoice_number | string or null (Invoice Number ) Unique identifier for delivery order |
{- "do_number": "string",
- "do_invoice_number": "string"
}Data Element ID: goods_receipt
| gr_number | string or null (Goods Receipt No. ) Unique identifier for delivery order referred in goods receipt |
{- "gr_number": "string"
}Data Element ID: green_building_certification
| gbc_name_certified_company | string or null (Registered Name of Certified Company ) Registered Name of Certified Company |
| gbc_certified_project | string or null (Registered Name of Certified Project ) Registered Name of Certified Project |
| gbc_postcode_certified_location | string or null (Postcode of Certified Location) Postcode of Certified Location |
{- "gbc_name_certified_company": "string",
- "gbc_certified_project": "string",
- "gbc_postcode_certified_location": "string"
}Data Element ID: green_product_certification
| gpc_name_certified_company | string or null (Name of Certified Company ) Registered Name of Certified Company |
| gpc_certification_number required | string (Certification Number ) Certification Number |
| gpc_licence_number | string or null (License Number ) License Number |
{- "gpc_name_certified_company": "string",
- "gpc_certification_number": "string",
- "gpc_licence_number": "string"
}Data Element ID: interim_certificate
| ic_certificate_no required | string (Certificate No ) Unique identifier for interim certificate |
{- "ic_certificate_no": "string"
}Data Element ID: invoice_finance_application
| ifa_application_id required | string (Trade Financing Application Id) Unique application reference number |
{- "ifa_application_id": "string"
}Data Element ID: invoice_finance_response
| ifr_transaction_reference_number | string or null (Transaction Reference Number ) Transaction Reference Number |
{- "ifr_transaction_reference_number": "string"
}Data Element ID: palm_oil_entity_certification
| poec_name_certified_entity | string or null (Name Of Certified Entity) Name of Certified Entity |
| poec_certification_number required | string (Certification Number ) Certification Number |
| poec_license_number | string or null (License Number ) License Number |
| poec_name_parent_company | string or null (Parent Company) Parent Company |
| poec_membership_number | string or null (Membership Number Of Certified Entity / Parent Company) Membership Number of Certified Entity / Parent Company |
{- "poec_name_certified_entity": "string",
- "poec_certification_number": "string",
- "poec_license_number": "string",
- "poec_name_parent_company": "string",
- "poec_membership_number": "string"
}Data Element ID: payment_progress_certificate
| ppc_project_number | string or null (Project No.) Unique Identifier for project |
{- "ppc_project_number": "string"
}Data Element ID: payment_response
| pr_project_number | string or null (Project No.) Unique Identifier for project |
{- "pr_project_number": "string"
}Data Element ID: purchase_order
| po_buyer | string or null (Buyer) Field UID: ORD- 0011-The entity contains the details of the buyer. |
{- "po_buyer": "string"
}Data Element ID: sales_invoice
| invoice_number required | string (Invoice Number) A unique identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used. |
{- "invoice_number": "string"
}Data Element ID: crane_blockage
| status required | string (Status)
|
| error | string or null (Error)
|
required | Array of objects (Results)
|
{- "status": "string",
- "error": "string",
- "results": [
- {
- "tta": [
- {
- "shipCraneLocation": "string",
- "startTime": "2019-08-24T14:15:22Z",
- "endTime": "2019-08-24T14:15:22Z"
}
], - "seq": 0
}
]
}Data Element ID: delivery_shipment_advice
| dsa_terminal_nm required | string (Terminal)
|
| dsa_no | string or null (DSA)
|
| dsa_status required | string (DSA Status)
|
| dsa_usn | string or null (USN)
|
| dsa_check_in_dt_time | string or null <date-time> (Check-In Date and Time)
|
| dsa_uncheck_in_dt_time | string or null <date-time> (Uncheck-In Date and Time)
|
| dsa_cargo_declarant required | string (Cargo Declarant)
|
| dsa_lighter_operator | string or null (Lighter Operator)
|
| dsa_mother_vessel | string or null (Mother Vessel)
|
| dsa_mother_vessel_imo | string or null (Mother Vessel IMO)
|
| dsa_truck_no | string or null (Truck Number)
|
| dsa_driver_pass_id | string or null (Driver Pass ID)
|
| dsa_driver_id | string or null (Driver ID)
|
| dsa_gate_in_dt_time | string or null <date-time> (Gate-In Date and Time)
|
| dsa_lifting_start_dt_time | string or null <date-time> (Lifting Start Date and Time)
|
| dsa_lifting_end_dt_time | string or null <date-time> (Lifting End Date and Time)
|
| dsa_wharf_in_dt_time | string or null <date-time> (Wharf-In Date and Time)
|
| dsa_atb_dt_time | string or null <date-time> (ATB Date and Time)
|
| dsa_atu_dt_time | string or null <date-time> (ATU Date and Time)
|
| dsa_lighter_nm | string or null (Lighter Name)
|
| dsa_vessel_movement_no | string or null (Vessel Movement Number)
|
| dsa_crane_no | string or null (Crane Number)
|
| dsa_crane_start_dt_time | string or null <date-time> (Crane Start Date and Time)
|
| dsa_crane_end_dt_time | string or null <date-time> (Crane End Date and Time)
|
| dsa_gate_out_dt_time | string or null <date-time> (Gate-Out Date and Time)
|
| dsa_cargo_type | string or null (Cargo Type)
|
| dsa_total_no_of_lift | integer or null <int64> (Total No. of Lifts)
|
| dsa_payment_mode | string or null (Payment Mode)
|
| dsa_bill_status | string or null (Bill Status)
|
| dsa_bill_receipt_no | string or null (Bill / Receipt Number)
|
| dsa_bill_receipt_dt | string or null <date-time> (Bill / Receipt Date)
|
| dsa_total_wharfage | number or null <double> (Total Wharfage ($))
|
| dsa_total_cranage | number or null <double> (Total Cranage ($))
|
| dsa_additional_charge | number or null <double> (Additional Charge ($))
|
| dsa_total_charges | number or null <double> (Total Charges ($))
|
| dsa_time_stamp required | string <date-time> (Last Update Date and Time)
|
| dsa_internal_identifier | string or null (Internal Identifier)
|
Array of objects or null (Export Cargo Details)
| |
Array of objects or null (Import Cargo Details)
|
{- "dsa_terminal_nm": "string",
- "dsa_no": "string",
- "dsa_status": "string",
- "dsa_usn": "string",
- "dsa_check_in_dt_time": "2019-08-24T14:15:22Z",
- "dsa_uncheck_in_dt_time": "2019-08-24T14:15:22Z",
- "dsa_cargo_declarant": "string",
- "dsa_lighter_operator": "string",
- "dsa_mother_vessel": "string",
- "dsa_mother_vessel_imo": "string",
- "dsa_truck_no": "string",
- "dsa_driver_pass_id": "string",
- "dsa_driver_id": "string",
- "dsa_gate_in_dt_time": "2019-08-24T14:15:22Z",
- "dsa_lifting_start_dt_time": "2019-08-24T14:15:22Z",
- "dsa_lifting_end_dt_time": "2019-08-24T14:15:22Z",
- "dsa_wharf_in_dt_time": "2019-08-24T14:15:22Z",
- "dsa_atb_dt_time": "2019-08-24T14:15:22Z",
- "dsa_atu_dt_time": "2019-08-24T14:15:22Z",
- "dsa_lighter_nm": "string",
- "dsa_vessel_movement_no": "string",
- "dsa_crane_no": "string",
- "dsa_crane_start_dt_time": "2019-08-24T14:15:22Z",
- "dsa_crane_end_dt_time": "2019-08-24T14:15:22Z",
- "dsa_gate_out_dt_time": "2019-08-24T14:15:22Z",
- "dsa_cargo_type": "string",
- "dsa_total_no_of_lift": 0,
- "dsa_payment_mode": "string",
- "dsa_bill_status": "string",
- "dsa_bill_receipt_no": "string",
- "dsa_bill_receipt_dt": "2019-08-24T14:15:22Z",
- "dsa_total_wharfage": 0.1,
- "dsa_total_cranage": 0.1,
- "dsa_additional_charge": 0.1,
- "dsa_total_charges": 0.1,
- "dsa_time_stamp": "2019-08-24T14:15:22Z",
- "dsa_internal_identifier": "string",
- "dsa_export_cargo_details": [
- {
- "dsa_cargo_description_code": "string",
- "dsa_uom_code": "string",
- "dsa_hand_carry_indicator": "string",
- "dsa_qty_declared": 0.1,
- "dsa_volume_declared": 0.1,
- "dsa_weight_declared": 0.1,
- "dsa_qty_actual": 0.1,
- "dsa_volume_actual": 0.1,
- "dsa_weight_actual": 0.1
}
], - "dsa_import_cargo_details": [
- {
- "dsa_cargo_description_code": "string",
- "dsa_uom_code": "string",
- "dsa_hand_carry_indicator": "string",
- "dsa_qty_declared": 0.1,
- "dsa_volume_declared": 0.1,
- "dsa_weight_declared": 0.1,
- "dsa_qty_actual": 0.1,
- "dsa_volume_actual": 0.1,
- "dsa_weight_actual": 0.1
}
]
}Data Element ID: job_report_usn
| jr_usn required | string (USN)
|
| jr_job_owner required | string (Job Owner)
|
| jr_lighter_operator required | string (Lighter Operator)
|
| jr_etb required | string <date-time> (ETB)
|
| jr_loading_status required | string (Loading Status)
|
| jr_main_lighter_operator required | string (Main Lighter Operator)
|
| jr_main_lighter_nm required | string (Main Lighter Name)
|
| jr_sub_lighter_operator | string or null (Sub Lighter Operator)
|
| jr_sub_lighter_nm | string or null (Sub Lighter Name)
|
| jr_mother_vessel_abbrev_nm | string or null (Mother Vessel Abbreviated Name)
|
| jr_careoff_total_no | number or null (Total No. of Careoff)
|
| jr_dsa_total_no | number or null (Total No. of DSA)
|
| jr_truck_total_no | number or null (Total No. of Truck)
|
| jr_total_no_of_lifts | number or null (Total No. of Lifts)
|
| jr_total_tonnage | number or null (Total Tonnage)
|
| jr_main_lighter_atb | string or null <date-time> (Main Lighter ATB Date and Time)
|
| jr_main_lighter_atu | string or null <date-time> (Main Lighter ATU Date and Time)
|
| jr_main_lighter_port_stay_mins | string or null <date-time> (Main Lighter Port Stay (min))
|
| jr_sub_lighter_atb | string or null <date-time> (Sub Lighter ATB Date and Time)
|
| jr_sub_lighter_atu | string or null <date-time> (Sub Lighter ATU Date and Time)
|
| jr_sub_lighter_port_stay_mins | string or null <date-time> (Sub Lighter Port Stay (min))
|
| jr_total_port_stay_mins | string or null <date-time> (Total Port Stay (min))
|
| jr_late_check_in_truck | boolean or null (Late Check-In (Truck))
|
| jr_late_check_in_main_lighter | boolean or null (Late Check-In (Main Lighter))
|
| jr_late_check_in_sub_lighter | boolean or null (Late Check-In (Sub Lighter))
|
| jr_no_show_main_lighter | boolean or null (No Show (Main Lighter))
|
| jr_no_show_sub_lighter | boolean or null (No Show (Sub Lighter))
|
{- "jr_usn": "string",
- "jr_job_owner": "string",
- "jr_lighter_operator": "string",
- "jr_etb": "2019-08-24T14:15:22Z",
- "jr_loading_status": "string",
- "jr_main_lighter_operator": "string",
- "jr_main_lighter_nm": "string",
- "jr_sub_lighter_operator": "string",
- "jr_sub_lighter_nm": "string",
- "jr_mother_vessel_abbrev_nm": "string",
- "jr_careoff_total_no": 0,
- "jr_dsa_total_no": 0,
- "jr_truck_total_no": 0,
- "jr_total_no_of_lifts": 0,
- "jr_total_tonnage": 0,
- "jr_main_lighter_atb": "2019-08-24T14:15:22Z",
- "jr_main_lighter_atu": "2019-08-24T14:15:22Z",
- "jr_main_lighter_port_stay_mins": "2019-08-24T14:15:22Z",
- "jr_sub_lighter_atb": "2019-08-24T14:15:22Z",
- "jr_sub_lighter_atu": "2019-08-24T14:15:22Z",
- "jr_sub_lighter_port_stay_mins": "2019-08-24T14:15:22Z",
- "jr_total_port_stay_mins": "2019-08-24T14:15:22Z",
- "jr_late_check_in_truck": true,
- "jr_late_check_in_main_lighter": true,
- "jr_late_check_in_sub_lighter": true,
- "jr_no_show_main_lighter": true,
- "jr_no_show_sub_lighter": true
}Data Element ID: lighter_boat_loading_confirmation
| lighter_boat_loading_confirmation_usn required | string (USN)
|
| lighter_boat_loading_confirmation_dsa_no required | string (DSA)
|
| lighter_boat_loading_confirmation_terminal required | string (Terminal)
|
| lighter_boat_loading_confirmation_loading_completed_dt_time required | string <date-time> (Loading Completed Date and Time)
|
Array of objects or null (Lighter Boat Loading Confirmation Attachment) non-empty
|
{- "lighter_boat_loading_confirmation_usn": "string",
- "lighter_boat_loading_confirmation_dsa_no": "string",
- "lighter_boat_loading_confirmation_terminal": "string",
- "lighter_boat_loading_confirmation_loading_completed_dt_time": "2019-08-24T14:15:22Z",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: lighter_boat_location
| lighter_loc_snapshot_dt_time required | string <date-time> (Snapshot Date-Time)
|
| lighter_loc_geofence | string or null (Geofence of Interest)
|
| lighter_loc_position_radius required | string (Position Radius (metres))
|
| lighter_loc_supply_boat_id required | string (Supply boat Identifier)
|
| lighter_loc_position_latitude required | number (Position Latitude)
|
| lighter_loc_position_longitude required | number (Position Longtitude)
|
| lighter_loc_heading required | number (Heading)
|
{- "lighter_loc_snapshot_dt_time": "2019-08-24T14:15:22Z",
- "lighter_loc_geofence": "string",
- "lighter_loc_position_radius": "string",
- "lighter_loc_supply_boat_id": "string",
- "lighter_loc_position_latitude": 0,
- "lighter_loc_position_longitude": 0,
- "lighter_loc_heading": 0
}Data Element ID: lighter_boat_schedule
| lighter_schedule_usn required | string (USN)
|
| lighter_schedule_eta_at_terminal required | string <date-time> (ETA at Terminal)
|
| lighter_schedule_eta_at_vessel | string or null <date-time> (Vessel ETA)
|
| lighter_schedule_et_cast_off_from_vessel | string or null <date-time> (ET Cast-Off from Vessel)
|
| lighter_schedule_supply_boat_job_id | string or null (Supply boat Job Identifier)
|
| lighter_schedule_job_start_time | string or null <date-time> (Job Start Time)
|
| lighter_schedule_ata | string or null <date-time> (Actual Time Arrival at Vessel)
|
| lighter_schedule_atc | string or null <date-time> (AT Cast-Off from Vessel)
|
| lighter_schedule_job_end_time | string or null <date-time> (Job End Time)
|
| lighter_schedule_supply_boat_id required | string (Supply boat Identifier)
|
| lighter_schedule_query_dt_time required | string <date-time> (Query DateTime)
|
| lighter_schedule_speed | number or null (Speed)
|
| lighter_schedule_time_stamp required | string <date-time> (Last Update Date and Time)
|
Array of objects or null (Lighter Boat Schedule Attachment) non-empty
|
{- "lighter_schedule_usn": "string",
- "lighter_schedule_eta_at_terminal": "2019-08-24T14:15:22Z",
- "lighter_schedule_eta_at_vessel": "2019-08-24T14:15:22Z",
- "lighter_schedule_et_cast_off_from_vessel": "2019-08-24T14:15:22Z",
- "lighter_schedule_supply_boat_job_id": "string",
- "lighter_schedule_job_start_time": "2019-08-24T14:15:22Z",
- "lighter_schedule_ata": "2019-08-24T14:15:22Z",
- "lighter_schedule_atc": "2019-08-24T14:15:22Z",
- "lighter_schedule_job_end_time": "2019-08-24T14:15:22Z",
- "lighter_schedule_supply_boat_id": "string",
- "lighter_schedule_query_dt_time": "2019-08-24T14:15:22Z",
- "lighter_schedule_speed": 0,
- "lighter_schedule_time_stamp": "2019-08-24T14:15:22Z",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: lighter_call
| lighter_call_terminal required | string (Terminal)
|
| lighter_call_lighter_nm required | string (Lighter Name)
|
| lighter_call_etb required | string <date-time> (Booked Slot Date and Time (ETB))
|
| lighter_call_etb_booking_submission_time | string or null <date-time> (ETB - Booking Submission Time)
|
| lighter_call_atb | string or null <date-time> (ATB Date and Time)
|
| lighter_call_crane_no | string or null (Crane Number)
|
| lighter_call_berth_no | string or null (Berth No.)
|
| lighter_call_usn required | string (USN)
|
| lighter_call_lighter_operator required | string (Lighter Operator)
|
| lighter_call_booking_by required | string (Booking By)
|
| lighter_call_booking_submitted_dt_time required | string <date-time> (Booking Submitted Date and Time)
|
| lighter_call_check_in_by | string or null (Check-In By)
|
| lighter_call_check_in_dt | string or null <date-time> (Check-In Date and Time)
|
| lighter_call_check_in_etb | string or null <date-time> (Check-In - ETB)
|
| lighter_call_uncheck_in_dt_time | string or null <date-time> (Uncheck-In Date and Time)
|
| lighter_call_atu | string or null <date-time> (ATU Date and Time)
|
| lighter_call_atu_atb_portstay | string or null <date-time> (ATU-ATB (Portstay))
|
| lighter_call_bill_status | string or null (Bill Status)
|
| lighter_call_bill_no | string or null (Bill Number)
|
| lighter_call_bill_dt | string or null <date-time> (Bill Date)
|
| lighter_call_time_stamp required | string <date-time> (Last Update Date and Time)
|
{- "lighter_call_terminal": "string",
- "lighter_call_lighter_nm": "string",
- "lighter_call_etb": "2019-08-24T14:15:22Z",
- "lighter_call_etb_booking_submission_time": "2019-08-24T14:15:22Z",
- "lighter_call_atb": "2019-08-24T14:15:22Z",
- "lighter_call_crane_no": "string",
- "lighter_call_berth_no": "string",
- "lighter_call_usn": "string",
- "lighter_call_lighter_operator": "string",
- "lighter_call_booking_by": "string",
- "lighter_call_booking_submitted_dt_time": "2019-08-24T14:15:22Z",
- "lighter_call_check_in_by": "string",
- "lighter_call_check_in_dt": "2019-08-24T14:15:22Z",
- "lighter_call_check_in_etb": "2019-08-24T14:15:22Z",
- "lighter_call_uncheck_in_dt_time": "2019-08-24T14:15:22Z",
- "lighter_call_atu": "2019-08-24T14:15:22Z",
- "lighter_call_atu_atb_portstay": "2019-08-24T14:15:22Z",
- "lighter_call_bill_status": "string",
- "lighter_call_bill_no": "string",
- "lighter_call_bill_dt": "2019-08-24T14:15:22Z",
- "lighter_call_time_stamp": "2019-08-24T14:15:22Z"
}Data Element ID: manifest
Array of objects or null (Line Item) non-empty
| |
| manifest_vessel_nm required | string (Vessel Name)
|
| manifest_vessel_destination required | string (Vessel Destination)
|
| manifest_vessel_eta required | string <date-time> (Vessel ETA)
|
| manifest_vessel_remarks | string or null (Vessel Remarks)
|
| manifest_lighter_operator | string or null (Lighter Operator)
|
| manifest_agent | string or null (Agent)
|
| manifest_no | string or null (Manifest Number)
|
Array of objects or null (Manifest Attachment) non-empty
|
{- "manifest_lineitem": [
- {
- "po_no": "string",
- "desc": "string",
- "supplier": "string",
- "remarks": "string"
}
], - "manifest_vessel_nm": "string",
- "manifest_vessel_destination": "string",
- "manifest_vessel_eta": "2019-08-24T14:15:22Z",
- "manifest_vessel_remarks": "string",
- "manifest_lighter_operator": "string",
- "manifest_agent": "string",
- "manifest_no": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: mother_vessel_loading_confirmation
| mother_vessel_loading_confirmation_usn required | string (USN)
|
| mother_vessel_loading_confirmation_vessel_nm required | string (Vessel Name)
|
| mother_vessel_loading_confirmation_loading_completed_dt_time required | string <date-time> (Loading Completed Date and Time)
|
Array of objects or null (Mother Vessel Loading Confirmation Attachment) non-empty
|
{- "mother_vessel_loading_confirmation_usn": "string",
- "mother_vessel_loading_confirmation_vessel_nm": "string",
- "mother_vessel_loading_confirmation_loading_completed_dt_time": "2019-08-24T14:15:22Z",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: pallet_information
Array of objects or null (Line Item) non-empty
| |
| pallet_info_usn required | string (USN)
|
| pallet_info_vessel_nm required | string (Vessel Name)
|
| pallet_info_vessel_imo | string or null (Vessel IMO)
|
| pallet_info_vessel_eta | string or null <date-time> (Vessel ETA)
|
| pallet_info_loading_dt_time required | string <date-time> (Loading DateTime)
|
| pallet_info_terminal required | string (Terminal)
|
| pallet_info_lighter_boat_nm | string or null (Lighter Boat Name)
|
required | Array of objects (Pallet Count Attachment) non-empty
|
{- "pallet_info_lineitem": [
- {
- "pallet_supplier": "string",
- "pallet_count": 0
}
], - "pallet_info_usn": "string",
- "pallet_info_vessel_nm": "string",
- "pallet_info_vessel_imo": "string",
- "pallet_info_vessel_eta": "2019-08-24T14:15:22Z",
- "pallet_info_loading_dt_time": "2019-08-24T14:15:22Z",
- "pallet_info_terminal": "string",
- "pallet_info_lighter_boat_nm": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: pilotage_service
| pilotage_cst_dt_time required | string <date-time> (CST / SRT Date & Time)
|
| pilotage_arrival_dt_time | string or null <date-time> (Arrive Date and Time)
|
| pilotage_onboard_dt_time | string or null <date-time> (Onboard Date and Time)
|
| pilotage_start_dt_time | string or null <date-time> (Start Date and Time)
|
| pilotage_end_dt_time | string or null <date-time> (End Date and Time)
|
| pilotage_nm required | string (Name of the Vessel)
|
| pilotage_imo required | string (International Maritime Organisation number)
|
| pilotage_loc_to_code | string or null (Location To Code)
|
| pilotage_loc_from_code | string or null (Location From Code)
|
| pilotage_snapshot_dt required | string <date-time> (Snapshot Date-Time)
|
{- "pilotage_cst_dt_time": "2019-08-24T14:15:22Z",
- "pilotage_arrival_dt_time": "2019-08-24T14:15:22Z",
- "pilotage_onboard_dt_time": "2019-08-24T14:15:22Z",
- "pilotage_start_dt_time": "2019-08-24T14:15:22Z",
- "pilotage_end_dt_time": "2019-08-24T14:15:22Z",
- "pilotage_nm": "string",
- "pilotage_imo": "string",
- "pilotage_loc_to_code": "string",
- "pilotage_loc_from_code": "string",
- "pilotage_snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: product_catalogue
| product_catalogue_sku required | string (SKU)
|
| product_catalogue_store_view_cd | string or null (Store View Code)
|
| product_catalogue_attribute_set_cd | string or null (Attribute Set Code)
|
| product_catalogue_product_type | string or null (Product Type)
|
| product_catalogue_categories | string or null (Categories)
|
| product_catalogue_product_websites | string or null (Product Websites)
|
| product_catalogue_nm required | string (Name)
|
| product_catalogue_desc required | string (Description)
|
| product_catalogue_short_desc required | string (Short Description)
|
| product_catalogue_weight | number or null (Weight)
|
| product_catalogue_product_online | boolean or null (Product Online)
|
| product_catalogue_tax_class_nm | string or null (Tax Class Name)
|
| product_catalogue_visibility | boolean or null (Visibility)
|
| product_catalogue_price required | number (Price)
|
| product_catalogue_special_price | number or null (Special Price)
|
| product_catalogue_special_price_from_dt | string or null <date-time> (Special Price From Date)
|
| product_catalogue_special_price_to_dt | string or null <date-time> (Special Price To Date)
|
| product_catalogue_url_key | string or null (URL Key)
|
| product_catalogue_meta_title | string or null (Meta Title)
|
| product_catalogue_meta_keywords | string or null (Meta Keywords)
|
| product_catalogue_meta_desc | string or null (Meta Description)
|
| product_catalogue_base_img | string or null (Base Image)
|
| product_catalogue_base_img_label | string or null (Base Image Label)
|
| product_catalogue_small_img | string or null (Small Image)
|
| product_catalogue_small_img_label | string or null (Small Image Label)
|
| product_catalogue_thumbnail_img | string or null (Thumbnail Image)
|
| product_catalogue_thumbnail_img_label | string or null (Thumbnail Image Label)
|
| product_catalogue_swatch_img | string or null (Swatch Image)
|
| product_catalogue_swatch_img_label | string or null (Swatch Image Label)
|
| product_catalogue_created_dt_time | string or null <date-time> (Created At)
|
| product_catalogue_updated_dt_time | string or null <date-time> (Updated At)
|
| product_catalogue_new_from_dt | string or null <date-time> (New From Date)
|
| product_catalogue_new_to_dt | string or null <date-time> (New To Date)
|
| product_catalogue_display_product_options_in | string or null (Display Product Options In)
|
| product_catalogue_map_price | number or null (Map Price)
|
| product_catalogue_msrp_price | number or null (MSRP Price)
|
| product_catalogue_map_enabled | boolean or null (Map Enabled)
|
| product_catalogue_gift_message_available | boolean or null (Gift Message Available)
|
| product_catalogue_custom_design | string or null (Custom Design)
|
| product_catalogue_custom_design_from | string or null (Custom Design From)
|
| product_catalogue_custom_design_to | string or null (Custom Design To)
|
| product_catalogue_custom_layout_update | string or null (Custom Layout Update)
|
| product_catalogue_page_layout | string or null (Page Layout)
|
| product_catalogue_product_options_container | string or null (Product Options Container)
|
| product_catalogue_msrp_display_actual_price_type | string or null (MSRP Display Actual Price Type)
|
| product_catalogue_country_of_manufacture | string or null (Country Of Manufacture)
|
| product_catalogue_additional_attributes | string or null (Additional Attributes)
|
| product_catalogue_qty | number or null (Quantity)
|
| product_catalogue_out_of_stock_qty | number or null (Out Of Stock Quantity)
|
| product_catalogue_use_config_min_qty | number or null (User Configuration Minimum Quantity)
|
| product_catalogue_is_qty_decimal | boolean or null (Is Quantity Decimal)
|
| product_catalogue_allow_backorders | boolean or null (Allow Backorders)
|
| product_catalogue_use_config_backorders | string or null (User Configuration Backorders)
|
| product_catalogue_min_cart_qty | number or null (Maximum Cart Quantity)
|
| product_catalogue_use_config_min_sale_qty | string or null (User Configuration Minimum Sale Quantity)
|
| product_catalogue_max_cart_qty | number or null (Minimum Cart Quantity)
|
| product_catalogue_use_config_max_sale_qty | string or null (User Configuration Maximum Sale Quantity)
|
| product_catalogue_is_in_stock | boolean or null (Is In Stock)
|
| product_catalogue_notify_on_stock_below | string or null (Notify On Stock Below)
|
| product_catalogue_use_config_notify_stock_qty | string or null (User Configuration Notify Stock Quantity)
|
| product_catalogue_manage_stock | string or null (Manage Stock)
|
| product_catalogue_use_config_manage_stock | string or null (User Configuration Manage Stock)
|
| product_catalogue_use_config_qty_increments | string or null (User Configuration Quantity Increments)
|
| product_catalogue_qty_increments | string or null (Quantity Increments)
|
| product_catalogue_use_config_enable_qty_inc | string or null (User Configuration Enable Quantity Increments)
|
| product_catalogue_enable_qty_increments | boolean or null (Enable Quantity Increments)
|
| product_catalogue_is_decimal_divided | boolean or null (Is Decimal Divided)
|
| product_catalogue_website_id | string or null (Website ID)
|
| product_catalogue_related_skus | string or null (Related SKUs)
|
| product_catalogue_related_position | string or null (Related Position)
|
| product_catalogue_crosssell_skus | string or null (Cross Sell SKUs)
|
| product_catalogue_crosssell_position | string or null (Cross Sell Position)
|
| product_catalogue_upsell_skus | string or null (Upsell SKUs)
|
| product_catalogue_upsell_position | string or null (Upsell Position)
|
| product_catalogue_additional_img | string or null (Additional Images)
|
| product_catalogue_additional_img_labels | string or null (Additional Image Labels)
|
| product_catalogue_hide_from_product_page | string or null (Hide From Product Page)
|
| product_catalogue_custom_options | string or null (Custom Options)
|
| product_catalogue_bundle_price_type | string or null (Bundle Price Type)
|
| product_catalogue_bundle_sku_type | string or null (Bundle SKU Type)
|
| product_catalogue_bundle_price_view | string or null (Bundle Price View)
|
| product_catalogue_bundle_weight_type | string or null (Bundle Weight Type)
|
| product_catalogue_bundle_values | string or null (Bundle Values)
|
| product_catalogue_bundle_shipment_type | string or null (Bundle Shipment Type)
|
| product_catalogue_associated_skus | string or null (Associated SKUs)
|
| product_catalogue_downloadable_links | string or null (Downloadable Links)
|
| product_catalogue_downloadable_samples | string or null (Downloadable Samples)
|
| product_catalogue_configurable_variations | string or null (Configurable Variations)
|
| product_catalogue_configurable_variation_labels | string or null (Configurable Variation Labels)
|
{- "product_catalogue_sku": "string",
- "product_catalogue_store_view_cd": "string",
- "product_catalogue_attribute_set_cd": "string",
- "product_catalogue_product_type": "string",
- "product_catalogue_categories": "string",
- "product_catalogue_product_websites": "string",
- "product_catalogue_nm": "string",
- "product_catalogue_desc": "string",
- "product_catalogue_short_desc": "string",
- "product_catalogue_weight": 0,
- "product_catalogue_product_online": true,
- "product_catalogue_tax_class_nm": "string",
- "product_catalogue_visibility": true,
- "product_catalogue_price": 0,
- "product_catalogue_special_price": 0,
- "product_catalogue_special_price_from_dt": "2019-08-24T14:15:22Z",
- "product_catalogue_special_price_to_dt": "2019-08-24T14:15:22Z",
- "product_catalogue_url_key": "string",
- "product_catalogue_meta_title": "string",
- "product_catalogue_meta_keywords": "string",
- "product_catalogue_meta_desc": "string",
- "product_catalogue_base_img": "string",
- "product_catalogue_base_img_label": "string",
- "product_catalogue_small_img": "string",
- "product_catalogue_small_img_label": "string",
- "product_catalogue_thumbnail_img": "string",
- "product_catalogue_thumbnail_img_label": "string",
- "product_catalogue_swatch_img": "string",
- "product_catalogue_swatch_img_label": "string",
- "product_catalogue_created_dt_time": "2019-08-24T14:15:22Z",
- "product_catalogue_updated_dt_time": "2019-08-24T14:15:22Z",
- "product_catalogue_new_from_dt": "2019-08-24T14:15:22Z",
- "product_catalogue_new_to_dt": "2019-08-24T14:15:22Z",
- "product_catalogue_display_product_options_in": "string",
- "product_catalogue_map_price": 0,
- "product_catalogue_msrp_price": 0,
- "product_catalogue_map_enabled": true,
- "product_catalogue_gift_message_available": true,
- "product_catalogue_custom_design": "string",
- "product_catalogue_custom_design_from": "string",
- "product_catalogue_custom_design_to": "string",
- "product_catalogue_custom_layout_update": "string",
- "product_catalogue_page_layout": "string",
- "product_catalogue_product_options_container": "string",
- "product_catalogue_msrp_display_actual_price_type": "string",
- "product_catalogue_country_of_manufacture": "string",
- "product_catalogue_additional_attributes": "string",
- "product_catalogue_qty": 0,
- "product_catalogue_out_of_stock_qty": 0,
- "product_catalogue_use_config_min_qty": 0,
- "product_catalogue_is_qty_decimal": true,
- "product_catalogue_allow_backorders": true,
- "product_catalogue_use_config_backorders": "string",
- "product_catalogue_min_cart_qty": 0,
- "product_catalogue_use_config_min_sale_qty": "string",
- "product_catalogue_max_cart_qty": 0,
- "product_catalogue_use_config_max_sale_qty": "string",
- "product_catalogue_is_in_stock": true,
- "product_catalogue_notify_on_stock_below": "string",
- "product_catalogue_use_config_notify_stock_qty": "string",
- "product_catalogue_manage_stock": "string",
- "product_catalogue_use_config_manage_stock": "string",
- "product_catalogue_use_config_qty_increments": "string",
- "product_catalogue_qty_increments": "string",
- "product_catalogue_use_config_enable_qty_inc": "string",
- "product_catalogue_enable_qty_increments": true,
- "product_catalogue_is_decimal_divided": true,
- "product_catalogue_website_id": "string",
- "product_catalogue_related_skus": "string",
- "product_catalogue_related_position": "string",
- "product_catalogue_crosssell_skus": "string",
- "product_catalogue_crosssell_position": "string",
- "product_catalogue_upsell_skus": "string",
- "product_catalogue_upsell_position": "string",
- "product_catalogue_additional_img": "string",
- "product_catalogue_additional_img_labels": "string",
- "product_catalogue_hide_from_product_page": "string",
- "product_catalogue_custom_options": "string",
- "product_catalogue_bundle_price_type": "string",
- "product_catalogue_bundle_sku_type": "string",
- "product_catalogue_bundle_price_view": "string",
- "product_catalogue_bundle_weight_type": "string",
- "product_catalogue_bundle_values": "string",
- "product_catalogue_bundle_shipment_type": "string",
- "product_catalogue_associated_skus": "string",
- "product_catalogue_downloadable_links": "string",
- "product_catalogue_downloadable_samples": "string",
- "product_catalogue_configurable_variations": "string",
- "product_catalogue_configurable_variation_labels": "string"
}Data Element ID: product_offering
| product_offering_no required | string (Product information number)
|
| product_offering_dt required | string <date-time> (Date)
|
| product_offering_item required | Array of strings (Item)
|
| product_offering_item_cd required | string (Item Code)
|
| product_offering_unit required | string (Unit)
|
| product_offering_unit_price | string or null (Unit price)
|
{- "product_offering_no": "string",
- "product_offering_dt": "2019-08-24T14:15:22Z",
- "product_offering_item": [
- "string"
], - "product_offering_item_cd": "string",
- "product_offering_unit": "string",
- "product_offering_unit_price": "string"
}Data Element ID: purchase_order_po
| po_no required | string (PO Number)
|
| po_vessel_nm required | string (Vessel Name)
|
| po_vessel_imo | string or null (Vessel IMO)
|
| po_req_delivery_dt | string or null <date-time> (Requested Delivery Date)
|
| po_vessel_eta | string or null <date-time> (Vessel ETA)
|
| po_job_coordinator | string or null (Job Coordinator)
|
| po_job_coordinator_contact | string or null (Job Coordinator Contact)
|
| po_supplier_nm required | string (Supplier Name)
|
| po_supplier_contact | string or null (Supplier Contact)
|
Array of objects or null (Line Item)
| |
| po_dt | string or null <date-time> (PO Date)
|
| po_total_price | number or null <double> (Total Price)
|
| po_payment_terms | number or null <double> (Payment Terms)
|
| po_delivery_instructions | string or null (Delivery Instructions)
|
| po_req_delivery_port | string or null (Requested Delivery Port)
|
Array of objects or null (Purchase Order (PO) Attachment)
|
{- "po_no": "string",
- "po_vessel_nm": "string",
- "po_vessel_imo": "string",
- "po_req_delivery_dt": "2019-08-24T14:15:22Z",
- "po_vessel_eta": "2019-08-24T14:15:22Z",
- "po_job_coordinator": "string",
- "po_job_coordinator_contact": "string",
- "po_supplier_nm": "string",
- "po_supplier_contact": "string",
- "po_lineitem": [
- {
- "type": "string",
- "no": "string",
- "catalog_ref": "string",
- "quant": 0,
- "unit": "string",
- "desc": "string",
- "unit_price": 0.1,
- "discount_amount": 0.1,
- "amount": 0.1
}
], - "po_dt": "2019-08-24T14:15:22Z",
- "po_total_price": 0.1,
- "po_payment_terms": 0.1,
- "po_delivery_instructions": "string",
- "po_req_delivery_port": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: ship_supplies_di
| di_supplier_nm | string or null (Supplier Name)
|
| di_supplier_uen | string or null (Supplier UEN)
|
| di_no | string or null (DO Number)
|
| di_dt | string or null <date-time> (DO Date)
|
required | Array of objects (Line Item) non-empty
|
| di_receiving_vessel_nm | string or null (Receiving Vessel Name)
|
| di_time_stamp required | string <date-time> (Last Update Date and Time)
|
| di_dsa required | string (DSA)
|
{- "di_supplier_nm": "string",
- "di_supplier_uen": "string",
- "di_no": "string",
- "di_dt": "2019-08-24T14:15:22Z",
- "di_lineitem": [
- {
- "item": "string",
- "qty": 0,
- "unit": "string",
- "desc": "string"
}
], - "di_receiving_vessel_nm": "string",
- "di_time_stamp": "2019-08-24T14:15:22Z",
- "di_dsa": "string"
}Data Element ID: ship_supplies_do
| do_supplier_nm required | string (Supplier Name)
|
| do_supplier_address required | string (Supplier Address)
|
| do_supplier_uen required | string (Supplier UEN)
|
| do_no required | string (DO Number)
|
| do_dt | string or null <date-time> (DO Date)
|
| do_receiving_vessel_nm required | string (Receiving Vessel Name)
|
required | Array of objects (Line Item) non-empty
|
Array of objects or null (Ship Supplies' Delivery Order Attachment) non-empty
| |
| do_time_stamp required | string <date-time> (Last Update Date and Time)
|
| do_remarks | string or null (Remarks)
|
{- "do_supplier_nm": "string",
- "do_supplier_address": "string",
- "do_supplier_uen": "string",
- "do_no": "string",
- "do_dt": "2019-08-24T14:15:22Z",
- "do_receiving_vessel_nm": "string",
- "do_lineitem": [
- {
- "po_no": "string",
- "po_raise_dt": "2019-08-24T14:15:22Z",
- "item": "string",
- "qty": 0,
- "unit": "string",
- "desc": "string"
}
], - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "do_time_stamp": "2019-08-24T14:15:22Z",
- "do_remarks": "string"
}Data Element ID: ship_supplies_invoice
| invoice_no required | string (Invoice Number)
|
| invoice_dt | string or null <date-time> (Invoice Date)
|
| invoice_total_payment_amt | number or null (Total Payment Amount)
|
| invoice_currency | string or null (Currency)
|
Array of objects or null (Ship Supplies' Invoice Attachment) non-empty
| |
| invoice_receiving_vessel_nm required | string (Receiving Vessel Name)
|
| invoice_payee | string or null (Payee)
|
Array of objects or null (Line Item) non-empty
| |
| invoice_po_no | string or null (PO Number)
|
{- "invoice_no": "string",
- "invoice_dt": "2019-08-24T14:15:22Z",
- "invoice_total_payment_amt": 0,
- "invoice_currency": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "invoice_receiving_vessel_nm": "string",
- "invoice_payee": "string",
- "invoice_lineitem": [
- {
- "invoice_goods_nm": "string",
- "invoice_goods_qty_amt": 0,
- "invoice_goods_qty_unit": "string",
- "invoice_goods_unit_price": 0
}
], - "invoice_po_no": "string"
}Data Element ID: truck_location
| truck_loc_snapshot_dt required | string <date-time> (Snapshot Date-Time)
|
| truck_loc_geofence | string or null (Geofence of Interest)
|
| truck_loc_position_radius | string or null (Position Radius (metres))
|
| truck_loc_trucker_nm | string or null (Trucker Name)
|
| truck_loc_position_latitude | number or null <double> (Position Latitude)
|
| truck_loc_position_longitude | number or null <double> (Position Longtitude)
|
| truck_loc_heading | number or null <double> (Heading)
|
| truck_loc_vehicle_no required | string (Vehicle Number)
|
| truck_speed | string or null (Speed)
|
| truck_notes | string or null (Notes)
|
{- "truck_loc_snapshot_dt": "2019-08-24T14:15:22Z",
- "truck_loc_geofence": "string",
- "truck_loc_position_radius": "string",
- "truck_loc_trucker_nm": "string",
- "truck_loc_position_latitude": 0.1,
- "truck_loc_position_longitude": 0.1,
- "truck_loc_heading": 0.1,
- "truck_loc_vehicle_no": "string",
- "truck_speed": "string",
- "truck_notes": "string"
}Data Element ID: truck_schedule
| truck_schedule_usn required | string (USN)
|
| truck_schedule_dsa required | string (DSA)
|
| truck_schedule_terminal required | string (Terminal)
|
| truck_schedule_eta_at_terminal required | string <date-time> (ETA at Terminal)
|
| truck_schedule_job_ref_no | string or null (Job Reference No)
|
| truck_schedule_pickup_loc | string or null (Pick-up Location)
|
| truck_schedule_pickup_time | string or null <date-time> (Pick-up Time)
|
| truck_schedule_dropoff_terminal_loc required | string (Drop-off (Terminal) Location)
|
| truck_schedule_dropoff_eta_time required | string <date-time> (Drop-off (ETA) Time)
|
Array of objects or null (Line Items) non-empty
| |
| truck_schedule_assigned_driver required | string (Assigned Driver)
|
| truck_schedule_assigned_vehicle_no required | string (Assigned Vehicle No.)
|
| truck_schedule_job_status | string or null (Job Status)
|
Array of objects or null (Truck Schedule Attachment) non-empty
| |
| truck_schedule_time_stamp required | string <date-time> (Last Update Date and Time)
|
{- "truck_schedule_usn": "string",
- "truck_schedule_dsa": "string",
- "truck_schedule_terminal": "string",
- "truck_schedule_eta_at_terminal": "2019-08-24T14:15:22Z",
- "truck_schedule_job_ref_no": "string",
- "truck_schedule_pickup_loc": "string",
- "truck_schedule_pickup_time": "2019-08-24T14:15:22Z",
- "truck_schedule_dropoff_terminal_loc": "string",
- "truck_schedule_dropoff_eta_time": "2019-08-24T14:15:22Z",
- "truck_schedule_line_items": [
- {
- "nm": "string",
- "qty": 0,
- "unit": "string",
- "desc": "string"
}
], - "truck_schedule_assigned_driver": "string",
- "truck_schedule_assigned_vehicle_no": "string",
- "truck_schedule_job_status": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
], - "truck_schedule_time_stamp": "2019-08-24T14:15:22Z"
}Data Element ID: vehicle_port_entry_exit
| vehicle_port_entry_exit_vehicle_no required | string (Vehicle Number)
|
| vehicle_port_entry_exit_vehicle_movement_type required | string (Vehicle Movement)
|
| vehicle_port_entry_exit_vehicle_portgatein_dt | string or null <date-time> (Vehicle Port GateIn Date-Time)
|
| vehicle_port_entry_exit_vehicle_portgateout_dt | string or null <date-time> (Vehicle Port GateOut Date-Time)
|
{- "vehicle_port_entry_exit_vehicle_no": "string",
- "vehicle_port_entry_exit_vehicle_movement_type": "string",
- "vehicle_port_entry_exit_vehicle_portgatein_dt": "2019-08-24T14:15:22Z",
- "vehicle_port_entry_exit_vehicle_portgateout_dt": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_current_position
Array of objects or null (Vessel Particulars Information)
| |
| vessel_source | string or null (Source)
|
| vessel_destination_code | string or null (Destination Code)
|
| vessel_destination | string or null (Destination)
|
| vessel_standardised_destination | string or null (Standardised Destination)
|
| vessel_eta_dt | string or null <date-time> (Vessel ETA)
|
| vessel_length | integer or null <int64> (Length of the Vessel)
|
| vessel_depth | integer or null <int64> (Depth of the Vessel)
|
| vessel_draught | integer or null <int64> (Draught of the Vessel)
|
| vessel_type | string or null (Type of the Vessel)
|
| vessel_grosstonnage | integer or null <int64> (Gross Tonnage of the Vessel)
|
| vessel_nettonnage | integer or null <int64> (Net Tonnage of the Vessel)
|
| vessel_deadweight | integer or null <int64> (Dead Weight of the Vessel)
|
| vessel_mmsi_number | integer or null <int64> (MMSI Number of the Vessel)
|
| vessel_year_built | integer or null <int64> (The year in which the vessel has been built)
|
| vessel_latitude | number or null <double> (Latitude)
|
| vessel_longitude | number or null <double> (Longitude)
|
| vessel_latitude_degrees | number or null <double> (Latitude Degrees)
|
| vessel_longitude_degrees | number or null <double> (Longitude Degrees)
|
| vessel_speed | number or null <double> (Speed)
|
| vessel_course | number or null <double> (Course)
|
| vessel_heading | number or null <double> (Heading)
|
| vessel_navigation_status | string or null (Navigation Status)
|
| vessel_time_stamp | string or null <date-time> (Last Update Time)
|
{- "vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string"
}
], - "vessel_source": "string",
- "vessel_destination_code": "string",
- "vessel_destination": "string",
- "vessel_standardised_destination": "string",
- "vessel_eta_dt": "2019-08-24T14:15:22Z",
- "vessel_length": 0,
- "vessel_depth": 0,
- "vessel_draught": 0,
- "vessel_type": "string",
- "vessel_grosstonnage": 0,
- "vessel_nettonnage": 0,
- "vessel_deadweight": 0,
- "vessel_mmsi_number": 0,
- "vessel_year_built": 0,
- "vessel_latitude": 0.1,
- "vessel_longitude": 0.1,
- "vessel_latitude_degrees": 0.1,
- "vessel_longitude_degrees": 0.1,
- "vessel_speed": 0.1,
- "vessel_course": 0.1,
- "vessel_heading": 0.1,
- "vessel_navigation_status": "string",
- "vessel_time_stamp": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_due_to_arrive
required | Array of objects (Vessel Particulars Information) non-empty
|
| vda_vessel_due_to_arrive_dt | string or null <date-time> (Vessel Due to Arrive Time)
|
| vda_vessel_location_from required | string (Location From)
|
| vda_vessel_location_to | string or null (Location To)
|
{- "vda_vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string"
}
], - "vda_vessel_due_to_arrive_dt": "2019-08-24T14:15:22Z",
- "vda_vessel_location_from": "string",
- "vda_vessel_location_to": "string"
}Data Element ID: vessel_information
required | Array of objects (Vessel Particulars Information) non-empty
|
| vessel_ism_manager | string or null (ISM Manager (If vessel flag is 'SG'))
|
| vessel_ship_manager | string or null (Ship Manager (if vessel flag is 'SG'))
|
| vessel_registered_ownership | string or null (Registered Ownership (if vessel flag is 'SG'))
|
| vessel_classification_society | string or null (Classification Society (if vessel flag is 'SG'))
|
| vessel_registration_status | string or null (Registration Status)
|
| vessel_registration_dt | string or null <date-time> (Registration Date)
|
| vessel_validity_dt | string or null <date-time> (Validity Date)
|
| vessel_date_of_closure | string or null <date-time> (Date of Closure)
|
| vessel_vessel_certificate_no | string or null (Certificate Number)
|
| vessel_issue_dt | string or null <date-time> (Issue Date)
|
| vessel_movement_start_dt | string or null <date-time> (Movement Start Date and Time)
|
| vessel_movement_end_dt | string or null <date-time> (Movement End Date and Time)
|
| vessel_movement_status | string or null (Movement Status)
|
| vessel_movement_type | string or null (Movement Type)
|
| vessel_location_from_cd required | string (Location From Code)
|
| vessel_location_to_cd | string or null (Location To Code)
|
| vessel_location_from required | string (Location From)
|
| vessel_location_to | string or null (Location To)
|
| vessel_movement_draft | number or null (Movement Draft)
|
| vessel_movement_height | number or null (Movement Height)
|
| vessel_arrived_dt | string or null <date-time> (Vessel Arrived Time)
|
| vessel_purpose | string or null (Vessel Purpose)
|
| vessel_location_cd | string or null (Location Code)
|
| vessel_location | string or null (Vessel Location)
|
| vessel_grid | string or null (Vessel Grid)
|
| vessel_arrival_agent | string or null (Agent of the Arrival Vessel)
|
| vessel_due_to_arrive_dt | string or null <date-time> (Vessel Due to Arrive Time)
|
| vessel_departed_dt | string or null <date-time> (Vessel Departed Time)
|
| vessel_departure_agent | string or null (Agent of the Departure Vessel)
|
| vessel_due_to_depart_dt | string or null <date-time> (Vessel Due to Depart)
|
| vessel_next_port | string or null (Next Port)
|
| vessel_next_port_of_call_country | string or null (Next Port of Call Country)
|
| vessel_cargo | number or null (Cargo)
|
| vessel_cert_issue_dt | string or null <date-time> (Date and Time of Certificate Issue)
|
| vessel_expiry_dt_of_port_certificate | string or null <date-time> (Expiry Date and Time of Port Certificate)
|
| vessel_master_nm | string or null (Master Name)
|
| vessel_datetime_of_querying required | string <date-time> (Querying Date Time)
|
{- "vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string",
- "vessel_length": 0,
- "vessel_breadth": 0,
- "vessel_depth": 0,
- "vessel_type": "string",
- "vessel_grosstonnage": 0,
- "vessel_nettonnage": 0,
- "vessel_deadweight": 0,
- "vessel_mmsi_number": 0,
- "vessel_year_built": 0
}
], - "vessel_ism_manager": "string",
- "vessel_ship_manager": "string",
- "vessel_registered_ownership": "string",
- "vessel_classification_society": "string",
- "vessel_registration_status": "string",
- "vessel_registration_dt": "2019-08-24T14:15:22Z",
- "vessel_validity_dt": "2019-08-24T14:15:22Z",
- "vessel_date_of_closure": "2019-08-24T14:15:22Z",
- "vessel_vessel_certificate_no": "string",
- "vessel_issue_dt": "2019-08-24T14:15:22Z",
- "vessel_movement_start_dt": "2019-08-24T14:15:22Z",
- "vessel_movement_end_dt": "2019-08-24T14:15:22Z",
- "vessel_movement_status": "string",
- "vessel_movement_type": "string",
- "vessel_location_from_cd": "string",
- "vessel_location_to_cd": "string",
- "vessel_location_from": "string",
- "vessel_location_to": "string",
- "vessel_movement_draft": 0,
- "vessel_movement_height": 0,
- "vessel_arrived_dt": "2019-08-24T14:15:22Z",
- "vessel_purpose": "string",
- "vessel_location_cd": "string",
- "vessel_location": "string",
- "vessel_grid": "string",
- "vessel_arrival_agent": "string",
- "vessel_due_to_arrive_dt": "2019-08-24T14:15:22Z",
- "vessel_departed_dt": "2019-08-24T14:15:22Z",
- "vessel_departure_agent": "string",
- "vessel_due_to_depart_dt": "2019-08-24T14:15:22Z",
- "vessel_next_port": "string",
- "vessel_next_port_of_call_country": "string",
- "vessel_cargo": 0,
- "vessel_cert_issue_dt": "2019-08-24T14:15:22Z",
- "vessel_expiry_dt_of_port_certificate": "2019-08-24T14:15:22Z",
- "vessel_master_nm": "string",
- "vessel_datetime_of_querying": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_movement
required | Array of objects (Vessel Particulars Information) non-empty
|
| vm_vessel_movement_start_dt | string or null <date-time> (Movement Start Date and Time)
|
| vm_vessel_movement_end_dt | string or null <date-time> (Movement End Date and Time)
|
| vm_vessel_movement_status | string or null (Movement Status)
|
| vm_vessel_movement_type | string or null (Movement Type)
|
| vm_vessel_location_from required | string (Location From)
|
| vm_vessel_location_to | string or null (Location To)
|
| vm_vessel_movement_draft | number or null (Movement Draft)
|
| vm_vessel_movement_height | number or null (Movement Height)
|
{- "vm_vessel_particulars": [
- {
- "vessel_nm": "string",
- "vessel_call_sign": "string",
- "vessel_imo_no": "string",
- "vessel_flag": "string"
}
], - "vm_vessel_movement_start_dt": "2019-08-24T14:15:22Z",
- "vm_vessel_movement_end_dt": "2019-08-24T14:15:22Z",
- "vm_vessel_movement_status": "string",
- "vm_vessel_movement_type": "string",
- "vm_vessel_location_from": "string",
- "vm_vessel_location_to": "string",
- "vm_vessel_movement_draft": 0,
- "vm_vessel_movement_height": 0
}Data Element ID: vvi
| vvi_vessel_nm required | string (Vessel Name)
|
| vvi_voyage_no required | string (Voyage Number)
|
| vvi_inward_voyage_no required | string (Inward Voyage Number)
|
| vvi_outward_voyage_no required | string (Outward Voyage Number)
|
| vvi_vessel_status required | string (Vessel Status)
|
| vvi_vessel_eta_dt | string or null <date-time> (Vessel Estimated Time of Arrival Date-Time)
|
| vvi_vessel_etd_dt | string or null <date-time> (Vessel Estimated Time of Departure Date-Time)
|
| vvi_vessel_ata_dt | string or null <date-time> (Vessel Actual Time of Arrival Date-Time)
|
| vvi_vessel_atd_dt | string or null <date-time> (Vessel Actual Time of Departure Date-Time)
|
| vvi_terminal_berth required | string (Terminal and Berth)
|
required | Array of objects (Time to Avoid) non-empty
|
{- "vvi_vessel_nm": "string",
- "vvi_voyage_no": "string",
- "vvi_inward_voyage_no": "string",
- "vvi_outward_voyage_no": "string",
- "vvi_vessel_status": "string",
- "vvi_vessel_eta_dt": "2019-08-24T14:15:22Z",
- "vvi_vessel_etd_dt": "2019-08-24T14:15:22Z",
- "vvi_vessel_ata_dt": "2019-08-24T14:15:22Z",
- "vvi_vessel_atd_dt": "2019-08-24T14:15:22Z",
- "vvi_terminal_berth": "string",
- "vvi_time_to_avoid": [
- {
- "location": "string",
- "start_dt": "2019-08-24T14:15:22Z",
- "end_dt": "2019-08-24T14:15:22Z"
}
]
}Data Element ID: vessel_activity
| container_no | string or null (Container Number)
|
| unique_cargo_ref | string or null (Unique Cargo Reference)
|
| vessel_imo | string or null (IMO Number)
|
| abbr_vessel_nm | string or null (Abbreviated Vessel Name)
|
| vessel_nm required | string (Full Vessel Name)
|
| abbr_inward_voy | string or null (Abbreviated Inward Voyage Number)
|
| inward_voyage_no required | string (Inward Voyage Number)
|
| abbr_outward_voy | string or null (Abbreviated Outward Voyage Number)
|
| outward_voyage_no required | string (Outward Voyage Number)
|
| vessel_btr_dt required | string <date-time> (Berthing Time Request Date-Time)
|
| vessel_etb_dt | string or null <date-time> (Vessel Estimated Time of Berthing Date-Time)
|
| vessel_etu_dt | string or null <date-time> (Vessel Estimated Time of Unberthing Date-Time)
|
| abbr_terminal_nm | string or null (Abbreviated Terminal Name)
|
| vessel_etd_dt | string or null <date-time> (Vessel Estimated Time of Departure Date-Time)
|
| terminal_berth required | string (Terminal and Berth)
|
| vessel_consortium_nm | string or null (Consortium Name)
|
| vessel_consortium_cd | string or null (Consortium Code)
|
| vessel_operator_cd required | string (Vessel Operator Code)
|
| vessel_operator_uen | string or null (Vessel Operator Unique Entity Number)
|
| vessel_operator_nm | string or null (Vessel Operator Name)
|
| vessel_psa_service | string or null (PSA Service Code)
|
| vessel_psa_service_desc | string or null (PSA Service Description)
|
| vessel_cust_service | string or null (Customer Service Code)
|
| vessel_cust_service_desc | string or null (Customer Service Description)
|
| vessel_status required | string (Vessel Status)
|
| vessel_shift_seq | string or null (Shift Sequence Number)
|
| vessel_atb_dt | string or null <date-time> (Vessel Actual Time of Berthing Date-Time)
|
| vessel_atu_dt | string or null <date-time> (Vessel Actual Time of Unberthing Date-Time)
|
| vessel_cod_dt | string or null <date-time> (Vessel Completion Of Discharge Date-Time)
|
| vessel_col_dt | string or null <date-time> (Vessel Completion Of Loading Date-Time)
|
| vessel_cob_dt | string or null <date-time> (Vessel Completion Of Bunker Date-Time)
|
| snapshot_dt required | string <date-time> (Snapshot Date-Time)
|
{- "container_no": "string",
- "unique_cargo_ref": "string",
- "vessel_imo": "string",
- "abbr_vessel_nm": "string",
- "vessel_nm": "string",
- "abbr_inward_voy": "string",
- "inward_voyage_no": "string",
- "abbr_outward_voy": "string",
- "outward_voyage_no": "string",
- "vessel_btr_dt": "2019-08-24T14:15:22Z",
- "vessel_etb_dt": "2019-08-24T14:15:22Z",
- "vessel_etu_dt": "2019-08-24T14:15:22Z",
- "abbr_terminal_nm": "string",
- "vessel_etd_dt": "2019-08-24T14:15:22Z",
- "terminal_berth": "string",
- "vessel_consortium_nm": "string",
- "vessel_consortium_cd": "string",
- "vessel_operator_cd": "string",
- "vessel_operator_uen": "string",
- "vessel_operator_nm": "string",
- "vessel_psa_service": "string",
- "vessel_psa_service_desc": "string",
- "vessel_cust_service": "string",
- "vessel_cust_service_desc": "string",
- "vessel_status": "string",
- "vessel_shift_seq": "string",
- "vessel_atb_dt": "2019-08-24T14:15:22Z",
- "vessel_atu_dt": "2019-08-24T14:15:22Z",
- "vessel_cod_dt": "2019-08-24T14:15:22Z",
- "vessel_col_dt": "2019-08-24T14:15:22Z",
- "vessel_cob_dt": "2019-08-24T14:15:22Z",
- "snapshot_dt": "2019-08-24T14:15:22Z"
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: crane_blockage
| vesselName required | string (Vessel Name) Name of vessel |
| voyageNumber required | string (Voyage Number) Loader full inward/ outward voyage number |
| numberOfBerthingSequences required | string (Number of Berthing Sequences) Number of berthing sequences to query/display |
{- "vesselName": "string",
- "voyageNumber": "string",
- "numberOfBerthingSequences": "string"
}Data Element ID: delivery_shipment_advice
| dsa_no required | string (DSA) Unique identifier for DSA. Delivery Shipment Advice |
| dsa_cargo_declarant required | string (Cargo Declarant) Name of cargo declarant |
{- "dsa_no": "string",
- "dsa_cargo_declarant": "string"
}Data Element ID: job_report_usn
| jr_usn required | string (USN) Unique identifier for job. Unique Shipment Number |
| jr_main_lighter_operator required | string (Main Lighter Operator) Name of assigned Lighter Operator |
{- "jr_usn": "string",
- "jr_main_lighter_operator": "string"
}Data Element ID: lighter_boat_loading_confirmation
| lighter_boat_loading_confirmation_usn required | string (USN) NA |
| lighter_boat_loading_confirmation_dsa_no required | string (DSA) NA |
{- "lighter_boat_loading_confirmation_usn": "string",
- "lighter_boat_loading_confirmation_dsa_no": "string"
}Data Element ID: lighter_boat_location
| lighter_loc_position_radius required | string (Position Radius (metres)) Radius of coverage from provided lighter boat coordinates |
| lighter_loc_position_latitude required | number (Position Latitude) Latitude coordinates of lighter boat. This field has a commonly agreed minimum decimal precision = 4 and maximum decimal precision = 10 |
| lighter_loc_position_longitude required | number (Position Longtitude) Longitude coordinates of lighter boat. This field has a commonly agreed minimum decimal precision = 4 and maximum decimal precision = 10 |
{- "lighter_loc_position_radius": "string",
- "lighter_loc_position_latitude": 0,
- "lighter_loc_position_longitude": 0
}Data Element ID: lighter_boat_schedule
| lighter_schedule_usn required | string (USN) Unique identifier for job. Unique Shipment Number |
| lighter_schedule_supply_boat_id required | string (Supply boat Identifier) Supply boat Identifier |
{- "lighter_schedule_usn": "string",
- "lighter_schedule_supply_boat_id": "string"
}Data Element ID: lighter_call
| lighter_call_lighter_nm required | string (Lighter Name) Name of lighter |
| lighter_call_usn required | string (USN) Unique identifier for job. Unique Shipment Number. |
{- "lighter_call_lighter_nm": "string",
- "lighter_call_usn": "string"
}Data Element ID: manifest
| manifest_vessel_nm required | string (Vessel Name) Vessel Name |
| manifest_vessel_destination required | string (Vessel Destination) Vessel Destination |
| manifest_vessel_eta required | string <date-time> (Vessel ETA) Estimated Time of Arrival (ETA) at vessel |
{- "manifest_vessel_nm": "string",
- "manifest_vessel_destination": "string",
- "manifest_vessel_eta": "2019-08-24T14:15:22Z"
}Data Element ID: mother_vessel_loading_confirmation
| mother_vessel_loading_confirmation_usn required | string (USN) Unique identifier for job. Unique Shipment Number |
{- "mother_vessel_loading_confirmation_usn": "string"
}Data Element ID: pallet_information
| pallet_info_usn required | string (USN) Unique identifier for job. Unique Shipment Number |
{- "pallet_info_usn": "string"
}Data Element ID: pilotage_service
| pilotage_imo required | string (International Maritime Organisation number) International Maritime Organisation (IMO) Vessel Identification number |
{- "pilotage_imo": "string"
}Data Element ID: product_catalogue
| product_catalogue_sku required | string (SKU) SKU |
| product_catalogue_nm required | string (Name) Name |
{- "product_catalogue_sku": "string",
- "product_catalogue_nm": "string"
}Data Element ID: product_offering
| product_offering_no required | string (Product information number) Product information number |
{- "product_offering_no": "string"
}Data Element ID: purchase_order_po
| po_no required | string (PO Number) PO Number |
{- "po_no": "string"
}Data Element ID: ship_supplies_di
| di_no required | string (DO Number) Delivery Order (DO) Number |
{- "di_no": "string"
}Data Element ID: ship_supplies_do
| do_no required | string (DO Number) Delivery Order (DO) Number |
{- "do_no": "string"
}Data Element ID: ship_supplies_invoice
| invoice_no required | string (Invoice Number) Identifier number of invoice |
{- "invoice_no": "string"
}Data Element ID: truck_location
| truck_loc_position_radius required | string (Position Radius (metres)) Radius of coverage from provided vehicle coordinates |
| truck_loc_position_latitude required | number (Position Latitude) Latitude coordinates of vehicle. This field has a commonly agreed minimum decimal precision = 4 and maximum decimal precision = 10 |
| truck_loc_position_longitude required | number (Position Longtitude) Longitude coordinates of vehicle. This field has a commonly agreed minimum decimal precision = 4 and maximum decimal precision = 10 |
{- "truck_loc_position_radius": "string",
- "truck_loc_position_latitude": 0,
- "truck_loc_position_longitude": 0
}Data Element ID: truck_schedule
| truck_schedule_usn required | string (USN) Unique identifier for job. Unique Shipment Number |
| truck_schedule_dsa required | string (DSA) Unique identifier for DSA. Delivery Shipment Advice |
{- "truck_schedule_usn": "string",
- "truck_schedule_dsa": "string"
}Data Element ID: vehicle_port_entry_exit
| vehicle_port_entry_exit_vehicle_no required | string (Vehicle Number) Registration number of the assigned vehicle |
{- "vehicle_port_entry_exit_vehicle_no": "string"
}Data Element ID: vessel_current_position
| vessel_nm required | string (Receiving Vessel Name) Name of the Vessel Note: Only latest data is available where applicable. |
{- "vessel_nm": "string"
}Data Element ID: vessel_information
| vessel_imo_no required | string (International Maritime Organisation Number) International Maritime Organisation (IMO) Vessel Identification Number, Note: For push, only latest data is available where applicable. For pull, this field will return results as at the query date and time supplied in "vessel_datetime_of_querying" (part of the parameter for this API). |
| vessel_datetime_of_querying required | string <date-time> (Querying Date Time) This field is used only for querying of vessel event data |
{- "vessel_imo_no": "string",
- "vessel_datetime_of_querying": "2019-08-24T14:15:22Z"
}Data Element ID: vessel_movement
| vessel_nm required | string (Receiving Vessel Name) Name of the Vessel, Note: For push, only latest data is available where applicable. For pull, this field will return results as at the query date and time supplied in "vessel_datetime_of_querying" (part of the parameter for this API). |
{- "vessel_nm": "string"
}Data Element ID: vvi
| vvi_vessel_nm required | string (Vessel Name) Name of vessel |
| vvi_voyage_no required | string (Voyage Number) Loader full inward/ outward voyage number |
{- "vvi_vessel_nm": "string",
- "vvi_voyage_no": "string"
}Data Element ID: vessel_activity
| vessel_nm required | string (Full Vessel Name) Full name of the vessel |
| voyage_no required | string (Voyage Number) Full inward/ outward voyage number |
{- "vessel_nm": "string",
- "voyage_no": "string"
}Data Element ID: liquid_bulk_agent_nomination_timestamp
| liquid_bulk_agent_nomination_timestamp_agent_nomination_of_terminal | string <date-time> (Agent nomination of terminal)
|
| liquid_bulk_vessel_clearance_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_vessel_clearance_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_vessel_clearance_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_agent_nomination_timestamp_agent_nomination_of_terminal": "2019-08-24T14:15:22Z",
- "liquid_bulk_vessel_clearance_timestamp_vessel_name": "string",
- "liquid_bulk_vessel_clearance_timestamp_imo_number": "string",
- "liquid_bulk_vessel_clearance_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_anchorage_timestamp
| liquid_bulk_moving_to_anchorage_timestamp_decide_to_move_vessel_from_sg_port_to_anchorage | string <date-time> (Submission of Q88)
|
| liquid_bulk_moving_to_anchorage_timestamp_instruct_agent_to_book_pilot_to_anchorage | string <date-time> (Instruct agent to Book pilot to anchorage)
|
| liquid_bulk_moving_to_anchorage_timestamp_pilot_booked | string <date-time> (Pilot booked)
|
| liquid_bulk_moving_to_anchorage_timestamp_pilot_order_confirmed | string <date-time> (Pilot order confirmed)
|
| liquid_bulk_moving_to_anchorage_timestamp_service_request_time | string <date-time> (Service request time)
|
| liquid_bulk_moving_to_anchorage_timestamp_cofirmed_service_time | string <date-time> (Cofirmed Service Time)
|
| liquid_bulk_moving_to_anchorage_timestamp_pilot_arrival_time | string <date-time> (Pilot Arrival Time)
|
| liquid_bulk_moving_to_anchorage_timestamp_pilot_onboard_time | string <date-time> (Pilot Onboard Time)
|
| liquid_bulk_moving_to_anchorage_timestamp_start_of_pilotage_service | string <date-time> (Start of Pilotage Service)
|
| liquid_bulk_moving_to_anchorage_timestamp_end_of_pilotage_service | string <date-time> (End of Pilotage Service)
|
| liquid_bulk_moving_to_anchorage_timestamp_vessel_arrive_at_anchorage | string <date-time> (Vessel arrive at anchorage)
|
| liquid_bulk_moving_to_anchorage_timestamp_vessel_tendering_nor | string <date-time> (Vessel tendering NOR)
|
| liquid_bulk_moving_to_anchorage_timestamp_sampling_tank_inspection_at_anchorage | string <date-time> (Sampling/Tank inspection at anchorage)
|
| liquid_bulk_anchorage_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_anchorage_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_anchorage_timestamp_anchorage_point required | string (Anchorage Point)
|
| liquid_bulk_anchorage_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_moving_to_anchorage_timestamp_decide_to_move_vessel_from_sg_port_to_anchorage": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_instruct_agent_to_book_pilot_to_anchorage": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_pilot_booked": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_pilot_order_confirmed": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_service_request_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_cofirmed_service_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_pilot_arrival_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_pilot_onboard_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_start_of_pilotage_service": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_end_of_pilotage_service": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_vessel_arrive_at_anchorage": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_vessel_tendering_nor": "2019-08-24T14:15:22Z",
- "liquid_bulk_moving_to_anchorage_timestamp_sampling_tank_inspection_at_anchorage": "2019-08-24T14:15:22Z",
- "liquid_bulk_anchorage_timestamp_vessel_name": "string",
- "liquid_bulk_anchorage_timestamp_imo_number": "string",
- "liquid_bulk_anchorage_timestamp_anchorage_point": "string",
- "liquid_bulk_anchorage_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_berthing_timestamp
| liquid_bulk_berthing_to_terminal_timestamp_instruct_agent_to_book_pilot_to_jetty | string <date-time> (Instruct agent to Book pilot to jetty)
|
| liquid_bulk_berthing_to_terminal_timestamp_time_actual_booking_is_done_by_agent | string <date-time> (Time actual booking is done by agent)
|
| liquid_bulk_berthing_to_terminal_timestamp_time_pilot_confirms_the_order | string <date-time> (Time pilot confirms the order)
|
| liquid_bulk_berthing_to_terminal_timestamp_service_request_time | string <date-time> (Service request time)
|
| liquid_bulk_berthing_to_terminal_timestamp_expected_boarding_time | string <date-time> (Expected boarding time)
|
| liquid_bulk_berthing_to_terminal_timestamp_pilot_arrival_time | string <date-time> (Pilot Arrival Time)
|
| liquid_bulk_berthing_to_terminal_timestamp_pilot_onboard_time | string <date-time> (Pilot Onboard Time)
|
| liquid_bulk_berthing_to_terminal_timestamp_start_of_pilotage_service | string <date-time> (Start of Pilotage Service)
|
| liquid_bulk_berthing_to_terminal_timestamp_end_of_pilotage_service | string <date-time> (End of Pilotage Service)
|
| liquid_bulk_berthing_to_terminal_timestamp_first_line_ashore | string <date-time> (First line ashore)
|
| liquid_bulk_berthing_to_terminal_timestamp_vessel_all_fast | string <date-time> (Vessel all fast)
|
| liquid_bulk_berthing_to_terminal_timestamp_gangway_down | string <date-time> (Gangway down)
|
| liquid_bulk_berthing_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_berthing_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_berthing_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_berthing_timestamp_jetty required | string (Jetty)
|
| liquid_bulk_berthing_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_berthing_to_terminal_timestamp_instruct_agent_to_book_pilot_to_jetty": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_time_actual_booking_is_done_by_agent": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_time_pilot_confirms_the_order": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_service_request_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_expected_boarding_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_pilot_arrival_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_pilot_onboard_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_start_of_pilotage_service": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_end_of_pilotage_service": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_first_line_ashore": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_vessel_all_fast": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_to_terminal_timestamp_gangway_down": "2019-08-24T14:15:22Z",
- "liquid_bulk_berthing_timestamp_vessel_name": "string",
- "liquid_bulk_berthing_timestamp_imo_number": "string",
- "liquid_bulk_berthing_timestamp_terminal": "string",
- "liquid_bulk_berthing_timestamp_jetty": "string",
- "liquid_bulk_berthing_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_cargo_post_ops_timestamp
| liquid_bulk_post_cargo_ops_surveyor_timestamp_surveyor_onboard | string <date-time> (Surveyor onboard)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_start_taking_sample | string <date-time> (Start taking sample)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_complete_taking_sample | string <date-time> (Complete taking sample)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_start_ullaging_calculation | string <date-time> (Start ullaging / calculation)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_complete_ullaging_calculation | string <date-time> (Complete ullaging / calculation)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_start_hose_disconnection | string <date-time> (Start Hose disconnection)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_surveyor_offboard | string <date-time> (Surveyor offboard)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_completed_hose_disconnection | string <date-time> (Completed hose disconnection)
|
| liquid_bulk_post_cargo_ops_surveyor_timestamp_documentation_on_board | string <date-time> (Documentation on board)
|
| liquid_bulk_cargo_post_ops_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_cargo_post_ops_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_cargo_post_ops_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_cargo_post_ops_timestamp_jetty required | string (Jetty)
|
| liquid_bulk_cargo_post_ops_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_post_cargo_ops_surveyor_timestamp_surveyor_onboard": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_start_taking_sample": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_complete_taking_sample": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_start_ullaging_calculation": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_complete_ullaging_calculation": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_start_hose_disconnection": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_surveyor_offboard": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_completed_hose_disconnection": "2019-08-24T14:15:22Z",
- "liquid_bulk_post_cargo_ops_surveyor_timestamp_documentation_on_board": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_post_ops_timestamp_vessel_name": "string",
- "liquid_bulk_cargo_post_ops_timestamp_imo_number": "string",
- "liquid_bulk_cargo_post_ops_timestamp_terminal": "string",
- "liquid_bulk_cargo_post_ops_timestamp_jetty": "string",
- "liquid_bulk_cargo_post_ops_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_cargo_pre_ops_timestamp
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_loading_master_onboard | string <date-time> (Loading master onboard)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_join_ship_shore_conference | string <date-time> (Join ship shore conference)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_leave_ship_shore_conference | string <date-time> (Leave ship shore conference)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_mla_hose_connection_start | string <date-time> (MLA/Hose connection start)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_mla_hose_connection_completed | string <date-time> (MLA/Hose connection completed)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nor_accepted | string <date-time> (NOR Accepted)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_hose_connected | string <date-time> (Nitrogen hose connected)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_purging_started | string <date-time> (Nitrogen purging started)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_purging_completed | string <date-time> (Nitrogen purging completed)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_blanketing_completed | string <date-time> (Nitrogen blanketing completed)
|
| liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_hose_disconnected | string <date-time> (Nitrogen hose disconnected)
|
| liquid_bulk_cargo_pre_ops_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_cargo_pre_ops_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_cargo_pre_ops_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_cargo_pre_ops_timestamp_jetty required | string (Jetty)
|
| liquid_bulk_cargo_pre_ops_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_loading_master_onboard": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_join_ship_shore_conference": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_leave_ship_shore_conference": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_mla_hose_connection_start": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_mla_hose_connection_completed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nor_accepted": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_hose_connected": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_purging_started": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_purging_completed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_blanketing_completed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_terminal_ops_timestamp_nitrogen_hose_disconnected": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_pre_ops_timestamp_vessel_name": "string",
- "liquid_bulk_cargo_pre_ops_timestamp_imo_number": "string",
- "liquid_bulk_cargo_pre_ops_timestamp_terminal": "string",
- "liquid_bulk_cargo_pre_ops_timestamp_jetty": "string",
- "liquid_bulk_cargo_pre_ops_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_cargo_transfer_timestamp
| liquid_bulk_cargo_transfer_timestamp_cargo_start | string <date-time> (Cargo start)
|
| liquid_bulk_cargo_transfer_timestamp_cargo_suspension | string <date-time> (Cargo suspension)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_loading_commence | string <date-time> (First foot loading commence)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_loading_completed | string <date-time> (First foot loading Completed)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_sampling_commenced | string <date-time> (First foot sampling commenced)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_sampling_completed | string <date-time> (First foot sampling completed)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_sample_taken | string <date-time> (First foot sample taken)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_sample_passed | string <date-time> (First foot sample passed)
|
| liquid_bulk_cargo_transfer_timestamp_clearance_to_resume_cargo_ops | string <date-time> (Clearance to resume cargo ops)
|
| liquid_bulk_cargo_transfer_timestamp_first_foot_resume | string <date-time> (First foot resume)
|
| liquid_bulk_cargo_transfer_timestamp_cargo_resume | string <date-time> (Cargo resume)
|
| liquid_bulk_cargo_transfer_timestamp_cargo_completed | string <date-time> (Cargo completed)
|
| liquid_bulk_cargo_transfer_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_cargo_transfer_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_cargo_transfer_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_cargo_transfer_timestamp_jetty required | string (Jetty)
|
| liquid_bulk_cargo_transfer_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_cargo_transfer_timestamp_cargo_start": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_cargo_suspension": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_loading_commence": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_loading_completed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_sampling_commenced": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_sampling_completed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_sample_taken": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_sample_passed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_clearance_to_resume_cargo_ops": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_first_foot_resume": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_cargo_resume": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_cargo_completed": "2019-08-24T14:15:22Z",
- "liquid_bulk_cargo_transfer_timestamp_vessel_name": "string",
- "liquid_bulk_cargo_transfer_timestamp_imo_number": "string",
- "liquid_bulk_cargo_transfer_timestamp_terminal": "string",
- "liquid_bulk_cargo_transfer_timestamp_jetty": "string",
- "liquid_bulk_cargo_transfer_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_cargo_unberthing_timestamp
| liquid_bulk_unberthing_timestamp_instruct_agent_to_book_pilot_to_leave_jetty | string <date-time> (Instruct agent to Book pilot to leave jetty)
|
| liquid_bulk_unberthing_timestamp_booking_time | string <date-time> (Booking time)
|
| liquid_bulk_unberthing_timestamp_confirmation_time | string <date-time> (Confirmation time)
|
| liquid_bulk_unberthing_timestamp_service_request_time | string <date-time> (Service request time)
|
| liquid_bulk_unberthing_timestamp_expected_boarding_time | string <date-time> (Expected boarding time)
|
| liquid_bulk_unberthing_timestamp_pilot_arrival_time | string <date-time> (Pilot Arrival Time)
|
| liquid_bulk_unberthing_timestamp_pilot_onboard_time | string <date-time> (Pilot Onboard Time)
|
| liquid_bulk_unberthing_timestamp_start_of_pilotage_service | string <date-time> (Start of Pilotage Service)
|
| liquid_bulk_unberthing_timestamp_end_of_pilotage_service | string <date-time> (End of Pilotage Service)
|
| liquid_bulk_unberthing_timestamp_vessel_cast_off | string <date-time> (Vessel cast off)
|
| liquid_bulk_unberthing_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_unberthing_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_unberthing_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_unberthing_timestamp_jetty required | string (Jetty)
|
| liquid_bulk_unberthing_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_unberthing_timestamp_instruct_agent_to_book_pilot_to_leave_jetty": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_booking_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_confirmation_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_service_request_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_expected_boarding_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_pilot_arrival_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_pilot_onboard_time": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_start_of_pilotage_service": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_end_of_pilotage_service": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_vessel_cast_off": "2019-08-24T14:15:22Z",
- "liquid_bulk_unberthing_timestamp_vessel_name": "string",
- "liquid_bulk_unberthing_timestamp_imo_number": "string",
- "liquid_bulk_unberthing_timestamp_terminal": "string",
- "liquid_bulk_unberthing_timestamp_jetty": "string",
- "liquid_bulk_unberthing_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_pre_berthing_timestamp
| liquid_bulk_pre_berthing_process_timestamp_complete_submission_of_pbq | string <date-time> (Complete submission of PBQ)
|
| liquid_bulk_pre_berthing_process_timestamp_advance_eta_notice_prior_to_arrival_in_sg | string <date-time> (Advance ETA notice prior to arrival in SG)
|
| liquid_bulk_pre_berthing_process_timestamp_entering_and_updating_vessel_eta | string <date-time> (Entering and updating vessel ETA)
|
| liquid_bulk_pre_berthing_process_timestamp_entering_&_updating_work_order_log_job | string <date-time> (Entering & updating Work order/log job)
|
| liquid_bulk_pre_berthing_process_timestamp_vessel_arrival_in_singapore_port | string <date-time> (Vessel arrival in Singapore port)
|
| liquid_bulk_pre_berthing_process_timestamp_vessel_tendering_nor | string <date-time> (Vessel tendering NOR)
|
| liquid_bulk_pre_berthing_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_pre_berthing_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_pre_berthing_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_pre_berthing_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_pre_berthing_process_timestamp_complete_submission_of_pbq": "2019-08-24T14:15:22Z",
- "liquid_bulk_pre_berthing_process_timestamp_advance_eta_notice_prior_to_arrival_in_sg": "2019-08-24T14:15:22Z",
- "liquid_bulk_pre_berthing_process_timestamp_entering_and_updating_vessel_eta": "2019-08-24T14:15:22Z",
- "liquid_bulk_pre_berthing_process_timestamp_entering_&_updating_work_order_log_job": "2019-08-24T14:15:22Z",
- "liquid_bulk_pre_berthing_process_timestamp_vessel_arrival_in_singapore_port": "2019-08-24T14:15:22Z",
- "liquid_bulk_pre_berthing_process_timestamp_vessel_tendering_nor": "2019-08-24T14:15:22Z",
- "liquid_bulk_pre_berthing_timestamp_vessel_name": "string",
- "liquid_bulk_pre_berthing_timestamp_imo_number": "string",
- "liquid_bulk_pre_berthing_timestamp_terminal": "string",
- "liquid_bulk_pre_berthing_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_terminal_nomination_timestamp
| liquid_bulk_customer_nomination_timestamp_entering_initial_nomination | string <date-time> (Entering initial nomination)
|
| liquid_bulk_customer_nomination_timestamp_entering_update_nomination | string <date-time> (Entering update nomination)
|
| liquid_bulk_customer_nomination_timestamp_cancelation_of_nomination | string <date-time> (Cancelation of nomination)
|
| liquid_bulk_customer_nomination_timestamp_acceptance_of_nomination | string <date-time> (Acceptance of nomination)
|
| liquid_bulk_customer_nomination_timestamp_rejection_of_nomination | string <date-time> (Rejection of nomination)
|
| liquid_bulk_customer_nomination_timestamp_appointment_of_surveyor_agent | string (Appointment of surveyor and agent)
|
| liquid_bulk_vessel_clearance_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_vessel_clearance_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_vessel_clearance_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_vessel_clearance_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_customer_nomination_timestamp_entering_initial_nomination": "2019-08-24T14:15:22Z",
- "liquid_bulk_customer_nomination_timestamp_entering_update_nomination": "2019-08-24T14:15:22Z",
- "liquid_bulk_customer_nomination_timestamp_cancelation_of_nomination": "2019-08-24T14:15:22Z",
- "liquid_bulk_customer_nomination_timestamp_acceptance_of_nomination": "2019-08-24T14:15:22Z",
- "liquid_bulk_customer_nomination_timestamp_rejection_of_nomination": "2019-08-24T14:15:22Z",
- "liquid_bulk_customer_nomination_timestamp_appointment_of_surveyor_agent": "string",
- "liquid_bulk_vessel_clearance_timestamp_imo_number": "string",
- "liquid_bulk_vessel_clearance_timestamp_terminal": "string",
- "liquid_bulk_vessel_clearance_timestamp_vessel_name": "string",
- "liquid_bulk_vessel_clearance_timestamp_remarks": "string"
}Data Element ID: liquid_bulk_vessel_clearance_timestamp
| liquid_bulk_vessel_clearance_submission_of_q88 | string <date-time> (Submission of Q88)
|
| liquid_bulk_vessel_clearance_receiving_of_q88 | string <date-time> (Receiving of Q88)
|
| liquid_bulk_vessel_clearance_confirmation_vessel_clearance | string <date-time> (Confirmation of vessel clearance)
|
| liquid_bulk_vessel_clearance_acknowledge_confirmation_vessel_clearance | string <date-time> (Acknowledge confirmation of clearance)
|
| liquid_bulk_vessel_clearance_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_vessel_clearance_timestamp_imo_number | string (IMO Number)
|
| liquid_bulk_vessel_clearance_timestamp_terminal required | string (Terminal)
|
| liquid_bulk_vessel_clearance_timestamp_jetty | string (Jetty)
|
| liquid_bulk_vessel_clearance_timestamp_remarks | string (Remarks)
|
{- "liquid_bulk_vessel_clearance_submission_of_q88": "2019-08-24T14:15:22Z",
- "liquid_bulk_vessel_clearance_receiving_of_q88": "2019-08-24T14:15:22Z",
- "liquid_bulk_vessel_clearance_confirmation_vessel_clearance": "2019-08-24T14:15:22Z",
- "liquid_bulk_vessel_clearance_acknowledge_confirmation_vessel_clearance": "2019-08-24T14:15:22Z",
- "liquid_bulk_vessel_clearance_timestamp_vessel_name": "string",
- "liquid_bulk_vessel_clearance_timestamp_imo_number": "string",
- "liquid_bulk_vessel_clearance_timestamp_terminal": "string",
- "liquid_bulk_vessel_clearance_timestamp_jetty": "string",
- "liquid_bulk_vessel_clearance_timestamp_remarks": "string"
}Data Element ID: demurrage_pilotage_service
| pilot_order_no required | string (OHS Pilot Order Number)
|
| pilot_imo_no required | string (IMO Number)
|
| pilot_location_to required | string (Location_To)
|
| pilot_location_from required | string (Location_From)
|
| pilot_service_request_time_agent_toa required | string <date-time> (Pilot Booking Request Time (Time of Advice))
|
| pilot_service_request_time required | string <date-time> (Pilot Service Request Time (SRT))
|
| pilot_booking_confirmed_time | string or null <date-time> (Pilot Booking Confirmed Time (CST))
|
| pilot_arrival_time | string or null <date-time> (Pilot Arrival Start Time)
|
| pilot_cancellation_requestor | string or null (Pilot Cancellation Requestor)
|
| pilot_onboard_time | string or null <date-time> (Pilot Onboard Time)
|
| pilotage_start_time | string or null <date-time> (Pilotage Start/Vessel Cast-off Time)
|
| pilotage_end_time | string or null <date-time> (Pilotage End Time)
|
| pilotage_delay_start_time | string or null <date-time> (Pilotage Delay Start Time)
|
| pilotage_delay_duration | number or null <double> (Pilotage Delay Duration)
|
| pilotage_delay_reason | string or null (Pilotage Delay Reason)
|
| pilotage_etub | string or null <date-time> (Estimated Time of Unberthing)
|
{- "pilot_order_no": "string",
- "pilot_imo_no": "string",
- "pilot_location_to": "string",
- "pilot_location_from": "string",
- "pilot_service_request_time_agent_toa": "2019-08-24T14:15:22Z",
- "pilot_service_request_time": "2019-08-24T14:15:22Z",
- "pilot_booking_confirmed_time": "2019-08-24T14:15:22Z",
- "pilot_arrival_time": "2019-08-24T14:15:22Z",
- "pilot_cancellation_requestor": "string",
- "pilot_onboard_time": "2019-08-24T14:15:22Z",
- "pilotage_start_time": "2019-08-24T14:15:22Z",
- "pilotage_end_time": "2019-08-24T14:15:22Z",
- "pilotage_delay_start_time": "2019-08-24T14:15:22Z",
- "pilotage_delay_duration": 0.1,
- "pilotage_delay_reason": "string",
- "pilotage_etub": "2019-08-24T14:15:22Z"
}Data Element ID: terminal_berthing_unberthing
| serviceProviderCompanyId required | string (Service Provider Company ID (UEN))
|
| adviceCode | string or null (Advice Code)
|
| vesselId | string or null (Vessel ID Number)
|
| vesselIMONumber | string or null (Vessel IMO Number)
|
| vesselName required | string (Vessel Name)
|
| vesselCallSignNumber | string or null (Vessel Call Sign)
|
| vesselFullInVoyNumber | string or null (Vessel Inward Voyage Number)
|
| vesselFullOutVoyNumber | string or null (Vessel Outward Voyage Number)
|
| shiftSeqNumber required | integer <int64> (Berthing Shift Sequence)
|
| terminalCode | string or null (Terminal Code)
|
| berthNumber | string or null (Berth Number)
|
| btrDateTime required | string <date-time> (Berth Time Required)
|
| ubtrDateTime required | string <date-time> (Unberth Time Required)
|
| etbDateTime | string or null <date-time> (Estimated Time of Berth)
|
| etuDateTime | string or null <date-time> (Estimated Time of Unberthing)
|
| atbDateTime | string or null <date-time> (Actual Time of Berth)
|
| atuDateTime | string or null <date-time> (Actual Time of Unberthing)
|
| agentId required | string (Agent UEN)
|
{- "serviceProviderCompanyId": "string",
- "adviceCode": "string",
- "vesselId": "string",
- "vesselIMONumber": "string",
- "vesselName": "string",
- "vesselCallSignNumber": "string",
- "vesselFullInVoyNumber": "string",
- "vesselFullOutVoyNumber": "string",
- "shiftSeqNumber": 0,
- "terminalCode": "string",
- "berthNumber": "string",
- "btrDateTime": "2019-08-24T14:15:22Z",
- "ubtrDateTime": "2019-08-24T14:15:22Z",
- "etbDateTime": "2019-08-24T14:15:22Z",
- "etuDateTime": "2019-08-24T14:15:22Z",
- "atbDateTime": "2019-08-24T14:15:22Z",
- "atuDateTime": "2019-08-24T14:15:22Z",
- "agentId": "string"
}Data Element ID: terminal_operations_arrival_information
| toai_arrival_id required | string (Arrival ID)
|
| toai_arrival_id_status required | string (Arrival ID Status)
|
| toai_pilot_on_board_for_mooring_time required | string <date-time> (Pilot on Board for Mooring Time)
|
| toai_jetty_berth_location required | string (Jetty/Berth)
|
| toai_imo_number required | string (IMO Number)
|
| toai_vessel_name required | string (Vessel Name)
|
| toai_vessel_size_dwt required | number <double> (Vessel Size (DWT))
|
required | Array of objects (Work Order Items)
|
| toai_first_line_rope_ashore_time | string or null <date-time> (First Line/Rope Ashore Time)
|
| toai_all_fast_time | string or null <date-time> (All fast Time)
|
| toai_pilot_on_board_for_unmooring_time | string or null <date-time> (Pilot on Board for Unmooring Time)
|
| toai_documentation_on_board_time | string or null <date-time> (Documentation On Board Time)
|
| toai_agent | string or null (Agent)
|
| toai_atb | string or null <date-time> (Actual Time of Berthing)
|
{- "toai_arrival_id": "string",
- "toai_arrival_id_status": "string",
- "toai_pilot_on_board_for_mooring_time": "2019-08-24T14:15:22Z",
- "toai_jetty_berth_location": "string",
- "toai_imo_number": "string",
- "toai_vessel_name": "string",
- "toai_vessel_size_dwt": 0.1,
- "toai_work_order_items": [
- {
- "work_order_id": "string"
}
], - "toai_first_line_rope_ashore_time": "2019-08-24T14:15:22Z",
- "toai_all_fast_time": "2019-08-24T14:15:22Z",
- "toai_pilot_on_board_for_unmooring_time": "2019-08-24T14:15:22Z",
- "toai_documentation_on_board_time": "2019-08-24T14:15:22Z",
- "toai_agent": "string",
- "toai_atb": "2019-08-24T14:15:22Z"
}Data Element ID: terminal_operations_tank_information
| tosi_work_order_id required | string (Work Order ID)
|
| tosi_tank_number required | string (Tank Number)
|
| tosi_work_order_sequence_number required | string (Work Order Sequence Number)
|
| tosi_product_name required | string (Product Name)
|
| tosi_product_quantity_in_l-obs required | number <double> (Product Quantity in L-obs)
|
| tosi_product_quantity_in_l-15-c required | number <double> (Product Quantity in L-15-C)
|
| tosi_product_quantity_in_mt required | number <double> (Product Quantity in Mt)
|
| tosi_product_quantity_in_mtv required | number <double> (Product Quantity in MtV)
|
| tosi_product_quantity_in_Bls-60-f required | number <double> (Product Quantity in Bls-60-F)
|
| tosi_cargo_start_first_foot_start_time | string <date-time> (Cargo Start/ First Foot Loading Start Time)
|
| tosi_first_foot_end_time | string or null <date-time> (First Foot Loading End Time)
|
| tosi_first_foot_clear_time | string or null <date-time> (First Foot Sampling Passed/Clearance Time)
|
| tosi_first_foot_resume_time | string or null <date-time> (Cargo Resume (after First Foot) Time)
|
| tosi_cargo_end_time | string or null <date-time> (Cargo End Time)
|
Array of objects or null (Cease Cargo Operation (uncalled for) items)
|
{- "tosi_work_order_id": "string",
- "tosi_tank_number": "string",
- "tosi_work_order_sequence_number": "string",
- "tosi_product_name": "string",
- "tosi_product_quantity_in_l-obs": 0.1,
- "tosi_product_quantity_in_l-15-c": 0.1,
- "tosi_product_quantity_in_mt": 0.1,
- "tosi_product_quantity_in_mtv": 0.1,
- "tosi_product_quantity_in_Bls-60-f": 0.1,
- "tosi_cargo_start_first_foot_start_time": "2019-08-24T14:15:22Z",
- "tosi_first_foot_end_time": "2019-08-24T14:15:22Z",
- "tosi_first_foot_clear_time": "2019-08-24T14:15:22Z",
- "tosi_first_foot_resume_time": "2019-08-24T14:15:22Z",
- "tosi_cargo_end_time": "2019-08-24T14:15:22Z",
- "tosi_cargo_cease_items": [
- {
- "cease_time": "2019-08-24T14:15:22Z",
- "continue_time": "2019-08-24T14:15:22Z"
}
]
}Data Element ID: terminal_operations_work_order_information
| towoi_work_order_id required | string (Work Order ID)
|
| towoi_work_order_status required | string (Work Order ID Status)
|
| toiwo_work_order_customer_name required | string (Customer Name)
|
| towoi_nor_tendered_time required | string <date-time> (Vessel tendering NOR Time)
|
| towoi_work_order_operation_type required | string (Operation Type)
|
| towoi_nor_accepted_time | string or null <date-time> (NOR Acceptance Time from Terminal)
|
| towoi_hose_connect_end_time | string or null <date-time> (Hose Connect End Time)
|
| towoi_hose_disconnect_end_time | string or null <date-time> (Hose Disconnection End Time)
|
| towoi_work_order_surveyor | string or null (Surveyor)
|
{- "towoi_work_order_id": "string",
- "towoi_work_order_status": "string",
- "toiwo_work_order_customer_name": "string",
- "towoi_nor_tendered_time": "2019-08-24T14:15:22Z",
- "towoi_work_order_operation_type": "string",
- "towoi_nor_accepted_time": "2019-08-24T14:15:22Z",
- "towoi_hose_connect_end_time": "2019-08-24T14:15:22Z",
- "towoi_hose_disconnect_end_time": "2019-08-24T14:15:22Z",
- "towoi_work_order_surveyor": "string"
}Data Element ID: demurrage_terminal_pilot_booking_information
| lqb_order_creation_time required | string <date-time> (LqB Order creation time)
|
| lqb_pilot_on_board_time required | string <date-time> (LqB Pilot On Board (POB) Time)
|
| pilot_lqb_imo_no required | string (IMO Number)
|
| pilot_lqb_location_to required | string (Location_To)
|
| pilot_lqb_location_from required | string (Location_From)
|
| lqb_agent_acknowledgment_time | string or null <date-time> (LqB Agent Acknowledgment Time)
|
{- "lqb_order_creation_time": "2019-08-24T14:15:22Z",
- "lqb_pilot_on_board_time": "2019-08-24T14:15:22Z",
- "pilot_lqb_imo_no": "string",
- "pilot_lqb_location_to": "string",
- "pilot_lqb_location_from": "string",
- "lqb_agent_acknowledgment_time": "2019-08-24T14:15:22Z"
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: liquid_bulk_agent_nomination_timestamp
| liquid_bulk_vessel_clearance_timestamp_vessel_name required | string (Vessel Name)
|
{- "liquid_bulk_vessel_clearance_timestamp_vessel_name": "string"
}Data Element ID: liquid_bulk_anchorage_timestamp
| liquid_bulk_anchorage_timestamp_vessel_name | string (Vessel Name)
|
{- "liquid_bulk_anchorage_timestamp_vessel_name": "string"
}Data Element ID: liquid_bulk_berthing_timestamp
| liquid_bulk_berthing_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_berthing_timestamp_jetty required | string (Jetty)
|
{- "liquid_bulk_berthing_timestamp_vessel_name": "string",
- "liquid_bulk_berthing_timestamp_jetty": "string"
}Data Element ID: liquid_bulk_cargo_post_ops_timestamp
| liquid_bulk_cargo_post_ops_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_cargo_post_ops_timestamp_jetty required | string (Jetty)
|
{- "liquid_bulk_cargo_post_ops_timestamp_vessel_name": "string",
- "liquid_bulk_cargo_post_ops_timestamp_jetty": "string"
}Data Element ID: liquid_bulk_cargo_pre_ops_timestamp
| liquid_bulk_cargo_pre_ops_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_cargo_pre_ops_timestamp_jetty required | string (Jetty)
|
{- "liquid_bulk_cargo_pre_ops_timestamp_vessel_name": "string",
- "liquid_bulk_cargo_pre_ops_timestamp_jetty": "string"
}Data Element ID: liquid_bulk_cargo_transfer_timestamp
| liquid_bulk_cargo_transfer_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_cargo_transfer_timestamp_jetty required | string (Jetty)
|
{- "liquid_bulk_cargo_transfer_timestamp_vessel_name": "string",
- "liquid_bulk_cargo_transfer_timestamp_jetty": "string"
}Data Element ID: liquid_bulk_cargo_unberthing_timestamp
| liquid_bulk_unberthing_timestamp_vessel_name required | string (Vessel Name)
|
| liquid_bulk_unberthing_timestamp_jetty required | string (Jetty)
|
{- "liquid_bulk_unberthing_timestamp_vessel_name": "string",
- "liquid_bulk_unberthing_timestamp_jetty": "string"
}Data Element ID: liquid_bulk_pre_berthing_timestamp
| liquid_bulk_pre_berthing_timestamp_vessel_name required | string (Vessel Name)
|
{- "liquid_bulk_pre_berthing_timestamp_vessel_name": "string"
}Data Element ID: liquid_bulk_terminal_nomination_timestamp
| liquid_bulk_vessel_clearance_timestamp_vessel_name required | string (Vessel Name)
|
{- "liquid_bulk_vessel_clearance_timestamp_vessel_name": "string"
}Data Element ID: liquid_bulk_vessel_clearance_timestamp
| liquid_bulk_vessel_clearance_timestamp_vessel_name required | string (Vessel Name)
|
{- "liquid_bulk_vessel_clearance_timestamp_vessel_name": "string"
}Data Element ID: bill_of_lading_verification
| blv_carrier_name required | string (Carrier Name)
|
| blv_bl_number required | string (BL Number)
|
| blv_issuance_date | string or null <date> (Issuance Date)
|
| blv_vessel_name | string or null (Vessel Name)
|
| blv_vessel_imo_number | string or null (Vessel IMO Number)
|
| blv_port_of_loading | string or null (Port of Loading)
|
| blv_port_of_discharge | string or null (Port of Discharge)
|
| blv_quantity_value | string or null (Quantity - Value)
|
| blv_quantity_unit_of_measure_code | string or null (Quantity - Unit of Measure Code)
|
| blv_quantity_other_unit_of_measure | string or null (Quantity - Other Unit of Measure)
|
| blv_goods_description | string or null (Goods Description)
|
| blv_shipper_name | string or null (Shipper Name)
|
| blv_consignee_name | string or null (Consignee Name)
|
| blv_shipper_country | string or null (Shipper Country)
|
| blv_consignee_country | string or null (Consignee Country)
|
| blv_error_code | string or null (Error Code)
|
{- "blv_carrier_name": "string",
- "blv_bl_number": "string",
- "blv_issuance_date": "2019-08-24",
- "blv_vessel_name": "string",
- "blv_vessel_imo_number": "string",
- "blv_port_of_loading": "string",
- "blv_port_of_discharge": "string",
- "blv_quantity_value": "string",
- "blv_quantity_unit_of_measure_code": "string",
- "blv_quantity_other_unit_of_measure": "string",
- "blv_goods_description": "string",
- "blv_shipper_name": "string",
- "blv_consignee_name": "string",
- "blv_shipper_country": "string",
- "blv_consignee_country": "string",
- "blv_error_code": "string"
}Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: bill_of_lading_verification
| blv_carrier_name required | string (Carrier Name) Issuing shipping line, Max characters= 70 |
| blv_bl_number required | string (BL Number) Unique identifier of the transport document allocated by the shipping line, Max characters= 35 |
{- "blv_carrier_name": "string",
- "blv_bl_number": "string"
}Data Element ID: certificate_of_origin
| bol_no | string or null (Bill of Lading / Transport Contract Document Number)
|
| inv_no | string or null (Invoice Number)
|
| contract_no | string or null (Contract Number)
|
| coo_doc_identifier | string or null (Document Identifier)
|
| coo_doc_credit_identifier | string or null (Documentary Credit Identifier)
|
| coo_po_no | string or null (Purchase Order Number)
|
| coo_no required | string (Certificate of Origin Number)
|
| coo_issue_dt required | string <date> (Issue Date)
|
| coo_consignee | string or null (Consignee)
|
| coo_consignor | string or null (Consignor)
|
| coo_importer | string or null (Importer)
|
| coo_exporter required | string (Exporter)
|
| coo_origin_country required | string (Origin Country)
|
| coo_pod | string or null (Place of Departure)
|
| coo_grossweight required | string (Gross Weight)
|
| coo_netweight | string or null (Net Weight)
|
| coo_transport_grossweight | string or null (Transport Means, gross weight)
|
required | Array of objects (Goods Details)
|
| coo_transport_identifier | string or null (Transport Means Identifier)
|
| coo_vehicle_no | string or null (Vehicle Registration Number)
|
| coo_equipment_identifier | string or null (Transport Equipment Identifier)
|
| coo_container_iso | string or null (Container Size and Type)
|
| coo_transport_mode | string or null (Mode of Transport)
|
Array of objects or null (Certificate of Origin Attachment)
|
{- "bol_no": "string",
- "inv_no": "string",
- "contract_no": "string",
- "coo_doc_identifier": "string",
- "coo_doc_credit_identifier": "string",
- "coo_po_no": "string",
- "coo_no": "string",
- "coo_issue_dt": "2019-08-24",
- "coo_consignee": "string",
- "coo_consignor": "string",
- "coo_importer": "string",
- "coo_exporter": "string",
- "coo_origin_country": "string",
- "coo_pod": "string",
- "coo_grossweight": "string",
- "coo_netweight": "string",
- "coo_transport_grossweight": "string",
- "coo_goods": [
- {
- "description": "string",
- "packages_no": "string",
- "hscode": "string",
- "packages_type": "string",
- "product_identifier": "string",
- "shipping_marks": "string"
}
], - "coo_transport_identifier": "string",
- "coo_vehicle_no": "string",
- "coo_equipment_identifier": "string",
- "coo_container_iso": "string",
- "coo_transport_mode": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: ebl_dcsa
required | Array of objects (Document)
|
required | Array of objects (Issue To)
|
| dcsa_ebl_jurisdiction required | string (Jurisdiction )
|
| dcsa_ebl_seat required | string (Seat)
|
required | Array of objects (Electronic Bill of Lading Attachment)
|
{- "dcsa_ebl_document": [
- {
- "bol_ref": "string",
- "shipping_ref": "string",
- "status": "string",
- "shipped_onboard": true,
- "freight_payment_cd": "PRE",
- "origin_charges_cd": "PRE",
- "destination_charges_cd": "PRE",
- "to_order": true,
- "place_of_receipt": [
- "string"
], - "port_of_load": [
- "string"
], - "port_of_discharge": [
- "string"
], - "place_of_delivery": [
- "string"
], - "shipped_onboard_date": "2019-08-24",
- "terms_and_conditions": "string",
- "origin_receipt_type": "CY",
- "destination_delivery_type": "CY",
- "origin_cargo_movement_type": "str",
- "destination_cargo_movement_type": "str",
- "issue_date": "2019-08-24",
- "received_shipment_date": "2019-08-24",
- "service_contract_ref": "string",
- "contract_quotation_ref": "string",
- "declared_value": 0.1,
- "declared_currency": "str",
- "carrier_cd": "stri",
- "carrier_cd_provider": "SMDG",
- "issuing_party": [
- {
- "name": "Asseco Denmark",
- "address": "Henrik",
- "country": "The Netherlands",
- "contact_nm": "Henrik",
- "contact_type": "Phone",
- "contact_details": "string",
- "identifying_code": "MSK",
- "code_provider": "SMDG",
- "code_name": "LCL",
- "tax_ref_type": "PAN",
- "tax_country_cd": "DK",
- "tax_ref": "AAAAA0000A"
}
], - "carrier_clause": "It is not allowed to…",
- "transports": [
- {
- "planned_arrival_date": "2019-08-24",
- "planned_departure_date": "2019-08-24",
- "pre_carriage": "RAIL",
- "on_carriage": "RAIL",
- "receipt_location_nm": "Port of Amsterdam",
- "receipt_location_type": "FACI",
- "receipt_unlocation_cd": "FRPAR",
- "receipt_facility_cd": "ADT",
- "receipt_facility_cd_provider": "SMDG",
- "pol_location_nm": "Port of Amsterdam",
- "pol_location_type": "UNLO",
- "pol_unlocation_cd": "FRPAR",
- "delivery_location_nm": "Port of Amsterdam",
- "delivery_location_type": "FACI",
- "delivery_unlocation_cd": "FRPAR",
- "delivery_facility_cd": "ADT",
- "delivery_facility_cd_provider": "SMDG",
- "pod_location_nm": "Port of Amsterdam",
- "pod_location_type": "UNLO",
- "pod_unlocation_cd": "FRPAR",
- "routing_location_nm": "Port of Amsterdam",
- "routing_location_type": "FACI",
- "routing_unlocation_cd": "FRPAR",
- "routing_facility_cd": "ADT",
- "routing_facility_cd_provider": "SMDG",
- "vessel_nm": "King of the Seas",
- "voy_no": "2103S",
- "universal_voy_no": "2103N"
}
], - "charges": [
- {
- "name": "Documentation fee - Destination",
- "currency_amount": 1012.12,
- "currency_cd": "DKK",
- "payment_term": "PRE",
- "calculation_basis": "Per day",
- "unit_price": 3456.6,
- "quantity": 34.4
}
], - "issue_place": [
- {
- "location_nm": "Port of Amsterdam",
- "location_type": "UNLO",
- "unlocation_cd": "FRPAR"
}
], - "invoice_payable_at": [
- {
- "location_nm": "Port of Amsterdam",
- "location_type": "UNLO",
- "unlocation_cd": "FRPAR"
}
], - "contact_details": [
- {
- "contact_nm": "Henrik",
- "contact_type": "Phone",
- "contact_value": "string"
}
], - "consignment": [
- {
- "booking_ref": "ABC709951",
- "weight": 13000.3,
- "weight_unit": "KGM",
- "volume": 12,
- "volume_unit": "MTQ",
- "goods_description": "300 boxes of blue shoes size 47",
- "hscode": [
- 851713
], - "references": [
- {
- "type": "FF",
- "value": "HHL00103004"
}
], - "custom_references": [
- {
- "type": "ACID",
- "country_cd": "DK",
- "value": 4988470982020120000
}
], - "cargo_items": [
- {
- "shipping_marks": "Made in China",
- "equipment_ref": "APZU4812090",
- "weight": 13000.3,
- "weight_unit": "KGM",
- "volume": 12,
- "volume_unit": "MTQ",
- "outer_packaging": [
- {
- "package_cd": "5H",
- "package_no": 18,
- "description": "Drum, steel",
- "imo_packaging_cd": "1A2",
- "dangerous_goods": [
- null
]
}
], - "customs_references": [
- {
- "type": "ACID",
- "country_cd": "DK",
- "value": 4988470982020120000
}
]
}
]
}
], - "utilized_transport_equipment": [
- {
- "equipment": [
- {
- "equipment_ref": "APZU4812090",
- "iso_equipment_cd": "22GP",
- "tare_weight": 4800,
- "weight_unit": "KGM"
}
], - "cargo_gross_weight": 12000,
- "cargo_gross_weight_unit": "KGM",
- "cargo_gross_volume": 120,
- "cargo_gross_volume_unit": "MTQ",
- "is_shipper_owned": true,
- "is_non_operating_reefer": true,
- "active_reefer": [
- {
- "temperature_setpoint": -15,
- "temperature_unit": "CEL",
- "o2_setpoint": 75.3,
- "co2_setpoint": 25,
- "humidity_setpoint": 95.6,
- "air_exchange_setpoint": 15.4,
- "air_exchange_unit": "MTQ",
- "is_ventilation_open": true,
- "is_drain_holes_open": true,
- "is_bulb_mode": true,
- "is_cold_treatment_required": true,
- "is_controlled_atmosphere_required": true
}
], - "seals": [
- {
- "seal_number": "string",
- "seal_source": "CUS",
- "seal_type": "WIR"
}
], - "references": [
- {
- "type": "FF",
- "value": "HHL00103004"
}
], - "customs_references": [
- {
- "type": "ACID",
- "country_cd": "DK",
- "value": 4988470982020120000
}
]
}
], - "references": [
- {
- "type": "FF",
- "value": "HHL00103004"
}
], - "customs_references": [
- {
- "type": "ACID",
- "country_cd": "DK",
- "value": 4988470982020120000
}
], - "document_party": [
- {
- "party": [
- {
- "name": "Asseco Denmark",
- "address": "Henrik",
- "address_country": "The Netherlands",
- "contact_nm": "Henrik",
- "contact_type": "Phone",
- "contact_value": "string",
- "identifying_code": [
- {
- "party_cd": "MSK",
- "code_provider": "SMDG",
- "code_name": "LCL"
}
], - "tax_ref": [
- {
- "type": "PAN",
- "country_code": "DK",
- "value": "AAAAA0000A"
}
]
}
], - "party_function": "DDS",
- "displayed_address": [
- "string"
], - "notified": true
}
]
}
], - "dcsa_ebl_issue_to": [
- {
- "platform_nm": "BOLE",
- "legal_nm": "Digital Container Shipping Association",
- "registration_no": 74567837,
- "registration_loc": "NL",
- "tax_ref": "NL859951480B01",
- "party_codes": [
- {
- "party_code": "529900T8BM49AURSDO55",
- "code_provider": "EPIU",
- "code_name": "Bolero"
}
]
}
], - "dcsa_ebl_jurisdiction": "string",
- "dcsa_ebl_seat": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: delivery_order
| do_buyer_company_address required | string (Buyer Company Address )
|
| do_buyer_company_name required | string (Buyer Company Name )
|
| do_date required | string <date> (Date )
|
| do_delivery_address required | string (Delivery Address )
|
required | Array of objects (Item Details)
|
| do_number required | string (Delivery Order Number)
|
| do_seller_company_address required | string (Seller’s Company Address )
|
| do_seller_company_name required | string (Seller’s Company Name )
|
| do_seller_registration_number required | string (Seller Registration)
|
| do_delivery_from | string or null (Deliver From )
|
| do_invoice_number | string or null (Invoice Number )
|
| do_lc_number | string or null (Letter Of Credit Number )
|
Array of objects or null (Delivery Order Attachment)
|
{- "do_buyer_company_address": "string",
- "do_buyer_company_name": "string",
- "do_date": "2019-08-24",
- "do_delivery_address": "string",
- "do_item_details": [
- {
- "description": "string",
- "quantity": "string",
- "serial_number": "string"
}
], - "do_number": "string",
- "do_seller_company_address": "string",
- "do_seller_company_name": "string",
- "do_seller_registration_number": "string",
- "do_delivery_from": "string",
- "do_invoice_number": "string",
- "do_lc_number": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: ebl
| ebl_reference required | string (Electronic Bill of Lading Reference)
|
required | Array of objects (Attachments) |
{- "ebl_reference": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: inspection_certificate
| ic_reference_number required | string (Inspection Certificate Reference Number)
|
Array of objects or null (Inspection Certificate Attachment)
|
{- "ic_reference_number": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: invoice_finance_application
| ifa_bank_name | string (Bank )
|
| ifa_date | string <date> (Date )
|
| ifa_applicant_name | string (Applicant )
|
| ifa_applicant_contact_person | string (Contact Person )
|
| ifa_applicant_telephone_no | string (Telephone )
|
| ifa_product | string (Trade Financing Product Name )
|
| ifa_application_id | string (Trade Financing Application Id)
|
| ifa_invoice_currency | string (Invoice Currency ) Currency unit in Invoice |
| ifa_tenor | string (Tenor )
|
| ifa_finance_date_start | string <date> (Finance Start Date)
|
| ifa_finance_date_due | string <date> (Finance Due Date )
|
| ifa_percentage_financing | number <double> (Percentage Of Financing)
|
| ifa_instruction_proceed | string (Instruction On Proceeds)
|
| ifa_payment_type | string (Payment Type )
|
| ifa_bearer_charges | string (Bearer Of Charges)
|
| ifa_counterparty_name | string (Name Of Counterparty)
|
| ifa_tt_remmitance_currency | string (Remittance Currency (Tt) )
|
| ifa_tt_amount | number <double> (Amount (Tt) )
|
| ifa_tt_beneficiary_account_no | string (Beneficiary Account Number (Tt) )
|
| ifa_tt_beneficiary_bank_name | string (Name Of Beneficiary Bank (Tt) )
|
| ifa_tt_beneficiary_bank_address | string (Address Of Beneficiary Bank (Tt) )
|
| ifa_tt_beneficiary_receiving_agent | string (Receiving Agent Of Beneficiary Bank (Tt) )
|
| ifa_co_beneficiary_name | string (Beneficiary Name (Co) )
|
| ifa_financing_currency | string or null (Financing Currency )
|
| ifa_port_loading | string or null (Port Of Loading )
|
| ifa_port_discharge | string or null (Port Of Discharge )
|
| ifa_vessel_number | string or null (Vessel Imo Number )
|
| ifa_fx_contract_number | string or null (Fx Contract Number )
|
| ifa_fx_rate | string or null (Fx Rate )
|
| ifa_counterparty_address | string or null (Address Of Counterparty)
|
| ifa_co_beneficiary_account_name | string or null (Account Name (Co) )
|
| ifa_co_beneficiary_account_number | string or null (Account Number (Co) )
|
| ifa_co_other_instructions | string or null (Other Instructions (Co) )
|
| ifa_tt_beneficiary_bank_swift_code | string or null (Swift Code- Beneficiary Bank (Tt))
|
| ifa_co_beneficiary_bank_swift_code | string or null Swift Code- Beneficiary Bank (Co) |
{- "ifa_bank_name": "string",
- "ifa_date": "2019-08-24",
- "ifa_applicant_name": "string",
- "ifa_applicant_contact_person": "string",
- "ifa_applicant_telephone_no": "string",
- "ifa_product": "string",
- "ifa_application_id": "string",
- "ifa_invoice_currency": "string",
- "ifa_tenor": "string",
- "ifa_finance_date_start": "2019-08-24",
- "ifa_finance_date_due": "2019-08-24",
- "ifa_percentage_financing": 0.1,
- "ifa_instruction_proceed": "string",
- "ifa_payment_type": "string",
- "ifa_bearer_charges": "string",
- "ifa_counterparty_name": "string",
- "ifa_tt_remmitance_currency": "string",
- "ifa_tt_amount": 0.1,
- "ifa_tt_beneficiary_account_no": "string",
- "ifa_tt_beneficiary_bank_name": "string",
- "ifa_tt_beneficiary_bank_address": "string",
- "ifa_tt_beneficiary_receiving_agent": "string",
- "ifa_co_beneficiary_name": "string",
- "ifa_financing_currency": "string",
- "ifa_port_loading": "string",
- "ifa_port_discharge": "string",
- "ifa_vessel_number": "string",
- "ifa_fx_contract_number": "string",
- "ifa_fx_rate": "string",
- "ifa_counterparty_address": "string",
- "ifa_co_beneficiary_account_name": "string",
- "ifa_co_beneficiary_account_number": "string",
- "ifa_co_other_instructions": "string",
- "ifa_tt_beneficiary_bank_swift_code": "string",
- "ifa_co_beneficiary_bank_swift_code": "string"
}Data Element ID: invoice_finance_response
| ifr_transaction_reference_number required | string (Transaction Reference Number )
|
| ifr_finance_approved_date | string or null <date> (Finance Approved Date)
|
| ifr_financing_start_date | string or null <date> (Financing Start Date)
|
| ifr_financing_maturity_date | string or null <date> (Financing Maturity Date)
|
| ifr_disbursement_date | string or null <date> (Disbursement Date)
|
| ifr_finance_status required | string <date> (Finance Status)
|
Array of objects or null (Invoice Finance Response Attachment)
|
{- "ifr_transaction_reference_number": "string",
- "ifr_finance_approved_date": "2019-08-24",
- "ifr_financing_start_date": "2019-08-24",
- "ifr_financing_maturity_date": "2019-08-24",
- "ifr_disbursement_date": "2019-08-24",
- "ifr_finance_status": "2019-08-24",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: letter_of_credit
| lc_doc_lc_form | string or null (Form of Documentary Credit)
|
| lc_dt_of_issue required | string <date> (Date Of Issue)
|
| lc_doc_lc_no | string or null (Documentary Credit Number)
|
| lc_dt_and_place_of_expiry | string or null (Date and Place of Expiry)
|
| lc_applicant | string or null (Applicant)
|
| lc_beneficiary_nm_and_address | string or null (Beneficiary)
|
| lc_doc_lc_currency_cd_and_amount | string or null (Currency Code, Amount)
|
| lc_available_with_by | string or null (Available with and by)
|
| lc_negotiation_deferred_payment_details | string or null (Negotiation/Deferred Payment Details)
|
| lc_partial_shipments | string or null (Partial Shipments)
|
| lc_transhipment | string or null (Transhipment)
|
| lc_latest_dt_of_shipment | string or null <date> (Latest Date of Shipment)
|
| lc_confirmation_instructions | string or null (Confirmation Instructions)
|
| lc_percentage_credit_amt_tolerance | string or null (Percentage Credit Amount Tolerance)
|
| lc_mixed_payment_details | string or null (Mixed Payment Details)
|
| lc_period_for_presentation_in_days | string or null (Period for Presentaton in Days)
|
Array of objects or null (Letter of Credit Attachment)
|
{- "lc_doc_lc_form": "string",
- "lc_dt_of_issue": "2019-08-24",
- "lc_doc_lc_no": "string",
- "lc_dt_and_place_of_expiry": "string",
- "lc_applicant": "string",
- "lc_beneficiary_nm_and_address": "string",
- "lc_doc_lc_currency_cd_and_amount": "string",
- "lc_available_with_by": "string",
- "lc_negotiation_deferred_payment_details": "string",
- "lc_partial_shipments": "string",
- "lc_transhipment": "string",
- "lc_latest_dt_of_shipment": "2019-08-24",
- "lc_confirmation_instructions": "string",
- "lc_percentage_credit_amt_tolerance": "string",
- "lc_mixed_payment_details": "string",
- "lc_period_for_presentation_in_days": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: letter_of_credit_application
| lca_date required | string <date> (Date)
|
| lca_applicant_name | string or null (Applicant's Name)
|
| lca_applicant_address | string or null (Applicant's Address)
|
| lca_contact_person_applicant | string or null (Contact Person (Applicant))
|
| lca_telephone_number_applicant | number or null <double> (Telephone Number (Applicant))
|
| lca_fax_applicant | number or null <double> (Fax No (Applicant))
|
| lca_debit_account_no | string or null (Debit Account No.)
|
| lca_beneficiary_type | string or null (Beneficiary Type (Local / Overseas))
|
| lca_beneficiary_name | string or null (Beneficiary's Name)
|
| lca_beneficiary_address | string or null (Beneficiary's Address)
|
| lca_contact_person_beneficiary | string or null (Contact Person (Beneficiary))
|
| lca_telephone_number_beneficiary | number or null <double> (Telephone Number (Beneficiary))
|
| lca_fax_beneficiary | number or null <double> (Fax No (Beneficiary))
|
| lca_third_party_name | string or null (Third Party Name)
|
| lca_third_party_address | string or null (Third Party Address)
|
| lca_advising_bank_name | string or null (Advising Bank Name)
|
| lca_advising_bank_address | string or null (Advising Bank Address)
|
| lca_advising_bank_swift_address | string or null (Advising Bank SWIFT Address)
|
| lca_currency | string or null (Currency)
|
| lca_amount | number or null <double> (Amount)
|
| lca_issuance_date | string or null <date> (LC Issuance Date)
|
| lca_date_expiry_beneficiary_country | string or null <date> (Expiry Date (Beneficiary Country))
|
| lca_date_expiry_applicant_country | string or null <date> (Expiry Date (Applicant Country))
|
| lca_charges | string or null (Charges)
|
| lca_documents | string or null (Documents Required)
|
| lca_special_instructions | string or null (Special Instructions)
|
| lca_special_type_credit_governing_rule | string or null (Special Type of Credit- Governing Rule)
|
| lca_tenor | string or null (Tenor )
|
| lca_shipment_from | string or null (Shipment From)
|
| lca_shipment_to | string or null (Shipment To)
|
| lca_date_latest_shipment | string or null <date> (Latest Shipment Date)
|
| lca_present_documents_in_X_days_after_shipment_date_but_before_LC_expiry | number or null <double> (Present documents in X days after shipment date but before LC expiry)
|
| lca_issuance_mode | string or null (LC issuance mode)
|
| lca_lc_to_be_confirmed_by_advising_bank | string or null (LC To Be Confirmed by Advising Bank)
|
| lca_confirmation_charges | string or null (Confirmation Charges)
|
| lca_tolerance | string or null (Tolerance)
|
| lca_goods_description | string or null (Goods description)
|
| lca_transshipment_allowed | string or null (Transshipment Allowed)
|
| lca_partial_shipment_allowed | string or null (Partial Shipment Allowed)
|
| lca_incoterms | string or null (Incoterms)
|
| lca_insurance_to_be_covered_by | string or null (Insurance To Be Covered By)
|
| lca_cover_no | string or null (Cover No.)
|
| lca_insurance_company | string or null (Insurance Company)
|
Array of objects or null (Letter of Credit Application Attachment)
|
{- "lca_date": "2019-08-24",
- "lca_applicant_name": "string",
- "lca_applicant_address": "string",
- "lca_contact_person_applicant": "string",
- "lca_telephone_number_applicant": 0.1,
- "lca_fax_applicant": 0.1,
- "lca_debit_account_no": "string",
- "lca_beneficiary_type": "string",
- "lca_beneficiary_name": "string",
- "lca_beneficiary_address": "string",
- "lca_contact_person_beneficiary": "string",
- "lca_telephone_number_beneficiary": 0.1,
- "lca_fax_beneficiary": 0.1,
- "lca_third_party_name": "string",
- "lca_third_party_address": "string",
- "lca_advising_bank_name": "string",
- "lca_advising_bank_address": "string",
- "lca_advising_bank_swift_address": "string",
- "lca_currency": "string",
- "lca_amount": 0.1,
- "lca_issuance_date": "2019-08-24",
- "lca_date_expiry_beneficiary_country": "2019-08-24",
- "lca_date_expiry_applicant_country": "2019-08-24",
- "lca_charges": "string",
- "lca_documents": "string",
- "lca_special_instructions": "string",
- "lca_special_type_credit_governing_rule": "string",
- "lca_tenor": "string",
- "lca_shipment_from": "string",
- "lca_shipment_to": "string",
- "lca_date_latest_shipment": "2019-08-24",
- "lca_present_documents_in_X_days_after_shipment_date_but_before_LC_expiry": 0.1,
- "lca_issuance_mode": "string",
- "lca_lc_to_be_confirmed_by_advising_bank": "string",
- "lca_confirmation_charges": "string",
- "lca_tolerance": "string",
- "lca_goods_description": "string",
- "lca_transshipment_allowed": "string",
- "lca_partial_shipment_allowed": "string",
- "lca_incoterms": "string",
- "lca_insurance_to_be_covered_by": "string",
- "lca_cover_no": "string",
- "lca_insurance_company": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: packing_list
| inv_no | string or null (Invoice Number )
|
| contract_no | string or null (Contract Number)
|
| issue_dt required | string (Issue Date)
|
| consignee_nm required | string (Consignee)
|
| buyer_nm required | string (Buyer)
|
| carrier_nm | string or null (Carrier (Transport Services Provider))
|
| seller_nm required | string (Seller)
|
| goods_pod required | string (Place of the delivery of the goods (by the carrier))
|
| unloading_loc | string or null (Baseport Unloading Location)
|
| carriage_condition_ref | string or null (Transport Contract Document Conditions)
|
| volume required | string (Volume (Cube))
|
| net_weight required | string (Net Weight)
|
| temperature required | string (Transport Temperature)
|
required | Array of objects (Goods Details)
|
| danger_lvl_cd | string or null (Packaging Danger Level Code)
|
| proper_nm | string or null (Proper Shipping / Technical Name)
|
| undg_no | string or null (UNDG Number)
|
| transport_nm required | string (Transport means identifier )
|
| vehicle_nm required | string (Vehicle registration number)
|
| equipment_identifier | string or null (Transport Equipment Identifier)
|
| conveyance_ref required | string (Conveyance reference number/Journey identifier)
|
Array of objects or null (Packing List Attachment)
|
{- "inv_no": "string",
- "contract_no": "string",
- "issue_dt": "string",
- "consignee_nm": "string",
- "buyer_nm": "string",
- "carrier_nm": "string",
- "seller_nm": "string",
- "goods_pod": "string",
- "unloading_loc": "string",
- "carriage_condition_ref": "string",
- "volume": "string",
- "net_weight": "string",
- "temperature": "string",
- "goods_details": [
- {
- "description": "string",
- "packages_no": "string",
- "hscode": "string",
- "packages_type": "string"
}
], - "danger_lvl_cd": "string",
- "proper_nm": "string",
- "undg_no": "string",
- "transport_nm": "string",
- "vehicle_nm": "string",
- "equipment_identifier": "string",
- "conveyance_ref": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: purchase_order
| po_additional_document_reference | string or null (Additional Document Reference)
|
| po_allowance_and_charge | string or null (Allowance And Charge)
|
| po_assets_expense_account | string or null (Assets Or Expenses Account)
|
| po_blanket_order_reference | string or null (Blanket Order Reference)
|
| po_buyer required | string (Buyer)
|
| po_carrier | string or null (Carrier)
|
| po_confirmed_earliest_schedule_date | string or null <date> (Confirmed Earliest Schedule Date)
|
| po_confirmed_latest_schedule_date | string or null <date> (Confirmed Latest Schedule Date)
|
| po_confirmed_schedule_date | string or null <date> (Confirmed Schedule Date)
|
| po_consignee | string or null (Consignee)
|
| po_consignee_agent | string or null (Consignee Agent)
|
| po_consignee_order_reference | string or null (Consignee Order Reference)
|
| po_cost_assignment_reference | string or null (Cost Assignment Reference)
|
| po_country_final_destination | string or null (Country Of Final Destination)
|
| po_customer_accountant | string or null (Customer Accountant)
|
| po_customer_reference | string or null (Customer Reference)
|
| po_customs_certificate_reference | string or null (Customs Certificate Reference)
|
| po_delivery_document_reference | string or null (Delivery Document Reference)
|
| po_delivery_instruction | string or null (Delivery Instruction)
|
| po_delivery_instruction_description | string or null (Delivery Instruction Description)
|
| po_despatch_document_note | string or null (Despatch Document Note)
|
| po_despatch_period | string or null (Despatch Period)
|
| po_document_information | string or null (Document Information)
|
| po_document_purpose | string or null (Document Purpose/Function)
|
| po_earliest_schedule_date | string or null <date> (Earliest Schedule Date)
|
| po_engineering_change_reference | string or null (Engineering Change Reference)
|
| po_export_license_reference | string or null (Export License Reference)
|
| po_import_license_reference | string or null (Import License Reference)
|
| po_invoice_currency | string or null (Invoice Currency)
|
| po_invoice_currency_exchange | string or null (Invoice Currency Exchange)
|
| po_invoicee | string or null (Invoicee)
|
| po_latest_schedule_date | string or null <date> (Latest Schedule Date)
|
| po_letter_of_credit_reference | string or null (Letter Of Credit Reference)
|
| po_minus_delivery_quantity | string or null (Minus Delivery Quantity)
|
| po_no_partial_delivery_allowed | string or null (No Partial Delivery Allowed)
|
| po_order_change_header | string or null (Order Change Header)
|
| po_order_currency | string or null (Order Currency)
|
| po_order_currency_exchange | string or null (Order Currency Exchange)
|
Array of objects or null (Order Details)
| |
| po_order_number_marketplace | string or null (Order Number Marketplace)
|
| po_order_response_header | string or null (Order Response Header)
|
| po_original_order_reference | string or null (Original Order Reference)
|
| po_payable_account | string or null (Payable Account)
|
| po_payee | string or null (Payee)
|
| po_payer | string or null (Payer)
|
| po_payment_instructions | string or null (Payment Instructions)
|
| po_payment_terms | string or null (Payment Terms)
|
| po_place_destination | string or null (Place Of Destination)
|
| po_place_discharge | string or null (Place Of Discharge)
|
| po_plus_delivery_quantity | string or null (Plus Delivery Quantity)
|
| po_price | string or null (Price)
|
| po_price_list_reference | string or null (Price List Reference)
|
| po_pricing_currency | string or null (Pricing Currency)
|
| po_pricing_currency_exchange | string or null (Pricing Currency Exchange)
|
| po_prior_order_change_reference | string or null (Prior Order Change Reference)
|
| po_prior_order_reference | string or null (Prior Order Reference)
|
| po_prior_order_response_reference | string or null (Prior Order Response Reference)
|
| po_quote_reference | string or null (Quote Reference (Offer))
|
| po_release_period | string or null (Release Period)
|
| po_report_reference | string or null (Sales Report Reference)
|
| po_request_for_quote_reference | string or null (Request For Quote Reference)
|
| po_requisition_reference | string or null (Requisition Reference)
|
| po_requisitioner | string or null (Requisitioner)
|
| po_response_reason_code | string or null (Response Reason Code)
|
| po_rounding_amount | string or null (Rounding Amount)
|
| po_scedule_period | string or null (Schedule Period)
|
| po_schedule_date | string or null <date> (Schedule Date)
|
| po_seller | string or null (Seller)
|
| po_ship_from | string or null (Ship From)
|
| po_ship_from_location | string or null (Ship From Location)
|
| po_ship_to | string or null (Ship To)
|
| po_ship_to_location | string or null (Ship To Location Or Address)
|
| po_shipping_grouping_identifier | string or null (Shipping Grouping Identifier)
|
| po_supplier_order_identifier | string or null (Supplier Order Identifier)
|
| po_tax_currency | string or null (Tax Currency)
|
| po_tax_currency_exchange | string or null (Tax Currency Exchange)
|
| po_tax_fee_totals | string or null (Tax Fee Totals)
|
| po_to_be_paid_amount | string or null (To Be Paid Amount)
|
| po_total_order_additional_allowance_amount | string or null (Total Order Additional Allowance Amount)
|
| po_total_order_additional_charge_amount | string or null (Total Order Additional Charge Amount)
|
| po_total_order_amount | string or null (Total Order Amount)
|
| po_total_amount | string or null (Total Amount)
|
| po_total_quantity | string or null (Total Quantity)
|
| po_total_tax_fee_amount | string or null (Total Tax Fee Amount)
|
| po_total_taxable_amount | string or null (Total Taxable Amount)
|
| po_transport_mode | string or null (Transport Mode)
|
Array of objects or null (Purchase Order Attachment)
|
{- "po_additional_document_reference": "string",
- "po_allowance_and_charge": "string",
- "po_assets_expense_account": "string",
- "po_blanket_order_reference": "string",
- "po_buyer": "string",
- "po_carrier": "string",
- "po_confirmed_earliest_schedule_date": "2019-08-24",
- "po_confirmed_latest_schedule_date": "2019-08-24",
- "po_confirmed_schedule_date": "2019-08-24",
- "po_consignee": "string",
- "po_consignee_agent": "string",
- "po_consignee_order_reference": "string",
- "po_cost_assignment_reference": "string",
- "po_country_final_destination": "string",
- "po_customer_accountant": "string",
- "po_customer_reference": "string",
- "po_customs_certificate_reference": "string",
- "po_delivery_document_reference": "string",
- "po_delivery_instruction": "string",
- "po_delivery_instruction_description": "string",
- "po_despatch_document_note": "string",
- "po_despatch_period": "string",
- "po_document_information": "string",
- "po_document_purpose": "string",
- "po_earliest_schedule_date": "2019-08-24",
- "po_engineering_change_reference": "string",
- "po_export_license_reference": "string",
- "po_import_license_reference": "string",
- "po_invoice_currency": "string",
- "po_invoice_currency_exchange": "string",
- "po_invoicee": "string",
- "po_latest_schedule_date": "2019-08-24",
- "po_letter_of_credit_reference": "string",
- "po_minus_delivery_quantity": "string",
- "po_no_partial_delivery_allowed": "string",
- "po_order_change_header": "string",
- "po_order_currency": "string",
- "po_order_currency_exchange": "string",
- "po_order_details": [
- {
- "contract_reference": "string",
- "order_change": "string",
- "delivery_quantity": "string",
- "marketplace": "string",
- "note": "string",
- "number": "string",
- "substituted_product": "string",
- "status": "string",
- "status_reason_code": "string",
- "supplier_identification": "string",
- "uuid": "string",
- "additional_allowance_amount": "string",
- "amount": "string",
- "response": "string",
- "sales_catalogue_reference": "string",
- "product": "string",
- "supplier": "string",
- "additional charge_amount": "string"
}
], - "po_order_number_marketplace": "string",
- "po_order_response_header": "string",
- "po_original_order_reference": "string",
- "po_payable_account": "string",
- "po_payee": "string",
- "po_payer": "string",
- "po_payment_instructions": "string",
- "po_payment_terms": "string",
- "po_place_destination": "string",
- "po_place_discharge": "string",
- "po_plus_delivery_quantity": "string",
- "po_price": "string",
- "po_price_list_reference": "string",
- "po_pricing_currency": "string",
- "po_pricing_currency_exchange": "string",
- "po_prior_order_change_reference": "string",
- "po_prior_order_reference": "string",
- "po_prior_order_response_reference": "string",
- "po_quote_reference": "string",
- "po_release_period": "string",
- "po_report_reference": "string",
- "po_request_for_quote_reference": "string",
- "po_requisition_reference": "string",
- "po_requisitioner": "string",
- "po_response_reason_code": "string",
- "po_rounding_amount": "string",
- "po_scedule_period": "string",
- "po_schedule_date": "2019-08-24",
- "po_seller": "string",
- "po_ship_from": "string",
- "po_ship_from_location": "string",
- "po_ship_to": "string",
- "po_ship_to_location": "string",
- "po_shipping_grouping_identifier": "string",
- "po_supplier_order_identifier": "string",
- "po_tax_currency": "string",
- "po_tax_currency_exchange": "string",
- "po_tax_fee_totals": "string",
- "po_to_be_paid_amount": "string",
- "po_total_order_additional_allowance_amount": "string",
- "po_total_order_additional_charge_amount": "string",
- "po_total_order_amount": "string",
- "po_total_amount": "string",
- "po_total_quantity": "string",
- "po_total_tax_fee_amount": "string",
- "po_total_taxable_amount": "string",
- "po_transport_mode": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: sales_invoice
| invoice_number required | string (Invoice Number)
|
| invoice_currency required | string (Invoice Currency Code)
|
| invoice_unit_currency required | string (Currency Unit)
|
| invoice_date | string or null <date> (Invoice Issue Date)
|
| invoice_terms | string or null (Payment Terms)
|
| invoice_date_due | string or null <date> (Payment Due Date)
|
| invoice_seller_company_name | string or null (Seller Trading Name)
|
| invoice_seller_company_address | string or null (Seller Postal Address)
|
| invoice_buyer_company_name | string or null (Buyer Trading Name)
|
| invoice_buyer_company_address | string or null (Buyer Postal Address)
|
| invoice_project_name | string or null (Project Name)
|
| invoice_project_description | string or null (Project Description)
|
| invoice_customer_no | string or null (Buyer Identifier)
|
| invoice_gross_amount | number or null <double> (Sum Of Charges On Document Level)
|
| invoice_discount_amount | number or null <double> (Sum Of Allowances On Document Level)
|
| invoice_tax_amount | number or null <double> (Invoice Total Vat Amount In Accounting Currency)
|
| invoice_net_amount | number or null <double> (Amount Due For Payment)
|
Array of objects or null (Item Details)
| |
| invoice_transport_details | string or null (Item Description)
|
| invoice_transport_number | string or null (Despatch Advice Reference)
|
| invoice_transportation_date | string or null <date> (Actual Delivery Date)
|
| invoice_delivery_from | string or null (Item Country Of Origin)
|
| invoice_delivery_to | string or null (Deliver To Address)
|
| invoice_fda_registration_number | string or null (Fda Registration Number )
|
| invoice_certification_number | string or null (Certification Number )
|
| invoice_supplier_name | string or null (Seller Trading Name)
|
| invoice_supplier_address | string or null (Seller Postal Address)
|
| invoice_tt_beneficiary_name | string or null (Payee Name)
|
| invoice_tt_beneficiary_address | string or null (Address Of Beneficiary / Supplier (Tt) )
|
| invoice_tt_beneficiary_account_number | string or null (Payment Account Identifier)
|
| invoice_tt_beneficiary_bank_name | string or null (Payment Account Name)
|
| invoice_tt_beneficiary_bank_address | string or null (Address Of Beneficiary Bank (TT) )
|
| invoice_tt_beneficiary_receiving_agent | string or null (Receiving Agent Of Beneficiary Bank (TT) )
|
| invoice_co_beneficiary_name | string or null (Payee Name)
|
| invoice_co_beneficiary_account_name | string or null (Payment Account Identifier)
|
| invoice_co_beneficiary_account_number | string or null (Payment Account Name)
|
| invoice_co_other_instructions | string or null (Payment Means Text)
|
Array of objects or null (Sales Invoice Attachment)
|
{- "invoice_number": "string",
- "invoice_currency": "string",
- "invoice_unit_currency": "string",
- "invoice_date": "2019-08-24",
- "invoice_terms": "string",
- "invoice_date_due": "2019-08-24",
- "invoice_seller_company_name": "string",
- "invoice_seller_company_address": "string",
- "invoice_buyer_company_name": "string",
- "invoice_buyer_company_address": "string",
- "invoice_project_name": "string",
- "invoice_project_description": "string",
- "invoice_customer_no": "string",
- "invoice_gross_amount": 0.1,
- "invoice_discount_amount": 0.1,
- "invoice_tax_amount": 0.1,
- "invoice_net_amount": 0.1,
- "invoice_item_details": [
- {
- "contract_reference": "string",
- "description_of_goods": "string",
- "quantity": "string",
- "unit_measurement": "string",
- "unit_price": "string",
- "note": "string"
}
], - "invoice_transport_details": "string",
- "invoice_transport_number": "string",
- "invoice_transportation_date": "2019-08-24",
- "invoice_delivery_from": "string",
- "invoice_delivery_to": "string",
- "invoice_fda_registration_number": "string",
- "invoice_certification_number": "string",
- "invoice_supplier_name": "string",
- "invoice_supplier_address": "string",
- "invoice_tt_beneficiary_name": "string",
- "invoice_tt_beneficiary_address": "string",
- "invoice_tt_beneficiary_account_number": "string",
- "invoice_tt_beneficiary_bank_name": "string",
- "invoice_tt_beneficiary_bank_address": "string",
- "invoice_tt_beneficiary_receiving_agent": "string",
- "invoice_co_beneficiary_name": "string",
- "invoice_co_beneficiary_account_name": "string",
- "invoice_co_beneficiary_account_number": "string",
- "invoice_co_other_instructions": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}| etd_type required | string (External Transport Document Type) Enum: "Ocean BOL" "Others"
|
| etd_bl_type | string or null (External BL Type) Enum: "To Order" "Bearer" null
|
| etd_reference_number required | string (External Reference Number)
|
| etd_notice required | string (Notice)
|
| etd_model_terms required | string (Model Terms)
|
required | object (Transport Document PDF)
|
Array of objects (External Transport Document Attachment)
|
{- "etd_type": "Ocean BOL",
- "etd_bl_type": "To Order",
- "etd_reference_number": "string",
- "etd_notice": "string",
- "etd_model_terms": "string",
- "etd_transport_doc_pdf": {
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}, - "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Other Documents
Data Element ID: other_documents
| note required | string (Note)
|
Array of objects or null (Other Documents Attachment)
|
{- "note": "string",
- "attachments": [
- {
- "filename": "string",
- "file_content": "string"
}
]
}Data Element ID: certificate_of_origin
| bol_no required | string (Bill of Lading / Transport Contract Document Number) Reference number to identify a document evidencing a transport contract |
| coo_origin_country required | string (Origin Country) Name of the country in which the goods have been produced or manufactured, according to criteria laid down for the application of the Customs tariff or quantitative restrictions, or any measure related to trade. |
{- "bol_no": "string",
- "coo_origin_country": "string"
}Data Element ID: ebl_dcsa
| bol_ref required | string (Bill of Lading Reference Number) A unique number allocated by the shipping line to the transport document and the main number used for the tracking of the status of the shipment. |
{- "bol_ref": "string"
}Data Element ID: delivery_order
| do_number required | string (Delivery Order Number) Unique identifier for invoice referred in delivery order |
| do_invoice_number | string or null (Invoice Number ) Unique identifier for delivery order |
{- "do_number": "string",
- "do_invoice_number": "string"
}Data Element ID: ebl
| ebl_reference | string or null (Electronic Bill of Lading Reference) Document Reference Number |
{- "ebl_reference": "string"
}Data Element ID: inspection_certificate
| ic_reference_number required | string (Inspection Certificate Reference Number) Unique reference number for Inspection Certificate |
{- "ic_reference_number": "string"
}Data Element ID: invoice_finance_application
| ifa_application_id required | string (Trade Financing Application Id) Unique application reference number |
{- "ifa_application_id": "string"
}Data Element ID: invoice_finance_response
| ifr_transaction_reference_number | string or null (Transaction Reference Number ) Transaction Reference Number |
{- "ifr_transaction_reference_number": "string"
}Data Element ID: letter_of_credit
| lc_dt_of_issue required | string <date> (Lc Doc Lc No) |
{- "lc_dt_of_issue": "2019-08-24"
}Data Element ID: letter_of_credit_application
| lca_date required | string <date> (Date) Date of document |
{- "lca_date": "2019-08-24"
}Data Element ID: purchase_order
| po_buyer | string or null (Buyer) Field UID: ORD- 0011-The entity contains the details of the buyer. |
{- "po_buyer": "string"
}Data Element ID: sales_invoice
| invoice_number required | string (Invoice Number) A unique identification of the Invoice. The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. No identification scheme is to be used. |
{- "invoice_number": "string"
}| etd_type required | string (External Transport Document Type) Enum: "Ocean BOL" "Others" The classification of the uploaded transport document based on its mode of transport, such as Ocean Bill of Lading (BOL) or Others. |
| etd_bl_type | string or null (External BL Type) Enum: "To Order" "Bearer" null Defines negotiability type of the Bill of Lading. Applicable if Document Type is "Ocean BOL". |
| etd_reference_number required | string (External Reference Number) Unique identifier assigned to the transport document by the issuing carrier or forwarder. |
{- "etd_type": "Ocean BOL",
- "etd_bl_type": "To Order",
- "etd_reference_number": "string"
}Other Documents
Data Element ID: other_documents
| note required | string (Note) Note |
{- "note": "string"
}