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 a 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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, View Departments
SecurityOAuth2
Responses
200

OK

201

Created

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/company-config/department",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsAdd 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

Department number

Example: "10"
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 
/**
 * Requires libcurl
 */

$curl = curl_init();

$payload = array(
  "id" => "ENG",
  "name" => "Engineering",
  "reportTitle" => "Engineering",
  "status" => "active",
  "supervisor" => array(
    "key" => "16"
  )
);

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>",
    "Content-Type: application/json"
  ],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/company-config/department",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness, Employee, Payment Approver
PermissionsList, View Departments
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the department.

Example: 28
Responses
200

OK

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

const key = "YOUR_key_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/company-config/department/" . key,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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"
      },
    • "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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsEdit Departments
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

Department number

Example: "10"
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 
/**
 * Requires libcurl
 */

const key = "YOUR_key_PARAMETER";
$curl = curl_init();

$payload = array(
  "supervisor" => array(
    "key" => "99"
  )
);

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>",
    "Content-Type: application/json"
  ],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/company-config/department/" . key,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "PATCH",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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.

Permissions and other requirements
SubscriptionCompany
User typeBusiness user with admin privileges
PermissionsDelete Departments
SecurityOAuth2
Request
path Parameters
key
required
string

System-assigned key for the department.

Example: 28
Responses
204

No Content

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

const key = "YOUR_key_PARAMETER";
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>"
  ],
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/objects/company-config/department/" . key,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "DELETE",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
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 departments

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/department"
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 result set, 4000 maximum.

Example: 100
Responses
200

OK

400

Bad Request

Request samples 
/**
 * Requires libcurl
 */

$curl = curl_init();

$payload = array(
  "object" => "company-config/department",
  "filters" => array(
    array(
      "$eq" => array(
        "status" => "active"
      )
    ),
    array(
      "$eq" => array(
        ""parent.id"" => "ENG"
      )
    )
  ),
  "filterExpression" => "1 and 2",
  "fields" => array(
    "id",
    "name",
    "href"
  ),
  "orderBy" => array(
    array(
      "id" => "asc"
    )
  )
);

curl_setopt_array($curl, [
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <YOUR_TOKEN_HERE>",
    "Content-Type: application/json"
  ],
  CURLOPT_POSTFIELDS => json_encode($payload),
  CURLOPT_PORT => "",
  CURLOPT_URL => "https://api.intacct.com/ia/api/v1/services/core/query",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$error = curl_error($curl);

curl_close($curl);

if ($error) {
  echo "cURL Error #:" . $error;
} else {
  echo $response;
}
Response samples
application/json
{
  • "ia::result": [
    • {
      • "id": "01",
      • "name": "Software",
      • "href": "/objects/company-config/department/1"
      },
    • {
      • "id": "02",
      • "name": "Hardware",
      • "href": "/objects/company-config/department/2"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}

Feedback