Skip to content
Developer

BaseBookingRealUsage

Locations and bookings14 EndpointsEvent / BaseBookingRealUsage

Returns a list of base booking real usage entries.

GET/api/event/base_booking_real_usage

Query parameters

idinteger
deletedbooleanThis property is used to mark an entity as deleted / archived
tokenstring
baseBookingstring
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of BaseBookingRealUsage objectsarray<BaseBookingRealUsage>

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_real_usage \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "token": "string",
    "start_value": 1.5,
    "stop_value": 1.5,
    "duration": 1,
    "kilometers": 1.5,
    "refueled_gas": 1.5,
    "refueled_oil": 1.5,
    "gas_type": "string",
    "is_training": true
  }
]

Creates a new base booking real usage entry.

POST/api/event/base_booking_real_usage

Request body application/json

  • dataBaseBookingRealUsage2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Add a new BaseBookingRealUsageBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/base_booking_real_usage \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Returns a single base booking real usage entry.

GET/api/event/base_booking_real_usage/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single BaseBookingRealUsageBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_real_usage/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Updates an existing base booking real usage entry.

PUT/api/event/base_booking_real_usage/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBookingRealUsage2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a BaseBookingRealUsageBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/base_booking_real_usage/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Updates an existing base booking real usage entry.

PATCH/api/event/base_booking_real_usage/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBookingRealUsage2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a BaseBookingRealUsageBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/base_booking_real_usage/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Get all BaseBookingRealUsage records of the customer's own bookings

GET/api/event/base_booking_real_usage_customer

Query parameters

idinteger
deletedbooleanThis property is used to mark an entity as deleted / archived
tokenstring
baseBookingstring
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Get all BaseBookingRealUsage records of the customer's own bookingsarray<BaseBookingRealUsage>

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/event/base_booking_real_usage_customer \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "token": "string",
    "start_value": 1.5,
    "stop_value": 1.5,
    "duration": 1,
    "kilometers": 1.5,
    "refueled_gas": 1.5,
    "refueled_oil": 1.5,
    "gas_type": "string",
    "is_training": true
  }
]

Add a new BaseBookingRealUsage for an own booking as a customer

POST/api/event/customer/base_booking_real_usage

Request body application/json

  • dataBaseBookingRealUsage2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Add a new BaseBookingRealUsage for an own booking as a customerBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/customer/base_booking_real_usage \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Update a BaseBookingRealUsage of an own booking as a customer

PUT/api/event/customer/base_booking_real_usage/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBookingRealUsage2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a BaseBookingRealUsage of an own booking as a customerBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/customer/base_booking_real_usage/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Update a BaseBookingRealUsage of an own booking as a customer

PATCH/api/event/customer/base_booking_real_usage/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBookingRealUsage2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a BaseBookingRealUsage of an own booking as a customerBaseBookingRealUsage

