Command Palette

Search for a command to run...

B
Request

System

System configuration, codes, datatables, reports, scheduled jobs, and audit logs

List codesRetrieve codeCreate codeList code valuesCreate code valueList datatablesRetrieve datatable definitionCreate datatableRetrieve datatable entriesCreate datatable entryList reportsRetrieve report definitionRun reportList scheduled jobsRetrieve scheduled jobRun scheduled jobUpdate scheduled jobList global configurationsRetrieve configurationUpdate configurationList audit logsRetrieve audit log entry
GET
/fineract-provider/api/v1/codes

List codes

Retrieves all system codes (drop-down/lookup definitions).

Returns

200List of codes

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/codes" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/codes/{codeId}

Retrieve code

Gets details of a specific code including its values.

Path Parameters

codeIdintegerrequired

Code ID

Returns

200Code details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/codes/:codeId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/codes

Create code

Creates a new code definition.

Request Bodyrequired

Code details

namestring

Returns

200Code created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/codes" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/codes/{codeId}/codevalues

List code values

Retrieves all values for a specific code.

Path Parameters

codeIdintegerrequired

Code ID

Returns

200List of code values

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/codes/:codeId/codevalues" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/codes/{codeId}/codevalues

Create code value

Creates a new value for a code.

Path Parameters

codeIdintegerrequired

Code ID

Request Bodyrequired

Code value details

namestring
positioninteger
descriptionstring
isActiveboolean

Returns

200Code value created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/codes/:codeId/codevalues" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name",
  "position": 1,
  "description": "sample_description",
  "isActive": true
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/datatables

List datatables

Retrieves all custom datatables.

Query Parameters

apptablestring

Filter by application table

Returns

200List of datatables

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/datatables" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/datatables/{datatable}

Retrieve datatable definition

Gets the column definition of a specific datatable.

Path Parameters

datatablestringrequired

Datatable name

Returns

200Datatable definition

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/datatables/:datatable" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/datatables

Create datatable

Creates a new custom datatable.

Request Bodyrequired

Datatable definition

datatableNamestring
apptableNamestring

Associated application table

multiRowboolean
columnsarray

Returns

200Datatable created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/datatables" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "datatableName": "sample_datatableName",
  "apptableName": "sample_apptableName",
  "multiRow": true,
  "columns": []
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/datatables/{datatable}/{apptableId}

Retrieve datatable entries

Gets data entries from a datatable for a specific entity.

Path Parameters

datatablestringrequired

Datatable name

apptableIdintegerrequired

Entity ID

Returns

200Datatable data

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/datatables/:datatable/:apptableId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/datatables/{datatable}/{apptableId}

Create datatable entry

Creates a new entry in a datatable for a specific entity.

Path Parameters

datatablestringrequired

Datatable name

apptableIdintegerrequired

Entity ID

Request Bodyrequired

Datatable entry data (varies by datatable)

Returns

200Entry created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/datatables/:datatable/:apptableId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/reports

List reports

Retrieves all configured reports.

Returns

200List of reports

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/reports" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/reports/{reportId}

Retrieve report definition

Gets the definition of a specific report.

Path Parameters

reportIdintegerrequired

Report ID

Returns

200Report definition

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/reports/:reportId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
GET
/fineract-provider/api/v1/runreports/{reportName}

Run report

Executes a report and returns the results.

Path Parameters

reportNamestringrequired

Report name

Query Parameters

R_officeIdinteger

Office filter

R_loanOfficerIdinteger

Loan officer filter

R_startDatestring

Start date

Returns

200Report results

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/runreports/:reportName" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
GET
/fineract-provider/api/v1/jobs

List scheduled jobs

Retrieves all scheduled jobs.

Returns

200List of jobs

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/jobs" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/jobs/{jobId}

Retrieve scheduled job

Gets details of a specific scheduled job.

Path Parameters

jobIdintegerrequired

Job ID

Returns

200Job details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/jobs/:jobId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
POST
/fineract-provider/api/v1/jobs/{jobId}?command=executeJob

Run scheduled job

Immediately executes a scheduled job.

Path Parameters

jobIdintegerrequired

Job ID

Returns

200Job execution started

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/jobs/:jobId?command=executeJob" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
PUT
/fineract-provider/api/v1/jobs/{jobId}

Update scheduled job

Updates job configuration including cron expression.

Path Parameters

jobIdintegerrequired

Job ID

Request Bodyrequired

Job configuration

cronExpressionstring
activeboolean

Returns

200Job updated

Request

curl
curl --request PUT \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/jobs/:jobId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "cronExpression": "sample_cronExpression",
  "active": true
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/configurations

List global configurations

Retrieves all global configuration settings.

Returns

200List of configurations

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/configurations" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/configurations/{configurationId}

Retrieve configuration

Gets a specific configuration setting.

Path Parameters

configurationIdintegerrequired

Configuration ID

Returns

200Configuration details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/configurations/:configurationId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}
PUT
/fineract-provider/api/v1/configurations/{configurationId}

Update configuration

Updates a global configuration setting.

Path Parameters

configurationIdintegerrequired

Configuration ID

Request Bodyrequired

Configuration value

valuestring
enabledboolean
stringValuestring
dateValuestring

Returns

200Configuration updated

Request

curl
curl --request PUT \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/configurations/:configurationId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "value": "sample_value",
  "enabled": true,
  "stringValue": "sample_stringValue",
  "dateValue": "01 January 2024"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
GET
/fineract-provider/api/v1/audits

List audit logs

Retrieves audit trail entries.

Query Parameters

actionNamestring

Filter by action

entityNamestring

Filter by entity

resourceIdinteger

Filter by resource ID

Returns

200Audit logs

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/audits" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "totalFilteredRecords": 25,
  "pageItems": [
    {
      "id": 1,
      "displayName": "Sample Item 1",
      "status": "active"
    },
    {
      "id": 2,
      "displayName": "Sample Item 2",
      "status": "active"
    }
  ]
}
GET
/fineract-provider/api/v1/audits/{auditId}

Retrieve audit log entry

Gets details of a specific audit log entry including the changes made.

Path Parameters

auditIdintegerrequired

Audit ID

Returns

200Audit log details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/audits/:auditId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json"

Response

json
{
  "id": 1,
  "status": {
    "id": 300,
    "code": "statusType.active",
    "value": "Active"
  },
  "officeId": 1,
  "officeName": "Head Office",
  "createdDate": "2024-01-15",
  "lastModifiedDate": "2024-01-20"
}

Was this page helpful?