Account ranges

Account groups can include individual named accounts or ranges of accounts. Create a range of accounts to facilitate account group creation and management.

List account ranges

get/objects/general-ledger/account-range

Returns a collection with a key, ID, and link for each group. This operation is mostly for use in testing; use the query service to find account groups that meet specific criteria and to specify the properties that you want in the response.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": [
    • {
      • "key": "57",
      • "id": "57",
      • "href": "/objects/general-ledger/account-range/130"
      },
    • {
      • "key": "58",
      • "id": "58",
      • "href": "/objects/general-ledger/account-range/132"
      },
    • {
      • "key": "59",
      • "id": "59",
      • "href": "/objects/general-ledger/account-range/133"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Get an account range

get/objects/general-ledger/account-range/{key}

Returns detailed information for a specified account range.

SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the account range.

Example: 170
Responses
200

OK

400

Bad Request

Request samples
Response samples
application/json
{
  • "ia::result": {
    • "id": "130",
    • "key": "130",
    • "glAccountGroup": {
      • "id": "Accounts Payable",
      • "key": "33",
      • "href": "/objects/general-ledger/account-group/33"
      },
    • "sortOrder": 0,
    • "rangeFrom": "1000",
    • "rangeTo": "1501",
    • "audit": {
      • "createdDateTime": "2022-03-11T09:21:52Z",
      • "modifiedDateTime": "2022-03-11T09:21:52Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/general-ledger/account-range/130"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}

Query account ranges

post/services/core/query

Use the query service to find account ranges that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

Request samples