Update Organization Preferences

curl --request PATCH \
  --url https://api.example.com/organizations/{organization_id}/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "is_insolvent": false,
  "insolvency_start_date": "2023-12-25",
  "insolvency_end_date": "2023-12-25",
  "insolvency_company_number": "<string>",
  "extra_paid_leave_days": 123,
  "first_payroll_date": "2023-12-25",
  "last_payroll_date": "2023-12-25",
  "first_payroll_intermezzo": "2023-12-25",
  "logo_id": "<string>",
  "preferences_country": "DE",
  "insurance_credit_preference": "<string>",
  "days_for_sickness_certificate": 4
}
'

import requests

url = "https://api.example.com/organizations/{organization_id}/preferences"

payload = {
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "is_insolvent": False,
    "insolvency_start_date": "2023-12-25",
    "insolvency_end_date": "2023-12-25",
    "insolvency_company_number": "<string>",
    "extra_paid_leave_days": 123,
    "first_payroll_date": "2023-12-25",
    "last_payroll_date": "2023-12-25",
    "first_payroll_intermezzo": "2023-12-25",
    "logo_id": "<string>",
    "preferences_country": "DE",
    "insurance_credit_preference": "<string>",
    "days_for_sickness_certificate": 4
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    valid_from: '2023-12-25',
    valid_to: '2023-12-25',
    is_insolvent: false,
    insolvency_start_date: '2023-12-25',
    insolvency_end_date: '2023-12-25',
    insolvency_company_number: '<string>',
    extra_paid_leave_days: 123,
    first_payroll_date: '2023-12-25',
    last_payroll_date: '2023-12-25',
    first_payroll_intermezzo: '2023-12-25',
    logo_id: '<string>',
    preferences_country: 'DE',
    insurance_credit_preference: '<string>',
    days_for_sickness_certificate: 4
  })
};

fetch('https://api.example.com/organizations/{organization_id}/preferences', 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://api.example.com/organizations/{organization_id}/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'valid_from' => '2023-12-25',
    'valid_to' => '2023-12-25',
    'is_insolvent' => false,
    'insolvency_start_date' => '2023-12-25',
    'insolvency_end_date' => '2023-12-25',
    'insolvency_company_number' => '<string>',
    'extra_paid_leave_days' => 123,
    'first_payroll_date' => '2023-12-25',
    'last_payroll_date' => '2023-12-25',
    'first_payroll_intermezzo' => '2023-12-25',
    'logo_id' => '<string>',
    'preferences_country' => 'DE',
    'insurance_credit_preference' => '<string>',
    'days_for_sickness_certificate' => 4
  ]),
  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://api.example.com/organizations/{organization_id}/preferences"

	payload := strings.NewReader("{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\",\n  \"is_insolvent\": false,\n  \"insolvency_start_date\": \"2023-12-25\",\n  \"insolvency_end_date\": \"2023-12-25\",\n  \"insolvency_company_number\": \"<string>\",\n  \"extra_paid_leave_days\": 123,\n  \"first_payroll_date\": \"2023-12-25\",\n  \"last_payroll_date\": \"2023-12-25\",\n  \"first_payroll_intermezzo\": \"2023-12-25\",\n  \"logo_id\": \"<string>\",\n  \"preferences_country\": \"DE\",\n  \"insurance_credit_preference\": \"<string>\",\n  \"days_for_sickness_certificate\": 4\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/organizations/{organization_id}/preferences")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\",\n  \"is_insolvent\": false,\n  \"insolvency_start_date\": \"2023-12-25\",\n  \"insolvency_end_date\": \"2023-12-25\",\n  \"insolvency_company_number\": \"<string>\",\n  \"extra_paid_leave_days\": 123,\n  \"first_payroll_date\": \"2023-12-25\",\n  \"last_payroll_date\": \"2023-12-25\",\n  \"first_payroll_intermezzo\": \"2023-12-25\",\n  \"logo_id\": \"<string>\",\n  \"preferences_country\": \"DE\",\n  \"insurance_credit_preference\": \"<string>\",\n  \"days_for_sickness_certificate\": 4\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/organizations/{organization_id}/preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\",\n  \"is_insolvent\": false,\n  \"insolvency_start_date\": \"2023-12-25\",\n  \"insolvency_end_date\": \"2023-12-25\",\n  \"insolvency_company_number\": \"<string>\",\n  \"extra_paid_leave_days\": 123,\n  \"first_payroll_date\": \"2023-12-25\",\n  \"last_payroll_date\": \"2023-12-25\",\n  \"first_payroll_intermezzo\": \"2023-12-25\",\n  \"logo_id\": \"<string>\",\n  \"preferences_country\": \"DE\",\n  \"insurance_credit_preference\": \"<string>\",\n  \"days_for_sickness_certificate\": 4\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "is_insolvent": false,
  "insolvency_start_date": "2023-12-25",
  "insolvency_end_date": "2023-12-25",
  "insolvency_company_number": "<string>",
  "extra_paid_leave_days": 123,
  "first_payroll_date": "2023-12-25",
  "last_payroll_date": "2023-12-25",
  "first_payroll_intermezzo": "2023-12-25",
  "logo_id": "<string>",
  "preferences_country": "DE",
  "insurance_credit_preference": "<string>",
  "days_for_sickness_certificate": 4
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PATCH

