Zum Inhalt springen
Developer

BaseBookableUsageCounter

Orte und Buchungen5 EndpunkteEvent / BaseBookableUsageCounter

Liefert eine Liste der Einträge für buchbare Nutzungszähler.

GET/api/event/base_bookable_usage_counter

Query-Parameter

idinteger
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE
namestring
tokenstring
baseBookablestring
baseBookableComponentstring
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 BaseBookableUsageCounter-Objekte.array<BaseBookableUsageCounter>

Felder anzeigen (11)
  • idinteger

    Primärschlüssel des Nutzungszählers. Interne ID.

  • tokenstring

    Öffentlicher Token des Nutzungszählers. Anstelle der ID verwendet.

  • counter_valuenumber (float)

    Wert des Nutzungszählers.

  • counter_unitstring

    Einheit des Nutzungszählers, zum Beispiel Stunden oder Stück.

  • use_real_usage_databoolean

    Der Zähler verwendet die erfasste tatsächliche Nutzung statt des geplanten Werts.

  • base_bookableBaseBookable16

    Buchbares Objekt, zu dem der Zähler gehört.

    Felder anzeigen (49)
    • ticketSeatingPlanIdinteger

      ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

    • idinteger

      Primärschlüssel der buchbaren Ressource. Interne ID.

    • tokenstring

      Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

    • bookable_typestring

      Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

    • floor_levelstring

      Etage, auf der das Buchbare liegt.

    • floor_sizeinteger

      Grundfläche in Quadratmetern.

    • pets_allowedboolean

      Haustiere sind erlaubt.

    • barrier_freeboolean

      Der Buchungsgegenstand ist barrierefrei.

    • cargo_volumeinteger

      Ladevolumen in Litern.

    • fuel_typestring

      Kraftstoffart des Fahrzeugs.

    • seating_capacityinteger

      Anzahl der Plätze.

    • has_wait_listboolean

      Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

    • booking_limitinteger

      Maximale Anzahl Buchungen.

    • billing_modestring

      Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

    • max_active_bookings_per_userinteger

      Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • max_advance_booking_hoursinteger

      Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • inventory_managedboolean

      Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

    • inventory_depositnumber (float)

      Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

    • require_addressboolean

      Die Adresse muss bei der Buchung eingegeben werden.

    • require_contactboolean

      Kontaktdaten müssen bei der Buchung eingegeben werden.

    • require_billingboolean

      Beim Buchen müssen Abrechnungsdaten eingegeben werden.

    • require_booking_titleboolean

      Beim Buchen muss ein Titel eingegeben werden.

    • allow_direct_billingboolean
    • require_ageboolean

      Das Alter muss bei der Buchung eingegeben werden.

    • counter_update_modestring

      Wie die Nutzungszähler des Buchbaren aktualisiert werden.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

  • base_bookable_componentBaseBookableComponent

    Komponente des buchbaren Objekts, zu dem der Zähler gehört.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Komponente. Interne ID.

    • tokenstring

      Öffentlicher Token der Komponente. Anstelle der ID verwendet.

    • maintenance_due_datestring (date-time)

      Datum, an dem die nächste Wartung fällig ist.

    • counter_thresholdstring

      Zählerstand, bei dem die Wartung fällig ist.

    • counter_unitstring

      Einheit des Zählers, zum Beispiel Stunden oder Kilometer.

    • base_bookableBaseBookable16

      Buchbares Objekt, zu dem die Komponente gehört.

    • expiry_warning_sent_atstring (date-time)

      Gesetzt, wenn eine Ablaufwarnung versendet wurde; wird geleert, wenn sich das Fälligkeitsdatum oder der Schwellenwert ändert, sodass die Warnung erneut scharf geschaltet wird (siehe BookableComponentExpiryCheckCommand)

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_usage_counter \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "token": "string",
    "counter_value": 1.5,
    "counter_unit": "string",
    "use_real_usage_data": true,
    "base_bookable": {
      "id": 42,
      "require_booking_title": true,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "name": "Beispiel"
    },
    "base_bookable_component": {
      "id": 42,
      "name": "Beispiel",
      "token": "string",
      "maintenance_due_date": "2026-10-15T09:30:00+02:00",
      "counter_threshold": "string",
      "counter_unit": "string",
      "expiry_warning_sent_at": "2026-10-15T09:30:00+02:00",
      "created": "2026-10-15T09:30:00+02:00",
      "updated": "2026-10-15T09:30:00+02:00",
      "deleted": true
    },
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  }
]

