Zum Inhalt springen
Developer

MembershipPauseRequest

CRM4 EndpunkteCRM / MembershipPauseRequest

Pause genehmigen (schreibt die Pause in die Mitgliedschaft) oder ablehnen

PUT/api/crm/membership_pause_request/{id}/decide

Pfad-Parameter

idPflichtstring

Query-Parameter

decisionPflichtstringAPPROVED oder DECLINEDErlaubt: APPROVEDDECLINED
commentstringOptionaler Kommentar zur Entscheidung

Antworten

200Mitgliedschaftspause genehmigen oder ablehnenMembershipPauseRequest

Felder anzeigen (19)
  • daysinteger
  • log_book_entryinteger
  • membership_namestring
  • personinteger
  • person_namestring
  • companyinteger
  • decided_by_user_namestring
  • idinteger

    Primärschlüssel der Anfrage zur Mitgliedschaftspause. Interne ID.

  • startstring (date-time)

    Erster Tag der Pause.

  • endstring (date-time)

    Letzter Tag der Pause (der ganze Tag ist eingeschlossen).

  • reasonstring

    Grund für die Pause.

  • statusstring

    Status der Anfrage, zum Beispiel offen, genehmigt oder abgelehnt.

  • decided_atstring (date-time)

    Zeitpunkt, zu dem über den Antrag entschieden wurde.

  • decision_commentstring

    Kommentar zur Entscheidung.

  • applied_atstring (date-time)

    Wann die Pause in die Mitgliedschaft eingetragen wurde.

  • withdrawn_atstring (date-time)

    Zeitpunkt, zu dem der Antrag zurückgezogen wurde.

  • extended_endstring (date-time)

    Das Mitgliedschaftsende, das die Pause gesetzt hat (nur, wenn die Einstellungen die Mitgliedschaft verlängern).

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url 'https://eure-instanz.iw-erp.de/api/crm/membership_pause_request/42/decide?decision=APPROVED' \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "membership_name": "Beispiel",
  "person_name": "Beispiel",
  "decided_by_user_name": "Beispiel",
  "id": 42,
  "decision_comment": "Text",
  "days": 1,
  "log_book_entry": 1,
  "person": 1,
  "company": 1,
  "start": "2026-10-15T09:30:00+02:00"
}

Pause genehmigen (schreibt die Pause in die Mitgliedschaft) oder ablehnen

PATCH/api/crm/membership_pause_request/{id}/decide

Pfad-Parameter

idPflichtstring

Query-Parameter

decisionPflichtstringAPPROVED oder DECLINEDErlaubt: APPROVEDDECLINED
commentstringOptionaler Kommentar zur Entscheidung

Antworten

200Mitgliedschaftspause genehmigen oder ablehnenMembershipPauseRequest

Felder anzeigen (19)
  • daysinteger
  • log_book_entryinteger
  • membership_namestring
  • personinteger
  • person_namestring
  • companyinteger
  • decided_by_user_namestring
  • idinteger

    Primärschlüssel der Anfrage zur Mitgliedschaftspause. Interne ID.

  • startstring (date-time)

    Erster Tag der Pause.

  • endstring (date-time)

    Letzter Tag der Pause (der ganze Tag ist eingeschlossen).

  • reasonstring

    Grund für die Pause.

  • statusstring

    Status der Anfrage, zum Beispiel offen, genehmigt oder abgelehnt.

  • decided_atstring (date-time)

    Zeitpunkt, zu dem über den Antrag entschieden wurde.

  • decision_commentstring

    Kommentar zur Entscheidung.

  • applied_atstring (date-time)

    Wann die Pause in die Mitgliedschaft eingetragen wurde.

  • withdrawn_atstring (date-time)

    Zeitpunkt, zu dem der Antrag zurückgezogen wurde.

  • extended_endstring (date-time)

    Das Mitgliedschaftsende, das die Pause gesetzt hat (nur, wenn die Einstellungen die Mitgliedschaft verlängern).

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url 'https://eure-instanz.iw-erp.de/api/crm/membership_pause_request/42/decide?decision=APPROVED' \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "membership_name": "Beispiel",
  "person_name": "Beispiel",
  "decided_by_user_name": "Beispiel",
  "id": 42,
  "decision_comment": "Text",
  "days": 1,
  "log_book_entry": 1,
  "person": 1,
  "company": 1,
  "start": "2026-10-15T09:30:00+02:00"
}

