Departments

Department is an optional dimension that can be used for tagging, filtering, and categorizing data in many areas of Sage Intacct.

The list of departments is shared by all entities in a company. Users can be restricted to only work with and see specific departments, which might affect what data they can see in reports, transactions, and other data records.

You can create a hierarchy of departments to reflect how departments are organized within a company. To set up a hierarchy, create the parent departments first and then specify the parent department when adding child departments.

List departments

get/objects/company-config/department

Returns up to 100 department references from the collection with a key, ID, and link for each department. This operation is mostly for use in testing; use the query service to find departments that meet certain criteria and to specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

201

Created

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "11",
      • "id": "Eng",
      • "href": "/objects/company-config/department/1"
      },
    • {
      • "key": "2",
      • "id": "Fin",
      • "href": "/objects/company-config/department/2"
      },
    • {
      • "key": "3",
      • "id": "HR",
      • "href": "/objects/company-config/department/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a department
post/objects/company-config/department
Creates a new department.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Department to create


id
required
string
Unique identifier for the department.


 
 Example:  "SW"
name
required
string
Department name.


 
 Example:  "Software Dev"
number
string
 Deprecated 
Department number.


 
reportTitle
string or null
 Default:  null
Department title displayed in reports.


 
 Example:  "Software Engineering"
status
string
 Default:  "active"
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "ENG",
  • "name": "Engineering",
  • "reportTitle": "Engineering",
  • "status": "active",
  • "supervisor": {
    • "key": "16"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "ENG",
    • "href": "/objects/company-config/department/12"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a department
get/objects/company-config/department/{key}
Returns detailed information for a specified department.


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


 
 Example:  28
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "id": "PS",
    • "key": "28",
    • "name": "Professional Services",
    • "parent": {
      • "key": "7",
      • "id": "CS--Client Services",
      • "name": "Client Services",
      • "href": "/objects/company-config/department/7"
      },
    • "supervisor": {
      • "key": "5",
      • "id": "MGR1--PS Dept - Manager",
      • "name": "PS Dept - Manager",
      • "href": "/objects/company-config/employee/5"
      },
    • "audit": {
      • "createdDateTime": "2023-01-08T11:28:12Z",
      • "modifiedDateTime": "2023-01-08T11:28:12Z",
      • "createdBy": "1",
      • "modifiedBy": "95",
      • "createdByUser": {
        },
      • "modifiedByUser": {
        }
      },
    • "status": "active",
    • "reportTitle": "Professional Services",
    • "href": "/objects/company-config/department/28"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a department
patch/objects/company-config/department/{key}
Updates an existing department by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  28
Request Body schema: application/json
name
string
Department name.


 
 Example:  "Software Dev"
number
string
 Deprecated 
Department number.


 
reportTitle
string or null
 Default:  null
Department title displayed in reports.


 
 Example:  "Software Engineering"
status
string
 Default:  "active"
Status of the dimension object:


    

  • active - Transactions can be posted to this dimension member and it can be used in reports.
    • 

  • activeNonPosting - Transactions cannot be posted to the dimension member but it can be used in reports.
    • 

  • inactive - The dimension member cannot be used for transactions or reports.
    • 



 Enum: "active" "activeNonPosting" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "supervisor": {
    • "key": "99"
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "SW",
    • "href": "/objects/company-config/department/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a department
delete/objects/company-config/department/{key}
Deletes a department. You can delete a department if it is not being used or referenced. Deleted departments cannot be recovered.


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


 
 Example:  28
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
    }
}