Get department
Returns a single department by its ID. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the department does not exist or belongs to a different organization.
curl --request GET \
--url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "9360d03ad7294220868d67f42a2a144d",
"externalSourceId": "SAP-4711",
"name": "Marketing",
"parentId": "63b7a7802a644e8ca296c9796ffa7074",
"vatType": "USE_CATEGORY",
"customDimensionPresetValues": [
{
"id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"dimensionDefinitionId": "VAT25",
"presetListValueId": "VAT25",
"presetListValueText": "25%",
"presetStringValue": null
}
],
"level": 1
}{
"result": "error",
"description": "Organization not found or access denied"
}{
"result": "error",
"code": "DEPARTMENT_NOT_FOUND",
"description": "Department not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.
"11adfe2a080040e3892ffb89c21ec44e"
String. The ID of the department to retrieve (32-character hex string), as returned in the id field of the response. Lookup by externalSourceId is not supported for departments, unlike organizationId. The literal value root is reserved: GET .../departments/root always resolves to the organization's root department (see the Get departments root endpoint), so a department whose own id happens to be root cannot be retrieved through this endpoint.
"9360d03ad7294220868d67f42a2a144d"
Response
OK
Unique identifier of the department.
External source identifier of the department, if set by an integration. Null when not set.
Display name of the department.
The id of the parent department. Null only for the organization's own root unit (level 0). Every other department, including a top-level one directly under the root, has this set to its parent's id.
VAT deduction handling for this department. Defaults to USE_CATEGORY when not explicitly set.
USE_CATEGORY, NON_DEDUCTABLE_VAT, DEDUCTABLE_VAT Preset custom dimension values configured for this department. Excludes values belonging to deleted dimension definitions.
Hide child attributes
Hide child attributes
Unique identifier of the preset value.
The ID of the custom dimension definition this preset value belongs to.
The ID of the selected list value, when the dimension uses a list of values. Null when a free-text preset is used instead.
Display text of the selected list value. Null when a free-text preset is used instead.
Free-text preset value, when the dimension does not use a list of values. Null when a list value is used instead.
Depth of the department within the organization's unit hierarchy. The organization's implicit root unit is level 0; a genuine top-level department is level 1.
curl --request GET \
--url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments/{departmentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "9360d03ad7294220868d67f42a2a144d",
"externalSourceId": "SAP-4711",
"name": "Marketing",
"parentId": "63b7a7802a644e8ca296c9796ffa7074",
"vatType": "USE_CATEGORY",
"customDimensionPresetValues": [
{
"id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
"dimensionDefinitionId": "VAT25",
"presetListValueId": "VAT25",
"presetListValueText": "25%",
"presetStringValue": null
}
],
"level": 1
}{
"result": "error",
"description": "Organization not found or access denied"
}{
"result": "error",
"code": "DEPARTMENT_NOT_FOUND",
"description": "Department not found"
}