Show fields (16)
  • idinteger

    Primary key of the real usage entry. Internal ID.

  • tokenstring

    Public token of the real usage entry. Used instead of the ID.

  • start_valuenumber (float)

    Counter value at the start of the booking, for example the odometer.

  • stop_valuenumber (float)

    Counter value at the end of the booking.

  • durationinteger

    Duration of the usage in minutes.

  • kilometersnumber (float)

    Kilometers driven.

  • refueled_gasnumber (float)

    Amount of fuel refueled.

  • refueled_oilnumber (float)

    Amount of oil refueled.

  • gas_typestring

    Type of fuel refueled.

  • is_trainingboolean

    The usage was a training.

  • billing_typeinteger

    Billing type of the usage.

  • base_bookingBaseBooking13

    Booking the usage belongs to.

    Show fields (17)
    • idinteger

      Primary key of the booking. Internal ID.

    • start_timestring (date-time)

      Start of the booking.

    • end_timestring (date-time)

      End of the booking.

    • booking_typestring

      Type of the booking, for example normal or substitution.

    • booking_statusstring

      Status of the booking, for example planned, done or cancelled.

    • externalboolean

      The booking was made by an external party.

    • modified_timeboolean

      The time of the booking was changed after it was created.

    • modified_locationboolean

      The location of the booking was changed after it was created.

    • modified_bookableboolean

      The bookable of the booking was changed after it was created.

    • modified_performing_personboolean

      The leader of the booking was changed after it was created.

    • searching_for_performing_personboolean

      A leader for the booking is still being searched for.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • colorstring

      Background color as hex value.

    • fg_colorstring

      Foreground color as hex value.

  • trainerCRMPerson10

    CRM person who used the bookable.

    Show fields (81)
    • 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.

    • positionstring

      Position or role of the person.

    • languagestring

      Preferred language of the person.

    • special_salutationstring

      Special salutation text for letters.

    • form_of_salutationstring

      Form of salutation, for example formal or informal.

    • birthdaystring (date-time)

      Birthday of the person.

    • known_allergiesstring

      Known allergies of the person.

    • confirmed_no_allergiesboolean

      Guardian confirmed that there are no known allergies.

    • allow_photosboolean

      Photos of the person may be taken and published.

    • allow_leaving_aloneboolean

      The person may leave the event alone.

    • authorized_pickupstring

      Persons who are allowed to pick up the person.

    • needs_supportboolean

      The person needs support, for example for inclusion.

    • support_descriptionstring

      Description of the support the person needs.

    • financial_supportboolean

      The person receives financial support.

    • financial_support_numberstring

      Number of the financial support.

    • municipal_supportboolean

      The person receives municipal support.

    • municipal_support_numberstring

      Number of the municipal support.

    • grade_levelinteger

      School grade level of the person.

    • school_classstring

      School class of the person.

    • start_timestring (date-time)

      Start of the membership or activity.

    • start_time_reasonstring

      Reason for the start.

    • end_timestring (date-time)

      End of the membership or activity.

    • end_time_reasonstring

      Reason for the end.

    • confirmed_gtc_timestring (date-time)

      Time the general terms and conditions were confirmed.

    • chatbot_opt_inboolean

      Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.

    • chatbot_opt_in_atstring (date-time)

      Time the person opted in to the chatbot.

    • chatbot_opt_in_text_versionstring

      Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

    • app_usage_statistics_opt_outboolean

      Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezaehlten Aufrufe selbst haben keinen Bezug zur Person.

    • crm_person_contact_dataarray<CRMPersonContactData>

      Contact data of the person, for example phone and e-mail.

    • archivedboolean

      Whether the person is archived.

    • subscribed_newsletterboolean

      Whether the person subscribed to the newsletter.

    • subscribed_magazineboolean

      Whether the person subscribed to the magazine.

    • printed_member_cardboolean

      Whether a member card has been printed for the person.

    • has_login_userboolean

      Whether the person has a login user.

    • profile_picture_urlstring

      URL of the profile picture of the person.

    • log_book_staffboolean

      Log book flag: staff.

    • log_book_staff1boolean

      Log book flag: staff, level 1.

    • log_book_staff2boolean

      Log book flag: staff, level 2.

    • log_book_memberboolean

      Log book flag: member.

    • log_book_trainerboolean

      Log book flag: trainer.

    • log_book_trainer1boolean

      Log book flag: trainer, level 1.

    • log_book_trainer2boolean

      Log book flag: trainer, level 2.

    • log_book_head_of_departmentboolean

      Log book flag: head of department.

    • log_book_supervisory_boardboolean

      Log book flag: supervisory board.

    • log_book_board_of_directorsboolean

      Log book flag: board of directors.

    • log_book_honorary_memberboolean

      Log book flag: honorary member.

    • log_book_club_card_oneboolean

      Log book flag: club card.

    • log_book_health_recoveredboolean

      Log book flag: recovered from illness.

    • log_book_health_vaccinatedboolean

      Log book flag: vaccinated.

    • log_book_health_vaccinated_additionstring

      Details of the vaccination.

    • log_book_good_conductboolean

      Log book flag: certificate of good conduct.

    • log_book_first_aidboolean

      Log book flag: first aid training.

    • log_book_measles_vaccinationboolean

      Log book flag: measles vaccination.

    • sync_lanistaboolean

      Whether the person is synchronized with Lanista.

    • categoryCRMPersonCategory

      Person category.

    • nicknamestring

      Nickname of the person.

    • preferred_color_hexstring

      Preferred color of the person as hex value.

    • avatar_tokenstring

      Token of the avatar image.

    • search_stringstring

      Text that the entity can be searched by.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • createdstring (date-time)

      Point in time the entity was created.

    • … 2 more fields
  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/customer/base_booking_real_usage/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_value": 1.5,
  "stop_value": 1.5,
  "duration": 1,
  "kilometers": 1.5,
  "refueled_gas": 1.5,
  "refueled_oil": 1.5,
  "gas_type": "string",
  "is_training": true
}

Aggregated real usage statistics (block/flight minutes, landings) by bookable, person, content type and month.

GET/api/event/base_booking_real_usage_statistics/summary

Query parameters

baseBookableintegerFilter by bookable id
participantintegerFilter by booking participant (person id)
contentTypeintegerFilter by booking content type id
startTimestringOnly usages of bookings starting at/after this date
endTimestringOnly usages of bookings starting at/before this date

Responses

default

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