Legt einen neuen Nutzungszähler-Eintrag für ein buchbares Basisobjekt an.

POST/api/event/base_bookable_usage_counter

Request-Body application/json

  • dataBaseBookableUsageCounter2
    Felder anzeigen (1)
    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Antworten

200BaseBookableUsageCounter neu anlegenBaseBookableUsageCounter

Felder anzeigen (11)
  • idinteger

    Primärschlüssel des Nutzungszählers. Interne ID.

  • tokenstring

    Öffentlicher Token des Nutzungszählers. Anstelle der ID verwendet.

  • counter_valuenumber (float)

    Wert des Nutzungszählers.

  • counter_unitstring

    Einheit des Nutzungszählers, zum Beispiel Stunden oder Stück.

  • use_real_usage_databoolean

    Der Zähler verwendet die erfasste tatsächliche Nutzung statt des geplanten Werts.

  • base_bookableBaseBookable16

    Buchbares Objekt, zu dem der Zähler gehört.

    Felder anzeigen (49)
    • ticketSeatingPlanIdinteger

      ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

    • idinteger

      Primärschlüssel der buchbaren Ressource. Interne ID.

    • tokenstring

      Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

    • bookable_typestring

      Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

    • floor_levelstring

      Etage, auf der das Buchbare liegt.

    • floor_sizeinteger

      Grundfläche in Quadratmetern.

    • pets_allowedboolean

      Haustiere sind erlaubt.

    • barrier_freeboolean

      Der Buchungsgegenstand ist barrierefrei.

    • cargo_volumeinteger

      Ladevolumen in Litern.

    • fuel_typestring

      Kraftstoffart des Fahrzeugs.

    • seating_capacityinteger

      Anzahl der Plätze.

    • has_wait_listboolean

      Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

    • booking_limitinteger

      Maximale Anzahl Buchungen.

    • billing_modestring

      Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

    • max_active_bookings_per_userinteger

      Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • max_advance_booking_hoursinteger

      Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • inventory_managedboolean

      Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

    • inventory_depositnumber (float)

      Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

    • require_addressboolean

      Die Adresse muss bei der Buchung eingegeben werden.

    • require_contactboolean

      Kontaktdaten müssen bei der Buchung eingegeben werden.

    • require_billingboolean

      Beim Buchen müssen Abrechnungsdaten eingegeben werden.

    • require_booking_titleboolean

      Beim Buchen muss ein Titel eingegeben werden.

    • allow_direct_billingboolean
    • require_ageboolean

      Das Alter muss bei der Buchung eingegeben werden.

    • counter_update_modestring

      Wie die Nutzungszähler des Buchbaren aktualisiert werden.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

  • base_bookable_componentBaseBookableComponent

    Komponente des buchbaren Objekts, zu dem der Zähler gehört.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Komponente. Interne ID.

    • tokenstring

      Öffentlicher Token der Komponente. Anstelle der ID verwendet.

    • maintenance_due_datestring (date-time)

      Datum, an dem die nächste Wartung fällig ist.

    • counter_thresholdstring

      Zählerstand, bei dem die Wartung fällig ist.

    • counter_unitstring

      Einheit des Zählers, zum Beispiel Stunden oder Kilometer.

    • base_bookableBaseBookable16

      Buchbares Objekt, zu dem die Komponente gehört.

    • expiry_warning_sent_atstring (date-time)

      Gesetzt, wenn eine Ablaufwarnung versendet wurde; wird geleert, wenn sich das Fälligkeitsdatum oder der Schwellenwert ändert, sodass die Warnung erneut scharf geschaltet wird (siehe BookableComponentExpiryCheckCommand)

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_usage_counter \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "token": "string",
  "counter_value": 1.5,
  "counter_unit": "string",
  "use_real_usage_data": true,
  "base_bookable": {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  },
  "base_bookable_component": {
    "id": 42,
    "name": "Beispiel",
    "token": "string",
    "maintenance_due_date": "2026-10-15T09:30:00+02:00",
    "counter_threshold": "string",
    "counter_unit": "string",
    "base_bookable": {
      "id": 42,
      "require_booking_title": true,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "name": "Beispiel"
    },
    "expiry_warning_sent_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Liefert einen einzelnen Eintrag für buchbare Nutzungszähler.

GET/api/event/base_bookable_usage_counter/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BaseBookableUsageCounter-Objekt.BaseBookableUsageCounter

Felder anzeigen (11)
  • idinteger

    Primärschlüssel des Nutzungszählers. Interne ID.

  • tokenstring

    Öffentlicher Token des Nutzungszählers. Anstelle der ID verwendet.

  • counter_valuenumber (float)

    Wert des Nutzungszählers.

  • counter_unitstring

    Einheit des Nutzungszählers, zum Beispiel Stunden oder Stück.

  • use_real_usage_databoolean

    Der Zähler verwendet die erfasste tatsächliche Nutzung statt des geplanten Werts.

  • base_bookableBaseBookable16

    Buchbares Objekt, zu dem der Zähler gehört.

    Felder anzeigen (49)
    • ticketSeatingPlanIdinteger

      ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

    • idinteger

      Primärschlüssel der buchbaren Ressource. Interne ID.

    • tokenstring

      Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

    • bookable_typestring

      Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

    • floor_levelstring

      Etage, auf der das Buchbare liegt.

    • floor_sizeinteger

      Grundfläche in Quadratmetern.

    • pets_allowedboolean

      Haustiere sind erlaubt.

    • barrier_freeboolean

      Der Buchungsgegenstand ist barrierefrei.

    • cargo_volumeinteger

      Ladevolumen in Litern.

    • fuel_typestring

      Kraftstoffart des Fahrzeugs.

    • seating_capacityinteger

      Anzahl der Plätze.

    • has_wait_listboolean

      Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

    • booking_limitinteger

      Maximale Anzahl Buchungen.

    • billing_modestring

      Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

    • max_active_bookings_per_userinteger

      Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • max_advance_booking_hoursinteger

      Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • inventory_managedboolean

      Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

    • inventory_depositnumber (float)

      Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

    • require_addressboolean

      Die Adresse muss bei der Buchung eingegeben werden.

    • require_contactboolean

      Kontaktdaten müssen bei der Buchung eingegeben werden.

    • require_billingboolean

      Beim Buchen müssen Abrechnungsdaten eingegeben werden.

    • require_booking_titleboolean

      Beim Buchen muss ein Titel eingegeben werden.

    • allow_direct_billingboolean
    • require_ageboolean

      Das Alter muss bei der Buchung eingegeben werden.

    • counter_update_modestring

      Wie die Nutzungszähler des Buchbaren aktualisiert werden.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

  • base_bookable_componentBaseBookableComponent

    Komponente des buchbaren Objekts, zu dem der Zähler gehört.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Komponente. Interne ID.

    • tokenstring

      Öffentlicher Token der Komponente. Anstelle der ID verwendet.

    • maintenance_due_datestring (date-time)

      Datum, an dem die nächste Wartung fällig ist.

    • counter_thresholdstring

      Zählerstand, bei dem die Wartung fällig ist.

    • counter_unitstring

      Einheit des Zählers, zum Beispiel Stunden oder Kilometer.

    • base_bookableBaseBookable16

      Buchbares Objekt, zu dem die Komponente gehört.

    • expiry_warning_sent_atstring (date-time)

      Gesetzt, wenn eine Ablaufwarnung versendet wurde; wird geleert, wenn sich das Fälligkeitsdatum oder der Schwellenwert ändert, sodass die Warnung erneut scharf geschaltet wird (siehe BookableComponentExpiryCheckCommand)

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_usage_counter/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "token": "string",
  "counter_value": 1.5,
  "counter_unit": "string",
  "use_real_usage_data": true,
  "base_bookable": {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  },
  "base_bookable_component": {
    "id": 42,
    "name": "Beispiel",
    "token": "string",
    "maintenance_due_date": "2026-10-15T09:30:00+02:00",
    "counter_threshold": "string",
    "counter_unit": "string",
    "base_bookable": {
      "id": 42,
      "require_booking_title": true,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "name": "Beispiel"
    },
    "expiry_warning_sent_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Aktualisiert einen vorhandenen Eintrag des Basis-Nutzungszählers für Buchbares.

PUT/api/event/base_bookable_usage_counter/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseBookableUsageCounter2
    Felder anzeigen (1)
    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Antworten

200BaseBookableUsageCounter aktualisierenBaseBookableUsageCounter

Felder anzeigen (11)
  • idinteger

    Primärschlüssel des Nutzungszählers. Interne ID.

  • tokenstring

    Öffentlicher Token des Nutzungszählers. Anstelle der ID verwendet.

  • counter_valuenumber (float)

    Wert des Nutzungszählers.

  • counter_unitstring

    Einheit des Nutzungszählers, zum Beispiel Stunden oder Stück.

  • use_real_usage_databoolean

    Der Zähler verwendet die erfasste tatsächliche Nutzung statt des geplanten Werts.

  • base_bookableBaseBookable16

    Buchbares Objekt, zu dem der Zähler gehört.

    Felder anzeigen (49)
    • ticketSeatingPlanIdinteger

      ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

    • idinteger

      Primärschlüssel der buchbaren Ressource. Interne ID.

    • tokenstring

      Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

    • bookable_typestring

      Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

    • floor_levelstring

      Etage, auf der das Buchbare liegt.

    • floor_sizeinteger

      Grundfläche in Quadratmetern.

    • pets_allowedboolean

      Haustiere sind erlaubt.

    • barrier_freeboolean

      Der Buchungsgegenstand ist barrierefrei.

    • cargo_volumeinteger

      Ladevolumen in Litern.

    • fuel_typestring

      Kraftstoffart des Fahrzeugs.

    • seating_capacityinteger

      Anzahl der Plätze.

    • has_wait_listboolean

      Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

    • booking_limitinteger

      Maximale Anzahl Buchungen.

    • billing_modestring

      Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

    • max_active_bookings_per_userinteger

      Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • max_advance_booking_hoursinteger

      Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • inventory_managedboolean

      Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

    • inventory_depositnumber (float)

      Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

    • require_addressboolean

      Die Adresse muss bei der Buchung eingegeben werden.

    • require_contactboolean

      Kontaktdaten müssen bei der Buchung eingegeben werden.

    • require_billingboolean

      Beim Buchen müssen Abrechnungsdaten eingegeben werden.

    • require_booking_titleboolean

      Beim Buchen muss ein Titel eingegeben werden.

    • allow_direct_billingboolean
    • require_ageboolean

      Das Alter muss bei der Buchung eingegeben werden.

    • counter_update_modestring

      Wie die Nutzungszähler des Buchbaren aktualisiert werden.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

  • base_bookable_componentBaseBookableComponent

    Komponente des buchbaren Objekts, zu dem der Zähler gehört.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Komponente. Interne ID.

    • tokenstring

      Öffentlicher Token der Komponente. Anstelle der ID verwendet.

    • maintenance_due_datestring (date-time)

      Datum, an dem die nächste Wartung fällig ist.

    • counter_thresholdstring

      Zählerstand, bei dem die Wartung fällig ist.

    • counter_unitstring

      Einheit des Zählers, zum Beispiel Stunden oder Kilometer.

    • base_bookableBaseBookable16

      Buchbares Objekt, zu dem die Komponente gehört.

    • expiry_warning_sent_atstring (date-time)

      Gesetzt, wenn eine Ablaufwarnung versendet wurde; wird geleert, wenn sich das Fälligkeitsdatum oder der Schwellenwert ändert, sodass die Warnung erneut scharf geschaltet wird (siehe BookableComponentExpiryCheckCommand)

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_usage_counter/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "token": "string",
  "counter_value": 1.5,
  "counter_unit": "string",
  "use_real_usage_data": true,
  "base_bookable": {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  },
  "base_bookable_component": {
    "id": 42,
    "name": "Beispiel",
    "token": "string",
    "maintenance_due_date": "2026-10-15T09:30:00+02:00",
    "counter_threshold": "string",
    "counter_unit": "string",
    "base_bookable": {
      "id": 42,
      "require_booking_title": true,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "name": "Beispiel"
    },
    "expiry_warning_sent_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Aktualisiert einen vorhandenen Eintrag des Basis-Nutzungszählers für Buchbares.

PATCH/api/event/base_bookable_usage_counter/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBaseBookableUsageCounter2
    Felder anzeigen (1)
    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

Antworten

200BaseBookableUsageCounter aktualisierenBaseBookableUsageCounter

Felder anzeigen (11)
  • idinteger

    Primärschlüssel des Nutzungszählers. Interne ID.

  • tokenstring

    Öffentlicher Token des Nutzungszählers. Anstelle der ID verwendet.

  • counter_valuenumber (float)

    Wert des Nutzungszählers.

  • counter_unitstring

    Einheit des Nutzungszählers, zum Beispiel Stunden oder Stück.

  • use_real_usage_databoolean

    Der Zähler verwendet die erfasste tatsächliche Nutzung statt des geplanten Werts.

  • base_bookableBaseBookable16

    Buchbares Objekt, zu dem der Zähler gehört.

    Felder anzeigen (49)
    • ticketSeatingPlanIdinteger

      ID des Platzplans des Raums, auch für die öffentliche Serialisierung.

    • idinteger

      Primärschlüssel der buchbaren Ressource. Interne ID.

    • tokenstring

      Öffentlicher Token der buchbaren Ressource. In Links anstelle der ID verwendet.

    • bookable_typestring

      Art der Buchungsressource, zum Beispiel Raum, Platz oder Fahrzeug.

    • floor_levelstring

      Etage, auf der das Buchbare liegt.

    • floor_sizeinteger

      Grundfläche in Quadratmetern.

    • pets_allowedboolean

      Haustiere sind erlaubt.

    • barrier_freeboolean

      Der Buchungsgegenstand ist barrierefrei.

    • cargo_volumeinteger

      Ladevolumen in Litern.

    • fuel_typestring

      Kraftstoffart des Fahrzeugs.

    • seating_capacityinteger

      Anzahl der Plätze.

    • has_wait_listboolean

      Der Buchungsgegenstand hat eine Warteliste, sobald er voll belegt ist.

    • booking_limitinteger

      Maximale Anzahl Buchungen.

    • billing_modestring

      Wie Buchungen zu diesem Buchbaren abgerechnet werden: BILLING_MODE_UPFRONT (null = vorab, Rechnung zum Buchungszeitpunkt) oder BILLING_MODE_USAGE (kostenlose Reservierung, nachgelagerte Abrechnung anhand der realen Nutzungsdaten) Auch im Standard: Die Mitglieder-App zeigt "Nutzung erfassen" nur für nutzungsabgerechnete Buchbare an.

    • max_active_bookings_per_userinteger

      Maximale Anzahl aktiver (zukünftiger, nicht stornierter) Selbstbedienungsbuchungen, die eine Person gleichzeitig für dieses buchbare Objekt halten darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • max_advance_booking_hoursinteger

      Maximale Anzahl Stunden, die eine Selbstbedienungsbuchung in der Zukunft beginnen darf. Null = unbegrenzt. Admin-Buchungen sind nicht begrenzt.

    • inventory_managedboolean

      Als Inventar erfasst (Inventar-Ausleihe): Die Geschäftsstelle übergibt den Eintrag und nimmt ihn zurück, mit Kaution und Erinnerungen. Wird nur verwendet, solange die Einstellung event_inventory_enabled aktiv ist.

    • inventory_depositnumber (float)

      Kaution pro Stück, die bei der Übergabe verlangt wird. Null = keine Kaution.

    • require_addressboolean

      Die Adresse muss bei der Buchung eingegeben werden.

    • require_contactboolean

      Kontaktdaten müssen bei der Buchung eingegeben werden.

    • require_billingboolean

      Beim Buchen müssen Abrechnungsdaten eingegeben werden.

    • require_booking_titleboolean

      Beim Buchen muss ein Titel eingegeben werden.

    • allow_direct_billingboolean
    • require_ageboolean

      Das Alter muss bei der Buchung eingegeben werden.

    • counter_update_modestring

      Wie die Nutzungszähler des Buchbaren aktualisiert werden.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Haupttelefonnummer.

    • main_faxstring

      Haupt-Faxnummer.

    • main_emailstring

      Haupt-E-Mail-Adresse.

    • websitestring

      Website-Adresse.

    • namestring

      Name der Einheit.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • short_identifierstring

      Kurzkennung der Entität.

    • image_urlstring

      URL des Bildes des Datensatzes.

    • slug_identifierstring

      Slug, der in URLs der Entität verwendet wird.

  • base_bookable_componentBaseBookableComponent

    Komponente des buchbaren Objekts, zu dem der Zähler gehört.

    Felder anzeigen (11)
    • idinteger

      Primärschlüssel der Komponente. Interne ID.

    • tokenstring

      Öffentlicher Token der Komponente. Anstelle der ID verwendet.

    • maintenance_due_datestring (date-time)

      Datum, an dem die nächste Wartung fällig ist.

    • counter_thresholdstring

      Zählerstand, bei dem die Wartung fällig ist.

    • counter_unitstring

      Einheit des Zählers, zum Beispiel Stunden oder Kilometer.

    • base_bookableBaseBookable16

      Buchbares Objekt, zu dem die Komponente gehört.

    • expiry_warning_sent_atstring (date-time)

      Gesetzt, wenn eine Ablaufwarnung versendet wurde; wird geleert, wenn sich das Fälligkeitsdatum oder der Schwellenwert ändert, sodass die Warnung erneut scharf geschaltet wird (siehe BookableComponentExpiryCheckCommand)

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/event/base_bookable_usage_counter/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "token": "string",
  "counter_value": 1.5,
  "counter_unit": "string",
  "use_real_usage_data": true,
  "base_bookable": {
    "id": 42,
    "require_booking_title": true,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "name": "Beispiel"
  },
  "base_bookable_component": {
    "id": 42,
    "name": "Beispiel",
    "token": "string",
    "maintenance_due_date": "2026-10-15T09:30:00+02:00",
    "counter_threshold": "string",
    "counter_unit": "string",
    "base_bookable": {
      "id": 42,
      "require_booking_title": true,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "name": "Beispiel"
    },
    "expiry_warning_sent_at": "2026-10-15T09:30:00+02:00",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}