Zum Inhalt springen
Developer

Inventory loan

Event / Inventarausleihe

Orte und Buchungen8 EndpunkteEvent / Inventory loan

Jeder Inventargegenstand mit Bestand, verliehenen, überfälligen und aktuell freien Stücken.

GET/api/event/inventory_loan_stock

Antworten

200Liste von {bookable, quantity, lent, overdue, available_now, deposit}

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/inventory_loan_stock \
  --header 'x-iw-jwt-token: <TOKEN>'

Freie Stücke eines Artikels zwischen Beginn und Ende (Buchungen und Ausleihen eingerechnet).

GET/api/event/inventory_loan_availability/{bookableId}

Pfad-Parameter

bookableIdPflichtstring

Query-Parameter

startPflichtstring
endPflichtstring

Antworten

200{quantity, used, available}

Anfrage
curl --request GET \
  --url 'https://eure-instanz.iw-erp.de/api/event/inventory_loan_availability/42?start=string&end=string' \
  --header 'x-iw-jwt-token: <TOKEN>'

Alle Ausleihen; Standardreihenfolge: Fälligkeitsdatum aufsteigend (state=RETURNED: zuletzt zurückgegeben zuerst). overdue=1 (oder state=OVERDUE) listet nur Ausleihen, deren Fälligkeitsdatum überschritten ist.

GET/api/event/inventory_loan

Query-Parameter

idstring
statestring
bookablestring
bookingstringDie Buchung, mit der der Gegenstand reserviert wurde (null erst, wenn die Buchung gelöscht ist). | Benötigtes Zugriffsrecht: SCOPE
personstring
depositStatestring
issuedAtstring
dueAtstring
returnedAtstring
createdstring
updatedstring
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 EventInventoryLoan-Objekte.array<EventInventoryLoan>

Felder anzeigen (22)
  • overdueboolean
  • deposit_refunded_amountnumber (float)

    Bei Rückgabe zurückgezahlter Betrag (Kaution abzüglich des einbehaltenen Anteils).

  • idinteger

    Primärschlüssel der Inventarausleihe. Interne ID.

  • bookable_namestring

    Name des Gegenstands zum Zeitpunkt der Übergabe.

  • borrower_namestring

    Name des Entleihers zum Zeitpunkt der Ausleihe bzw. der eingetragene Name bei Personen ohne Personendatensatz.

  • quantityinteger

    Anzahl der verliehenen Gegenstände.

  • statestring

    Status der Ausleihe, zum Beispiel ausgegeben oder zurückgegeben.

  • issued_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand ausgegeben wurde.

  • due_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben werden muss.

  • returned_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben wurde.

  • deposit_amountnumber (float)

    Für das Darlehen gezahlte Kaution.

  • deposit_statestring

    Status der Kaution, zum Beispiel einbehalten oder erstattet.

  • deposit_retained_amountnumber (float)

    Anteil der Kaution, der bei Rückgabe einbehalten wird.

  • condition_on_issuestring

    Zustand des Postens bei der Ausgabe.

  • condition_on_returnstring

    Zustand des Postens bei der Rückgabe.

  • notestring

    Interne Notiz der Geschäftsstelle, wird dem Entleiher nicht angezeigt.

  • issued_by_namestring

    Name des Mitarbeitenden, der den Gegenstand ausgegeben hat.

  • returned_by_namestring

    Name des Mitarbeitenden, der den Gegenstand zurückgenommen hat.

  • last_reminder_atstring (date-time)

    Letzte Erinnerung (bald fällig oder überfällig), die an den Entleiher gesendet wurde.

  • reminder_countinteger

    Anzahl der für die Ausleihe versendeten Mahnungen.

  • 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/event/inventory_loan \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "bookable_name": "Beispiel",
    "borrower_name": "Beispiel",
    "issued_by_name": "Beispiel",
    "returned_by_name": "Beispiel",
    "overdue": true,
    "deposit_refunded_amount": 49.9,
    "quantity": 1,
    "state": "string",
    "issued_at": "2026-10-15T09:30:00+02:00"
  }
]

Das Element einer Buchung (Termin) übergeben; Element und Entleiher stammen aus der Buchung.

POST/api/event/inventory_loan

Ohne dueAt läuft die Ausleihe bis zum Ende der Buchung. Die Kaution ist standardmäßig die Kaution der Position multipliziert mit der Menge. force=true überspringt die Bestandsprüfung.

Request-Body application/json

  • bookingintegerPflicht
  • quantityinteger
  • due_atstring
  • deposit_amountnumber
  • conditionstring
  • notestring
  • forceboolean

