Location groups

A location group is a specified set of locations, or a set of locations that meet certain criteria. You can use groups to filter or display information in multiple ways, for instance by showing data from only certain locations.

List location groups

get/objects/company-config/location-group

Returns up to 100 location 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 location groups that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "CO",
      • "href": "/objects/company-config/location-group/1"
      },
    • {
      • "key": "2",
      • "id": "CA",
      • "href": "/objects/company-config/location-group/2"
      },
    • {
      • "key": "3",
      • "id": "CT",
      • "href": "/objects/company-config/location-group/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a Location group
post/objects/company-config/location-group
Creates a new Location group.


SecurityOAuth2 
Request 
Request Body schema: application/json
Creates a new Location group.


id
required
string
Location group ID. Displayed together with the group name in Sage Intacct (ID--Name). Location group IDs cannot be changed after the group has been created.


 
 Example:  "WH1"
name
required
string
Location group name. Displayed together with the group ID in Sage Intacct (ID--Name).


 
 Example:  "Western Region Warehouses"
description
string
Description of the location group.


 
 Example:  "Western Region Warehouses"
object
Default contact for this group.


 
key
string
System-assigned key for the contact.


 
 Example:  "7"
id
string
Contact ID.


 
 Example:  "Jeff Pinkerton"
groupType
string
 Default:  "all"
Group membership type. The group type and options that you select determine which locations will be included in report data when you filter on this location group.


If you are creating financial reports that show locations in rows or columns, your selection will also determine the column headings and row headings that will appear, and the order in which they will be listed.


    

  • specific - Specify the locations to include and their order in the members array.
    • 

  • all - All locations that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "specific"
sortField
string
Location field by which to sort the locations when the group is displayed in reports.


 
 Example:  "LOCATIONID"
sortOrder
string
 Default:  "ascending"
Sort order for locations that match the memberFilter when the group is displayed in reports. Only applicable when groupType = all.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
integer
The maximum number of locations that match the memberFilter to include in the location group. Only applicable when groupType = all.


 
 Example:  11
isDimensionStructure
boolean
 Default:  false
Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.


 
 Example:  false
conditionType
string
 Default:  "and"
Whether multiple memberFilter are treated as 'and', 'or', or as a complex expression.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string
Expression for combining multiple filters. Only applicable if the 'conditionType' = 'expression'.


 
 Example:  "(1 AND 2)"
object
One or more filters to select the locations to include in the location group. Only applicable when groupType = all.


 
object
string
Object type to filter on.


 
 Example:  "accounts-payable/vendor"
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 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.


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"
Array of objects  <= 1 items 
Sort order for the results that match the filters when the group is displayed in reports. Each entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.


 
 Example:  [{"id":"asc"}]
 Array (<= 1 items)
property name*
additional property
string
 Enum: "asc" "desc"  
size
integer
The maximum number of records that match the filters to include in the group when it is displayed in reports.


 
 Example:  100
Array of objects
Members of the location group. Only applicable when groupType = specific.


 
 Array 
object
Location that this member represents.


 
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "WA",
  • "name": "Washington",
  • "description": "Washington State",
  • "groupType": "all",
  • "memberFilter": {
    • "object": "company-config/location",
    • "filterExpression": "and",
    • "filters": [
      • {
        }
      ],
    • "orderBy": {
      • "-name": "asc"
      }
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "IN",
    • "href": "/objects/company-config/location-group/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a location group
get/objects/company-config/location-group/{key}
Returns detailed information for a specified location group.


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


 
 Example:  49
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Top Locations",
    • "name": "Top Level Locations",
    • "description": "Top Level Locations",
    • "groupType": "specific",
    • "primaryContact": {
      • "key": "211",
      • "id": "1099 Int",
      • "href": "/objects/company-config/contact/211"
      },
    • "memberFilter": {
      • "object": "company-config/location",
      • "filterExpression": "and",
      • "orderBy": {
        }
      },
    • "audit": {
      • "createdDateTime": "2023-08-16T13:26:56Z",
      • "modifiedDateTime": "2023-08-16T13:26:56Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "groupMembers": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/company-config/location-group/15"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a Location group
patch/objects/company-config/location-group/{key}
Updates an existing Location group by setting field values. Any fields not provided remain unchanged. New values for any arrays will replace the existing array.


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


 
 Example:  49
Request Body schema: application/json
name
string
Location group name. Displayed together with the group ID in Sage Intacct (ID--Name).


 
 Example:  "Western Region Warehouses"
description
string
Description of the location group.


 
 Example:  "Western Region Warehouses"
object
Default contact for this group.


 
key
string
System-assigned key for the contact.


 
 Example:  "7"
id
string
Contact ID.


 
 Example:  "Jeff Pinkerton"
groupType
string
 Default:  "all"
Group membership type. The group type and options that you select determine which locations will be included in report data when you filter on this location group.


If you are creating financial reports that show locations in rows or columns, your selection will also determine the column headings and row headings that will appear, and the order in which they will be listed.


    

  • specific - Specify the locations to include and their order in the members array.
    • 

  • all - All locations that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "specific"
sortField
string
Location field by which to sort the locations when the group is displayed in reports.


 
 Example:  "LOCATIONID"
sortOrder
string
 Default:  "ascending"
Sort order for locations that match the memberFilter when the group is displayed in reports. Only applicable when groupType = all.


 Enum: "ascending" "descending"  
 Example:  "ascending"
maxMatches
integer
The maximum number of locations that match the memberFilter to include in the location group. Only applicable when groupType = all.


 
 Example:  11
isDimensionStructure
boolean
 Default:  false
Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.


 
 Example:  false
conditionType
string
 Default:  "and"
Whether multiple memberFilter are treated as 'and', 'or', or as a complex expression.


 Enum: "and" "expression" "or"  
 Example:  "and"
expression
string
Expression for combining multiple filters. Only applicable if the 'conditionType' = 'expression'.


 
 Example:  "(1 AND 2)"
object
One or more filters to select the locations to include in the location group. Only applicable when groupType = all.


 
object
string
Object type to filter on.


 
 Example:  "accounts-payable/vendor"
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 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.


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"
Array of objects  <= 1 items 
Sort order for the results that match the filters when the group is displayed in reports. Each entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.


 
 Example:  [{"id":"asc"}]
 Array (<= 1 items)
property name*
additional property
string
 Enum: "asc" "desc"  
size
integer
The maximum number of records that match the filters to include in the group when it is displayed in reports.


 
 Example:  100
Array of objects
Members of the location group. Only applicable when groupType = specific.


 
 Array 
object
Location that this member represents.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "My Top Locations america",
  • "memberFilter": {
    • "object": "company-config/location",
    • "filterExpression": "and",
    • "filters": [
      • {
        }
      ],
    • "orderBy": {
      • "-name": "asc"
      }
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "My Locations new",
    • "href": "/objects/company-config/location-group/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a Location group
delete/objects/company-config/location-group/{key}
Deletes a Location group.


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


 
 Example:  49
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 location 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:  "company-config/location-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": "location-group",
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "fields": [
    • "id",
    • "name",
    • "description",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "WA01",
      • "name": "Wenatchee",
      • "description": "Wenatchee, WA",
      • "href": "/objects/location-group/1"
      },
    • {
      • "id": "12",
      • "name": "Leavenworth",
      • "description": "Leavenworth, WA",
      • "href": "/objects/location-group/12"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}