Zum Inhalt springen
Developer

VolunteerHourRequirement

Ehrenamt6 EndpunkteTimeTracking / VolunteerHourRequirement

Individuelle Regeln für Ehrenamtsstunden auflisten

GET/api/time/volunteer_hour_requirement

Query-Parameter

idinteger
personstring
companystring
exemptboolean
validFromstring
validUntilstring
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der VolunteerHourRequirement-Objekte.array<VolunteerHourRequirement>

Felder anzeigen (9)
  • idinteger

    Primärschlüssel der Ehrenamtsstunden-Vorgabe. Interne ID.

  • personCRMPerson27

    Ehrenamtliche Person, für die die Anforderung gilt.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • companyCRMCompany24

    Unternehmen, für das die Anforderung gilt.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Unternehmens. Interne ID.

    • short_namestring

      Kurzname des Unternehmens.

    • company_namestring

      Rechtlicher Name der Firma.

    • numberstring

      Kunden- oder Lieferantennummer des Unternehmens.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Unternehmensnummer als Text, einschließlich Präfix.

  • valid_fromstring (date-time)

    Beginn des Bedarfs.

  • valid_untilstring (date-time)

    Ende der Anforderung.

  • exemptboolean

    Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

  • required_hoursnumber (float)

    Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

  • reasonstring

    Grund für die Anforderung oder Befreiung.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Bedarf angelegt wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_hour_requirement \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "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"
    },
    "valid_from": "2026-10-15T09:30:00+02:00",
    "valid_until": "2026-10-15T09:30:00+02:00",
    "exempt": true,
    "required_hours": 1.5,
    "reason": "string",
    "created": "2026-10-15T09:30:00+02:00"
  }
]

Individuelle Regel für Ehrenamtsstunden hinzufügen

POST/api/time/volunteer_hour_requirement

Request-Body application/json

  • dataVolunteerHourRequirement2
    Felder anzeigen (7)
    • personCRMPerson35

      Ehrenamtliche Person, für die die Anforderung gilt.

    • companyCRMCompany25

      Unternehmen, für das die Anforderung gilt.

    • valid_fromstring (date-time)

      Beginn des Bedarfs.

    • valid_untilstring (date-time)

      Ende der Anforderung.

    • exemptboolean

      Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

    • required_hoursnumber (float)

      Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

    • reasonstring

      Grund für die Anforderung oder Befreiung.

Antworten

200VolunteerHourRequirement neu anlegenVolunteerHourRequirement

Felder anzeigen (9)
  • idinteger

    Primärschlüssel der Ehrenamtsstunden-Vorgabe. Interne ID.

  • personCRMPerson27

    Ehrenamtliche Person, für die die Anforderung gilt.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • companyCRMCompany24

    Unternehmen, für das die Anforderung gilt.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Unternehmens. Interne ID.

    • short_namestring

      Kurzname des Unternehmens.

    • company_namestring

      Rechtlicher Name der Firma.

    • numberstring

      Kunden- oder Lieferantennummer des Unternehmens.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Unternehmensnummer als Text, einschließlich Präfix.

  • valid_fromstring (date-time)

    Beginn des Bedarfs.

  • valid_untilstring (date-time)

    Ende der Anforderung.

  • exemptboolean

    Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

  • required_hoursnumber (float)

    Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

  • reasonstring

    Grund für die Anforderung oder Befreiung.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Bedarf angelegt wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_hour_requirement \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "valid_from": "2026-10-15T09:30:00+02:00",
    "valid_until": "2026-10-15T09:30:00+02:00",
    "exempt": true,
    "required_hours": 1.5,
    "reason": "string"
  }
}
'
Antwort 200 application/json
{
  "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"
  },
  "valid_from": "2026-10-15T09:30:00+02:00",
  "valid_until": "2026-10-15T09:30:00+02:00",
  "exempt": true,
  "required_hours": 1.5,
  "reason": "string",
  "created": "2026-10-15T09:30:00+02:00"
}

Einzelne individuelle Ehrenamtsstunden-Regel abrufen

GET/api/time/volunteer_hour_requirement/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes VolunteerHourRequirement-Objekt.VolunteerHourRequirement

Felder anzeigen (9)
  • idinteger

    Primärschlüssel der Ehrenamtsstunden-Vorgabe. Interne ID.

  • personCRMPerson27

    Ehrenamtliche Person, für die die Anforderung gilt.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • companyCRMCompany24

    Unternehmen, für das die Anforderung gilt.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Unternehmens. Interne ID.

    • short_namestring

      Kurzname des Unternehmens.

    • company_namestring

      Rechtlicher Name der Firma.

    • numberstring

      Kunden- oder Lieferantennummer des Unternehmens.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Unternehmensnummer als Text, einschließlich Präfix.

  • valid_fromstring (date-time)

    Beginn des Bedarfs.

  • valid_untilstring (date-time)

    Ende der Anforderung.

  • exemptboolean

    Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

  • required_hoursnumber (float)

    Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

  • reasonstring

    Grund für die Anforderung oder Befreiung.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Bedarf angelegt wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_hour_requirement/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "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"
  },
  "valid_from": "2026-10-15T09:30:00+02:00",
  "valid_until": "2026-10-15T09:30:00+02:00",
  "exempt": true,
  "required_hours": 1.5,
  "reason": "string",
  "created": "2026-10-15T09:30:00+02:00"
}

Einzelne Ehrenamtsstunden-Regel aktualisieren