Antworten

200Das neue DarlehenEventInventoryLoan

Felder anzeigen (22)
  • overdueboolean
  • deposit_refunded_amountnumber (float)

    Bei Rückgabe zurückgezahlter Betrag (Kaution abzüglich des einbehaltenen Anteils).

  • idinteger

    Primärschlüssel der Inventarausleihe. Interne ID.

  • bookable_namestring

    Name des Gegenstands zum Zeitpunkt der Übergabe.

  • borrower_namestring

    Name des Entleihers zum Zeitpunkt der Ausleihe bzw. der eingetragene Name bei Personen ohne Personendatensatz.

  • quantityinteger

    Anzahl der verliehenen Gegenstände.

  • statestring

    Status der Ausleihe, zum Beispiel ausgegeben oder zurückgegeben.

  • issued_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand ausgegeben wurde.

  • due_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben werden muss.

  • returned_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben wurde.

  • deposit_amountnumber (float)

    Für das Darlehen gezahlte Kaution.

  • deposit_statestring

    Status der Kaution, zum Beispiel einbehalten oder erstattet.

  • deposit_retained_amountnumber (float)

    Anteil der Kaution, der bei Rückgabe einbehalten wird.

  • condition_on_issuestring

    Zustand des Postens bei der Ausgabe.

  • condition_on_returnstring

    Zustand des Postens bei der Rückgabe.

  • notestring

    Interne Notiz der Geschäftsstelle, wird dem Entleiher nicht angezeigt.

  • issued_by_namestring

    Name des Mitarbeitenden, der den Gegenstand ausgegeben hat.

  • returned_by_namestring

    Name des Mitarbeitenden, der den Gegenstand zurückgenommen hat.

  • last_reminder_atstring (date-time)

    Letzte Erinnerung (bald fällig oder überfällig), die an den Entleiher gesendet wurde.

  • reminder_countinteger

    Anzahl der für die Ausleihe versendeten Mahnungen.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/inventory_loan \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "booking": 1,
  "quantity": 1,
  "due_at": "2026-10-15T09:30:00+02:00",
  "deposit_amount": 49.9,
  "condition": "string",
  "note": "string"
}
'
Antwort 200 application/json
{
  "id": 42,
  "bookable_name": "Beispiel",
  "borrower_name": "Beispiel",
  "issued_by_name": "Beispiel",
  "returned_by_name": "Beispiel",
  "overdue": true,
  "deposit_refunded_amount": 49.9,
  "quantity": 1,
  "state": "string",
  "issued_at": "2026-10-15T09:30:00+02:00"
}

Liefert einen einzelnen Eintrag zur Inventarausleihe bei Veranstaltungen.

GET/api/event/inventory_loan/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Liefert ein einzelnes EventInventoryLoan-Objekt.EventInventoryLoan

Felder anzeigen (22)
  • overdueboolean
  • deposit_refunded_amountnumber (float)

    Bei Rückgabe zurückgezahlter Betrag (Kaution abzüglich des einbehaltenen Anteils).

  • idinteger

    Primärschlüssel der Inventarausleihe. Interne ID.

  • bookable_namestring

    Name des Gegenstands zum Zeitpunkt der Übergabe.

  • borrower_namestring

    Name des Entleihers zum Zeitpunkt der Ausleihe bzw. der eingetragene Name bei Personen ohne Personendatensatz.

  • quantityinteger

    Anzahl der verliehenen Gegenstände.

  • statestring

    Status der Ausleihe, zum Beispiel ausgegeben oder zurückgegeben.

  • issued_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand ausgegeben wurde.

  • due_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben werden muss.

  • returned_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben wurde.

  • deposit_amountnumber (float)

    Für das Darlehen gezahlte Kaution.

  • deposit_statestring

    Status der Kaution, zum Beispiel einbehalten oder erstattet.

  • deposit_retained_amountnumber (float)

    Anteil der Kaution, der bei Rückgabe einbehalten wird.

  • condition_on_issuestring

    Zustand des Postens bei der Ausgabe.

  • condition_on_returnstring

    Zustand des Postens bei der Rückgabe.

  • notestring

    Interne Notiz der Geschäftsstelle, wird dem Entleiher nicht angezeigt.

  • issued_by_namestring

    Name des Mitarbeitenden, der den Gegenstand ausgegeben hat.

  • returned_by_namestring

    Name des Mitarbeitenden, der den Gegenstand zurückgenommen hat.

  • last_reminder_atstring (date-time)

    Letzte Erinnerung (bald fällig oder überfällig), die an den Entleiher gesendet wurde.

  • reminder_countinteger

    Anzahl der für die Ausleihe versendeten Mahnungen.

  • 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/event/inventory_loan/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "bookable_name": "Beispiel",
  "borrower_name": "Beispiel",
  "issued_by_name": "Beispiel",
  "returned_by_name": "Beispiel",
  "overdue": true,
  "deposit_refunded_amount": 49.9,
  "quantity": 1,
  "state": "string",
  "issued_at": "2026-10-15T09:30:00+02:00"
}

