Account groups

Account groups are the fundamental building blocks of financial reporting. Every account must be part of an account group if its data is to be used in a balance sheet, income statement, cash flow, or other report. The most basic types of account groups contain either individual accounts or other account groups.

Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List account groups

get/objects/general-ledger/account-group

Returns up to 100 account groups from the 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": "1",
      • "id": "Accts_Payable",
      • "href": "/objects/general-ledger/account-group/1"
      },
    • {
      • "key": "2",
      • "id": "Accts_Receivable",
      • "href": "/objects/general-ledger/account-group/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create an account group
post/objects/general-ledger/account-group
Creates a new account group.


SecurityOAuth2 
Request 
Request Body schema: application/json
Account group to create


id
required
string
Account group name.


 
 Example:  "85 - Cash"
title
string
Display on report as.


 
 Example:  null
totalTitle
string
Display total line as.


 
 Example:  "Total Accounts Payable"
manager
string
Person to consult if there are questions about the account group. This is a free form field not tied to users (you can provide a partner name, or any other name).


 
 Example:  null
calculationMethod
string or null
 Default:  null
Calculation method


 Enum: "endOfPeriod" null "period" "startOfPeriod"  
 Example:  "period"
object
Use report filters to restrict the data displayed by dimension or other factors. Report filters can be more restrictive than filtering at other levels. The filters here work on charts, graphs, performance cards, and financial reports, but are ignored in GL reports. 


Valid values for all dimension report filters:


    

  • noFilter - Do not filter on this dimension. Include all transactions, regardless of the dimension value.
    • 

  • specific - Only include transactions with the specified dimension value.
    • 

  • specificHierarchy - Only include transactions with the specified dimension value and its children.
    • 

  • nullValue - Only include transactions that have no value set for this dimension.
    • 



 
location
string
Location filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
debitOrCredit
string or null
 Default:  null
Include debits, credits, or both in reports.


 Enum: "both" "creditOnly" "debitOnly" null  
 Example:  "both"
department
string
Department filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
vendor
string or null
 Default:  null
Vendor filter to use in reports.


 Enum: "noFilter" null "specific" "specificHierarchy" "unspecified"  
 Example:  null
customer
string
Customer filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
project
string
Project filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
employee
string
Employee filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
item
string
Item filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific"  
 Example:  null
class
string
Class filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
contract
string
Contract filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
task
string
Task filter to use in reports.


 Enum: "noFilter" null "nullValue"  
 Example:  null
warehouse
string
Warehouse filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
costtype
string
Cost type filter to use in reports.


 Enum: "noFilter" null "nullValue"  
 Example:  null
asset
string
Asset filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
normalBalance
string
Normal balance, either debit or credit.


 Enum: "credit" "debit"  
 Example:  "credit"
groupType
string or null
 Default:  null
Account group type. 


    

  • accounts - Consists of one or  more accounts from the chart of accounts.
    • 

  • groups - Contains other account groups, thus forming a hierarchy. You can have groups within groups within groups, and so on, to any level of depth.
    • 

  • statisticalAccounts - Consists of accounts that contain specific non-financial data, such as headcount, hospital beds, square footage, or hotel rooms. Using statistical account groups, you can calculate against and report on data to get a virtually unlimited variety of ratios and business metrics
    • 

  • computation - Consists of other account groups or individual accounts that you use as components in a mathematical equation; results of the equation display in financial report.
    • 

  • category - Contains accounts based on their category.
    • 

  • statisticalCategory - Contains statistical accounts based on their category.
    • 



 Enum: "accounts" "category" "computation" "groups" null "statisticalAccounts" "statisticalCategory"  
 Example:  "groups"
isKPI
boolean
Is a KPI.


 
 Example:  false
includeChildAmount
boolean
Roll up child amounts.


 
 Example:  true
object
Department to filter by if reportFilters.department is set to specific or specificHierarchy.


 
key
string
System-assigned key for the department.


 
 Example:  "9"
id
string
Unique identifier of the department.


 
 Example:  "01"
object
Department group to filter by if reportFilters.department is set to specific or specificHierarchy.


 
key
string
System-assigned key for the department group.


 
 Example:  "3086"
id
string
Unique identifier of the department group.


 
 Example:  "SA01"
name
string
Name of the department group.


 
 Example:  "Sales"
object
Account group purpose to associate with this account group.


 
key
string
System-assigned key for the account group purpose.


 
 Example:  "126"
id
string
Unique identifier of the account group purpose.


 
 Example:  "P&L"
name
string
Name of the account group purpose.


 
 Example:  null
object
Location to filter by if reportFilters.location is set to specific or specificHierarchy.


 
key
string
 
id
string
 
object
Location group to filter by if reportFilters.location is set to specific or specificHierarchy.


 
key
string
 
 Example:  null
id
string
 
 Example:  null
name
string
 
 Example:  null
Array of objects
Array of account range for the account group.


 
 Array 
sortOrder
integer
 Default:  0
Set the sort order of the account range


 
 Example:  2
rangeFrom
string
Specify GL account to start range


 
 Example:  "1000"
rangeTo
string
Specify GL account to end range


 
 Example:  "1001"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
{
  • "ia::result": {
    • "key": "41",
    • "id": "Budget1",
    • "href": "/objects/general-ledger/account-group/41"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get an account group
get/objects/general-ledger/account-group/{key}
Returns detailed information for a specified account group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account group.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
null
Update an account group
patch/objects/general-ledger/account-group/{key}
Updates an existing account group by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account group.


 
Request Body schema: application/json
title
string
Display on report as.


 
 Example:  null
totalTitle
string
Display total line as.


 
 Example:  "Total Accounts Payable"
manager
string
Person to consult if there are questions about the account group. This is a free form field not tied to users (you can provide a partner name, or any other name).


 
 Example:  null
calculationMethod
string or null
 Default:  null
Calculation method


 Enum: "endOfPeriod" null "period" "startOfPeriod"  
 Example:  "period"
object
Use report filters to restrict the data displayed by dimension or other factors. Report filters can be more restrictive than filtering at other levels. The filters here work on charts, graphs, performance cards, and financial reports, but are ignored in GL reports. 


Valid values for all dimension report filters:


    

  • noFilter - Do not filter on this dimension. Include all transactions, regardless of the dimension value.
    • 

  • specific - Only include transactions with the specified dimension value.
    • 

  • specificHierarchy - Only include transactions with the specified dimension value and its children.
    • 

  • nullValue - Only include transactions that have no value set for this dimension.
    • 



 
location
string
Location filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
debitOrCredit
string or null
 Default:  null
Include debits, credits, or both in reports.


 Enum: "both" "creditOnly" "debitOnly" null  
 Example:  "both"
department
string
Department filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
vendor
string or null
 Default:  null
Vendor filter to use in reports.


 Enum: "noFilter" null "specific" "specificHierarchy" "unspecified"  
 Example:  null
customer
string
Customer filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
project
string
Project filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
employee
string
Employee filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
item
string
Item filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific"  
 Example:  null
class
string
Class filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
contract
string
Contract filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
task
string
Task filter to use in reports.


 Enum: "noFilter" null "nullValue"  
 Example:  null
warehouse
string
Warehouse filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
costtype
string
Cost type filter to use in reports.


 Enum: "noFilter" null "nullValue"  
 Example:  null
asset
string
Asset filter to use in reports.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  null
normalBalance
string
Normal balance, either debit or credit.


 Enum: "credit" "debit"  
 Example:  "credit"
groupType
string or null
 Default:  null
Account group type. 


    

  • accounts - Consists of one or  more accounts from the chart of accounts.
    • 

  • groups - Contains other account groups, thus forming a hierarchy. You can have groups within groups within groups, and so on, to any level of depth.
    • 

  • statisticalAccounts - Consists of accounts that contain specific non-financial data, such as headcount, hospital beds, square footage, or hotel rooms. Using statistical account groups, you can calculate against and report on data to get a virtually unlimited variety of ratios and business metrics
    • 

  • computation - Consists of other account groups or individual accounts that you use as components in a mathematical equation; results of the equation display in financial report.
    • 

  • category - Contains accounts based on their category.
    • 

  • statisticalCategory - Contains statistical accounts based on their category.
    • 



 Enum: "accounts" "category" "computation" "groups" null "statisticalAccounts" "statisticalCategory"  
 Example:  "groups"
isKPI
boolean
Is a KPI.


 
 Example:  false
includeChildAmount
boolean
Roll up child amounts.


 
 Example:  true
object
Department to filter by if reportFilters.department is set to specific or specificHierarchy.


 
key
string
System-assigned key for the department.


 
 Example:  "9"
id
string
Unique identifier of the department.


 
 Example:  "01"
object
Department group to filter by if reportFilters.department is set to specific or specificHierarchy.


 
key
string
System-assigned key for the department group.


 
 Example:  "3086"
id
string
Unique identifier of the department group.


 
 Example:  "SA01"
name
string
Name of the department group.


 
 Example:  "Sales"
object
Account group purpose to associate with this account group.


 
key
string
System-assigned key for the account group purpose.


 
 Example:  "126"
id
string
Unique identifier of the account group purpose.


 
 Example:  "P&L"
name
string
Name of the account group purpose.


 
 Example:  null
object
Location to filter by if reportFilters.location is set to specific or specificHierarchy.


 
key
string
 
id
string
 
object
Location group to filter by if reportFilters.location is set to specific or specificHierarchy.


 
key
string
 
 Example:  null
id
string
 
 Example:  null
name
string
 
 Example:  null
Array of objects
Array of account range for the account group.


 
 Array 
sortOrder
integer
 Default:  0
Set the sort order of the account range


 
 Example:  2
rangeFrom
string
Specify GL account to start range


 
 Example:  "1000"
rangeTo
string
Specify GL account to end range


 
 Example:  "1001"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
null
Response samples 
application/json
{
  • "ia::result": {
    • "key": "21",
    • "id": "Accts_Payable",
    • "href": "/objects/general-ledger/account-group/21"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete an account group
delete/objects/general-ledger/account-group/{key}
Deletes an account group.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the account group.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "Payload contains errors",
      • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
      • "errorId": "REST-1064",
      • "additionalInfo": {
        },
      • "details": [
        ]
      },
    • "ia::meta": {
      • "totalCount": 3,
      • "totalSuccess": 2,
      • "totalError": 1
      }
    },
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query account groups
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "general-ledger/account-group"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}