Bulk Data Export Formats
There are two export formats available via the Bulk Data API which control whether the company, relationship and tier information is combined in a single CSV or split across many.
- Single table - When the payload specifies
output_multiple_tables
as "no" the export is combined into a single CSV sheet. - Multiple table - When the payload specifies
output_multiple_tables
"yes" the export is split into three files. One file contains company information for the export, another contains the relationship information between companies and the final file contains the tier numbers which locate the companies in the export (i.e contain the tier numbers).
Single Table Export
The format of the single table export is as follows, where each row represents a relationship between a customer and supplier. The tier of the customer and supplier is also given.
Column | Description |
---|---|
root_node_name | The delivery name of the company the tier view is run for. |
root_node_vid | The Versed Identifier of the root company. |
customer_tier | The tier number of the customer of the row. The customer tier is 1 less than the supplier tier. |
customer_delivery_name | The delivery name of the customer of the row. |
customer_vid | The Versed Identifier of the customer company. |
customer_cid | The cluster identifier of the customer company. |
supplier_tier | The tier number of the supplier in the row. The supplier tier is 1 greater than the customer tier. |
supplier_delivery_name | The delivery name of the supplier, which is the legal name if not null. |
supplier_vid | The Versed Identifiers of the supplier company. |
supplier_cid | The cluster identifier of the supplier company. |
edge_ids | A list of the edge identifiers that make up the row. |
cluster_edge_id | The unique identifier of the cluster edge of the row. |
edge_score | The total confidence score of the row. |
hs_codes | The HS codes extracted from shipping evidence support the row. |
status_code | The status code of the cluster edge. |
evidence_types | The evidence types which support the row. |
specific_evidence_types | The granular evidence types which support the row. |
latest_edge_date | The latest date of the edges which support the relationship in the row. |
latest_finalized_edge_date | The latest finalized date of the edges which support the relationship in the row. |
customer_display_name | The display name of the customer company. |
customer_company_legal_name | The legal name if known of the customer company. |
customer_country | The country of the customer company. |
customer_domiciled_country | The customer domiciled country - a PermID field. |
customer_incorporated_country | The customer incorporated country - a PermID field. |
customer_bol_transaction_country | The customer BOL transaction field - a country aggregated from countries found in shipping records. |
customer_hq_country | The customer HQ country. |
customer_permid | The PermID of the customer in the row. |
customer_lei | The LEI of the customer in the row. |
customer_url | The URL(s) of the customer company in the row. |
supplier_display_name | The supplier display name. |
supplier_company_legal_name | The legal name if known of the supplier company. |
supplier_country | The country of the supplier in the row. |
supplier_domiciled_country | The domiciled country of the supplier in the row - a PermID field. |
supplier_incorporated_country | The incorporated country of the supplier - a PermID field. |
supplier_bol_transaction_country | A country extracted from shipping records associated with the supplier. |
supplier_hq_country | The country of the supplier HQ. |
supplier_permid | The PermID of the supplier in the row. |
supplier_lei | The LEI of the supplier in the row. |
supplier_url | The URL(s) of the supplier company in the row. |
Multiple Table Export
The multiple table export splits information in the export into multiple tables to reduce duplication. The companies and edges tables store the companies and relationships that appear in the export only once. The tiers table lays out how each relationship and customer/supplier pair is positioned in the supply map.
Companies Table
The companies table contains a list of all of the companies in the export. Generally companies will appear multiple times in the dataset - this is captured in the tiers table. The companies table is the unique set of companies exported.
Column | Description |
---|---|
delivery_name | Delivery name (the legal name if not null or the display name) of companies in the tier view export. |
vid | The Versed IDentifier of the company in the export. |
cid | The cluster id of the company. |
display_name | The display name (common name) of the company. |
company_legal_name | The legal name of the company. |
country | The country associated with the company. |
domiciled_country | The domiciled country of the company - a PermID field. |
incorporated_country | The incorporated country of the company - a PermID field. |
bol_transaction_country | A country extracted from shipping data related to the company as a supplier. |
hq_country | The country of the company HQ. |
permid | The PermID of the company. |
lei | The LEI of the company. |
url | URLs of the company website. |
Tiers Table
The tiers table represents the locations of the customers and suppliers in the dataset. The tier numbers for each customer and supplier are shown along with the cluster_edge_id
, which is a foreign key into the edges table.
Column | Description |
---|---|
root_node_name | The delivery name of the company the tier view is run for. |
root_node_vid | The Versed IDentifier of the root company. |
cluster_edge_id | The unique identifier of the cluster edge of the row. |
edge_ids | A list of the edge identifiers that make up the row. |
customer_tier | The tier number of the customer of the row. The customer tier is 1 less than the supplier tier. |
supplier_tier | The tier number of the supplier in the row. The supplier tier is 1 greater than the customer tier. |
supplier_vid | The Versed IDentifiers of the supplier company. |
customer_vid | The Versed IDentifier of the customer company. |
Edges Table
The edges table represents the unique relationships present in the dataset. Each edge appears only once. Should relationships appear multiple times, they will be listed many times in the tiers table.
Column | Description |
---|---|
cluster_edge_id | The unique identifier of the cluster edge of the row. |
edge_ids | The edge ids which make up the cluster edge. |
hs_codes | The HS codes extracted from shipping evidence for this edge. |
edge_score | The total score of the edge. |
latest_edge_date | The latest date supporting the edge. |
latest_finalized_edge_date | The latest date from finalised evidence supporting the edge. |
evidence_types | Evidence types supporting the edge. |
specific_evidence_types | Granular evidence types supporting the edge. |
status_code | The status code support the edge (related to human checking procedure). |