Fineract Native Import API

Get Import Based on Entity

GET https://api.fineract.yourlocalinstance/fineract-provider/v1/import?entityType={}

This endpoint allows you to get existing list import based on the entity.

Path Parameters

Name	Type	Description
Entity type	string	Entity type such as loan account, savings account

Headers

Name	Type	Description
Authentication	string	Authentication token to track down who is emptying the stocks

200 Import Successfully retrieved. Example Response.

[{
    "importId": 5,
    "documentId": 5,
    "name": "CHART_OF_ACCOUNTS2020-04-01 (2).xls",
    "importTime": [2020, 4, 1],
    "endTime": [2020, 4, 1],
    "completed": true,
    "createdBy": 4,
    "totalRecords": 639,
    "successCount": 0,
    "failureCount": 639
}, {
    "importId": 4,
    "documentId": 4,
    "name": "CHART_OF_ACCOUNTS2020-04-01 (1).xls",
    "importTime": [2020, 4, 1],
    "endTime": [2020, 4, 1],
    "completed": true,
    "createdBy": 4,
    "totalRecords": 639,
    "successCount": 0,
    "failureCount": 639
}, {
    "importId": 3,
    "documentId": 3,
    "name": "CHART_OF_ACCOUNTS2020-04-01.xls",
    "importTime": [2020, 4, 1],
    "endTime": [2020, 4, 1],
    "completed": true,
    "createdBy": 4,
    "totalRecords": 639,
    "successCount": 0,
    "failureCount": 639
}, {
    "importId": 2,
    "documentId": 2,
    "name": "CHART_OF_ACCOUNTS2020-04-01.xls",
    "importTime": [2020, 4, 1],
    "endTime": [2020, 4, 1],
    "completed": true,
    "createdBy": 4,
    "totalRecords": 639,
    "successCount": 0,
    "failureCount": 639
}, {
    "importId": 1,
    "documentId": 1,
    "name": "CHART_OF_ACCOUNTS2020-04-01.xls",
    "importTime": [2020, 4, 1],
    "endTime": [2020, 4, 1],
    "completed": true,
    "createdBy": 4,
    "totalRecords": 639,
    "successCount": 0,
    "failureCount": 639
}]

404 Could not find the matching entity. Example Response.

{"developerMessage":"The requested resource is not available.","httpStatusCode":"404","defaultUserMessage":"The requested resource is not available.","userMessageGlobalisationCode":"error.msg.resource.not.found","errors":[{"developerMessage":"Entity type ls does not exist","defaultUserMessage":"Entity type ls does not exist","userMessageGlobalisationCode":"error.msg.entity.type.invalid","parameterName":"id","value":null,"args":[{"value":"ls"}]}]}

Perform a bulk upload

POST https://api.fineract.yourlocalinstance/fineract-provider/v1/{entityType}/{transactions}

To perform a bulk upload.

Request Body

Name	Type	Description
file	object	file upload in xlsx format
locale	string	local parameters such as language
date	string	Date format required by the API

200 Response Example to be updated.

400 Response Example to be updated.