CSV Upload¶
To request multiple reports via the openESG platform, you can upload a CSV file containing the required information.
CSV format¶
You should add a header to the csv file, to dynamically select, which data do you want to provide.
You can select from the following fields.
organization_nameorganization_legal_form(must be one of the following:ab,adoer,ag,eg,ek,ek-ohg,gbr,gmbh,gmbh-co-kg,kg,kdoer,ltd,ohg,other,part-gmbb,partg,se,se-co-kg,sole-proprietorship,stiftung,stiftung-co-kg,ug,ug-co-kg,natural_person. Default:gmbh). Alternatively to thekey, one can also pass thename, e.g.GmbHinstead ofgmbhorganization_vat_idorganization_court_of_registrationorganization_commercial_register_numberorganization_homepageorganization_emailorganization_phoneorganization_address_line_1organization_address_line_2organization_house_numberorganization_zip_codeorganization_cityorganization_country(must be a ISO 3166-1 alpha-2 country code (e.g.AT,CH,FR). Default:DE.)user_emailuser_salutation(must be one of the following:dear_mr,dear_mrs,good_day.)user_first_nameuser_last_nameuser_phoneuser_locale(must be one of the following:en_US,de_DE,fr_FR,es_ESorit_IT. Default:de_DE)user_timezone(must be one of the tz database, e.g.Europe/Berlin. Default:UTC)personal_messagereason(will be part of a Report to distinguish the purpose of the report)submission_date(must be in the ISO 8601 format (YYYY-MM-DD), e.g.2024-10-01.)creation_date(must be in the ISO 8601 format (YYYY-MM-DD), e.g.2024-10-01. Default: current date time)customer_identifier(can be used to filter reports or report requests)provider_notification(must be one of the following:directly,after_esg_risk_check,no_notification. Default:directly)requestor_email(if not provided, the upload user will be used; otherwise, it will be used to check for an existing user in the current organization. If no matching user is found, a new user in the current organization will be created.)requestor_first_namerequestor_last_namerequestor2_email(If specified, the requestor user is granted additional access to the report request. If it doesn't exist, it will be created in the current organization.)requestor2_first_namerequestor2_last_namerequestor3_email(If specified, the requestor user is granted additional access to the report request. If it doesn't exist, it will be created in the current organization.)requestor3_first_namerequestor3_last_name
The delimiter should be a comma (,) or a semicolon (;).
CSV upload with pre-selected Report Template¶
Mandatory fields (pre-selected Report Template)¶
organization_nameuser_email
Example (pre-selected Report Template)¶
Here is an example with three organizations:
organization_name,organization_legal_form,organization_vat_id,organization_email,organization_homepage,user_salutation,user_first_name,user_last_name,user_email,provider_notification
Test Customer,gmbh,DE123456789,test@customer.de,https://testcustomer.de,dear_mr,Max,Mustermann,max.mustermann@testcustomer.de,directly
Test Company,ag,DE123456788,test@company.de,https://testcustomer.de,dear_mr,Max,Mustermann,max.mustermann@testcustomer.de,no_notification
Test Company 2,ek-ohg,DE123456787,test@company2.de,https://testcomapny2.de,dear_mrs,Jane,Doe,jane.doe@testcompany2.de,directly
General CSV upload¶
The general CSV upload is based on the regular CSV upload but offers you the option to specify a Report Template per line
Mandatory fields (general CSV upload)¶
organization_nameuser_emailreport_template(must be either the ID or the key of the Report Template, e.g.123orvsme)
Example (general CSV upload)¶
Here is an example with three organizations:
organization_name,organization_legal_form,organization_vat_id,organization_email,organization_homepage,user_salutation,user_first_name,user_last_name,user_email,provider_notification,report_template
Test Customer,gmbh,DE123456789,test@customer.de,https://testcustomer.de,dear_mr,Max,Mustermann,max.mustermann@testcustomer.de,directly,11
Test Company,ag,DE123456788,test@company.de,https://testcustomer.de,dear_mr,Max,Mustermann,max.mustermann@testcustomer.de,no_notification,vsme
Test Company 2,ek-ohg,DE123456787,test@company2.de,https://testcomapny2.de,dear_mrs,Jane,Doe,jane.doe@testcompany2.de,directly,vsme