VolunteerHourSettlement

Volunteering7 EndpointsTimeTracking / VolunteerHourSettlement

List volunteer hour settlements

GET/api/time/volunteer_hour_settlement

Query parameters

`id`integer
`person`string	Set when the hours are owed per member.
`company`string	Billing account the compensation is charged to. When the hours are owed per account (household), the settlement belongs to the account only and person stays empty.
`status`string
`periodStart`string
`periodEnd`string
`generationDate`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of VolunteerHourSettlement objectsarray<VolunteerHourSettlement>

Show fields (19)

subject_namestring
Display name of the settled member or billing account.
idinteger
Primary key of the volunteer hour settlement. Internal ID.
personCRMPerson27
Set when the hours are owed per member.
Show fields (11)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
companyCRMCompany24
Billing account the compensation is charged to. When the hours are owed per account (household), the settlement belongs to the account only and person stays empty.
Show fields (6)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
obligation_scopestring
Scope of the volunteer obligation, for example year or month.
period_startstring (date-time)
Start of the settled period.
period_endstring (date-time)
End of the settled period.
required_minutesinteger
Minutes the volunteer had to work.
credited_minutesinteger
Minutes the volunteer worked and got credited.
carried_in_minutesinteger
Minutes carried in from the previous period.
missing_minutesinteger
Minutes missing to the obligation.
surplus_minutesinteger
Minutes worked above the obligation.
carried_out_minutesinteger
Surplus taken into the next period.
compensation_ratenumber (float)
Compensation per missing hour in force when the settlement was generated (frozen).
compensation_amountnumber (float)
Amount paid as compensation for the missing minutes.
compensation_cappedboolean
The compensation was reduced to the configured maximum.
statusstring
Status of the settlement, for example open or settled.
notestring
Note on the settlement.
generation_datestring (date-time)
Time the settlement was generated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/volunteer_hour_settlement_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await VolunteerHourSettlementController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "subject_name": "Beispiel",
    "id": 42,
    "person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "number": 1,
      "manual_number": 1,
      "number_string": "string",
      "gender": "string",
      "nickname": "string",
      "preferred_color_hex": "string"
    },
    "company": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "number": "string",
      "manual_number": 1,
      "number_string": "string"
    },
    "obligation_scope": "string",
    "period_start": "2026-10-15T09:30:00+02:00",
    "period_end": "2026-10-15T09:30:00+02:00",
    "required_minutes": 1,
    "credited_minutes": 1,
    "carried_in_minutes": 1
  }
]

Preview the settlement of the period containing `date` (default today) without writing anything: who owes how many hours, what has been credited, the compensation per member.

GET/api/time/volunteer_hour_settlement/preview

person / company restrict it to one member or billing account.

Query parameters

`date`string	A date inside the period
`person`integer	Id of a member
`company`integer	Id of a billing account

Responses

default

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/volunteer_hour_settlement_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await VolunteerHourSettlementController.getPreview();
if (result.success) {
  print(result.data);
}

Create the settlements of the period containing `date`. Already settled members and members without obligation are skipped. `createInvoices` (default: true in the INVOICE mode) invoices the compensation to the billing accounts right away.

POST/api/time/volunteer_hour_settlement/generate

Responses

default

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/generate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/volunteer_hour_settlement_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await VolunteerHourSettlementController.postGenerate();
if (result.success) {
  print(result.data);
}

Get a single volunteer hour settlement

GET/api/time/volunteer_hour_settlement/{id}

Path parameters

idrequiredstring

Responses

200Returns a single VolunteerHourSettlementVolunteerHourSettlement

Show fields (19)

subject_namestring
Display name of the settled member or billing account.
idinteger
Primary key of the volunteer hour settlement. Internal ID.
personCRMPerson27
Set when the hours are owed per member.
Show fields (11)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
companyCRMCompany24
Billing account the compensation is charged to. When the hours are owed per account (household), the settlement belongs to the account only and person stays empty.
Show fields (6)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
obligation_scopestring
Scope of the volunteer obligation, for example year or month.
period_startstring (date-time)
Start of the settled period.
period_endstring (date-time)
End of the settled period.
required_minutesinteger
Minutes the volunteer had to work.
credited_minutesinteger
Minutes the volunteer worked and got credited.
carried_in_minutesinteger
Minutes carried in from the previous period.
missing_minutesinteger
Minutes missing to the obligation.
surplus_minutesinteger
Minutes worked above the obligation.
carried_out_minutesinteger
Surplus taken into the next period.
compensation_ratenumber (float)
Compensation per missing hour in force when the settlement was generated (frozen).
compensation_amountnumber (float)
Amount paid as compensation for the missing minutes.
compensation_cappedboolean
The compensation was reduced to the configured maximum.
statusstring
Status of the settlement, for example open or settled.
notestring
Note on the settlement.
generation_datestring (date-time)
Time the settlement was generated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/volunteer_hour_settlement_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await VolunteerHourSettlementController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "subject_name": "Beispiel",
  "id": 42,
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "number": "string",
    "manual_number": 1,
    "number_string": "string"
  },
  "obligation_scope": "string",
  "period_start": "2026-10-15T09:30:00+02:00",
  "period_end": "2026-10-15T09:30:00+02:00",
  "required_minutes": 1,
  "credited_minutes": 1,
  "carried_in_minutes": 1
}

