Get GL Accounts

This API retrieves detailed information about all General Ledger (GL) accounts, providing essential data such as account identifiers, balances, and associated metadata. It enables seamless financial tracking, reconciliation, and reporting for organizations managing multiple GL accounts.

Response Body

The response is a JSON object containing the following fields:

Field Name	Type	Description
options	Array	A list of GL account options.
options[].id	Integer	The unique identifier for the GL account.
options[].name	String	The name of the GL account.
options[].glCode	String	The general ledger code associated with the account.
options[].disabled	Boolean	Indicates whether the GL account is disabled (`true` if disabled, `false` otherwise).
options[].manualEntriesAllowed	Boolean	Specifies if manual entries are allowed for the account.
options[].type	Object	Contains details about the type of GL account.
options[].type.id	Integer	The unique identifier for the GL account type.
options[].type.code	String	A system-defined code representing the GL account type.
options[].type.value	String	The category of the GL account (e.g., ASSET, LIABILITY).
options[].usage	Object	Provides information about how the GL account is used.
options[].usage.id	Integer	The unique identifier for the account usage type.
options[].usage.code	String	A system-defined code representing the GL account usage.
options[].usage.value	String	The type of usage assigned to the GL account (e.g., HEADER, DETAIL).
options[].nameDecorated	String	A formatted version of the GL account name for display purposes.
options[].tagId	Object	Contains metadata associated with the GL account.
options[].tagId.id	Integer	The unique identifier for the tag assigned to the GL account.
options[].parentId	Integer	The unique identifier of the parent GL account (if applicable).

Responses

🟢200Get GL Accounts

application/json

Body

Example

{
    "options": [
        {
            "id": 1,
            "name": "CURRENT ASSETS",
            "glCode": "101000",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 2,
                "code": "accountUsage.header",
                "value": "HEADER"
            },
            "nameDecorated": "CURRENT ASSETS",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 2,
            "name": "CASH ACCOUNT",
            "parentId": 1,
            "glCode": "101100",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 2,
                "code": "accountUsage.header",
                "value": "HEADER"
            },
            "nameDecorated": "....CASH ACCOUNT",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 3,
            "name": "CASH: NIGERIA NOTES & COINS",
            "parentId": 2,
            "glCode": "101101",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 1,
                "code": "accountUsage.detail",
                "value": "DETAIL"
            },
            "nameDecorated": "........CASH: NIGERIA NOTES & COINS",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 4,
            "name": "TELLER_1",
            "parentId": 2,
            "glCode": "101102",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 1,
                "code": "accountUsage.detail",
                "value": "DETAIL"
            },
            "nameDecorated": "........TELLER_1",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 5,
            "name": "TELLER_2",
            "parentId": 2,
            "glCode": "101103",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 1,
                "code": "accountUsage.detail",
                "value": "DETAIL"
            },
            "nameDecorated": "........TELLER_2",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 6,
            "name": "TELLER_3",
            "parentId": 2,
            "glCode": "101104",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 1,
                "code": "accountUsage.detail",
                "value": "DETAIL"
            },
            "nameDecorated": "........TELLER_3",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 7,
            "name": "TELLER_4",
            "parentId": 2,
            "glCode": "101105",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 1,
                "code": "accountUsage.detail",
                "value": "DETAIL"
            },
            "nameDecorated": "........TELLER_4",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 8,
            "name": "BANK BALANCES",
            "parentId": 1,
            "glCode": "101200",
            "disabled": false,
            "manualEntriesAllowed": true,
            "type": {
                "id": 1,
                "code": "accountType.asset",
                "value": "ASSET"
            },
            "usage": {
                "id": 2,
                "code": "accountUsage.header",
                "value": "HEADER"
            },
            "nameDecorated": "....BANK BALANCES",
            "tagId": {
                "id": 0
            }
        },
        {
            "id": 9,
            "name": "First Bank of Nigeria",
            "parentId": 8,
            "glCode": "101201",
            "disabled

🟢200Get GL Accounts [ASSET]

🟢200Get GL Account [LIABILITY]

Response Body

Request

Request Code Samples

Responses

Get GL Accounts

Response Body#

Request

Request Code Samples

Responses

Response Body