Pilot logbook of a person as PDF: one row per flight leg, times in UTC, with the person's function (PIC / dual / instructor). A member gets their own logbook; with read access to event bookings any person's logbook can be requested via `person`.

GET/api/event/base_booking_real_usage_logbook/pdf

Query parameters

personintegerPerson id (requires read access to event bookings unless it is the own person)
startTimestringOnly flights of bookings starting at/after this date
endTimestringOnly flights of bookings starting at/before this date

Responses

default

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

Add a new BaseBookingRealUsageSection for a usage record of an own booking as a customer

POST/api/event/customer/base_booking_real_usage_section

Request body application/json

  • dataBaseBookingRealUsageSection2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Add a new BaseBookingRealUsageSection for a usage record of an own booking as a customerBaseBookingRealUsageSection

Show fields (15)
  • idinteger

    Primary key of the usage section. Internal ID.

  • tokenstring

    Public token of the usage section. Used instead of the ID.

  • start_locationstring

    Location where the section started.

  • start_timestring (date-time)

    Start time of the section.

  • start_section_timestring (date-time)

    Start time of the section within the usage.

  • end_locationstring

    Location where the section ended.

  • end_timestring (date-time)

    End time of the section.

  • end_section_timestring (date-time)

    End time of the section within the usage.

  • number_of_landingsinteger

    Number of landings in the section.

  • base_booking_real_usageBaseBookingRealUsage

    Real usage the section belongs to.

    Show fields (16)
    • idinteger

      Primary key of the real usage entry. Internal ID.

    • tokenstring

      Public token of the real usage entry. Used instead of the ID.

    • start_valuenumber (float)

      Counter value at the start of the booking, for example the odometer.

    • stop_valuenumber (float)

      Counter value at the end of the booking.

    • durationinteger

      Duration of the usage in minutes.

    • kilometersnumber (float)

      Kilometers driven.

    • refueled_gasnumber (float)

      Amount of fuel refueled.

    • refueled_oilnumber (float)

      Amount of oil refueled.

    • gas_typestring

      Type of fuel refueled.

    • is_trainingboolean

      The usage was a training.

    • billing_typeinteger

      Billing type of the usage.

    • base_bookingBaseBooking13

      Booking the usage belongs to.

    • trainerCRMPerson10

      CRM person who used the bookable.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • start_base_locationBaseLocation10

    Master record for startLocation (e.g. airport, matched via shortIdentifier = ICAO code)

    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • end_base_locationBaseLocation10

    Master record for endLocation (e.g. airport, matched via shortIdentifier = ICAO code)

    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/event/customer/base_booking_real_usage_section \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_location": "string",
  "start_time": "2026-10-15T09:30:00+02:00",
  "start_section_time": "2026-10-15T09:30:00+02:00",
  "end_location": "string",
  "end_time": "2026-10-15T09:30:00+02:00",
  "end_section_time": "2026-10-15T09:30:00+02:00",
  "number_of_landings": 1,
  "base_booking_real_usage": {
    "id": 42,
    "token": "string",
    "start_value": 1.5,
    "stop_value": 1.5,
    "duration": 1,
    "kilometers": 1.5,
    "refueled_gas": 1.5,
    "refueled_oil": 1.5,
    "gas_type": "string",
    "is_training": true
  }
}

Update a BaseBookingRealUsageSection of an own booking's usage record as a customer

PUT/api/event/customer/base_booking_real_usage_section/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBookingRealUsageSection2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a BaseBookingRealUsageSection of an own booking's usage record as a customerBaseBookingRealUsageSection

