Project groups

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

List project groups

get/objects/projects/project-group

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

Permissions and other requirements
SubscriptionProjects
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList, View Projects
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/projects/project-group/1"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/projects/project-group/3"
      },
    • {
      • "key": "5",
      • "id": "5",
      • "href": "/objects/projects/project-group/5"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a project group
post/objects/projects/project-group
Creates a new project group. 


Project groups created at the top level of a company can't include projects that belong to entities. You must create a project group from the entity to include those projects.



Permissions and other requirements



SubscriptionProjects


User typeBusiness


PermissionsAdd Projects







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


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


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


 
 Example:  "Projects that are waiting on PO"
description
string or null
Description of the project group.


 
 Example:  "Projects with G10 and above."
groupType
string
 Default:  "all"
Group membership type. The group type and related fields determine how projects will be organized hierarchically and how related projects will be managed in the Projects list.


Depending on the group type, you can either specify individual projects to include and their order, or include all projects that match certain criteria. This will impact how parent and child projects are displayed and managed, providing up to 5 levels of hierarchical organization for enhanced billing flexibility and organizational clarity.


    

  • specific - Specify the projects to include and their hierarchical relationships in the groupMembers array.
    • 

  • all - Include all projects that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "all"
object
One or more filters to select the projects to include in the project group. Can be used with both all and specific group types. 


You can use this filter to show only projects managed by the current user: {"$eq":{"manager.id":"current(user)"}}


 
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)
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
Member projects of the project group and their sort order. The sort order is set by the order of projects in the array in POST or PATCH operations, and will be used in any reports that show the project groups in columns or rows. Only applicable when groupType = specific.


 
 Array 
key
string
Project key.


 
 Example:  "1"
id
string
Project ID.


 
 Example:  "DIM - BTI"
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": "P-GRP-01",
  • "name": "Top Priority Projects",
  • "description": "Group for top priority projects",
  • "groupType": "all",
  • "memberFilter": {
    • "object": "projects/project",
    • "filters": [
      • {
        },
      • {
        }
      ],
    • "filterExpression": "and",
    • "orderBy": [
      • {
        }
      ]
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "21",
    • "id": "E 01",
    • "href": "/objects/projects/project-group/21"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a project group
get/objects/projects/project-group/{key}
Returns detailed information for a specified project group.



Permissions and other requirements



SubscriptionProjects


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsList, View Projects







SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project group.


 
 Example:  46
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "Top Projects",
    • "name": "Top Level Projects",
    • "description": "Top Level Projects",
    • "groupType": "specific",
    • "audit": {
      • "createdDateTime": "2024-06-28T21:25:33Z",
      • "modifiedDateTime": "2024-06-28T21:25:33Z",
      • "createdByUser": {
        },
      • "createdBy": "1",
      • "modifiedByUser": {
        },
      • "modifiedBy": "1"
      },
    • "entity": {
      • "key": null,
      • "id": null,
      • "name": null
      },
    • "groupMembers": [
      • {
        },
      • {
        }
      ],
    • "isDimensionStructure": true,
    • "memberFilter": {
      • "object": "projects/project",
      • "filterExpression": "and",
      • "orderBy": [
        ]
      },
    • "href": "/objects/projects/project-group/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a project group
patch/objects/projects/project-group/{key}
Updates an existing project group by setting field values. Any fields not provided remain unchanged. Providing a new value for the groupMembers array replaces the entire array.



Permissions and other requirements



SubscriptionProjects


User typeBusiness


PermissionsList, View, Edit Projects







SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project group.


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


 
 Example:  "Projects that are waiting on PO"
description
string or null
Description of the project group.


 
 Example:  "Projects with G10 and above."
groupType
string
 Default:  "all"
Group membership type. The group type and related fields determine how projects will be organized hierarchically and how related projects will be managed in the Projects list.


Depending on the group type, you can either specify individual projects to include and their order, or include all projects that match certain criteria. This will impact how parent and child projects are displayed and managed, providing up to 5 levels of hierarchical organization for enhanced billing flexibility and organizational clarity.


    

  • specific - Specify the projects to include and their hierarchical relationships in the groupMembers array.
    • 

  • all - Include all projects that match the memberFilter criteria.
    • 



 Enum: "all" "specific"  
 Example:  "all"
object
One or more filters to select the projects to include in the project group. Can be used with both all and specific group types. 


You can use this filter to show only projects managed by the current user: {"$eq":{"manager.id":"current(user)"}}


 
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)
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
Member projects of the project group and their sort order. The sort order is set by the order of projects in the array in POST or PATCH operations, and will be used in any reports that show the project groups in columns or rows. Only applicable when groupType = specific.


 
 Array 
key
string
Project key.


 
 Example:  "1"
id
string
Project ID.


 
 Example:  "DIM - BTI"
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 001 project",
  • "groupMembers": [
    • {
      • "id": "DIM - BTI"
      },
    • {
      • "id": "DIM - ASC"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "E 01",
    • "href": "/objects/projects/project-group/7"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a project group
delete/objects/projects/project-group/{key}
Deletes a project group.



Permissions and other requirements



SubscriptionProjects


User typeBusiness


PermissionsList, View, Delete Projects







SecurityOAuth2 
Request 
path Parameters
key
required
string
system-assigned unique key for the project group.


 
 Example:  46
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 project 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:  "projects/project-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 has (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 result set, 4000 maximum.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "projects-project-group",
  • "filters": [
    • {
      • "$eq": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "id",
    • "name",
    • "groupType",
    • "description",
    • "conditionType",
    • "sortOrder",
    • "maxMatches",
    • "href"
    ],
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "23",
      • "id": "Projects without PO",
      • "name": "Projects that are waiting on PO",
      • "groupType": "specific",
      • "description": "Projects with G10 and above.",
      • "conditionType": "and",
      • "sortOrder": "ascending",
      • "maxMatches": "10",
      • "href": "/objects/projects/project-group/23"
      },
    • {
      • "key": "24",
      • "id": "Projects with Contracts",
      • "name": "Contract-based Projects",
      • "groupType": "specific",
      • "description": "Projects with contracts over $10,000.",
      • "conditionType": "or",
      • "sortOrder": "descending",
      • "maxMatches": "20",
      • "href": "/objects/projects/project-group/24"
      },
    • {
      • "key": "25",
      • "id": "Internal Projects",
      • "name": "Internal Projects Group",
      • "groupType": "specific",
      • "description": "Projects managed internally.",
      • "conditionType": "and",
      • "sortOrder": "ascending",
      • "maxMatches": "5",
      • "href": "/objects/projects/project-group/25"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}