Delete a settlement that has no invoice. Its entries become editable again.

DELETE/api/time/volunteer_hour_settlement/{id}

Path parameters

idrequiredstring

Responses

default

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/volunteer_hour_settlement_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await VolunteerHourSettlementController.delete('42');
if (result.success) {
  print(result.data);
}

Invoice the compensation of a settlement to its billing account

POST/api/time/volunteer_hour_settlement/{id}/invoice

Path parameters

idrequiredstring

Responses

200Invoice the compensation of a VolunteerHourSettlementVolunteerHourSettlement

Show fields (19)

subject_namestring
Display name of the settled member or billing account.
idinteger
Primary key of the volunteer hour settlement. Internal ID.
personCRMPerson27
Set when the hours are owed per member.
Show fields (11)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
companyCRMCompany24
Billing account the compensation is charged to. When the hours are owed per account (household), the settlement belongs to the account only and person stays empty.
Show fields (6)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
obligation_scopestring
Scope of the volunteer obligation, for example year or month.
period_startstring (date-time)
Start of the settled period.
period_endstring (date-time)
End of the settled period.
required_minutesinteger
Minutes the volunteer had to work.
credited_minutesinteger
Minutes the volunteer worked and got credited.
carried_in_minutesinteger
Minutes carried in from the previous period.
missing_minutesinteger
Minutes missing to the obligation.
surplus_minutesinteger
Minutes worked above the obligation.
carried_out_minutesinteger
Surplus taken into the next period.
compensation_ratenumber (float)
Compensation per missing hour in force when the settlement was generated (frozen).
compensation_amountnumber (float)
Amount paid as compensation for the missing minutes.
compensation_cappedboolean
The compensation was reduced to the configured maximum.
statusstring
Status of the settlement, for example open or settled.
notestring
Note on the settlement.
generation_datestring (date-time)
Time the settlement was generated.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'package:http/http.dart' as http;

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/invoice'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "subject_name": "Beispiel",
  "id": 42,
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "number": "string",
    "manual_number": 1,
    "number_string": "string"
  },
  "obligation_scope": "string",
  "period_start": "2026-10-15T09:30:00+02:00",
  "period_end": "2026-10-15T09:30:00+02:00",
  "required_minutes": 1,
  "credited_minutes": 1,
  "carried_in_minutes": 1
}

Waive the compensation of a settlement (Erlass), with an optional `note`

POST/api/time/volunteer_hour_settlement/{id}/waive

Path parameters

idrequiredstring

Responses

200Waive the compensation of a VolunteerHourSettlementVolunteerHourSettlement

Show fields (19)

subject_namestring
Display name of the settled member or billing account.
idinteger
Primary key of the volunteer hour settlement. Internal ID.
personCRMPerson27
Set when the hours are owed per member.
Show fields (11)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
companyCRMCompany24
Billing account the compensation is charged to. When the hours are owed per account (household), the settlement belongs to the account only and person stays empty.
Show fields (6)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
obligation_scopestring
Scope of the volunteer obligation, for example year or month.
period_startstring (date-time)
Start of the settled period.
period_endstring (date-time)
End of the settled period.
required_minutesinteger
Minutes the volunteer had to work.
credited_minutesinteger
Minutes the volunteer worked and got credited.
carried_in_minutesinteger
Minutes carried in from the previous period.
missing_minutesinteger
Minutes missing to the obligation.
surplus_minutesinteger
Minutes worked above the obligation.
carried_out_minutesinteger
Surplus taken into the next period.
compensation_ratenumber (float)
Compensation per missing hour in force when the settlement was generated (frozen).
compensation_amountnumber (float)
Amount paid as compensation for the missing minutes.
compensation_cappedboolean
The compensation was reduced to the configured maximum.
statusstring
Status of the settlement, for example open or settled.
notestring
Note on the settlement.
generation_datestring (date-time)
Time the settlement was generated.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'POST', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive")
  .post(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'package:http/http.dart' as http;

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/time/volunteer_hour_settlement/42/waive'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "subject_name": "Beispiel",
  "id": 42,
  "person": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "number": 1,
    "manual_number": 1,
    "number_string": "string",
    "gender": "string",
    "nickname": "string",
    "preferred_color_hex": "string"
  },
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "number": "string",
    "manual_number": 1,
    "number_string": "string"
  },
  "obligation_scope": "string",
  "period_start": "2026-10-15T09:30:00+02:00",
  "period_end": "2026-10-15T09:30:00+02:00",
  "required_minutes": 1,
  "credited_minutes": 1,
  "carried_in_minutes": 1
}