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
required
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 related fields determine which locations are included in the group. If you are creating reports that use locations in rows or columns, these fields 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 groupMembers array. You can optionally filter the array with the memberFilter settings.
    • 

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



 Enum: "all" "specific"  
 Example:  "specific"
object
One or more filters to select the locations to include in the location group. Can be used in addition to the groupMembers array to filter from a selected list of locations.


 
object
string
Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.


 
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)
Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records 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. The 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 and their sort order. Only applicable when groupType = specific.


 
 Array 
object
Location that this member represents.


 
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
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": [
      • {
        }
      ]
    }
}
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 a 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 a 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 related fields determine which locations are included in the group. If you are creating reports that use locations in rows or columns, these fields 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 groupMembers array. You can optionally filter the array with the memberFilter settings.
    • 

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



 Enum: "all" "specific"  
 Example:  "specific"
object
One or more filters to select the locations to include in the location group. Can be used in addition to the groupMembers array to filter from a selected list of locations.


 
object
string
Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.


 
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)
Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records 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. The 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 and their sort order. Only applicable when groupType = specific.


 
 Array 
object
Location that this member represents.


 
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
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "My Top Locations america",
  • "memberFilter": {
    • "object": "company-config/location",
    • "filterExpression": "and",
    • "filters": [
      • {
        }
      ],
    • "orderBy": [
      • {
        }
      ]
    }
}
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 a 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
    }
}