Below is a table detailing definitions for all terms included in the API and CSV Templates (User Interface fields). Asterisks next to CSV field indicate a required field. The first table includes the data fields on all FVRs, while the following four tables are document-type-specific data fields (Invoices, Bills of Lading, Purchase Orders, and Warehouse Receipts)
| CSV Field | API Field | Description | Accepted Values/Format |
|---|---|---|---|
| POOL_ID* | pool_identification | A pool is an optional, convenience measure to cluster requests for reference. This ID can be created by the user and can be used to reference the pool | Character string, max 35 characters |
| BATCH_ID* | submitter_batch_identification | A batch is created when multiple FVRs are uploaded at once. This ID is generated by the user and can be used to reference the batch | Character string, max 35 characters |
| VALIDATION_SERVICE* | data_set_validation_service | Defines which validation service is requested- registration or financing | _REGI-Data set registration _REFI-Data set registration and financing |
| BATCH_BOOKING* | batch_booking | Identifies whether the submitter wants the batch of financing validation requests to be treated as a single securitized unit, or as individual validation requests | TRUE/FALSE |
| FVR_ID* | financing_validation_request_details.submitter_data_set_identification | FVR ID is generated by the user and can be used to reference the FVR | Character string, max 35 characters |
| APPLICANT.NAME* | financing_applicant.name | Name of the Financing Applicant, also known as the beneficiary | Character string, max 70 characters |
| APPLICANT.COUNTRY* | financing_applicant.country_of_domicile | Financing Applicant’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha-2 format country code |
| APPLICANT.BIC | financing_applicant.any_bic | Financing Applicant’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’. | ISO 9362 format BIC Code, charchter string, max 11 characters |
| APPLICANT.LEI | financing_applicant.lei | “Financing Applicant’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“.” | ISO 17442 format LEI, charchter string, max 20 characters |
| APPLICANT.EMAIL | financing_applicant.email_address | Financing Applicant’s email address | Character string, max 256 characters |
| APPLICANT.OTHER_ID | financing_applicant.other.identification | Other identifications for the Financing Applicant | Character string, max 35 characters |
| APPLICANT.OTHER_ID.SCHEME_CODE | financing_applicant.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| APPLICANT.OTHER_ID.SCHEME_NAME | financing_applicant.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme. | Character string, max 256 characters |
| APPLICANT.OTHER_ID.ISSUER | financing_applicant.other.issuer | Issuer of the other Financing Applicant identification | Character string, max 35 characters |
| COLLATERAL_TYPE* | collateral_type | Code to identify the type of underlying collateral being pledged against the financing | TREC-Trade receivables. OTGI-Other Goods or Inventory. Movable property such as machinery or commodities. CASH-Cash. |
| PRE_SHIPMENT_FINANCING | pre_shipment_financing | Indicates that financing is being applied for before shipment of goods | YES/NO |
| RECOURSE | with_recourse | Indicates loan is secured with collateral. | YES/NO |
| FINANCING_AMOUNT | financing_request_amount.amount | Amount of money requested for financing. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| FINANCING_CURRENCY | financing_request_amount.currency | “Currency within which the financing amount is being requested. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“.” | ISO 4217 format Currency Code |
| CSV Field | API Field | Description | Accepted Values/Format |
|---|---|---|---|
| INV.SUBMITTER_DOC_REF* | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| INV.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha 2 Format |
| INV.ISSUER.NAME | document_issuer.name | Name of the Document Issuer | Character string, max 70 characters |
| INV.ISSUER.COUNTRY | document_issuer.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha-2 format country code |
| INV.ISSUER.BIC | document_issuer.any_bic | Issuer’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’. | ISO 9362 format BIC Code, charchter string, max 11 characters |
| INV.ISSUER.LEI | document_issuer.lei | “Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“.” | ISO 17442 format LEI, charchter string, max 20 characters |
| INV.ISSUER.EMAIL | document_issuer.email_address | Issuer’s email address | Character string, max 256 characters |
| INV.ISSUER.OTHER_ID | document_issuer.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| INV.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| INV.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer.other.scheme_name.proprietary | Document issuer other identification scheme name. Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| INV.ISSUER.OTHER_ID.ISSUER | document_issuer.other.issuer | Issuer of the Issuer’s other identification | Character string, max 35 characters |
| INV.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| INV.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| INV.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| INV.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| INV.ISSUE_DATE* | issue_date | “Date on which the invoice was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format |
| INV.SELLER.NAME* | seller_identification.name | Name of the Document Seller | Character string, max 70 characters |
| INV.SELLER.COUNTRY* | seller_identification.country_of_domicile | Seller’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| INV.SELLER.BIC | seller_identification.identifications.any_bic | Seller’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| INV.SELLER.LEI | seller_identification.identifications.lei | “Seller’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| INV.SELLER.EMAIL | seller_identification.identifications.email_address | Seller’s email address | Character string, max 256 characters |
| INV.SELLER.OTHER_ID | seller_identification.identifications.other.identifiaction | Other identifications for the Seller | Character string, max 35 characters |
| INV.SELLER.OTHER_ID.SCHEME_CODE | seller_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| INV.SELLER.OTHER_ID.SCHEME_NAME | seller_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| INV.SELLER.OTHER_ID.ISSUER | seller_identification.identifications.other.issuer | Issuer of the other Seller identification | Character string, max 35 characters |
| INV.BUYER.NAME* | buyer_identification.name | Name of the Document Buyer | Character string, max 70 characters |
| INV.BUYER.COUNTRY* | buyer_identification.country_of_domicile | Buyer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| INV.BUYER.BIC | buyer_identification.identifications.any_bic | Buyer’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| INV.BUYER.LEI | buyer_identification.identifications.lei | “Buyer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| INV.BUYER.EMAIL | buyer_identification.identifications.email_address | Buyer’s email address | Character string, max 256 characters |
| INV.BUYER.OTHER_ID | buyer_identification.identifications.other.identifiaction | Other identifications for the Buyer | Character string, max 35 characters |
| INV.BUYER.OTHER_ID.SCHEME_CODE | buyer_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| INV.BUYER.OTHER_ID.SCHEME_NAME | buyer_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme. | Character string, max 256 characters |
| INV.BUYER.OTHER_ID.ISSUER | buyer_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| INV.NUMBER* | invoice_number | Document number identifier of the invoice | Character string, max 50 characters |
| INV.AMOUNT* | total_invoice_amount.amount | Total amount of the invoice. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| INV.CURRENCY* | total_invoice_amount.currency | “Currency within which the invoice amount is reported. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“” | ISO 4217 format currency code |
| INV.COMM_LINE_ITEMS.ID | commercial_line_items.line_item_identification | Identification of the commercial line items | Character string, max 70 characters |
| INV.COMM_LINE_ITEMS.QUANTITY_UNIT_CODE | commercial_line_items.quantity.unit_of_measure.unit_of_measure_code | Quantity unit code for the commercial line items. Specifies a unit of measure with a code or free text | UN/ECE Recommendation 20 format code, character string, max 35 characters |
| INV.COMM_LINE_ITEMS.OTHER_UNIT_OF_MEASURE | commercial_line_items.quantity.unit_of_measure.other-unit_of_measure | Other unit of measure for the commercial line items. Specifies a unit of measure with a code or free text | Character string, max 35 characters |
| INV.COMM_LINE_ITEMS.QUANTITY.VALUE | commercial_line_items.quantity.value | Specifies the quantity of a product in a trade transaction | Number of objects represented as a decimal number, for example 0.75 or 45.6. |
| INV.COMM_LINE_ITEMS.QUANTITY.FACTOR | commercial_line_items.quantity.factor | Quantity factor of the price unit indicates the price unit for which the unit price of the document line is valid | Specifies a numeric string with a maximum length of 15 digits. |
| INV.COMM_LINE_ITEMS.UNIT_PRICE_AMOUNT | commercial_line_items.unit_price.amount | Unit price amount of the commercial line items. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| INV.COMM_LINE_ITEMS.UNIT_PRICE_CURRENCY | commercial_line_items.unit_price.currency | “Currency within which the commercial line items unit price amount is reported. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“.” | ISO 4217 format currency code |
| INV.COMM_LINE_ITEMS.PRODUCT_NAME | commercial_line_items.product_name | Name of the product within commercial line items | Character string, max 70 characters |
| INV.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFIER_TYPE | commercial_line_items.product_identifier.structured_product_identifier.type | Specifies the type of identifier of a product. | _BINR-buyers_item_number _COMD-commercial_description_code_name _EANC-ean _HRTR-harmonized_tariff_code_name _MANI-manufacturers_item_number _MODL-model_number _PART-part_number _QOTA-quota_category _STYL-style_number _SUPI-suppliers_item_number *UPCC-universal_product_code |
| INV.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFER | commercial_line_items.product_identifier.structured_product_identifier.identifier | Identifies a product in coded form or free text | Character string, max 35 characters |
| INV.COMM_LINE_ITEMS.OTHER_PRODUCT_ID | commercial_line_items.other_product_identifier.identification | Information related to an identification, eg, party identification or account identification | Character string, max 35 characters |
| INV.COMM_LINE_ITEMS.OTHER_PRODUCT_ID.TYPE | commercial_line_items.other_product_identifier.identificationtype | Type of identification included to specify the product | Character string, max 35 characters |
| INV.SHIP_TO_NAME | ship_to_name | Name of person to whom the shipment is being sent | Character string, max 70 characters |
| INV.SHIP_TO_ADDRESS | ship_to_address_line | Address where the shipment is being sent | <=5 items |
| INV.SHIP_TO_COUNTRY | ship_to_country | Country where the shipment is being sent. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| INV.PAYMENT_METHOD | payment_method | Specifies the transfer method that will be used to transfer an amount of money | _CHK-Written order to a bank to pay a certain amount of money from one person to another person. _TRF-Transfer of an amount of money in the books of the account servicer. _DD-Collection of an amount of money from the debtor’s bank account by the creditor. The amount of money and dates of collections may vary. _TRA-Transfer of an amount of money in the books of the account servicer. An advice should be sent back to the account owner. |
| CSV Field | API Field | Description | Accepted Values/Format |
|---|---|---|---|
| BL.SUBMITTER_DOC_REF* | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| BL.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha 2 Format |
| BL.ISSUER.NAME | document_issuer.name | Name of the Document Issuer | Character string, max 70 characters |
| BL.ISSUER.COUNTRY | document_issuer.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| BL.ISSUER.BIC | document_issuer.any_bic | Issuer’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| BL.ISSUER.LEI | document_issuer.lei | “Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| BL.ISSUER.EMAIL | document_issuer.email_address | Issuer’s email address | Character string, max 256 characters |
| BL.ISSUER.OTHER_ID | document_issuer.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| BL.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| BL.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| BL.ISSUER.OTHER_ID.ISSUER | document_issuer.other.issuer | Issuer of the other Issuer identification | Character string, max 35 characters |
| BL.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| BL.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| BL.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| BL.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| BL.ISSUE_DATE* | issue_date | “Date on which the BL was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format |
| BL.SHIPPER.NAME* | shipper_identification.name | Name of the document shipper | Character string, max 70 characters |
| BL.SHIPPER.COUNTRY* | shipper_identification.country_of_domicile | Shipper’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| BL.SHIPPER.BIC | shipper_identification.identifications.any_bic | Shipper’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| BL.SHIPPER.LEI | shipper_identification.identifications.lei | “Shipper’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| BL.SHIPPER.EMAIL | shipper_identification.identifications.email_address | Shipper’s email address | Character string, max 256 characters |
| BL.SHIPPER.OTHER_ID | shipper_identification.identifications.other.identifiaction | Other identifications for the shipper | Character string, max 35 characters |
| BL.SHIPPER.OTHER_ID.SCHEME_CODE | shipper_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| BL.SHIPPER.OTHER_ID.SCHEME_NAME | shipper_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme. | Character string, max 256 characters |
| BL.SHIPPER.OTHER_ID.ISSUER | shipper_identification.identifications.other.issuer | Issuer of the other shipper identification | Character string, max 35 characters |
| BL.CONSIGNEE.NAME* | consignee_identification.name | Name of the consignee | Character string, max 70 characters |
| BL.CONSIGNEE.COUNTRY* | consignee_identification.country_of_domicile | Consignee’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| BL.CONSIGNEE.BIC | consignee_identification.identifications.any_bic | Consignee’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| BL.CONSIGNEE.LEI | consignee_identification.identifications.lei | “Consignee’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| BL.CONSIGNEE.EMAIL | consignee_identification.identifications.email_address | Consignee’s email address | Character string, max 256 characters |
| BL.CONSIGNEE.OTHER_ID | consignee_identification.identifications.other.identifiaction | Other identifications for the consignee | Character string, max 35 characters |
| BL.CONSIGNEE.OTHER_ID.SCHEME_CODE | consignee_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| BL.CONSIGNEE.OTHER_ID.SCHEME_NAME | consignee_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| BL.CONSIGNEE.OTHER_ID.ISSUER | consignee_identification.identifications.other.issuer | Issuer of the consignee’s other identification | Character string, max 35 characters |
| BL.CARRIER.NAME* | carrier_identification.name | Name of the Document carrier | Character string, max 70 characters |
| BL.CARRIER.COUNTRY* | carrier_identification.country_of_domicile | Carrier’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| BL.CARRIER.BIC | carrier_identification.identifications.any_bic | Carrier’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| BL.CARRIER.LEI | carrier_identification.identifications.lei | “Carrier’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| BL.CARRIER.EMAIL | carrier_identification.identifications.email_address | Carrier’s email address | Character string, max 256 characters |
| BL.CARRIER.OTHER_ID | carrier_identification.identifications.other.identifiaction | Other identifications for the carrier | Character string, max 35 characters |
| BL.CARRIER.OTHER_ID.SCHEME_CODE | carrier_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| BL.CARRIER.OTHER_ID.SCHEME_NAME | carrier_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| BL.CARRIER.OTHER_ID.ISSUER | carrier_identification.identifications.other.issuer | Issuer of the carrier’s other identification | Character string, max 35 characters |
| BL.NUMBER* | bill_of_lading_number | Document identification number for the bill of lading | Character string, max 35 characters |
| BL.PORT_OF_LOADING | port_of_loading | Port where goods were loaded | Character string, max 70 characters |
| BL.PORT_OF_DISCHARGE | port_of_discharge | Port where goods were discharged | Character string, max 70 characters |
| BL.VESSEL.NAME | vessel_name | Name of the vessel involved in the shipment | Character string, max 70 characters |
| BL.VESSEL.IMO | vessel_imo_number | The International Maritime Organization (IMO) number is a unique identifier for ships, registered ship owners and management companies | IMO format number |
| BL.COMM_LINE_ITEMS.ID | commercial_line_items.line_item_identification | Identification of the commercial line items | Character string, max 70 characters |
| BL.COMM_LINE_ITEMS.QUANTITY_UNIT_CODE | commercial_line_items.quantity.unit_of_measure.unit_of_measure_code | Quantity unit code for the commercial line items. Specifies a unit of measure with a code or free text | UN/ECE Recommendation 20 format code, character string, max 35 characters |
| BL.COMM_LINE_ITEMS.OTHER_UNIT_OF_MEASURE | commercial_line_items.quantity.unit_of_measure.other-unit_of_measure | Other unit of measure for the commercial line items. Specifies a unit of measure with a code or free text | Character string, max 35 characters |
| BL.COMM_LINE_ITEMS.QUANTITY.VALUE | commercial_line_items.quantity.value | Specifies the quantity of a product in a trade transaction | Number of objects represented as a decimal number, for example 0.75 or 45.6. |
| BL.COMM_LINE_ITEMS.QUANTITY.FACTOR | commercial_line_items.quantity.factor | Quantity factor of the price unit indicates the price unit for which the unit price of the document line is valid | Specifies a numeric string with a maximum length of 15 digits. |
| BL.COMM_LINE_ITEMS.UNIT_PRICE.CURRENCY | commercial_line_items.unit_price.currency | “Currency within which the commercial line items unit price amount is being recorded. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“” | ISO 4217 format currency code |
| BL.COMM_LINE_ITEMS.UNIT_PRICE.AMOUNT | commercial_line_items.unit_price.amount | Unit price amount of the commercial line items. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| BL.COMM_LINE_ITEMS.PRODUCT_NAME | commercial_line_items.product_name | Name of the product within commercial line items | Character string, max 70 characters |
| BL.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFIER_TYPE | commercial_line_items.product_identifier.structured_product_identifier.type | Specifies the type of identifier of a product | _BINR-buyers_item_number _COMD-commercial_description_code_name _EANC-ean _HRTR-harmonized_tariff_code_name _MANI-manufacturers_item_number _MODL-model_number _PART-part_number _QOTA-quota_category _STYL-style_number _SUPI-suppliers_item_number *UPCC-universal_product_code |
| BL.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFER | commercial_line_items.product_identifier.structured_product_identifier.identifier | Identifies a product in coded form or free text | Character string, max 35 characters |
| BL.COMM_LINE_ITEMS.OTHER_PRODUCT_ID | commercial_line_items.other_product_identifier.identification | Information related to an identification, eg, party identification or account identification | Character string, max 35 characters |
| BL.COMM_LINE_ITEMS.OTHER_PRODUCT_ID.TYPE | commercial_line_items.other_product_identifier.identificationtype | Type of identification included to specify the product | Character string, max 35 characters |
| BL.ONBOARD_DATE | onboard_date | “Onboard date. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format |
| BL.TRANSFERABLE | transferable | Indicates whether or not the document is transferable through endorsement or as a bearer document, or not transferable | _TRNA-Document cannot be transfered to a new consignee/beneficiary _TRAL-Document can be transfered to a new consignee/owner through endorsement of the existing consignee/beneficiary *BEAR-Document is freely transferable as a bearer instrument where the consignee/beneficiary is determined by physical ownership of the original document |
| CSV Field | API Field | Description | Accepted Values/Format |
|---|---|---|---|
| PO.SUBMITTER_DOC_REF* | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| PO.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha 2 Format |
| PO.ISSUER.NAME | document_issuer.name | Name of the Document Issuer | Character string, max 70 characters |
| PO.ISSUER.COUNTRY | document_issuer.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| PO.ISSUER.BIC | document_issuer.any_bic | Issuer’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| PO.ISSUER.LEI | document_issuer.lei | “Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| PO.ISSUER.EMAIL | document_issuer.email_address | Issuer’s email address | Character string, max 256 characters |
| PO.ISSUER.OTHER_ID | document_issuer.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| PO.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| PO.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| PO.ISSUER.OTHER_ID.ISSUER | document_issuer.other.issuer | Issuer of the other Issuer identification | Character string, max 35 characters |
| PO.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| PO.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| PO.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| PO.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| PO.ISSUE_DATE* | issue_date | “Date on which the purchase order was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format |
| PO.SELLER.NAME* | seller_identification.name | Name of the Document Seller | Character string, max 70 characters |
| PO.SELLER.COUNTRY* | seller_identification.country_of_domicile | Seller’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| PO.SELLER.BIC | seller_identification.identifications.any_bic | Seller’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| PO.SELLER.LEI | seller_identification.identifications.lei | “Seller’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| PO.SELLER.EMAIL | seller_identification.identifications.email_address | Seller’s email address | Character string, max 256 characters |
| PO.SELLER.OTHER_ID | seller_identification.identifications.other.identifiaction | Other identifications for the Seller | Character string, max 35 characters |
| PO.SELLER.OTHER_ID.SCHEME_CODE | seller_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| PO.SELLER.OTHER_ID.SCHEME_NAME | seller_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme. | Character string, max 256 characters |
| PO.SELLER.OTHER_ID.ISSUER | seller_identification.identifications.other.issuer | Issuer of the other Seller identification | Character string, max 35 characters |
| PO.BUYER.NAME* | buyer_identification.name | Name of the Document Buyer | Character string, max 70 characters |
| PO.BUYER.COUNTRY* | buyer_identification.country_of_domicile | Buyer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| PO.BUYER.BIC | buyer_identification.identifications.any_bic | Buyer’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| PO.BUYER.LEI | buyer_identification.identifications.lei | “Buyer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“.” | ISO 17442 format LEI, charchter string, max 20 characters |
| PO.BUYER.EMAIL | buyer_identification.identifications.email_address | Buyer’s email address | Character string, max 256 characters |
| PO.BUYER.OTHER_ID | buyer_identification.identifications.other.identifiaction | Other identifications for the Buyer | Character string, max 35 characters |
| PO.BUYER.OTHER_ID.SCHEME_CODE | buyer_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| PO.BUYER.OTHER_ID.SCHEME_NAME | buyer_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| PO.BUYER.OTHER_ID.ISSUER | buyer_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| PO.NUMBER* | purchase_order_number | Document number identifier of the purchase order | Character string, max 35 characters |
| PO.AMOUNT* | total_purchase_order_amount.amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| PO.CURRENCY* | total_purchase_order_amount.currency | “A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“” | ISO 4217 format currency code |
| PO.COMM_LINE_ITEMS.ID | commercial_line_items.line_item_identification | Identification of the commercial line items | Character string, max 70 characters |
| PO.COMM_LINE_ITEMS.QUANTITY_UNIT_CODE | commercial_line_items.quantity.unit_of_measure.unit_of_measure_code | Quantity unit code for the commercial line items. Specifies a unit of measure with a code or free text | UN/ECE Recommendation 20 format code, character string, max 35 characters |
| PO.COMM_LINE_ITEMS.OTHER_UNIT_OF_MEASURE | commercial_line_items.quantity.unit_of_measure.other-unit_of_measure | Other unit of measure for the commercial line items. Specifies a unit of measure with a code or free text | Character string, max 35 characters |
| PO.COMM_LINE_ITEMS.QUANTITY.VALUE | commercial_line_items.quantity.value | Specifies the quantity of a product in a trade transaction | Number of objects represented as a decimal number, for example 0.75 or 45.6. |
| PO.COMM_LINE_ITEMS.QUANTITY.FACTOR | commercial_line_items.quantity.factor | Quantity factor of the price unit indicates the price unit for which the unit price of the document line is valid | Specifies a numeric string with a maximum length of 15 digits. |
| PO.COMM_LINE_ITEMS.UNIT_PRICE_AMOUNT | commercial_line_items.unit_price.amount | Unit price amount of the commercial line items. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| PO.COMM_LINE_ITEMS.UNIT_PRICE_CURRENCY | commercial_line_items.unit_price.currency | “Currency within which the commercial line items unit price amount is being reported. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“” | ISO 4217 format currency code |
| PO.COMM_LINE_ITEMS.PRODUCT_NAME | commercial_line_items.product_name | Name of the product within commercial line items | Character string, max 70 characters |
| PO.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFIER_TYPE | commercial_line_items.product_identifier.structured_product_identifier.type | Specifies the type of identifier of a product | _BINR-buyers_item_number _COMD-commercial_description_code_name _EANC-ean _HRTR-harmonized_tariff_code_name _MANI-manufacturers_item_number _MODL-model_number _PART-part_number _QOTA-quota_category _STYL-style_number _SUPI-suppliers_item_number *UPCC-universal_product_code |
| PO.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFER | commercial_line_items.product_identifier.structured_product_identifier.identifier | Identifies a product in coded form or free text | Character string, max 35 characters |
| PO.COMM_LINE_ITEMS.OTHER_PRODUCT_ID | commercial_line_items.other_product_identifier.identification | Information related to an identification, eg, party identification or account identification | Character string, max 35 characters |
| PO.COMM_LINE_ITEMS.OTHER_PRODUCT_ID.TYPE | commercial_line_items.other_product_identifier.identificationtype | Type of identification included to specify the product | Character string, max 35 characters |
| CSV Field | API Field | Description | Accepted Values/Format |
|---|---|---|---|
| WHR.SUBMITTER_DOC_REF* | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| WHR.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha 2 Format |
| WHR.ISSUER.NAME | document_issuer.name | Name of the Document Issuer | Character string, max 70 characters |
| WHR.ISSUER.COUNTRY | document_issuer.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| WHR.ISSUER.BIC | document_issuer.any_bic | Issuer’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| WHR.ISSUER.LEI | document_issuer.lei | “Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| WHR.ISSUER.EMAIL | document_issuer.email_address | Issuer’s email address | Character string, max 256 characters |
| WHR.ISSUER.OTHER_ID | document_issuer.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| WHR.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| WHR.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| WHR.ISSUER.OTHER_ID.ISSUER | document_issuer.other.issuer | Issuer of the other Issuer identification | Character string, max 35 characters |
| WHR.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| WHR.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| WHR.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| WHR.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| WHR.ISSUE_DATE* | issue_date | “Date on which the warehouse receipt was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format |
| WHR.NUMBER* | warehouse_receipt_number | Document number identifier of the warehouse receipt | Character string, max 35 characters |
| WHR.DEPOSITOR.NAME* | depositor_identification.name | Name of the document depositor | Character string, max 70 characters |
| WHR.DEPOSITOR.COUNTRY* | depositor_identification.country_of_domicile | Depositor’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| WHR.DEPOSITOR.BIC | depositor_identification.identifications.any_bic | Depositor’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| WHR.DEPOSITOR.LEI | depositor_identification.identifications.lei | “Depositor’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, charchter string, max 20 characters |
| WHR.DEPOSITOR.EMAIL | depositor_identification.identifications.email_address | Depositor’s email address | Character string, max 256 characters |
| WHR.DEPOSITOR.OTHER_ID | depositor_identification.identifications.other.identifiaction | Other identifications for the depositor | Character string, max 35 characters |
| WHR.DEPOSITOR.OTHER_ID.SCHEME_CODE | depositor_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| WHR.DEPOSITOR.OTHER_ID.SCHEME_NAME | depositor_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme. | Character string, max 256 characters |
| WHR.DEPOSITOR.OTHER_ID.ISSUER | depositor_identification.identifications.other.issuer | Issuer of the other depositor identification | Character string, max 35 characters |
| WHR.WAREHOUSE_ADDRESS* | warehouse_address_line | Address of the warehouse | <= 5 items |
| WHR.WAREHOUSE_COUNTRY | warehouse_country | Country of the warehouse. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| WHR.COMM_LINE_ITEMS.ID | commercial_line_items.line_item_identification | Identification of the commercial line items | Character string, max 70 characters |
| WHR.COMM_LINE_ITEMS.QUANTITY_UNIT_CODE | commercial_line_items.quantity.unit_of_measure.unit_of_measure_code | Quantity unit code for the commercial line items. Specifies a unit of measure with a code or free text | UN/ECE Recommendation 20 format code, character string, max 35 characters |
| WHR.COMM_LINE_ITEMS.OTHER_UNIT_OF_MEASURE | commercial_line_items.quantity.unit_of_measure.other-unit_of_measure | Other unit of measure for the commercial line items. Specifies a unit of measure with a code or free text | Character string, max 35 characters |
| WHR.COMM_LINE_ITEMS.QUANTITY.VALUE | commercial_line_items.quantity.value | Specifies the quantity of a product in a trade transaction | Number of objects represented as a decimal number, for example 0.75 or 45.6. |
| WHR.COMM_LINE_ITEMS.QUANTITY.FACTOR | commercial_line_items.quantity.factor | Quantity factor of the price unit indicates the price unit for which the unit price of the document line is valid | Specifies a numeric string with a maximum length of 15 digits. |
| WHR.COMM_LINE_ITEMS.UNIT_PRICE_AMOUNT | commercial_line_items.unit_price.currency | “Currency within which the commercial line items unit price amount is being recorded. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“” | ISO 4217 format currency code |
| WHR.COMM_LINE_ITEMS.UNIT_PRICE_CURRENCY | commercial_line_items.unit_price.amount | Unit price amount of the commercial line items. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| WHR.COMM_LINE_ITEMS.PRODUCT_NAME | commercial_line_items.product_name | Name of the product within commercial line items | Character string, max 70 characters |
| WHR.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFIER_TYPE | commercial_line_items.product_identifier.structured_product_identifier.type | Specifies the type of identifier of a product | _BINR-buyers_item_number _COMD-commercial_description_code_name _EANC-ean _HRTR-harmonized_tariff_code_name _MANI-manufacturers_item_number _MODL-model_number _PART-part_number _QOTA-quota_category _STYL-style_number _SUPI-suppliers_item_number *UPCC-universal_product_code |
| WHR.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFER | commercial_line_items.product_identifier.structured_product_identifier.identifier | Identifies a product in coded form or free text | Character string, max 35 characters |
| WHR.COMM_LINE_ITEMS.OTHER_PRODUCT_ID | commercial_line_items.other_product_identifier.identification | Information related to an identification, eg, party identification or account identification | Character string, max 35 characters |
| WHR.COMM_LINE_ITEMS.OTHER_PRODUCT_ID.TYPE | commercial_line_items.other_product_identifier.identificationtype | Type of identification included to specify the product | Character string, max 35 characters |
| CSV Field | API Field | Description | Acceptable Values/Format |
|---|---|---|---|
| LOI.SUBMITTER_DOC_REF | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| LOI.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha 2 Format |
| LOI.ISSUER.NAME | document_issuer_identification.name | Name of the Document Issuer | Character string, max 70 characters |
| LOI.ISSUER.COUNTRY | document_issuer_identification.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| LOI.ISSUER.BIC | document_issuer_identification.identifications.any_bic | Issuer’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| LOI.ISSUER.LEI | document_issuer_identification.identifications.lei | “Issuer’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| LOI.ISSUER.EMAIL | document_issuer_identification.identifications.email_address | Issuer’s email address | Character string, max 256 characters |
| LOI.ISSUER.OTHER_ID | document_issuer_identification.identifications.other.identification | Issuer’s other identification | Character string, max 35 characters |
| LOI.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer_identification.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| LOI.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer_identification.other.scheme_name.proprietary | Document issuer other identification scheme name. Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| LOI.ISSUER.OTHER_ID.ISSUER | document_issuer_identification.other.issuer | Issuer of the Issuer’s other identification | Character string, max 35 characters |
| LOI.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| LOI.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| LOI.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| LOI.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| LOI.ISSUE.DATE | issue_date | “Date on which the Letter of Indemnity was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format (API), DD/MM/YYYY (CSV) |
| LOI.BUYER.NAME | buyer_identification.name | Name of the buyer | Character string, max 70 characters |
| LOI.BUYER.COUNTRY | buyer_identification.country_of_domicile | Buyer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| LOI.BUYER.BIC | buyer_identification.identifications.any_bic | Buyer’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| LOI.BUYER.LEI | buyer_identification.identifications.lei | “Buyer’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| LOI.BUYER.EMAIL | buyer_identification.identifications.email_address | Buyer’s email address | Character string, max 256 characters |
| LOI.BUYER.OTHER_ID | buyer_identification.identifications.other.identification | Buyer’s other identification | Character string, max 35 characters |
| LOI.BUYER.OTHER_ID.SCHEME_CODE | buyer_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| LOI.BUYER.OTHER_ID.SCHEME_NAME | buyer_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| LOI.BUYER.OTHER_ID.ISSUER | buyer_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| LOI.ADDRESSEE.NAME | addressee_identification.name | Name of the Document Addressee | Character string, max 70 characters |
| LOI.ADDRESSEE.COUNTRY | addressee_identification.country_of_domicile | Addressee’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| LOI.ADDRESSEE.BIC | addressee_identification.identifications.any_bic | Addressee’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| LOI.ADDRESSEE.LEI | addressee_identification.identifications.lei | “Addressee’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| LOI.ADDRESSEE.EMAIL | addressee_identification.identifications.email_address | Addressee’s email address | Character string, max 256 characters |
| LOI.ADDRESSEE.OTHER_ID | addressee_identification.identifications.other.identification | Addressee’s other identification | Character string, max 35 characters |
| LOI.ADDRESSEE.OTHER_ID.SCHEME_CODE | addressee_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| LOI.ADDRESSEE.OTHER_ID.SCHEME_NAME | addressee_identification.identifications.scheme_name.proprietary | Document issuer other identification scheme name. Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| LOI.ADDRESSEE.OTHER_ID.ISSUER | addressee_identification.identifications.other.issuer | Issuer of the Issuer’s other identification | Character string, max 35 characters |
| LOI.BL.NUMBER | bill_of_lading_number | Document identification number for the bill of lading | Character string, max 35 characters |
| LOI.BL.ISSUE_DATE | bill_of_lading_issue_date | “Date on which the Bill of Lading was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format (API), DD/MM/YYYY (CSV) |
| LOI.AMOUNT | letter_of_indemnity_amount.amount | A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| LOI.CURRENCY | letter_of_indemnity_amount.currency | “Currency within which the invoice amount is reported. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“” | ISO 4217 format currency code |
| LOI.LC_NUMBER | letter_of_credit_number | Documentary Credit Number as per Field 20 in the MT 700 swift message. | Character string, max 70 characters |
| LOI.VESSEL.NAME | vessel_name | Name of the vessel involved in the shipment | Character string, max 70 characters |
| LOI.VESSEL.IMO | vessel_imo_number | The International Maritime Organization (IMO) number is a unique identifier for ships, registered ship owners and management companies | IMO number format, max 7 characters |
| LOI.PORT_OF_LOADING | port_of_loading | Port where goods were loaded | Character string, max 70 characters |
| LOI.PORT_OF_DISCHARGE | port_of_discharge | Port where goods were discharged | Character string, max 70 characters |
| CSV Field | API Field | Description | Acceptable Values/Format |
|---|---|---|---|
| BDN.SUBMITTER_DOC_REF | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| BDN.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha 2 Format |
| BDN.ISSUER.NAME | document_issuer_identification.name | Name of the Document Issuer | Character string, max 70 characters |
| BDN.ISSUER.COUNTRY | document_issuer_identification.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| BDN.ISSUER.BIC | document_issuer_identification.identifications.any_bic | Issuer’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| BDN.ISSUER.LEI | document_issuer_identification.identifications.lei | Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442 “Financial Services - Legal Entity Identifier (LEI)” | ISO 17442 format LEI, charchter string, max 20 characters |
| BDN.ISSUER.EMAIL | document_issuer_identification.identifications.email_address | Issuer’s email address | Character string, max 256 characters |
| BDN.ISSUER.OTHER_ID | document_issuer_identification.identifications.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| BDN.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer_identification.identifications.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| BDN.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer_identification.identifications.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| BDN.ISSUER.OTHER_ID.ISSUER | document_issuer_identification.identifications.other.issuer | Issuer of the other Issuer identification | Character string, max 35 characters |
| BDN.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| BDN.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| BDN.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| BDN.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| BDN.SUPPLIER.NAME | supplier_identification.name | Name of the supplier | Character string, max 70 characters |
| BDN.SUPPLIER.COUNTRY | supplier_identification.country_of_domicile | Supplier’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| BDN.SUPPLIER.BIC | supplier_identification.identifications.any_bic | Supplier’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| BDN.SUPPLIER.LEI | supplier_identification.identifications.lei | “Supplier’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO). | Character string, max 20 characters |
| BDN.SUPPLIER.EMAIL | supplier_identification.identifications.email_address | Supplier’s email address | Character string, max 256 characters |
| BDN.SUPPLIER.OTHER_ID | supplier_identification.identifications.other.identification | Supplier’s other identification | Character string, max 35 characters |
| BDN.SUPPLIER.OTHER_ID.SCHEME_CODE | supplier_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| BDN.SUPPLIER.OTHER_ID.SCHEME_NAME | supplier_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| BDN.SUPPLIER.OTHER_ID.ISSUER | supplier_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| BDN.ISSUE_DATE | issue_date | “Date on which the Bunker Delivery Note was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format (API), DD/MM/YYYY (CSV) |
| BDN.NUMBER | bunker_delivery_note_number | Document identification number for the Bunker Delivery Note | Character string, max 35 characters |
| BDN.SB_NUMBER | bunker_license_number | Licence number assigned to the harbour craft for use as a tanker, prefixed with the letters “SB”, as defined under the Maritime and Port Authority of Singapore Act (Chapter 170A, Section 41). | Character string, max 35 characters |
| BDN.BUNKER_TANKER_NAME | delivery_vessel_name | Name of the bunker barge or tanker supplying bunker(s) to the vessel. | Character string, max 70 characters |
| BDN.VESSEL.NAME | receiver_vessel_name | Name of the receiving vessel. | Character string, max 70 characters |
| BDN.VESSEL.IMO_NUMBER | receiver_vessel_imo_number | The International Maritime Organization (IMO) number is a unique identifier for ships, registered ship owners and management companies | IMO format number |
| BDN.PORT_OF_DELIVERY | port_of_delivery | Port of bunkering/delivery | Character string, max 70 characters |
| CSV Field | API Field | Description | Acceptable Values/Format |
|---|---|---|---|
| DO.SUBMITTER_DOC_REF | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| DO.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha 2 Format |
| DO.ISSUER.NAME | document_issuer_identification.name | Name of the Document Issuer | Character string, max 70 characters |
| DO.ISSUER.COUNTRY | document_issuer_identification.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| DO.ISSUER.BIC | document_issuer_identification.identifications.any_bic | Issuer’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| DO.ISSUER.LEI | document_issuer_identification.identifications.lei | Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442 “Financial Services - Legal Entity Identifier (LEI)” | ISO 17442 format LEI, charchter string, max 20 characters |
| DO.ISSUER.EMAIL | document_issuer_identification.identifications.email_address | Issuer’s email address | Character string, max 256 characters |
| DO.ISSUER.OTHER_ID | document_issuer_identification.identifications.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| DO.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer_identification.identifications.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| DO.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer_identification.identifications.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| DO.ISSUER.OTHER_ID.ISSUER | document_issuer_identification.identifications.other.issuer | Issuer of the other Issuer identification | Character string, max 35 characters |
| DO.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| DO.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| DO.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| DO.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| DO.SUPPLIER.NAME | supplier_identification.name | Name of the supplier | Character string, max 70 characters |
| DO.SUPPLIER.COUNTRY | supplier_identification.country_of_domicile | Supplier’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| DO.SUPPLIER.BIC | supplier_identification.identifications.any_bic | Supplier’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| DO.SUPPLIER.LEI | supplier_identification.identifications.lei | “Supplier’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| DO.SUPPLIER.EMAIL | supplier_identification.identifications.email_address | Supplier’s email address | Character string, max 256 characters |
| DO.SUPPLIER.OTHER_ID | supplier_identification.identifications.other.identification | Supplier’s other identification | Character string, max 35 characters |
| DO.SUPPLIER.OTHER_ID.SCHEME_CODE | supplier_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| DO.SUPPLIER.OTHER_ID.SCHEME_NAME | supplier_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| DO.SUPPLIER.OTHER_ID.ISSUER | supplier_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| DO.BUYER.NAME | buyer_identification.name | Name of the buyer | Character string, max 70 characters |
| DO.BUYER.COUNTRY | buyer_identification.country_of_domicile | Buyer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| DO.BUYER.BIC | buyer_identification.identifications.any_bic | Buyer’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| DO.BUYER.LEI | buyer_identification.identifications.lei | “Buyer’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| DO.BUYER.EMAIL | buyer_identification.identifications.email_address | Buyer’s email address | Character string, max 256 characters |
| DO.BUYER.OTHER_ID | buyer_identification.identifications.other.identification | Buyer’s other identification | Character string, max 35 characters |
| DO.BUYER.OTHER_ID.SCHEME_CODE | buyer_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| DO.BUYER.OTHER_ID.SCHEME_NAME | buyer_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| DO.BUYER.OTHER_ID.ISSUER | buyer_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| DO.NUMBER | delivery_order_number | Document identification number for the Delivery Order | Character string, max 35 characters |
| DO.ISSUE_DATE | issue_date | “Date on which the Delivery Order was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format (API), DD/MM/YYYY (CSV) |
| DO.DELIVERY_ADDRESS | delivery_address_line | Full address of delivery location | Character string, max 70 characters |
| DO.DATE_OF_GOODS_RECEIPT | date_of_goods_receipt | “Date on which the delivery was received. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format (API), DD/MM/YYYY (CSV) |
| DO.COMM_LINE_ITEMS.ID | commercial_line_items.line_item_identification | Identification of the commercial line items | Character string, max 70 characters |
| DO.COMM_LINE_ITEMS.QUANTITY_UNIT_CODE | commercial_line_items.quantity.unit_of_measure.unit_of_measure_code | Quantity unit code for the commercial line items. Specifies a unit of measure with a code or free text | UN/ECE Recommendation 20 format code, character string, max 35 characters |
| DO.COMM_LINE_ITEMS.OTHER_UNIT_OF_MEASURE | commercial_line_items.quantity.unit_of_measure.other-unit_of_measure | Other unit of measure for the commercial line items. Specifies a unit of measure with a code or free text | Character string, max 35 characters |
| DO.COMM_LINE_ITEMS.QUANTITY.VALUE | commercial_line_items.quantity.value | Specifies the quantity of a product in a trade transaction. | Number of objects represented as a decimal number, for example 0.75 or 1045.6 (without commas) |
| DO.COMM_LINE_ITEMS.QUANTITY.FACTOR | commercial_line_items.quantity.factor | Quantity factor of the price unit indicates the price unit for which the unit price of the document line is valid | Specifies a numeric string with a maximum length of 15 digits. |
| DO.COMM_LINE_ITEMS.UNIT_PRICE_CURRENCY | commercial_line_items.unit_price.currency | “Currency within which the commercial line items unit price amount is reported. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“.” | ISO 4217 format currency code |
| DO.COMM_LINE_ITEMS.UNIT_PRICE_AMOUNT | commercial_line_items.unit_price.amount | Unit price amount of the commercial line items. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| DO.COMM_LINE_ITEMS.PRODUCT_NAME | commercial_line_items.product_name | Name of the product within commercial line items | Character string, max 70 characters |
| DO.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFIER_TYPE | commercial_line_items.product_identifier.structured_product_identifier.type | Specifies the type of identifier of a product. | _BINR-buyers_item_number _COMD-commercial_description_code_name _EANC-ean _HRTR-harmonized_tariff_code_name _MANI-manufacturers_item_number _MODL-model_number _PART-part_number _QOTA-quota_category _STYL-style_number _SUPI-suppliers_item_number *UPCC-universal_product_code |
| DO.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFER | commercial_line_items.product_identifier.structured_product_identifier.identifier | Identifies a product in coded form or free text | Character string, max 35 characters |
| DO.COMM_LINE_ITEMS.OTHER_PRODUCT_ID | commercial_line_items.other_product_identifier.identification | Information related to an identification, eg, party identification or account identification | Character string, max 35 characters |
| DO.COMM_LINE_ITEMS.OTHER_PRODUCT_ID.TYPE | commercial_line_items.other_product_identifier.identification_type | Type of identification included to specify the product | Character string, max 35 characters |
| CSV Field | API Field | Description | Acceptable Values/Format |
|---|---|---|---|
| AWB.SUBMITTER_DOC_REF | submitter_document_reference | Reference number for the document, generated by the user | Character string, max 35 characters |
| AWB.DOC_ISSUE_COUNTRY | country_of_issue | Country where the document was issued. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). | ISO 3166, Alpha 2 Format |
| AWB.ISSUER.NAME | document_issuer_identification.name | Name of the Document Issuer | Character string, max 70 characters |
| AWB.ISSUER.COUNTRY | document_issuer_identification.country_of_domicile | Issuer’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| AWB.ISSUER.BIC | document_issuer_identification.identifications.any_bic | Issuer’s BIC. Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, charchter string, max 11 characters |
| AWB.ISSUER.LEI | document_issuer_identification.identifications.lei | Issuer’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442 “Financial Services - Legal Entity Identifier (LEI)” | ISO 17442 format LEI, charchter string, max 20 characters |
| AWB.ISSUER.EMAIL | document_issuer_identification.identifications.email_address | Issuer’s email address | Character string, max 256 characters |
| AWB.ISSUER.OTHER_ID | document_issuer_identification.identifications.other.identification | Other identifications for the Issuer | Character string, max 35 characters |
| AWB.ISSUER.OTHER_ID.SCHEME_CODE | document_issuer_identification.identifications.other.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| AWB.ISSUER.OTHER_ID.SCHEME_NAME | document_issuer_identification.identifications.other.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| AWB.ISSUER.OTHER_ID.ISSUER | document_issuer_identification.identifications.other.issuer | Issuer of the other Issuer identification | Character string, max 35 characters |
| AWB.TRADE_UTILITY_SERVICE.SERVICE_NAME | trade_utility_service.service_name | Uniquely identifies a trade utility service against which to perform a document genuineness check | Character string, max 70 characters |
| AWB.TRADE_UTILITY_SERVICE.RECORD_ID | trade_utility_service.record_identifier | Identification of the record at the trade utility | Character string, max 70 characters |
| AWB.TRADE_UTILITY_SERVICE.RECORD_OWNER_ID | trade_utility_service.record_owner_identification | Identification of the record owner at the trade utility | Character string, max 70 characters |
| AWB.TRADE_UTILITY_SERVICE.RECORD_OWNER_EMAIL | trade_utility_service.record_owner_contact_emails | Email addresses of the record owners | Character string, max 256 characters |
| AWB.CONSIGNEE.NAME | consignee_identification.name | Name of the consignee/receiver | Character string, max 70 characters |
| AWB.CONSIGNEE.COUNTRY | consignee_identification.country_of_domicile | Consignee’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| AWB.CONSIGNEE.BIC | consignee_identification.identifications.any_bic | Consignee/Receiver’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| AWB.CONSIGNEE.LEI | consignee_identification.identifications.lei | “Consignee/Receiver’s Legal Entity Identifier. LEI is a code allocated to a party as described in ISO 17442”“Financial Services - Legal Entity Identifier (LEI)”“” | ISO 17442 format LEI, character string, max 20 characters |
| AWB.CONSIGNEE.EMAIL | consignee_identification.identifications.email_address | Consignee/Receiver’s email address | Character string, max 256 characters |
| AWB.CONSIGNEE.OTHER_ID | consignee_identification.identifications.other.identification | Consignee/Receiver’s other identification | Character string, max 35 characters |
| AWB.CONSIGNEE.OTHER_ID.SCHEME_CODE | consignee_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| AWB.CONSIGNEE.OTHER_ID.SCHEME_NAME | consignee_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| AWB.CONSIGNEE.OTHER_ID.ISSUER | consignee_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| AWB.SHIPPER.NAME | shipper_identification.name | Name of the shipper/consignor | Character string, max 70 characters |
| AWB.SHIPPER.COUNTRY | shipper_identification.country_of_domicile | Shipper/Consignor’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| AWB.SHIPPER.BIC | shipper_identification.identifications.any_bic | Shipper’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| AWB.SHIPPER.LEI | shipper_identification.identifications.lei | “Shipper’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| AWB.SHIPPER.EMAIL | shipper_identification.identifications.email_address | Shipper’s email address | Character string, max 256 characters |
| AWB.SHIPPER.OTHER_ID | shipper_identification.identifications.other.identification | Shipper’s other identification | Character string, max 35 characters |
| AWB.SHIPPER.OTHER_ID.SCHEME_CODE | shipper_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| AWB.SHIPPER.OTHER_ID.SCHEME_NAME | shipper_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| AWB.SHIPPER.OTHER_ID.ISSUER | shipper_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| AWB.CARRIER.NAME | carrier_identification.name | Name of the carrier | Character string, max 70 characters |
| AWB.CARRIER.COUNTRY | carrier_identification.country_of_domicile | Carrier’s country of domicile. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code) | ISO 3166, Alpha-2 format country code |
| AWB.CARRIER.BIC | carrier_identification.identifications.any_bic | Carrier’s BIC- Code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority, as described in ISO 9362: 2014 - ‘Banking - Banking telecommunication messages - Business identifier code (BIC)’ | ISO 9362 format BIC Code, character string, max 11 characters |
| AWB.CARRIER.LEI | carrier_identification.identifications.lei | “Carrier’s Legal Entity Identifier. LEI is a 20-character, alpha-numeric code based on the ISO 17442 standard developed by the International Organization for Standardization (ISO).” | Character string, max 20 characters |
| AWB.CARRIER.EMAIL | carrier_identification.identifications.email_address | Carrier’s email address | Character string, max 256 characters |
| AWB.CARRIER.OTHER_ID | carrier_identification.identifications.other.identification | Carrier’s other identification | Character string, max 35 characters |
| AWB.CARRIER.OTHER_ID.SCHEME_CODE | carrier_identification.identifications.scheme_name.code | Name of the identification scheme, in a coded form as published in an external list | Character string, between 1 and 4 characters |
| AWB.CARRIER.OTHER_ID.SCHEME_NAME | carrier_identification.identifications.scheme_name.proprietary | Sets of elements to identify a name of the organisation identification scheme | Character string, max 256 characters |
| AWB.CARRIER.OTHER_ID.ISSUER | carrier_identification.identifications.other.issuer | Issuer of the other Buyer identification | Character string, max 35 characters |
| AWB.NUMBER | air_way_bill_number | Document identification number for the Air Waybill | Character string, max 35 characters |
| AWB.ISSUE_DATE | issue_date | “Date on which the Air Waybill was issued. YYYY-MM-DD representation is defined in”“XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004”” which is aligned with ISO 8601” | YYYY-MM-DD format (API), DD/MM/YYYY (CSV) |
| AWB.AIRPORT_OF_DEPARTURE | port_of_departure | Airport where goods were loaded. A unique 3-letter code to identify an airport, as published by The International Civil Aviation Organization (ICAO) | ICAO airport code format, max 3 characters |
| AWB.AIRPORT_OF_DESTINATION | port_of_destination | Airport where goods were discharged. A unique 3-letter code to identify an airport, as published by The International Civil Aviation Organization (ICAO) | ICAO airport code format, max 3 characters |
| AWB.COMM_LINE_ITEMS.ID | commercial_line_items.line_item_identification | Identification of the commercial line items | Character string, max 70 characters |
| AWB.COMM_LINE_ITEMS.QUANTITY_UNIT_CODE | commercial_line_items.quantity.unit_of_measure.unit_of_measure_code | Quantity unit code for the commercial line items. Specifies a unit of measure with a code or free text | UN/ECE Recommendation 20 format code, character string, max 35 characters |
| AWB.COMM_LINE_ITEMS.OTHER_UNIT_OF_MEASURE | commercial_line_items.quantity.unit_of_measure.other-unit_of_measure | Other unit of measure for the commercial line items. Specifies a unit of measure with a code or free text | Character string, max 35 characters |
| AWB.COMM_LINE_ITEMS.QUANTITY | commercial_line_items.quantity | Specifies the quantity of a product in a trade transaction. | Number of objects represented as a decimal number, for example 0.75 or 1045.6 (without commas) |
| AWB.COMM_LINE_ITEMS.QUANTITY.FACTOR | commercial_line_items.quantity.factor | Quantity factor of the price unit indicates the price unit for which the unit price of the document line is valid | Specifies a numeric string with a maximum length of 15 digits. |
| AWB.COMM_LINE_ITEMS.UNIT_PRICE_AMOUNT | commercial_line_items.unit_price.amount | Unit price amount of the commercial line items. A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217 | Character string, max 19 characters |
| AWB.COMM_LINE_ITEMS.UNIT_PRICE_CURRENCY | commercial_line_items.unit_price.currency | “Currency within which the commercial line items unit price amount is reported. A code allocated to a currency by a Maintenance Agency under an international identification scheme as described in the latest edition of the international standard ISO 4217”“Codes for the representation of currencies and funds”“.” | ISO 4217 format currency code |
| AWB.COMM_LINE_ITEMS.PRODUCT_NAME | commercial_line_items.product_name | Name of the product within commercial line items | Character string, max 70 characters |
| AWB.COMM_LINE_ITEMS.STRUCTURED_PRODUCT_IDENTIFER | commercial_line_items.product_identifier.structured_product_identifier.identifier | Identifies a product in coded form or free text | Character string, max 35 characters |
| AWB.COMM_LINE_ITEMS.OTHER_PRODUCT_ID | commercial_line_items.other_product_identifier.identification | Information related to an identification, eg, party identification or account identification | Character string, max 35 characters |
| AWB.COMM_LINE_ITEMS.OTHER_PRODUCT_ID.TYPE | commercial_line_items.other_product_identifier.identification_type | Type of identification included to specify the product | Character string, max 35 characters |