Chart of Accounts

Get list of accounts

  • Endpoint: {SERVER_URL}/api/method/eclectics.api.account.list

  • Method: GET

  • Payload:

{
    "fields": [
        "name",
        "account_name",
        "parent_account",
        "account_type",
        "root_type",
        "is_disabled"
    ],
    "filters": [],
    "start": 0,
    "page_length": 0,
    "order_by": "name asc"
}

  • Headers

{
    "Authorization": "token <YOUR_TOKEN>"
}

Create an Account

  • Endpoint: {SERVER_URL}/api/method/eclectics.api.account.create

  • Method: POST

  • Payload:

{
    "account_name": "Cash 2",
    "account_number": "1110",
    "parent_account_number": "1100",
    "account_type": "",
    "is_group": false,
    "tax_rate": 16,
    "balance_must_be": "Debit",
    "account_currency": "USD",
    "is_restricted": false,
    "do_not_show_in_trial_balance": false
}

  • Headers

Warning

  • Be careful when setting balance_must_be parameter as it might later restrict you to post credit entries if you have specified that the balance must be Debit and vice versa. Use this option sparingly

  • Setting account currency to a value other than the base currency restricts that transactions can only be posted in the specified currency

  • Tax rate applies to accounts whose account type value has been set as Tax. Otherwise it is reset to 0

{
   "Authorization": "token <YOUR_TOKEN>"
}

  • These fields may not be exhaustive. Check the general guidance section on how to check all the parameters that an endpoint can accept

Update an Account

  • Endpoint: {SERVER_URL}/api/method/eclectics.api.account.update

  • Method: POST

  • Payload:

{
    "account_number": "1110",
    "account_name": "Updated Cash 2",
    "parent_account_number": "1100",
    "account_type": "",
    "is_group": false,
    "is_restricted": false,
    "do_not_show_in_trial_balance": false
}

  • Headers

{
    "Authorization": "token <YOUR_TOKEN>"
}

  • These fields are not exhaustive. Check the general guidance section on how to check all the parameters that an endpoint can accept

Delete an Account

  • Endpoint: {SERVER_URL}/api/method/eclectics.api.account.delete

  • Method: DELETE

  • Payload:

{
    "account_number": "1110"
}

  • Headers

{
    "Authorization": "token <YOUR_TOKEN>"
}

Get a single Account details

  • Endpoint: {SERVER_URL}/api/method/eclectics.api.account.get

  • Method: GET

  • Payload:

{
    "account_number": "1110"
}

  • Headers

{
    "Authorization": "token <YOUR_TOKEN>"
}

Enable/Disable an account

To disable (freeze) or enable (unfreeze) an account, use this endpoint

  • Endpoint: {SERVER_URL}/api/method/eclectics.api.account.toggle_status

  • Method: POST

  • Payload:

{
    "account_number": "1110",
    "enabled": 0
}

  • Headers

{
    "Authorization": "token <YOUR_TOKEN>"
}

Warning

  • When disabling an account, you can get this error message You are not authorized to set Frozen value. To resolve this error:

    • Login to the backend and go to Account Settings->Accounts Closing tab and specify the value of Role Allowed to Set Frozen Accounts and Edit Frozen Entries

    • Assign the role you have just specified to the user that you are using to authenticate in the backend

  • Freezing an account restricts users from making new accounting entries before a set date

  • Enabling/disabling an account updates freeze_account property

  • Freezing and unfreezing an account has extensive implications in the system and thus you need to restrict which user can freeze or unfreeze an account