Particeep

How to import data

This page will explain how to import your own data with Particeep's API.
This can be especially useful if you have a lot of data from an external source or a previous environment that you quickly want to integrate to the API database in one go.
The following entities can currently be imported via CSV files :

Other API entities should be added soon !

1 - The import module

When importing data, you must simply upload a CSV file via the following endpoints from the import module :
(POST) /v1/import/user/csv
(POST) /v1/import/enterprise/csv
(POST) /v1/import/fundraise-loan/csv
(POST) /v1/import/fundraise-equity/csv
(POST) /v1/import/fundraise-reward/csv
(POST) /v1/import/transaction/csv
The documentation on how to upload a file with our API can be found here
If you are used to work with Excel, here is the official documentation on how to convert an XLS file to a CSV file.

2 - CSV formats

Each entity must be imported following a specific format. Here are some example CSV files and details on the fields formats for each entity.
You should make sure that :

User

Here is a sample file

Field Required Format
Email X String
Password X String
First name String
Last name String
Gender: (MAN or WOMAN) String
Birth date ISO 8601
Birth place String
Phone number String
Residence country ISO 3166-1
Street number String
Street String
Zip code String
Town String
Nationality String

Enterprise

Here is a sample file

Field Required Format
Email of the project's owner X String
Project name X String
Project creation date ISO 8601
Activity domain String
Legal status String
Short description of the project String
Long description of the project (HTML allowed) String
Project website URL String
Project status String
Street number String
Street String
Zip code String
City String
Country (e.g., FR) String

You should note that the import will fail in the following cases : non-existing owner email.

Loan fundraise

Here is a sample file

Field Required Format
Project name X String
Amount target X Double
Short description String
Long description (HTML allowed) String
Offline description (HTML allowed) String
Start date ISO 8601
End date ISO 8601
Currency X ISO 4217
Score String
Term duration X Int
Rate (in %) X Double
Tax rate (in %) Double
Amount minimum Double
Reimbursment method, possible values: CONSTANT, INFINE, COUPON_CONSTANT String
Repayment frequency (in month) Int
Repayment start date ISO 8601
Deferred period(in month) Int

You should note that the import will fail in the following cases : non-existing or duplicate enterprise name.

Equity fundraise

Here is a sample file

Field Required Format
Project name X String
Amount target X Double
Short description String
Long description (HTML allowed) String
Offline description (HTML allowed) String
Start date ISO 8601
End date ISO 8601
Currency X ISO 4217
Yield String
Financial instrument (Declarative field) String
Fees added at initial investment (in %) Double
Fees added at initial investment Double
Fees added on the selling price of a share (in %) Double
Government taxes that will be applied on the investment (in %) Double
Value of a share in this fundraise Double
Total number of shares Int
Shares available for this fundraise Int
Round (e.g., Serie A, Serie B). This is a declarative field String
Valuation of the project before the fundraise Double
Min amount an investor can invest in this fundraise Double
Max amount an investor can invest in this fundraise Double

You should note that the import will fail in the following cases : non-existing or duplicate enterprise name.

Reward fundraise

Here is a sample file

Field Required Format
Project name (must be the same as the project) X String
Amount target X Double
Short description String
Long description (HTML allowed) String
Offline description (HTML allowed) String
Start date ISO 8601
End date ISO 8601
Currency X ISO 4217

You should note that the import will fail in the following cases : non-existing or duplicate enterprise name.

Transaction

Here is a sample file

Field Required Format
E-mail of the user doing the transaction X String
Project name receiving the transaction X String
Transaction amount X Double
Transaction fees (in %) Double
Currency X ISO 4217

You should note that the import will fail in the following cases : non-existing issuer email, non-existing or duplicate enterprise name, multiple fundraises for the enterprise.

2 - Api response

The api will send you a response in the following format :


			{
	  "lineTreated": 0,
	  "nbCreated": 0,
	  "nbFail": 0,
	  "lineWithError": [
	    {
	      "line": 0,
	      "error": "string"
	    }
	  ],
	  "lineOnSuccess": [
	    {
	      "line": 0,
	      "success": {
	      	/*imported entity*/
	      }
	    }
	  ]
	}
		
The array lineOnSuccess contains each line that has been successfully imported and the corresponding created entity.
The array lineWithError contains each line that failed with the reason of the failure. You can then fix the errors and try to import them again.


Next steps

Now that you know how to import your own data, you may want to know how to easily visualize them with GraphQL :