Create department
Creates a new department in the given organization. Without parentId the department is created directly under the organization’s root department; with parentId it is created under that department. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when parentId is omitted and the organization has no valid root department configured.
curl --request POST \
--url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Marketing",
"externalSourceId": "SAP-4711",
"vatType": "USE_CATEGORY"
}
'import requests
url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments"
payload = {
"name": "Marketing",
"externalSourceId": "SAP-4711",
"vatType": "USE_CATEGORY"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Marketing', externalSourceId: 'SAP-4711', vatType: 'USE_CATEGORY'})
};
fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Marketing',
'externalSourceId' => 'SAP-4711',
'vatType' => 'USE_CATEGORY'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments"
payload := strings.NewReader("{\n \"name\": \"Marketing\",\n \"externalSourceId\": \"SAP-4711\",\n \"vatType\": \"USE_CATEGORY\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Marketing\",\n \"externalSourceId\": \"SAP-4711\",\n \"vatType\": \"USE_CATEGORY\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Marketing\",\n \"externalSourceId\": \"SAP-4711\",\n \"vatType\": \"USE_CATEGORY\"\n}"
response = http.request(request)
puts response.read_body{
"id": "9360d03ad7294220868d67f42a2a144d",
"externalSourceId": "SAP-4711",
"name": "Marketing",
"parentId": "63b7a7802a644e8ca296c9796ffa7074",
"vatType": "USE_CATEGORY",
"customDimensionPresetValues": [],
"level": 1
}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"
Body
Display name of the department. Must be non-empty and not whitespace-only. Leading and trailing whitespace is trimmed.
255Optional external source identifier, for example the department's ID in an integrated system. Leading and trailing whitespace is trimmed, and an empty value is stored as null.
255Optional. The id of the department to create this one under. It must be a department in the same organization. When omitted, null or empty, the department is created as a top-level department directly under the organization's root department (level 1).
Optional. VAT deduction handling for the department, case-sensitive. Applies to this department only, whether or not parentId is set: it is not inherited from the parent department. Defaults to USE_CATEGORY when omitted, null or empty.
USE_CATEGORY, NON_DEDUCTABLE_VAT, DEDUCTABLE_VAT Response
Created — returns the newly created department
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, in the order they were created. The order is stable, so identical requests return the values in the same order. 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 POST \
--url https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Marketing",
"externalSourceId": "SAP-4711",
"vatType": "USE_CATEGORY"
}
'import requests
url = "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments"
payload = {
"name": "Marketing",
"externalSourceId": "SAP-4711",
"vatType": "USE_CATEGORY"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Marketing', externalSourceId: 'SAP-4711', vatType: 'USE_CATEGORY'})
};
fetch('https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Marketing',
'externalSourceId' => 'SAP-4711',
'vatType' => 'USE_CATEGORY'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments"
payload := strings.NewReader("{\n \"name\": \"Marketing\",\n \"externalSourceId\": \"SAP-4711\",\n \"vatType\": \"USE_CATEGORY\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Marketing\",\n \"externalSourceId\": \"SAP-4711\",\n \"vatType\": \"USE_CATEGORY\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://stage-api.findity.com/api/v1/admin/organizations/{organizationId}/departments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Marketing\",\n \"externalSourceId\": \"SAP-4711\",\n \"vatType\": \"USE_CATEGORY\"\n}"
response = http.request(request)
puts response.read_body{
"id": "9360d03ad7294220868d67f42a2a144d",
"externalSourceId": "SAP-4711",
"name": "Marketing",
"parentId": "63b7a7802a644e8ca296c9796ffa7074",
"vatType": "USE_CATEGORY",
"customDimensionPresetValues": [],
"level": 1
}