Account groups

All financial reports include account groups, these indicate which accounting data to include in your reports. For example, a report might include the "Accounts Payable" account group for a specific customer or in a specific location.

Account groups organize accounts into re-usable structures, creating the groupings and amounts that you want to see on reports. You can create as many groups as you need, from large hierarchical structures like "Net Income" to flat account groups such as "Cash and Cash Equivalents," and then use them across many different reports, graphs, and dashboard performance cards.

List account groups

get/objects/general-ledger/account-group

Returns a collection with a key, ID, and link for each account 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": "647",
      • "id": "Liquidity Ratios",
      • "href": "/objects/general-ledger/account-group/647"
      },
    • {
      • "key": "621",
      • "id": "Cash and ST Investments",
      • "href": "/objects/general-ledger/account-group/621"
      },
    • {
      • "key": "629",
      • "id": "Days in Month",
      • "href": "/objects/general-ledger/account-group/629"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "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
ID for the account group.


 
 Example:  "85 - Cash"
title
string
Header row title for the account group on financial reports.


 
 Example:  "Cash"
displayTotalLineAs
string
Total line title for the account group on financial reports.


 
 Example:  "Total Accounts Payable"
manager
string
Name of the manager responsible for the account group.


 
 Example:  "John Smith"
calculationMethod
string or null
 Default:  "period"
Calculation method used when calculating amounts on reports for each account group.


Valid calculation methods are:


    

  • period - calculates only the amounts in the selected period.
    • 

  • startOfPeriod - calculates the amounts cumulatively up to the start of the selected period.
    • 

  • endOfPeriod - calculates the amounts cumulatively up to the end of the selected period.
    • 

  • null - not supported.
    • 



 Enum: "endOfPeriod" null "period" "startOfPeriod"  
 Example:  "period"
normalBalance
string
 Default:  "credit"
Use this account group as either a debit balance or a credit balance, for example Cash is generally a debit balance, and Sales, a credit balance. 


Make sure that the normal balance is the same for all accounts in the account group. The normal balance takes the designation from the top of the group. For example, if the parent is debit normal, all included accounts will be added, regardless of their normal balance setting. 


 Enum: "credit" "debit"  
 Example:  "credit"
groupType
string or null
 Default:  "accounts"
Indicate the type of account group. Different account group types yield different results in your financial reports.


Valid account group types:


    

  • accounts - the simplest and most basic type of account group types, it consists of one or  more accounts from the chart of accounts.
    • 

  • statisticalAccounts - includes accounts that contain specific non-financial data, used for calculating ratios and business metrics such as, headcount or square footage.
    • 

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

  • category - contains accounts based on categories (account groups) configured when your Intacct company was first set up.
    • 

  • statisticalCategory - contains statistical accounts, also based on the pre-configured categories.
    • 

  • null - not supported.
    • 



 Enum: "accounts" "category" "computation" "groups" null "statisticalAccounts" "statisticalCategory"  
 Example:  "groups"
isKPI
boolean
 Default:  false
Use true to specify the account group is a KPI account group. Key Performance Indicators (KPI) measure how effectively your company is meeting business objectives.  KPI account groups can be used in financial reports just like any other account groups. 


 
 Example:  false
includeChildAmount
boolean
 Default:  false
Use true to roll up an entire hierarchy of child transactions into one total.


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


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


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


 
 Example:  "P&L"
object
Filtering on the account group restricts the information displayed to certain dimensions. You can also filter for multiple locations and departments at the same time by using a dimension group.


Valid values for all report filters, use in reports where the account group is specified:


    

  • noFilter - includes all account group transactions for the dimension and it's sub-dimensions.
    • 

  • null - includes account group transactions where the dimension is not specified.
    • 

  • specific - only includes account group transactions for the specified dimension or dimension group (only for location and department). 
    • 

  • specificHierarchy - includes account group transactions for the specified dimension hierarchy, including it's sub-dimensions.
    • 



 
location
string or null
 Default:  "noFilter"
Include account group transactions for a specific location (including sub-locations) or location group (contains multiple locations) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
debitOrCredit
string or null
 Default:  null
Include debit only or credit only account group transactions in your reports where the account group is specified. Use both to include all debit and credit transactions within the account group. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "both" "creditOnly" "debitOnly" null  
 Example:  "both"
department
string or null
 Default:  null
Include account group transactions for a specific department (including sub-departments) or department group (contains multiple departments) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
vendor
string or null
 Default:  null
Include account group transactions for a specific vendor (including sub-vendors) in your reports where the account group is specified. 


 Enum: "noFilter" null "specific" "specificHierarchy" "unspecified"  
 Example:  "noFilter"
customer
string or null
 Default:  null
Include account group transactions for a specific customer (including sub-customers) in your reports where the account group is specified. 


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
project
string or null
 Default:  null
Include account group transactions for a specific project (including sub-projects) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
employee
string or null
 Default:  null
Include account group transactions for a specific employee (including sub-employees) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
item
string or null
 Default:  null
Include all account group transactions with specific inventory items in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue" "specific"  
 Example:  "noFilter"
class
string or null
 Default:  null
Include account group transactions for a specific class (including sub-classes) in your reports where the account group is specified. 


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
contract
string or null
 Default:  null
Include account group transactions for a specific contract (including sub-contracts) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
task
string or null
 Default:  null
Include all account group transactions with tasks in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue"  
 Example:  "noFilter"
warehouse
string or null
 Default:  null
Include account group transactions for a specific warehouse (including sub-warehouses) in your reports where the account group is specified. 


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
costType
string or null
 Default:  null
Include all account group transactions with cost types in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue"  
 Example:  "noFilter"
asset
string or null
 Default:  null
Include account group transactions for a specific asset (including sub-assets) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
affiliateEntity
string
Include all account group transactions with specific affiliate entities in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue" "specific"  
 Example:  "noFilter"
object
Filter by the specified dimension values if reportFilters is set to specific or specificHierarchy. 


A dimension is a classification system used to organize, sort, and report on your company information in meaningful ways. Each dimension has a set of related values with transactions and entries. Every transaction you enter can be tagged with multiple dimension values for identification and reporting.


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


You can filter by a single location, or alternatively, you can filter by multiple locations using a locationGroup. You cannot filter both location and locationGroup at the same time. 


 
key
string or null
Location key


 
 Example:  "1"
id
string or null
Location ID


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


You can filter by a single department, or alternatively, you can filter by multiple departments using a departmentGroup. You cannot filter both department and departmentGroup at the same time.


 
key
string or null
Department key


 
 Example:  "9"
id
string or null
Department ID


 
 Example:  "PRS"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key


 
 Example:  "23"
id
string or null
Affiliate entity ID


 
 Example:  "AFF-23"
object
Location group to filter by if reportFilters.location is set to specific or specificHierarchy.


You can filter by multiple locations using a locationGroup, or alternatively, you can filter by a single location. You cannot filter both locationGroup and location at the same time. 


 
key
string or null
 
 Example:  "7"
id
string or null
 
 Example:  "USA-GRP"
object
Department group to filter by if reportFilters.department is set to specific or specificHierarchy. If you've defined department groups, these will be available to you in addition to the individual departments. 


You can filter by multiple departments using a departmentGroup, or alternatively, you can filter by a single department. You cannot filter both departmentGroup and department at the same time.


 
key
string or null
System-assigned key for the department group.


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


 
 Example:  "SA-GRP"
Array of objects
Array of account ranges 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"
Array of objects
Array of statistical account ranges 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"
Array of objects
Array of account group members for the account group.


 
 Array 
key
string
System-assigned unique key for the account group member.


 
 Example:  "23"
id
string
Unique identifier for the account group member.


 
 Example:  "23"
sortOrder
integer
Sort order for the account group members.


 
 Example:  1
object
Account group containing the account group member.


 
Array of objects
Array of account group category members for the account group.


 
 Array 
sortOrder
integer
Sort order.


 
 Example:  1
object
 
Array of objects
Array of statistical account group category members for the account group.


 
 Array 
sortOrder
integer
Sort order.


 
 Example:  1
object
 
Array of objects
Array of computation group members for the account group.


 
 Array 
object or object or object
 
operator
string
Operator


 Enum: "add" "divide" "multiply" "subtract"  
 Example:  "add"
object or object or object
 
numberOfDecimalPlaces
integer  [ 0 .. 9 ] 
Precision.


 
 Example:  2
displayAs
string
Display as.


 Enum: "dailyAverage" "monthlyAverage" "number" "percent" "quarterlyAverage" "ratioWithDecimals" "ratioWithoutDecimals" "weeklyAverage"  
 Example:  "number"
unit
string
Unit of measurement.


 
 Example:  "$"
unitPlacement
string or null
Unit of measurement alignment.


 Enum: "left" null "right"  
 Example:  "right"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "AGG Group",
  • "normalBalance": "debit",
  • "calculationMethod": "period",
  • "includeChildAmount": false,
  • "title": "ReportFilter",
  • "displayTotalLineAs": "Total ReportFilter",
  • "reportFilters": {
    • "debitOrCredit": "both",
    • "department": "noFilter",
    • "location": "noFilter",
    • "vendor": "noFilter",
    • "customer": "noFilter",
    • "project": "noFilter",
    • "employee": "noFilter",
    • "item": "noFilter",
    • "class": "noFilter",
    • "task": "noFilter",
    • "warehouse": "noFilter",
    • "asset": "noFilter",
    • "affiliateEntity": "noFilter"
    },
  • "groupType": "accounts",
  • "isKPI": false,
  • "manager": "AG",
  • "accountGroupPurpose": {
    • "id": "21"
    },
  • "accountRanges": [
    • {
      • "sortOrder": 0,
      • "rangeFrom": "1000",
      • "rangeTo": "2000"
      },
    • {
      • "sortOrder": 1,
      • "rangeFrom": "3000",
      • "rangeTo": "3000"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "719",
    • "id": "AGG Group",
    • "href": "/objects/general-ledger/account-group/719"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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.


 
 Example:  23
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "AG-Computation-01",
    • "normalBalance": "debit",
    • "calculationMethod": "period",
    • "includeChildAmount": false,
    • "title": "AG-Computation-01",
    • "displayTotalLineAs": "Total AG-Computation-01",
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "departmentGroup": {
        },
      • "locationGroup": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        },
      • "task": {
        },
      • "warehouse": {
        },
      • "asset": {
        },
      • "affiliateEntity": {
        }
      },
    • "reportFilters": {
      • "debitOrCredit": "both",
      • "department": "specificHierarchy",
      • "location": "specific",
      • "vendor": "noFilter",
      • "customer": "noFilter",
      • "project": "noFilter",
      • "employee": "noFilter",
      • "item": "noFilter",
      • "class": "noFilter",
      • "contract": null,
      • "task": "noFilter",
      • "warehouse": "noFilter",
      • "costType": null,
      • "asset": "noFilter",
      • "affiliateEntity": "noFilter"
      },
    • "groupType": "computation",
    • "isKPI": false,
    • "audit": {
      • "createdDateTime": "2024-07-04T06:36:03Z",
      • "modifiedDateTime": "2024-07-04T06:36:03Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "manager": "John Doe",
    • "accountGroupPurpose": {
      • "key": "10",
      • "id": "P&L",
      • "href": "/objects/general-ledger/account-group-purpose/10"
      },
    • "accountRanges": [ ],
    • "accountGroupMembers": [ ],
    • "accountGroupComputation": [
      • {
        }
      ],
    • "accountGroupCategoryMembers": [ ],
    • "statisticalAccountGroupCategoryMembers": [ ],
    • "statisticalAccountRanges": [ ],
    • "href": "/objects/general-ledger/account-group/713"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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.


 
 Example:  23
Request Body schema: application/json
title
string
Header row title for the account group on financial reports.


 
 Example:  "Cash"
displayTotalLineAs
string
Total line title for the account group on financial reports.


 
 Example:  "Total Accounts Payable"
manager
string
Name of the manager responsible for the account group.


 
 Example:  "John Smith"
calculationMethod
string or null
 Default:  "period"
Calculation method used when calculating amounts on reports for each account group.


Valid calculation methods are:


    

  • period - calculates only the amounts in the selected period.
    • 

  • startOfPeriod - calculates the amounts cumulatively up to the start of the selected period.
    • 

  • endOfPeriod - calculates the amounts cumulatively up to the end of the selected period.
    • 

  • null - not supported.
    • 



 Enum: "endOfPeriod" null "period" "startOfPeriod"  
 Example:  "period"
normalBalance
string
 Default:  "credit"
Use this account group as either a debit balance or a credit balance, for example Cash is generally a debit balance, and Sales, a credit balance. 


Make sure that the normal balance is the same for all accounts in the account group. The normal balance takes the designation from the top of the group. For example, if the parent is debit normal, all included accounts will be added, regardless of their normal balance setting. 


 Enum: "credit" "debit"  
 Example:  "credit"
groupType
string or null
 Default:  "accounts"
Indicate the type of account group. Different account group types yield different results in your financial reports.


Valid account group types:


    

  • accounts - the simplest and most basic type of account group types, it consists of one or  more accounts from the chart of accounts.
    • 

  • statisticalAccounts - includes accounts that contain specific non-financial data, used for calculating ratios and business metrics such as, headcount or square footage.
    • 

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

  • category - contains accounts based on categories (account groups) configured when your Intacct company was first set up.
    • 

  • statisticalCategory - contains statistical accounts, also based on the pre-configured categories.
    • 

  • null - not supported.
    • 



 Enum: "accounts" "category" "computation" "groups" null "statisticalAccounts" "statisticalCategory"  
 Example:  "groups"
isKPI
boolean
 Default:  false
Use true to specify the account group is a KPI account group. Key Performance Indicators (KPI) measure how effectively your company is meeting business objectives.  KPI account groups can be used in financial reports just like any other account groups. 


 
 Example:  false
includeChildAmount
boolean
 Default:  false
Use true to roll up an entire hierarchy of child transactions into one total.


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


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


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


 
 Example:  "P&L"
object
Filtering on the account group restricts the information displayed to certain dimensions. You can also filter for multiple locations and departments at the same time by using a dimension group.


Valid values for all report filters, use in reports where the account group is specified:


    

  • noFilter - includes all account group transactions for the dimension and it's sub-dimensions.
    • 

  • null - includes account group transactions where the dimension is not specified.
    • 

  • specific - only includes account group transactions for the specified dimension or dimension group (only for location and department). 
    • 

  • specificHierarchy - includes account group transactions for the specified dimension hierarchy, including it's sub-dimensions.
    • 



 
location
string or null
 Default:  "noFilter"
Include account group transactions for a specific location (including sub-locations) or location group (contains multiple locations) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
debitOrCredit
string or null
 Default:  null
Include debit only or credit only account group transactions in your reports where the account group is specified. Use both to include all debit and credit transactions within the account group. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "both" "creditOnly" "debitOnly" null  
 Example:  "both"
department
string or null
 Default:  null
Include account group transactions for a specific department (including sub-departments) or department group (contains multiple departments) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
vendor
string or null
 Default:  null
Include account group transactions for a specific vendor (including sub-vendors) in your reports where the account group is specified. 


 Enum: "noFilter" null "specific" "specificHierarchy" "unspecified"  
 Example:  "noFilter"
customer
string or null
 Default:  null
Include account group transactions for a specific customer (including sub-customers) in your reports where the account group is specified. 


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
project
string or null
 Default:  null
Include account group transactions for a specific project (including sub-projects) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
employee
string or null
 Default:  null
Include account group transactions for a specific employee (including sub-employees) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
item
string or null
 Default:  null
Include all account group transactions with specific inventory items in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue" "specific"  
 Example:  "noFilter"
class
string or null
 Default:  null
Include account group transactions for a specific class (including sub-classes) in your reports where the account group is specified. 


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
contract
string or null
 Default:  null
Include account group transactions for a specific contract (including sub-contracts) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
task
string or null
 Default:  null
Include all account group transactions with tasks in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue"  
 Example:  "noFilter"
warehouse
string or null
 Default:  null
Include account group transactions for a specific warehouse (including sub-warehouses) in your reports where the account group is specified. 


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
costType
string or null
 Default:  null
Include all account group transactions with cost types in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue"  
 Example:  "noFilter"
asset
string or null
 Default:  null
Include account group transactions for a specific asset (including sub-assets) in your reports where the account group is specified.


 Enum: "noFilter" null "nullValue" "specific" "specificHierarchy"  
 Example:  "noFilter"
affiliateEntity
string
Include all account group transactions with specific affiliate entities in your reports where the account group is specified. This filter has limited options, it works on charts, graphs, performance cards, and financial reports, but is ignored in GL reports.


 Enum: "noFilter" null "nullValue" "specific"  
 Example:  "noFilter"
object
Filter by the specified dimension values if reportFilters is set to specific or specificHierarchy. 


A dimension is a classification system used to organize, sort, and report on your company information in meaningful ways. Each dimension has a set of related values with transactions and entries. Every transaction you enter can be tagged with multiple dimension values for identification and reporting.


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


You can filter by a single location, or alternatively, you can filter by multiple locations using a locationGroup. You cannot filter both location and locationGroup at the same time. 


 
key
string or null
Location key


 
 Example:  "1"
id
string or null
Location ID


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


You can filter by a single department, or alternatively, you can filter by multiple departments using a departmentGroup. You cannot filter both department and departmentGroup at the same time.


 
key
string or null
Department key


 
 Example:  "9"
id
string or null
Department ID


 
 Example:  "PRS"
object
 
key
string or null
Employee key


 
 Example:  "10"
id
string or null
Employee ID


 
 Example:  "EMP-10"
object
 
key
string or null
Project key


 
 Example:  "2"
id
string or null
Project ID


 
 Example:  "NET-XML30-2"
object
 
key
string or null
Customer key


 
 Example:  "13"
id
string or null
Customer ID


 
 Example:  "CUST-13"
object
 
key
string or null
Vendor key


 
 Example:  "357"
id
string or null
Vendor ID


 
 Example:  "1605212096809"
object
 
key
string or null
Item key


 
 Example:  "13"
id
string or null
Item ID


 
 Example:  "Case 13"
object
 
key
string or null
Warehouse key


 
 Example:  "6"
id
string or null
Warehouse ID


 
 Example:  "WH01"
object
 
key
string or null
Class key


 
 Example:  "731"
id
string or null
Class ID


 
 Example:  "REST_CLS_001"
object
 
id
string or null
Task ID


 
 Example:  "1"
key
string or null
Task key


 
 Example:  "1"
object
 
id
string or null
Cost Type ID


 
 Example:  "2"
key
string or null
Cost Type key


 
 Example:  "2"
object
 
id
string or null
Asset ID


 
 Example:  "A001"
key
string or null
Asset key


 
 Example:  "1"
object
 
id
string or null
Contract ID


 
 Example:  "CON-0045-1"
key
string or null
Contract key


 
 Example:  "12"
object
 
key
string or null
Affiliate entity key


 
 Example:  "23"
id
string or null
Affiliate entity ID


 
 Example:  "AFF-23"
object
Location group to filter by if reportFilters.location is set to specific or specificHierarchy.


You can filter by multiple locations using a locationGroup, or alternatively, you can filter by a single location. You cannot filter both locationGroup and location at the same time. 


 
key
string or null
 
 Example:  "7"
id
string or null
 
 Example:  "USA-GRP"
object
Department group to filter by if reportFilters.department is set to specific or specificHierarchy. If you've defined department groups, these will be available to you in addition to the individual departments. 


You can filter by multiple departments using a departmentGroup, or alternatively, you can filter by a single department. You cannot filter both departmentGroup and department at the same time.


 
key
string or null
System-assigned key for the department group.


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


 
 Example:  "SA-GRP"
Array of objects
Array of account ranges 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"
Array of objects
Array of statistical account ranges 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"
Array of objects
Array of account group members for the account group.


 
 Array 
key
string
System-assigned unique key for the account group member.


 
 Example:  "23"
id
string
Unique identifier for the account group member.


 
 Example:  "23"
sortOrder
integer
Sort order for the account group members.


 
 Example:  1
object
Account group containing the account group member.


 
Array of objects
Array of account group category members for the account group.


 
 Array 
sortOrder
integer
Sort order.


 
 Example:  1
object
 
Array of objects
Array of statistical account group category members for the account group.


 
 Array 
sortOrder
integer
Sort order.


 
 Example:  1
object
 
Array of objects
Array of computation group members for the account group.


 
 Array 
object or object or object
 
operator
string
Operator


 Enum: "add" "divide" "multiply" "subtract"  
 Example:  "add"
object or object or object
 
numberOfDecimalPlaces
integer  [ 0 .. 9 ] 
Precision.


 
 Example:  2
displayAs
string
Display as.


 Enum: "dailyAverage" "monthlyAverage" "number" "percent" "quarterlyAverage" "ratioWithDecimals" "ratioWithoutDecimals" "weeklyAverage"  
 Example:  "number"
unit
string
Unit of measurement.


 
 Example:  "$"
unitPlacement
string or null
Unit of measurement alignment.


 Enum: "left" null "right"  
 Example:  "right"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "accountRanges": [
    • {
      • "sortOrder": 0,
      • "rangeFrom": "1001",
      • "rangeTo": "2000"
      },
    • {
      • "sortOrder": 1,
      • "rangeFrom": "2001",
      • "rangeTo": "5000"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "719",
    • "id": "AGG Group",
    • "href": "/objects/general-ledger/account-group/719"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
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.


 
 Example:  23
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
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": "general-ledger/account-group",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "621",
      • "id": "Cash and ST Investments",
      • "href": "/objects/general-ledger/account-group/621"
      },
    • {
      • "key": "629",
      • "id": "Days in Month",
      • "href": "/objects/general-ledger/account-group/629"
      },
    • {
      • "key": "647",
      • "id": "Liquidity Ratios",
      • "href": "/objects/general-ledger/account-group/647"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}