Einzelne Mitgliedschaftspause abrufen

GET/api/crm/membership_pause_request/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes MembershipPauseRequest-Objekt.MembershipPauseRequest

Felder anzeigen (19)
  • daysinteger
  • log_book_entryinteger
  • membership_namestring
  • personinteger
  • person_namestring
  • companyinteger
  • decided_by_user_namestring
  • idinteger

    Primärschlüssel der Anfrage zur Mitgliedschaftspause. Interne ID.

  • startstring (date-time)

    Erster Tag der Pause.

  • endstring (date-time)

    Letzter Tag der Pause (der ganze Tag ist eingeschlossen).

  • reasonstring

    Grund für die Pause.

  • statusstring

    Status der Anfrage, zum Beispiel offen, genehmigt oder abgelehnt.

  • decided_atstring (date-time)

    Zeitpunkt, zu dem über den Antrag entschieden wurde.

  • decision_commentstring

    Kommentar zur Entscheidung.

  • applied_atstring (date-time)

    Wann die Pause in die Mitgliedschaft eingetragen wurde.

  • withdrawn_atstring (date-time)

    Zeitpunkt, zu dem der Antrag zurückgezogen wurde.

  • extended_endstring (date-time)

    Das Mitgliedschaftsende, das die Pause gesetzt hat (nur, wenn die Einstellungen die Mitgliedschaft verlängern).

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/membership_pause_request/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "membership_name": "Beispiel",
  "person_name": "Beispiel",
  "decided_by_user_name": "Beispiel",
  "id": 42,
  "decision_comment": "Text",
  "days": 1,
  "log_book_entry": 1,
  "person": 1,
  "company": 1,
  "start": "2026-10-15T09:30:00+02:00"
}

Mitgliedschaftspausen auflisten (Filter status=REQUESTED für die offenen)

GET/api/crm/membership_pause_request

Query-Parameter

idinteger
statusstring
personstring
companystring
logBookEntrystring
startstringErster Tag der Pause. | Benötigt Zugriffsrecht: SCOPE
endstringLetzter Tag der Pause (der ganze Tag ist eingeschlossen). | Benötigt Zugriffs-Tag: SCOPE
createdstring
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 MembershipPauseRequest-Objekte.array<MembershipPauseRequest>

Felder anzeigen (19)
  • daysinteger
  • log_book_entryinteger
  • membership_namestring
  • personinteger
  • person_namestring
  • companyinteger
  • decided_by_user_namestring
  • idinteger

    Primärschlüssel der Anfrage zur Mitgliedschaftspause. Interne ID.

  • startstring (date-time)

    Erster Tag der Pause.

  • endstring (date-time)

    Letzter Tag der Pause (der ganze Tag ist eingeschlossen).

  • reasonstring

    Grund für die Pause.

  • statusstring

    Status der Anfrage, zum Beispiel offen, genehmigt oder abgelehnt.

  • decided_atstring (date-time)

    Zeitpunkt, zu dem über den Antrag entschieden wurde.

  • decision_commentstring

    Kommentar zur Entscheidung.

  • applied_atstring (date-time)

    Wann die Pause in die Mitgliedschaft eingetragen wurde.

  • withdrawn_atstring (date-time)

    Zeitpunkt, zu dem der Antrag zurückgezogen wurde.

  • extended_endstring (date-time)

    Das Mitgliedschaftsende, das die Pause gesetzt hat (nur, wenn die Einstellungen die Mitgliedschaft verlängern).

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/membership_pause_request \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "membership_name": "Beispiel",
    "person_name": "Beispiel",
    "decided_by_user_name": "Beispiel",
    "id": 42,
    "decision_comment": "Text",
    "days": 1,
    "log_book_entry": 1,
    "person": 1,
    "company": 1,
    "start": "2026-10-15T09:30:00+02:00"
  }
]