organizations

{organization_id}

preferences

Update Organization Preferences

curl --request PATCH \
  --url https://api.example.com/organizations/{organization_id}/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "is_insolvent": false,
  "insolvency_start_date": "2023-12-25",
  "insolvency_end_date": "2023-12-25",
  "insolvency_company_number": "<string>",
  "extra_paid_leave_days": 123,
  "first_payroll_date": "2023-12-25",
  "last_payroll_date": "2023-12-25",
  "first_payroll_intermezzo": "2023-12-25",
  "logo_id": "<string>",
  "preferences_country": "DE",
  "insurance_credit_preference": "<string>",
  "days_for_sickness_certificate": 4
}
'

import requests

url = "https://api.example.com/organizations/{organization_id}/preferences"

payload = {
    "valid_from": "2023-12-25",
    "valid_to": "2023-12-25",
    "is_insolvent": False,
    "insolvency_start_date": "2023-12-25",
    "insolvency_end_date": "2023-12-25",
    "insolvency_company_number": "<string>",
    "extra_paid_leave_days": 123,
    "first_payroll_date": "2023-12-25",
    "last_payroll_date": "2023-12-25",
    "first_payroll_intermezzo": "2023-12-25",
    "logo_id": "<string>",
    "preferences_country": "DE",
    "insurance_credit_preference": "<string>",
    "days_for_sickness_certificate": 4
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    valid_from: '2023-12-25',
    valid_to: '2023-12-25',
    is_insolvent: false,
    insolvency_start_date: '2023-12-25',
    insolvency_end_date: '2023-12-25',
    insolvency_company_number: '<string>',
    extra_paid_leave_days: 123,
    first_payroll_date: '2023-12-25',
    last_payroll_date: '2023-12-25',
    first_payroll_intermezzo: '2023-12-25',
    logo_id: '<string>',
    preferences_country: 'DE',
    insurance_credit_preference: '<string>',
    days_for_sickness_certificate: 4
  })
};

