Command Palette

Search for a command to run...

B
Request

Accounting

General ledger accounts, journal entries, accounting rules, and financial reporting

List ledger accountsRetrieve ledger accountCreate ledger accountUpdate ledger accountDelete ledger accountList journal entriesRetrieve journal entryCreate journal entriesReverse journal entryList accounting closuresCreate accounting closureList accounting rulesCreate accounting ruleRun periodic accrual accounting
GET
/fineract-provider/api/v1/glaccounts

List ledger accounts

Retrieves all general ledger accounts in the chart of accounts.

Query Parameters

typeinteger

Filter by account type (1=Asset, 2=Liability, 3=Equity, 4=Income, 5=Expense)

searchParamstring

Search by name or GL code

usageinteger

Filter by usage (1=Detail, 2=Header)

Returns

200List of GL accounts

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/glaccounts" \
  --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/glaccounts/{glAccountId}

Retrieve ledger account

Gets details of a specific general ledger account.

Path Parameters

glAccountIdintegerrequired

GL Account ID

Query Parameters

fetchRunningBalanceboolean

Include running balance

Returns

200GL account details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/glaccounts/:glAccountId" \
  --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/glaccounts

Create ledger account

Creates a new general ledger account in the chart of accounts.

Request Bodyrequired

GL account details

namestring

Account name

glCodestring

Unique GL code

typeinteger

Account type (1-5)

usageinteger

Usage type (1=Detail, 2=Header)

manualEntriesAllowedboolean
descriptionstring
parentIdinteger

Parent account ID

tagIdinteger

Tag code value ID

Returns

200GL account created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/glaccounts" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name",
  "glCode": "sample_glCode",
  "type": 1,
  "usage": 1,
  "manualEntriesAllowed": true,
  "description": "sample_description",
  "parentId": 1,
  "tagId": 1
}'

Response

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

Update ledger account

Updates an existing general ledger account.

Path Parameters

glAccountIdintegerrequired

GL Account ID

Request Bodyrequired

Updated account details

namestring
glCodestring
descriptionstring
manualEntriesAllowedboolean
disabledboolean

Returns

200GL account updated

Request

curl
curl --request PUT \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/glaccounts/:glAccountId" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "sample_name",
  "glCode": "sample_glCode",
  "description": "sample_description",
  "manualEntriesAllowed": true,
  "disabled": true
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
DELETE
/fineract-provider/api/v1/glaccounts/{glAccountId}

Delete ledger account

Deletes a general ledger account. Only accounts without transactions can be deleted.

Path Parameters

glAccountIdintegerrequired

GL Account ID

Returns

200GL account deleted

Request

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

Response

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

List journal entries

Retrieves journal entries with optional filtering by date range, office, and account.

Query Parameters

officeIdinteger

Filter by office

glAccountIdinteger

Filter by GL account

entryIdinteger

Filter by entry ID

Returns

200List of journal entries

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/journalentries" \
  --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/journalentries/{entryId}

Retrieve journal entry

Gets details of a specific journal entry.

Path Parameters

entryIdintegerrequired

Entry ID

Returns

200Journal entry details

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/journalentries/:entryId" \
  --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/journalentries

Create journal entries

Creates a new journal entry with debit and credit lines. Debits must equal credits.

Request Bodyrequired

Journal entry details

officeIdinteger

Office ID

transactionDatestring
currencyCodestring

Currency code (e.g., USD)

commentsstring
referenceNumberstring
creditsarray
debitsarray
dateFormatstring
localestring

Returns

200Journal entry created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/journalentries" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "officeId": 1,
  "transactionDate": "01 January 2024",
  "currencyCode": "sample_currencyCode",
  "comments": "sample_comments",
  "referenceNumber": "sample_referenceNumber",
  "credits": [],
  "debits": [],
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}
POST
/fineract-provider/api/v1/journalentries/{transactionId}?command=reverse

Reverse journal entry

Creates a reversal entry for an existing journal entry.

Path Parameters

transactionIdstringrequired

Transaction ID to reverse

Request Bodyrequired

Reversal details

commentsstring

Reversal reason

Returns

200Journal entry reversed

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/journalentries/:transactionId?command=reverse" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "comments": "sample_comments"
}'

Response

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

List accounting closures

Retrieves all accounting period closures.

Query Parameters

officeIdinteger

Filter by office

Returns

200List of closures

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/glclosures" \
  --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"
    }
  ]
}
POST
/fineract-provider/api/v1/glclosures

Create accounting closure

Creates a new accounting period closure, preventing entries before the closure date.

Request Bodyrequired

Closure details

officeIdinteger
closingDatestring
commentsstring
dateFormatstring
localestring

Returns

200Closure created

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/glclosures" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "officeId": 1,
  "closingDate": "01 January 2024",
  "comments": "sample_comments",
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

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

List accounting rules

Retrieves all configured accounting rules for automatic journal entry creation.

Returns

200List of accounting rules

Request

curl
curl --request GET \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/accountingrules" \
  --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"
    }
  ]
}
POST
/fineract-provider/api/v1/accountingrules

Create accounting rule

Creates a new accounting rule for automatic GL mappings.

Request Bodyrequired

Accounting rule details

namestring
officeIdinteger
accountToDebitinteger
accountToCreditinteger
descriptionstring

Returns

200Accounting rule created

Request

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

Response

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

Run periodic accrual accounting

Executes periodic accrual accounting to recognize income and expenses.

Request Bodyrequired

Accrual parameters

tillDatestring

Accrue up to this date

dateFormatstring
localestring

Returns

200Accruals processed

Request

curl
curl --request POST \
  --url "https://your-fineract-instance.com/fineract-provider/api/v1/runaccruals" \
  --header "Authorization: Basic {credentials}" \
  --header "Fineract-Platform-TenantId: default" \
  --header "Content-Type: application/json" \
  --data '{
  "tillDate": "01 January 2024",
  "dateFormat": "01 January 2024",
  "locale": "sample_locale"
}'

Response

json
{
  "officeId": 1,
  "resourceId": 1,
  "changes": {}
}

Was this page helpful?