return (condition, retained_amount = einbehaltener Teil der Kaution, note, returned_at), extend (due_at, force).

PUT/api/event/inventory_loan/{id}/{action}

Pfad-Parameter

idPflichtstring
actionPflichtstring

Request-Body application/json

  • conditionstring
  • retained_amountnumber
  • notestring
  • returned_atstring
  • due_atstring
  • forceboolean

Antworten

200Das Darlehen nach der AktionEventInventoryLoan

Felder anzeigen (22)
  • overdueboolean
  • deposit_refunded_amountnumber (float)

    Bei Rückgabe zurückgezahlter Betrag (Kaution abzüglich des einbehaltenen Anteils).

  • idinteger

    Primärschlüssel der Inventarausleihe. Interne ID.

  • bookable_namestring

    Name des Gegenstands zum Zeitpunkt der Übergabe.

  • borrower_namestring

    Name des Entleihers zum Zeitpunkt der Ausleihe bzw. der eingetragene Name bei Personen ohne Personendatensatz.

  • quantityinteger

    Anzahl der verliehenen Gegenstände.

  • statestring

    Status der Ausleihe, zum Beispiel ausgegeben oder zurückgegeben.

  • issued_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand ausgegeben wurde.

  • due_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben werden muss.

  • returned_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben wurde.

  • deposit_amountnumber (float)

    Für das Darlehen gezahlte Kaution.

  • deposit_statestring

    Status der Kaution, zum Beispiel einbehalten oder erstattet.

  • deposit_retained_amountnumber (float)

    Anteil der Kaution, der bei Rückgabe einbehalten wird.

  • condition_on_issuestring

    Zustand des Postens bei der Ausgabe.

  • condition_on_returnstring

    Zustand des Postens bei der Rückgabe.

  • notestring

    Interne Notiz der Geschäftsstelle, wird dem Entleiher nicht angezeigt.

  • issued_by_namestring

    Name des Mitarbeitenden, der den Gegenstand ausgegeben hat.

  • returned_by_namestring

    Name des Mitarbeitenden, der den Gegenstand zurückgenommen hat.

  • last_reminder_atstring (date-time)

    Letzte Erinnerung (bald fällig oder überfällig), die an den Entleiher gesendet wurde.

  • reminder_countinteger

    Anzahl der für die Ausleihe versendeten Mahnungen.

  • 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/event/inventory_loan/42/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "condition": "string",
  "retained_amount": 49.9,
  "note": "string",
  "returned_at": "2026-10-15T09:30:00+02:00",
  "due_at": "2026-10-15T09:30:00+02:00",
  "force": true
}
'
Antwort 200 application/json
{
  "id": 42,
  "bookable_name": "Beispiel",
  "borrower_name": "Beispiel",
  "issued_by_name": "Beispiel",
  "returned_by_name": "Beispiel",
  "overdue": true,
  "deposit_refunded_amount": 49.9,
  "quantity": 1,
  "state": "string",
  "issued_at": "2026-10-15T09:30:00+02:00"
}

return (condition, retained_amount = einbehaltener Teil der Kaution, note, returned_at), extend (due_at, force).

PATCH/api/event/inventory_loan/{id}/{action}

Pfad-Parameter

idPflichtstring
actionPflichtstring

Request-Body application/json

  • conditionstring
  • retained_amountnumber
  • notestring
  • returned_atstring
  • due_atstring
  • forceboolean

Antworten

200Das Darlehen nach der AktionEventInventoryLoan