fetch('https://api.example.com/organizations/{organization_id}/preferences', 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://api.example.com/organizations/{organization_id}/preferences",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'valid_from' => '2023-12-25',
    'valid_to' => '2023-12-25',
    'is_insolvent' => false,
    'insolvency_start_date' => '2023-12-25',
    'insolvency_end_date' => '2023-12-25',
    'insolvency_company_number' => '<string>',
    'extra_paid_leave_days' => 123,
    'first_payroll_date' => '2023-12-25',
    'last_payroll_date' => '2023-12-25',
    'first_payroll_intermezzo' => '2023-12-25',
    'logo_id' => '<string>',
    'preferences_country' => 'DE',
    'insurance_credit_preference' => '<string>',
    'days_for_sickness_certificate' => 4
  ]),
  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://api.example.com/organizations/{organization_id}/preferences"

	payload := strings.NewReader("{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\",\n  \"is_insolvent\": false,\n  \"insolvency_start_date\": \"2023-12-25\",\n  \"insolvency_end_date\": \"2023-12-25\",\n  \"insolvency_company_number\": \"<string>\",\n  \"extra_paid_leave_days\": 123,\n  \"first_payroll_date\": \"2023-12-25\",\n  \"last_payroll_date\": \"2023-12-25\",\n  \"first_payroll_intermezzo\": \"2023-12-25\",\n  \"logo_id\": \"<string>\",\n  \"preferences_country\": \"DE\",\n  \"insurance_credit_preference\": \"<string>\",\n  \"days_for_sickness_certificate\": 4\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.example.com/organizations/{organization_id}/preferences")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\",\n  \"is_insolvent\": false,\n  \"insolvency_start_date\": \"2023-12-25\",\n  \"insolvency_end_date\": \"2023-12-25\",\n  \"insolvency_company_number\": \"<string>\",\n  \"extra_paid_leave_days\": 123,\n  \"first_payroll_date\": \"2023-12-25\",\n  \"last_payroll_date\": \"2023-12-25\",\n  \"first_payroll_intermezzo\": \"2023-12-25\",\n  \"logo_id\": \"<string>\",\n  \"preferences_country\": \"DE\",\n  \"insurance_credit_preference\": \"<string>\",\n  \"days_for_sickness_certificate\": 4\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/organizations/{organization_id}/preferences")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"valid_from\": \"2023-12-25\",\n  \"valid_to\": \"2023-12-25\",\n  \"is_insolvent\": false,\n  \"insolvency_start_date\": \"2023-12-25\",\n  \"insolvency_end_date\": \"2023-12-25\",\n  \"insolvency_company_number\": \"<string>\",\n  \"extra_paid_leave_days\": 123,\n  \"first_payroll_date\": \"2023-12-25\",\n  \"last_payroll_date\": \"2023-12-25\",\n  \"first_payroll_intermezzo\": \"2023-12-25\",\n  \"logo_id\": \"<string>\",\n  \"preferences_country\": \"DE\",\n  \"insurance_credit_preference\": \"<string>\",\n  \"days_for_sickness_certificate\": 4\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "is_insolvent": false,
  "insolvency_start_date": "2023-12-25",
  "insolvency_end_date": "2023-12-25",
  "insolvency_company_number": "<string>",
  "extra_paid_leave_days": 123,
  "first_payroll_date": "2023-12-25",
  "last_payroll_date": "2023-12-25",
  "first_payroll_intermezzo": "2023-12-25",
  "logo_id": "<string>",
  "preferences_country": "DE",
  "insurance_credit_preference": "<string>",
  "days_for_sickness_certificate": 4
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

organization_id

required

Body

application/json

DEOrganizationPreferencesUpdateRequest
GBOrganizationPreferencesUpdateRequest

Update organization preferences for Germany. The model must contain only optional fields.

valid_from

string<date> | null

valid_to

string<date> | null

is_insolvent

boolean

default:false

insolvency_start_date

string<date> | null

insolvency_end_date

string<date> | null

insolvency_company_number

string | null

insurance_subsidy_method

enum<string> | null

Available options:

remuneration,

assessment_ceiling

extra_paid_leave_days

integer | null

first_payroll_date

string<date> | null

First payroll (ever) run by the company

last_payroll_date

string<date> | null

Last payroll run in other system before Intermezzo's first payroll

first_payroll_intermezzo

string<date> | null

First date Intermezzo software is used for payroll

logo_id

preferences_country

string

default:DE

Allowed value: "DE"

insurance_credit_preference

string | null

Für die Möglichkeit der Überweisung, Verrechnung oder Gutschrift ist eine entsprechende Eingabemöglichkeit vorzusehen.

days_for_sickness_certificate

integer | null

default:4

additional_childcare_sick_days_reason

enum<integer> | null

Reason for the selection of the number of additional paid sick days for childcare.

Available options:

0,

1,

2,

3

Response

Successful Response

DEOrganizationPreferencesResponse
GBOrganizationPreferencesResponse

integer

required

valid_from

string<date> | null

valid_to

string<date> | null

is_insolvent

boolean

default:false

insolvency_start_date

string<date> | null

insolvency_end_date

string<date> | null

insolvency_company_number

string | null

insurance_subsidy_method

enum<string> | null

Available options:

remuneration,

assessment_ceiling

extra_paid_leave_days

integer | null

first_payroll_date

string<date> | null

First payroll (ever) run by the company

last_payroll_date

string<date> | null

Last payroll run in other system before Intermezzo's first payroll

first_payroll_intermezzo

string<date> | null

First date Intermezzo software is used for payroll

logo_id

string | null

preferences_country

string

default:DE

Allowed value: "DE"

insurance_credit_preference

string | null

Für die Möglichkeit der Überweisung, Verrechnung oder Gutschrift ist eine entsprechende Eingabemöglichkeit vorzusehen.

days_for_sickness_certificate

integer | null

default:4

additional_childcare_sick_days_reason

enum<integer> | null

Reason for the selection of the number of additional paid sick days for childcare.

Available options:

0,

1,

2,

3

Shutdown Org

Get Current Organization Preferences

⌘I

Core

Germany

Great Britain

Update Organization Preferences

Authorizations

Path Parameters

Body

Response