Show fields (15)
  • idinteger

    Primary key of the usage section. Internal ID.

  • tokenstring

    Public token of the usage section. Used instead of the ID.

  • start_locationstring

    Location where the section started.

  • start_timestring (date-time)

    Start time of the section.

  • start_section_timestring (date-time)

    Start time of the section within the usage.

  • end_locationstring

    Location where the section ended.

  • end_timestring (date-time)

    End time of the section.

  • end_section_timestring (date-time)

    End time of the section within the usage.

  • number_of_landingsinteger

    Number of landings in the section.

  • base_booking_real_usageBaseBookingRealUsage

    Real usage the section belongs to.

    Show fields (16)
    • idinteger

      Primary key of the real usage entry. Internal ID.

    • tokenstring

      Public token of the real usage entry. Used instead of the ID.

    • start_valuenumber (float)

      Counter value at the start of the booking, for example the odometer.

    • stop_valuenumber (float)

      Counter value at the end of the booking.

    • durationinteger

      Duration of the usage in minutes.

    • kilometersnumber (float)

      Kilometers driven.

    • refueled_gasnumber (float)

      Amount of fuel refueled.

    • refueled_oilnumber (float)

      Amount of oil refueled.

    • gas_typestring

      Type of fuel refueled.

    • is_trainingboolean

      The usage was a training.

    • billing_typeinteger

      Billing type of the usage.

    • base_bookingBaseBooking13

      Booking the usage belongs to.

    • trainerCRMPerson10

      CRM person who used the bookable.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • start_base_locationBaseLocation10

    Master record for startLocation (e.g. airport, matched via shortIdentifier = ICAO code)

    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • end_base_locationBaseLocation10

    Master record for endLocation (e.g. airport, matched via shortIdentifier = ICAO code)

    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/event/customer/base_booking_real_usage_section/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_location": "string",
  "start_time": "2026-10-15T09:30:00+02:00",
  "start_section_time": "2026-10-15T09:30:00+02:00",
  "end_location": "string",
  "end_time": "2026-10-15T09:30:00+02:00",
  "end_section_time": "2026-10-15T09:30:00+02:00",
  "number_of_landings": 1,
  "base_booking_real_usage": {
    "id": 42,
    "token": "string",
    "start_value": 1.5,
    "stop_value": 1.5,
    "duration": 1,
    "kilometers": 1.5,
    "refueled_gas": 1.5,
    "refueled_oil": 1.5,
    "gas_type": "string",
    "is_training": true
  }
}

Update a BaseBookingRealUsageSection of an own booking's usage record as a customer

PATCH/api/event/customer/base_booking_real_usage_section/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBaseBookingRealUsageSection2
    Show fields (1)
    • deletedboolean

      This property is used to mark an entity as deleted / archived

Responses

200Update a BaseBookingRealUsageSection of an own booking's usage record as a customerBaseBookingRealUsageSection

Show fields (15)
  • idinteger

    Primary key of the usage section. Internal ID.

  • tokenstring

    Public token of the usage section. Used instead of the ID.

  • start_locationstring

    Location where the section started.

  • start_timestring (date-time)

    Start time of the section.

  • start_section_timestring (date-time)

    Start time of the section within the usage.

  • end_locationstring

    Location where the section ended.

  • end_timestring (date-time)

    End time of the section.

  • end_section_timestring (date-time)

    End time of the section within the usage.

  • number_of_landingsinteger

    Number of landings in the section.

  • base_booking_real_usageBaseBookingRealUsage

    Real usage the section belongs to.

    Show fields (16)
    • idinteger

      Primary key of the real usage entry. Internal ID.

    • tokenstring

      Public token of the real usage entry. Used instead of the ID.

    • start_valuenumber (float)

      Counter value at the start of the booking, for example the odometer.

    • stop_valuenumber (float)

      Counter value at the end of the booking.

    • durationinteger

      Duration of the usage in minutes.

    • kilometersnumber (float)

      Kilometers driven.

    • refueled_gasnumber (float)

      Amount of fuel refueled.

    • refueled_oilnumber (float)

      Amount of oil refueled.

    • gas_typestring

      Type of fuel refueled.

    • is_trainingboolean

      The usage was a training.

    • billing_typeinteger

      Billing type of the usage.

    • base_bookingBaseBooking13

      Booking the usage belongs to.

    • trainerCRMPerson10

      CRM person who used the bookable.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

  • start_base_locationBaseLocation10

    Master record for startLocation (e.g. airport, matched via shortIdentifier = ICAO code)

    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • end_base_locationBaseLocation10

    Master record for endLocation (e.g. airport, matched via shortIdentifier = ICAO code)

    Show fields (29)
    • idinteger

      Primary key of the location. Internal ID.

    • tokenstring

      Public token of the location. Used in links instead of the ID.

    • location_typestring

      Type of the location, for example room, hall or outdoor area.

    • in_contact_centerboolean

      The location is shown in the contact center.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • namestring

      Name of the entity.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • short_identifierstring

      Short identifier of the entity.

    • image_urlstring

      URL of the image of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/event/customer/base_booking_real_usage_section/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "token": "string",
  "start_location": "string",
  "start_time": "2026-10-15T09:30:00+02:00",
  "start_section_time": "2026-10-15T09:30:00+02:00",
  "end_location": "string",
  "end_time": "2026-10-15T09:30:00+02:00",
  "end_section_time": "2026-10-15T09:30:00+02:00",
  "number_of_landings": 1,
  "base_booking_real_usage": {
    "id": 42,
    "token": "string",
    "start_value": 1.5,
    "stop_value": 1.5,
    "duration": 1,
    "kilometers": 1.5,
    "refueled_gas": 1.5,
    "refueled_oil": 1.5,
    "gas_type": "string",
    "is_training": true
  }
}