Felder anzeigen (22)
  • overdueboolean
  • deposit_refunded_amountnumber (float)

    Bei Rückgabe zurückgezahlter Betrag (Kaution abzüglich des einbehaltenen Anteils).

  • idinteger

    Primärschlüssel der Inventarausleihe. Interne ID.

  • bookable_namestring

    Name des Gegenstands zum Zeitpunkt der Übergabe.

  • borrower_namestring

    Name des Entleihers zum Zeitpunkt der Ausleihe bzw. der eingetragene Name bei Personen ohne Personendatensatz.

  • quantityinteger

    Anzahl der verliehenen Gegenstände.

  • statestring

    Status der Ausleihe, zum Beispiel ausgegeben oder zurückgegeben.

  • issued_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand ausgegeben wurde.

  • due_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben werden muss.

  • returned_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben wurde.

  • deposit_amountnumber (float)

    Für das Darlehen gezahlte Kaution.

  • deposit_statestring

    Status der Kaution, zum Beispiel einbehalten oder erstattet.

  • deposit_retained_amountnumber (float)

    Anteil der Kaution, der bei Rückgabe einbehalten wird.

  • condition_on_issuestring

    Zustand des Postens bei der Ausgabe.

  • condition_on_returnstring

    Zustand des Postens bei der Rückgabe.

  • notestring

    Interne Notiz der Geschäftsstelle, wird dem Entleiher nicht angezeigt.

  • issued_by_namestring

    Name des Mitarbeitenden, der den Gegenstand ausgegeben hat.

  • returned_by_namestring

    Name des Mitarbeitenden, der den Gegenstand zurückgenommen hat.

  • last_reminder_atstring (date-time)

    Letzte Erinnerung (bald fällig oder überfällig), die an den Entleiher gesendet wurde.

  • reminder_countinteger

    Anzahl der für die Ausleihe versendeten Mahnungen.

  • 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/event/inventory_loan/42/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "condition": "string",
  "retained_amount": 49.9,
  "note": "string",
  "returned_at": "2026-10-15T09:30:00+02:00",
  "due_at": "2026-10-15T09:30:00+02:00",
  "force": true
}
'
Antwort 200 application/json
{
  "id": 42,
  "bookable_name": "Beispiel",
  "borrower_name": "Beispiel",
  "issued_by_name": "Beispiel",
  "returned_by_name": "Beispiel",
  "overdue": true,
  "deposit_refunded_amount": 49.9,
  "quantity": 1,
  "state": "string",
  "issued_at": "2026-10-15T09:30:00+02:00"
}

Eigene Ausleihen (alle Personen der ausgewählten Firma); onlyLent=1 lässt zurückgegebene weg.

GET/api/event/customer/inventory_loan

Query-Parameter

idstring
statestring
bookablestring
bookingstringDie Buchung, mit der der Gegenstand reserviert wurde (null erst, wenn die Buchung gelöscht ist). | Benötigtes Zugriffsrecht: SCOPE
personstring
depositStatestring
issuedAtstring
dueAtstring
returnedAtstring
createdstring
updatedstring
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 die eigenen EventInventoryLoan-Objektearray<EventInventoryLoan2>

Felder anzeigen (17)
  • overdueboolean
  • deposit_refunded_amountnumber (float)

    Bei Rückgabe zurückgezahlter Betrag (Kaution abzüglich des einbehaltenen Anteils).

  • idinteger

    Primärschlüssel der Inventarausleihe. Interne ID.

  • bookable_namestring

    Name des Gegenstands zum Zeitpunkt der Übergabe.

  • borrower_namestring

    Name des Entleihers zum Zeitpunkt der Ausleihe bzw. der eingetragene Name bei Personen ohne Personendatensatz.

  • quantityinteger

    Anzahl der verliehenen Gegenstände.

  • statestring

    Status der Ausleihe, zum Beispiel ausgegeben oder zurückgegeben.

  • issued_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand ausgegeben wurde.

  • due_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben werden muss.

  • returned_atstring (date-time)

    Zeitpunkt, zu dem der Gegenstand zurückgegeben wurde.

  • deposit_amountnumber (float)

    Für das Darlehen gezahlte Kaution.

  • deposit_statestring

    Status der Kaution, zum Beispiel einbehalten oder erstattet.

  • deposit_retained_amountnumber (float)

    Anteil der Kaution, der bei Rückgabe einbehalten wird.

  • condition_on_issuestring

    Zustand des Postens bei der Ausgabe.

  • condition_on_returnstring

    Zustand des Postens bei der Rückgabe.

  • 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/event/customer/inventory_loan \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "bookable_name": "Beispiel",
    "borrower_name": "Beispiel",
    "overdue": true,
    "deposit_refunded_amount": 49.9,
    "quantity": 1,
    "state": "string",
    "issued_at": "2026-10-15T09:30:00+02:00",
    "due_at": "2026-10-15T09:30:00+02:00",
    "returned_at": "2026-10-15T09:30:00+02:00"
  }
]