PUT/api/time/volunteer_hour_requirement/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataVolunteerHourRequirement2
    Felder anzeigen (7)
    • personCRMPerson35

      Ehrenamtliche Person, für die die Anforderung gilt.

    • companyCRMCompany25

      Unternehmen, für das die Anforderung gilt.

    • valid_fromstring (date-time)

      Beginn des Bedarfs.

    • valid_untilstring (date-time)

      Ende der Anforderung.

    • exemptboolean

      Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

    • required_hoursnumber (float)

      Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

    • reasonstring

      Grund für die Anforderung oder Befreiung.

Antworten

200VolunteerHourRequirement aktualisierenVolunteerHourRequirement

Felder anzeigen (9)
  • idinteger

    Primärschlüssel der Ehrenamtsstunden-Vorgabe. Interne ID.

  • personCRMPerson27

    Ehrenamtliche Person, für die die Anforderung gilt.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • companyCRMCompany24

    Unternehmen, für das die Anforderung gilt.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Unternehmens. Interne ID.

    • short_namestring

      Kurzname des Unternehmens.

    • company_namestring

      Rechtlicher Name der Firma.

    • numberstring

      Kunden- oder Lieferantennummer des Unternehmens.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Unternehmensnummer als Text, einschließlich Präfix.

  • valid_fromstring (date-time)

    Beginn des Bedarfs.

  • valid_untilstring (date-time)

    Ende der Anforderung.

  • exemptboolean

    Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

  • required_hoursnumber (float)

    Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

  • reasonstring

    Grund für die Anforderung oder Befreiung.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Bedarf angelegt wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_hour_requirement/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "valid_from": "2026-10-15T09:30:00+02:00",
    "valid_until": "2026-10-15T09:30:00+02:00",
    "exempt": true,
    "required_hours": 1.5,
    "reason": "string"
  }
}
'
Antwort 200 application/json
{
  "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"
  },
  "valid_from": "2026-10-15T09:30:00+02:00",
  "valid_until": "2026-10-15T09:30:00+02:00",
  "exempt": true,
  "required_hours": 1.5,
  "reason": "string",
  "created": "2026-10-15T09:30:00+02:00"
}

Einzelne Ehrenamtsstunden-Regel aktualisieren

PATCH/api/time/volunteer_hour_requirement/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataVolunteerHourRequirement2
    Felder anzeigen (7)
    • personCRMPerson35

      Ehrenamtliche Person, für die die Anforderung gilt.

    • companyCRMCompany25

      Unternehmen, für das die Anforderung gilt.

    • valid_fromstring (date-time)

      Beginn des Bedarfs.

    • valid_untilstring (date-time)

      Ende der Anforderung.

    • exemptboolean

      Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

    • required_hoursnumber (float)

      Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

    • reasonstring

      Grund für die Anforderung oder Befreiung.

Antworten

200VolunteerHourRequirement aktualisierenVolunteerHourRequirement

Felder anzeigen (9)
  • idinteger

    Primärschlüssel der Ehrenamtsstunden-Vorgabe. Interne ID.

  • personCRMPerson27

    Ehrenamtliche Person, für die die Anforderung gilt.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Person. Interne ID.

    • first_namestring

      Vorname der Person.

    • last_namestring

      Nachname der Person.

    • numberinteger

      Mitglieds- oder Kundennummer der Person.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

    • genderstring

      Geschlecht der Person.

    • titlestring

      Akademischer oder sonstiger Titel der Person.

    • nicknamestring

      Spitzname der Person.

    • preferred_color_hexstring

      Bevorzugte Farbe der Person als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

  • companyCRMCompany24

    Unternehmen, für das die Anforderung gilt.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Unternehmens. Interne ID.

    • short_namestring

      Kurzname des Unternehmens.

    • company_namestring

      Rechtlicher Name der Firma.

    • numberstring

      Kunden- oder Lieferantennummer des Unternehmens.

    • manual_numberinteger

      Manuell gesetzte Nummer statt der automatischen Nummer.

    • number_stringstring

      Unternehmensnummer als Text, einschließlich Präfix.

  • valid_fromstring (date-time)

    Beginn des Bedarfs.

  • valid_untilstring (date-time)

    Ende der Anforderung.

  • exemptboolean

    Das ehrenamtlich tätige Mitglied ist von der Anforderung befreit.

  • required_hoursnumber (float)

    Stunden pro Periode anstelle des installationsweiten Werts. null = installationsweiter Wert.

  • reasonstring

    Grund für die Anforderung oder Befreiung.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Bedarf angelegt wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_hour_requirement/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "valid_from": "2026-10-15T09:30:00+02:00",
    "valid_until": "2026-10-15T09:30:00+02:00",
    "exempt": true,
    "required_hours": 1.5,
    "reason": "string"
  }
}
'
Antwort 200 application/json
{
  "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"
  },
  "valid_from": "2026-10-15T09:30:00+02:00",
  "valid_until": "2026-10-15T09:30:00+02:00",
  "exempt": true,
  "required_hours": 1.5,
  "reason": "string",
  "created": "2026-10-15T09:30:00+02:00"
}

Eine einzelne Ehrenamtsstunden-Regel löschen

DELETE/api/time/volunteer_hour_requirement/{id}

Pfad-Parameter

idPflichtstring

Antworten

default

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/time/volunteer_hour_requirement/42 \
  --header 'x-iw-jwt-token: <TOKEN>'