Skip to content
Developer

PredefinedBillingItem

Billing5 EndpointsBilling / PredefinedBillingItem

Returns a list of PredefinedBillingItem objects

GET/api/invoice/predefinedbillingitems

Query parameters

deletedstringDefault value: false
billingTypestring, PUBLIC_LIST
companystring
baseBookablestring, PUBLIC_LIST
baseEventstring, PUBLIC_LIST
billingTypeCategorystring, PUBLIC_LIST
isPreferredboolean, PUBLIC_LIST
isDefaultboolean, PUBLIC_LIST
isGlobalboolean, PUBLIC_LIST
isDiscountboolean, PUBLIC_LIST
isFreeboolean, PUBLIC_LIST
isPassiveboolean, PUBLIC_LIST
unifiedCatEmptystring
orderinteger, PUBLIC_LIST
namestring, PUBLIC_LIST
createdstring, PUBLIC_LIST
conditionDateAfterstring, PUBLIC_LIST
conditionDateBeforestring, PUBLIC_LIST
conditionCountryCodestring, PUBLIC_LIST
conditionZipCodeFromstring, PUBLIC_LIST
conditionZipCodeTostring, PUBLIC_LIST
conditionTimeAfterHourstring, PUBLIC_LIST
conditionTimeBeforeHourstring, PUBLIC_LIST
conditionMaxLengthstring, PUBLIC_LIST
conditionBookingContentTypestringItem applies only to bookings with this content type (e.g. flight type). Null = all content types.
usageTimeBasestringSection time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.
baseLocationstringLocation this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION
conditionDayOfWeekMaskstringDay-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.
conditionFirstUsageOnlystringCharge applies only once per usage record (first matching section, quantity 1)
skustring, PUBLIC_LIST
barcodestring, PUBLIC_LIST
producerGuaranteeYearsstringHerstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig). Producer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label. | , PUBLIC_LIST
producerBrandstringHersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels. Producer / brand offering the commercial guarantee of durability. | , PUBLIC_LIST
cancellationTermUnitstringAllowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.
cancellationNoticeValuestringNumeric value of the notice period before the cancellation term. Null = inherit from settings.
cancellationNoticeUnitstringUnit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.
externalAccessModestringAccess granted by an external purchase, independently of billing recurrence or event budgets.
externalAccessDurationDaysstring
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 PredefinedBillingItem objectsarray<PredefinedBillingItem>

Show fields (53)
  • idinteger

    Primary key of the mapped billing item. Internal ID.

  • namestringrequired

    Name of the billing item.

  • descriptionstringrequired

    Description of the billing item shown to the customer.

  • internal_descriptionstring

    Internal description of the billing item, not shown to the customer.

  • fixed_hoursnumber (float)

    Fixed number of hours billed.

  • fixed_pricenumber (float)

    Fixed price billed.

  • fixed_price_base_unitnumber (float)

    Base unit for the fixed price.

  • price_fixed_hoursnumber (float)

    Price for the fixed hours.

  • price_additional_hoursnumber (float)

    Price for each additional hour.

  • name_additional_hoursstring

    Name of the additional hours item.

  • description_additional_hoursstring

    Description of the additional hours item.

  • time_billed_on_ticket_closeboolean

    Whether the time is billed when the ticket is closed.

  • billing_typeBillingItemType

    Billing item type.

    Show fields (12)
    • idinteger

      Primary key of the billing item type. Internal ID.

    • namestring

      Name of the billing item type.

    • fixed_price_addon_one_namestring

      Name of the first fixed price addon.

    • fixed_price_addon_two_namestring

      Name of the second fixed price addon.

    • fixed_price_addon_one_name_personstring

      Name of the first fixed price addon for persons.

    • fixed_price_addon_two_name_personstring

      Name of the second fixed price addon for persons.

    • categorystringrequired

      Category of the billing item type.

      Allowed: project subscription bookable event shipping location

    • typestringrequired

      Type of the billing item type.

      Allowed: subscription bookable-hour event-fixed sla hours days fixed internal

    • unitstring

      Unit of the billing item type, for example piece or hour.

    • force_repeatingboolean

      Items of this type always repeat.

    • can_repeatboolean

      Items of this type can repeat.

    • deletedboolean

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

  • buying_pricenumber (float)

    Purchase price of the item.

  • recurrenceCRMRecurrence

    Recurrence the billing item follows.

    Show fields (9)
    • idinteger

      Primary key of the recurrence. Internal ID.

    • namestring

      Name of the recurrence, for example monthly.

    • onceboolean

      The recurrence happens only once.

    • allow_partial_on_eq_start_billingboolean

      Allows partial billing if start and billed date are equal. primarily used for the first billing of a yearly contract

    • date_stringstring

      Date pattern of the recurrence as text.

    • tolerancenumber (float)

      Tolerance in days around the recurrence date.

    • deletedboolean

      The recurrence is deleted.

    • rounding_stepsinteger

      Steps used to round the recurrence.

    • month_factorinteger

      Number of months between two recurrences.

  • deletedboolean

    Whether the billing item is deleted.

  • condition_date_afterstring (date-time)

    The item applies only to dates after this date.

  • condition_date_beforestring (date-time)

    The item applies only to dates before this date.

  • condition_country_codestring

    Country code the item applies to.

  • condition_zip_code_fromstring

    Start of the postal code range the item applies to.

  • condition_zip_code_tostring

    End of the postal code range the item applies to.

  • condition_time_after_hourinteger

    The item applies only after this hour of the day.

  • condition_max_lengthinteger

    Maximum length the item applies to.

  • condition_time_before_hourinteger

    The item applies only before this hour of the day.

  • condition_sub_access_tagAccessTag

    Access tag a subscription must have for the item to apply.

    Show fields (6)
    • idinteger

      Primary key of the access tag. Internal ID, used as the reference in access rights.

    • 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

    • short_identifierstring

      Short identifier of the entity.

  • condition_show_despite_missing_access_tagboolean

    Whether the item is shown even if the access tag is missing.

  • condition_sub_free_logicstring

    Free-form condition logic for the subscription.

  • fixed_price_logicstring

    Free-form logic that calculates the fixed price.

  • sub_self_service_addboolean

    Whether members can add the subscription themselves.

  • sub_self_service_deleteboolean

    Whether members can cancel the subscription themselves.

  • sub_self_service_add_fixed_pricenumber (float)

    Fixed price charged when members add the subscription themselves.

  • sub_self_service_delete_fixed_pricenumber (float)

    Fixed price charged when members cancel the subscription themselves.

  • sub_pre_paidboolean

    Whether the subscription is paid in advance.

  • sub_only_billed_after_startboolean

    Whether the subscription is only billed after its start date.

  • sub_people_age_group_oneinteger

    Upper age limit of age group one.

  • sub_people_age_group_one_discountinteger

    Discount in percent for age group one.

  • sub_people_age_group_one_freeinteger

    Number of free places for age group one.

  • sub_people_age_group_twointeger

    Upper age limit of age group two.

  • sub_people_age_group_two_discountinteger

    Discount in percent for age group two.

  • sub_people_age_group_two_freeinteger

    Number of free places for age group two.

  • sub_people_age_group_threeinteger

    Upper age limit of age group three.

  • sub_people_age_group_three_discountinteger

    Discount in percent for age group three.

  • sub_people_age_group_three_freeinteger

    Number of free places for age group three.

  • sub_people_age_group_fourinteger

    Upper age limit of age group four.

  • sub_people_age_group_four_discountinteger

    Discount in percent for age group four.

  • sub_people_age_group_four_freeinteger

    Number of free places for age group four.

  • price_is_bruttoboolean

    Whether the prices are gross prices including tax.

  • skustring

    Artikelnummer (Stock Keeping Unit)

  • barcodestring

    Barcode (ISBN, UPC, GTIN usw.)

  • baseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • secondaryBaseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • baseEventBaseEvent7
    Show fields (22)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable3
    • secondaryBaseBookableBaseBookable3
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • … 78 more fields
  • … 45 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/predefinedbillingitems \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "name": "Beispiel",
    "description": "Text",
    "id": 42,
    "internal_description": "Text",
    "fixed_hours": 1.5,
    "fixed_price": 49.9,
    "fixed_price_base_unit": 49.9,
    "price_fixed_hours": 49.9,
    "price_additional_hours": 49.9,
    "name_additional_hours": "string"
  }
]

Creates a single PredefinedBillingItem

POST/api/invoice/predefinedbillingitems

Request body application/json

  • predefinedbillingitemPredefinedBillingItem2
    Show fields (23)
    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

      Internal description of the billing item, not shown to the customer.

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • billing_typeBillingItemType4

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

    • deletedboolean

      Whether the billing item is deleted.

    • sub_self_service_addboolean

      Whether members can add the subscription themselves.

    • sub_self_service_add_fixed_pricenumber (float)

      Fixed price charged when members add the subscription themselves.

    • price_is_bruttoboolean

      Whether the prices are gross prices including tax.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig). Producer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels. Producer / brand offering the commercial guarantee of durability.

    • energy_label_attachmentAttachment12

      Energielabel (EU Energieverbrauchskennzeichnung) als Bild/PDF fuer Shop, Warenkorb und Mail. EU energy label image/PDF of this product.

    • garan_label_attachmentAttachment12

      Grosses EU GARAN Label (DVO 2025/1960): kostenlose Haltbarkeitsgarantie des Herstellers von mehr als zwei Jahren, mit Jahren, Marke und Modell. Full EU GARAN label (commercial guarantee of durability > 2 years).

    • garan_label_pictogram_attachmentAttachment12

      "Nested label" / Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick/Hover muss das grosse Label (garanLabelAttachment) erscheinen. EU GARAN "nested label" pictogram showing only the years; links to the full label online.

    • ucatsarray<UnifiedCategory11>

      Unified categories of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • accounting_software_numberstring

      Number of the entity in the accounting software.

Responses

200Creates a single PredefinedBillingItemPredefinedBillingItem

Show fields (53)
  • idinteger

    Primary key of the mapped billing item. Internal ID.

  • namestringrequired

    Name of the billing item.

  • descriptionstringrequired

    Description of the billing item shown to the customer.

  • internal_descriptionstring

    Internal description of the billing item, not shown to the customer.

  • fixed_hoursnumber (float)

    Fixed number of hours billed.

  • fixed_pricenumber (float)

    Fixed price billed.

  • fixed_price_base_unitnumber (float)

    Base unit for the fixed price.

  • price_fixed_hoursnumber (float)

    Price for the fixed hours.

  • price_additional_hoursnumber (float)

    Price for each additional hour.

  • name_additional_hoursstring

    Name of the additional hours item.

  • description_additional_hoursstring

    Description of the additional hours item.

  • time_billed_on_ticket_closeboolean

    Whether the time is billed when the ticket is closed.

  • billing_typeBillingItemType

    Billing item type.

    Show fields (12)
    • idinteger

      Primary key of the billing item type. Internal ID.

    • namestring

      Name of the billing item type.

    • fixed_price_addon_one_namestring

      Name of the first fixed price addon.

    • fixed_price_addon_two_namestring

      Name of the second fixed price addon.

    • fixed_price_addon_one_name_personstring

      Name of the first fixed price addon for persons.

    • fixed_price_addon_two_name_personstring

      Name of the second fixed price addon for persons.

    • categorystringrequired

      Category of the billing item type.

      Allowed: project subscription bookable event shipping location

    • typestringrequired

      Type of the billing item type.

      Allowed: subscription bookable-hour event-fixed sla hours days fixed internal

    • unitstring

      Unit of the billing item type, for example piece or hour.

    • force_repeatingboolean

      Items of this type always repeat.

    • can_repeatboolean

      Items of this type can repeat.

    • deletedboolean

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

  • buying_pricenumber (float)

    Purchase price of the item.

  • recurrenceCRMRecurrence

    Recurrence the billing item follows.

    Show fields (9)
    • idinteger

      Primary key of the recurrence. Internal ID.

    • namestring

      Name of the recurrence, for example monthly.

    • onceboolean

      The recurrence happens only once.

    • allow_partial_on_eq_start_billingboolean

      Allows partial billing if start and billed date are equal. primarily used for the first billing of a yearly contract

    • date_stringstring

      Date pattern of the recurrence as text.

    • tolerancenumber (float)

      Tolerance in days around the recurrence date.

    • deletedboolean

      The recurrence is deleted.

    • rounding_stepsinteger

      Steps used to round the recurrence.

    • month_factorinteger

      Number of months between two recurrences.

  • deletedboolean

    Whether the billing item is deleted.

  • condition_date_afterstring (date-time)

    The item applies only to dates after this date.

  • condition_date_beforestring (date-time)

    The item applies only to dates before this date.

  • condition_country_codestring

    Country code the item applies to.

  • condition_zip_code_fromstring

    Start of the postal code range the item applies to.

  • condition_zip_code_tostring

    End of the postal code range the item applies to.

  • condition_time_after_hourinteger

    The item applies only after this hour of the day.

  • condition_max_lengthinteger

    Maximum length the item applies to.

  • condition_time_before_hourinteger

    The item applies only before this hour of the day.

  • condition_sub_access_tagAccessTag

    Access tag a subscription must have for the item to apply.

    Show fields (6)
    • idinteger

      Primary key of the access tag. Internal ID, used as the reference in access rights.

    • 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

    • short_identifierstring

      Short identifier of the entity.

  • condition_show_despite_missing_access_tagboolean

    Whether the item is shown even if the access tag is missing.

  • condition_sub_free_logicstring

    Free-form condition logic for the subscription.

  • fixed_price_logicstring

    Free-form logic that calculates the fixed price.

  • sub_self_service_addboolean

    Whether members can add the subscription themselves.

  • sub_self_service_deleteboolean

    Whether members can cancel the subscription themselves.

  • sub_self_service_add_fixed_pricenumber (float)

    Fixed price charged when members add the subscription themselves.

  • sub_self_service_delete_fixed_pricenumber (float)

    Fixed price charged when members cancel the subscription themselves.

  • sub_pre_paidboolean

    Whether the subscription is paid in advance.

  • sub_only_billed_after_startboolean

    Whether the subscription is only billed after its start date.

  • sub_people_age_group_oneinteger

    Upper age limit of age group one.

  • sub_people_age_group_one_discountinteger

    Discount in percent for age group one.

  • sub_people_age_group_one_freeinteger

    Number of free places for age group one.

  • sub_people_age_group_twointeger

    Upper age limit of age group two.

  • sub_people_age_group_two_discountinteger

    Discount in percent for age group two.

  • sub_people_age_group_two_freeinteger

    Number of free places for age group two.

  • sub_people_age_group_threeinteger

    Upper age limit of age group three.

  • sub_people_age_group_three_discountinteger

    Discount in percent for age group three.

  • sub_people_age_group_three_freeinteger

    Number of free places for age group three.

  • sub_people_age_group_fourinteger

    Upper age limit of age group four.

  • sub_people_age_group_four_discountinteger

    Discount in percent for age group four.

  • sub_people_age_group_four_freeinteger

    Number of free places for age group four.

  • price_is_bruttoboolean

    Whether the prices are gross prices including tax.

  • skustring

    Artikelnummer (Stock Keeping Unit)

  • barcodestring

    Barcode (ISBN, UPC, GTIN usw.)

  • baseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • secondaryBaseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • baseEventBaseEvent7
    Show fields (22)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable3
    • secondaryBaseBookableBaseBookable3
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • … 78 more fields
  • … 45 more fields
Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/predefinedbillingitems \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "predefinedbillingitem": {
    "name": "Beispiel",
    "description": "Text",
    "internal_description": "Text",
    "fixed_hours": 1.5,
    "fixed_price": 49.9,
    "fixed_price_base_unit": 49.9
  }
}
'
Response 200 application/json
{
  "name": "Beispiel",
  "description": "Text",
  "id": 42,
  "internal_description": "Text",
  "fixed_hours": 1.5,
  "fixed_price": 49.9,
  "fixed_price_base_unit": 49.9,
  "price_fixed_hours": 49.9,
  "price_additional_hours": 49.9,
  "name_additional_hours": "string"
}

This method will get a single PredefinedBillingItem Object with the given id

GET/api/invoice/predefinedbillingitems/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single PredefinedBillingItemPredefinedBillingItem

Show fields (53)
  • idinteger

    Primary key of the mapped billing item. Internal ID.

  • namestringrequired

    Name of the billing item.

  • descriptionstringrequired

    Description of the billing item shown to the customer.

  • internal_descriptionstring

    Internal description of the billing item, not shown to the customer.

  • fixed_hoursnumber (float)

    Fixed number of hours billed.

  • fixed_pricenumber (float)

    Fixed price billed.

  • fixed_price_base_unitnumber (float)

    Base unit for the fixed price.

  • price_fixed_hoursnumber (float)

    Price for the fixed hours.

  • price_additional_hoursnumber (float)

    Price for each additional hour.

  • name_additional_hoursstring

    Name of the additional hours item.

  • description_additional_hoursstring

    Description of the additional hours item.

  • time_billed_on_ticket_closeboolean

    Whether the time is billed when the ticket is closed.

  • billing_typeBillingItemType

    Billing item type.

    Show fields (12)
    • idinteger

      Primary key of the billing item type. Internal ID.

    • namestring

      Name of the billing item type.

    • fixed_price_addon_one_namestring

      Name of the first fixed price addon.

    • fixed_price_addon_two_namestring

      Name of the second fixed price addon.

    • fixed_price_addon_one_name_personstring

      Name of the first fixed price addon for persons.

    • fixed_price_addon_two_name_personstring

      Name of the second fixed price addon for persons.

    • categorystringrequired

      Category of the billing item type.

      Allowed: project subscription bookable event shipping location

    • typestringrequired

      Type of the billing item type.

      Allowed: subscription bookable-hour event-fixed sla hours days fixed internal

    • unitstring

      Unit of the billing item type, for example piece or hour.

    • force_repeatingboolean

      Items of this type always repeat.

    • can_repeatboolean

      Items of this type can repeat.

    • deletedboolean

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

  • buying_pricenumber (float)

    Purchase price of the item.

  • recurrenceCRMRecurrence

    Recurrence the billing item follows.

    Show fields (9)
    • idinteger

      Primary key of the recurrence. Internal ID.

    • namestring

      Name of the recurrence, for example monthly.

    • onceboolean

      The recurrence happens only once.

    • allow_partial_on_eq_start_billingboolean

      Allows partial billing if start and billed date are equal. primarily used for the first billing of a yearly contract

    • date_stringstring

      Date pattern of the recurrence as text.

    • tolerancenumber (float)

      Tolerance in days around the recurrence date.

    • deletedboolean

      The recurrence is deleted.

    • rounding_stepsinteger

      Steps used to round the recurrence.

    • month_factorinteger

      Number of months between two recurrences.

  • deletedboolean

    Whether the billing item is deleted.

  • condition_date_afterstring (date-time)

    The item applies only to dates after this date.

  • condition_date_beforestring (date-time)

    The item applies only to dates before this date.

  • condition_country_codestring

    Country code the item applies to.

  • condition_zip_code_fromstring

    Start of the postal code range the item applies to.

  • condition_zip_code_tostring

    End of the postal code range the item applies to.

  • condition_time_after_hourinteger

    The item applies only after this hour of the day.

  • condition_max_lengthinteger

    Maximum length the item applies to.

  • condition_time_before_hourinteger

    The item applies only before this hour of the day.

  • condition_sub_access_tagAccessTag

    Access tag a subscription must have for the item to apply.

    Show fields (6)
    • idinteger

      Primary key of the access tag. Internal ID, used as the reference in access rights.

    • 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

    • short_identifierstring

      Short identifier of the entity.

  • condition_show_despite_missing_access_tagboolean

    Whether the item is shown even if the access tag is missing.

  • condition_sub_free_logicstring

    Free-form condition logic for the subscription.

  • fixed_price_logicstring

    Free-form logic that calculates the fixed price.

  • sub_self_service_addboolean

    Whether members can add the subscription themselves.

  • sub_self_service_deleteboolean

    Whether members can cancel the subscription themselves.

  • sub_self_service_add_fixed_pricenumber (float)

    Fixed price charged when members add the subscription themselves.

  • sub_self_service_delete_fixed_pricenumber (float)

    Fixed price charged when members cancel the subscription themselves.

  • sub_pre_paidboolean

    Whether the subscription is paid in advance.

  • sub_only_billed_after_startboolean

    Whether the subscription is only billed after its start date.

  • sub_people_age_group_oneinteger

    Upper age limit of age group one.

  • sub_people_age_group_one_discountinteger

    Discount in percent for age group one.

  • sub_people_age_group_one_freeinteger

    Number of free places for age group one.

  • sub_people_age_group_twointeger

    Upper age limit of age group two.

  • sub_people_age_group_two_discountinteger

    Discount in percent for age group two.

  • sub_people_age_group_two_freeinteger

    Number of free places for age group two.

  • sub_people_age_group_threeinteger

    Upper age limit of age group three.

  • sub_people_age_group_three_discountinteger

    Discount in percent for age group three.

  • sub_people_age_group_three_freeinteger

    Number of free places for age group three.

  • sub_people_age_group_fourinteger

    Upper age limit of age group four.

  • sub_people_age_group_four_discountinteger

    Discount in percent for age group four.

  • sub_people_age_group_four_freeinteger

    Number of free places for age group four.

  • price_is_bruttoboolean

    Whether the prices are gross prices including tax.

  • skustring

    Artikelnummer (Stock Keeping Unit)

  • barcodestring

    Barcode (ISBN, UPC, GTIN usw.)

  • baseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • secondaryBaseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • baseEventBaseEvent7
    Show fields (22)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable3
    • secondaryBaseBookableBaseBookable3
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • … 78 more fields
  • … 45 more fields
Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/predefinedbillingitems/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "name": "Beispiel",
  "description": "Text",
  "id": 42,
  "internal_description": "Text",
  "fixed_hours": 1.5,
  "fixed_price": 49.9,
  "fixed_price_base_unit": 49.9,
  "price_fixed_hours": 49.9,
  "price_additional_hours": 49.9,
  "name_additional_hours": "string"
}

This method will update a PredefinedBillingItem Object

PUT/api/invoice/predefinedbillingitems/{id}

Path parameters

idrequiredstring

Request body application/json

  • predefinedbillingitemPredefinedBillingItem2
    Show fields (23)
    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

      Internal description of the billing item, not shown to the customer.

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • billing_typeBillingItemType4

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

    • deletedboolean

      Whether the billing item is deleted.

    • sub_self_service_addboolean

      Whether members can add the subscription themselves.

    • sub_self_service_add_fixed_pricenumber (float)

      Fixed price charged when members add the subscription themselves.

    • price_is_bruttoboolean

      Whether the prices are gross prices including tax.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig). Producer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels. Producer / brand offering the commercial guarantee of durability.

    • energy_label_attachmentAttachment12

      Energielabel (EU Energieverbrauchskennzeichnung) als Bild/PDF fuer Shop, Warenkorb und Mail. EU energy label image/PDF of this product.

    • garan_label_attachmentAttachment12

      Grosses EU GARAN Label (DVO 2025/1960): kostenlose Haltbarkeitsgarantie des Herstellers von mehr als zwei Jahren, mit Jahren, Marke und Modell. Full EU GARAN label (commercial guarantee of durability > 2 years).

    • garan_label_pictogram_attachmentAttachment12

      "Nested label" / Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick/Hover muss das grosse Label (garanLabelAttachment) erscheinen. EU GARAN "nested label" pictogram showing only the years; links to the full label online.

    • ucatsarray<UnifiedCategory11>

      Unified categories of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • accounting_software_numberstring

      Number of the entity in the accounting software.

Responses

200Update a PredefinedBillingItemPredefinedBillingItem

Show fields (53)
  • idinteger

    Primary key of the mapped billing item. Internal ID.

  • namestringrequired

    Name of the billing item.

  • descriptionstringrequired

    Description of the billing item shown to the customer.

  • internal_descriptionstring

    Internal description of the billing item, not shown to the customer.

  • fixed_hoursnumber (float)

    Fixed number of hours billed.

  • fixed_pricenumber (float)

    Fixed price billed.

  • fixed_price_base_unitnumber (float)

    Base unit for the fixed price.

  • price_fixed_hoursnumber (float)

    Price for the fixed hours.

  • price_additional_hoursnumber (float)

    Price for each additional hour.

  • name_additional_hoursstring

    Name of the additional hours item.

  • description_additional_hoursstring

    Description of the additional hours item.

  • time_billed_on_ticket_closeboolean

    Whether the time is billed when the ticket is closed.

  • billing_typeBillingItemType

    Billing item type.

    Show fields (12)
    • idinteger

      Primary key of the billing item type. Internal ID.

    • namestring

      Name of the billing item type.

    • fixed_price_addon_one_namestring

      Name of the first fixed price addon.

    • fixed_price_addon_two_namestring

      Name of the second fixed price addon.

    • fixed_price_addon_one_name_personstring

      Name of the first fixed price addon for persons.

    • fixed_price_addon_two_name_personstring

      Name of the second fixed price addon for persons.

    • categorystringrequired

      Category of the billing item type.

      Allowed: project subscription bookable event shipping location

    • typestringrequired

      Type of the billing item type.

      Allowed: subscription bookable-hour event-fixed sla hours days fixed internal

    • unitstring

      Unit of the billing item type, for example piece or hour.

    • force_repeatingboolean

      Items of this type always repeat.

    • can_repeatboolean

      Items of this type can repeat.

    • deletedboolean

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

  • buying_pricenumber (float)

    Purchase price of the item.

  • recurrenceCRMRecurrence

    Recurrence the billing item follows.

    Show fields (9)
    • idinteger

      Primary key of the recurrence. Internal ID.

    • namestring

      Name of the recurrence, for example monthly.

    • onceboolean

      The recurrence happens only once.

    • allow_partial_on_eq_start_billingboolean

      Allows partial billing if start and billed date are equal. primarily used for the first billing of a yearly contract

    • date_stringstring

      Date pattern of the recurrence as text.

    • tolerancenumber (float)

      Tolerance in days around the recurrence date.

    • deletedboolean

      The recurrence is deleted.

    • rounding_stepsinteger

      Steps used to round the recurrence.

    • month_factorinteger

      Number of months between two recurrences.

  • deletedboolean

    Whether the billing item is deleted.

  • condition_date_afterstring (date-time)

    The item applies only to dates after this date.

  • condition_date_beforestring (date-time)

    The item applies only to dates before this date.

  • condition_country_codestring

    Country code the item applies to.

  • condition_zip_code_fromstring

    Start of the postal code range the item applies to.

  • condition_zip_code_tostring

    End of the postal code range the item applies to.

  • condition_time_after_hourinteger

    The item applies only after this hour of the day.

  • condition_max_lengthinteger

    Maximum length the item applies to.

  • condition_time_before_hourinteger

    The item applies only before this hour of the day.

  • condition_sub_access_tagAccessTag

    Access tag a subscription must have for the item to apply.

    Show fields (6)
    • idinteger

      Primary key of the access tag. Internal ID, used as the reference in access rights.

    • 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

    • short_identifierstring

      Short identifier of the entity.

  • condition_show_despite_missing_access_tagboolean

    Whether the item is shown even if the access tag is missing.

  • condition_sub_free_logicstring

    Free-form condition logic for the subscription.

  • fixed_price_logicstring

    Free-form logic that calculates the fixed price.

  • sub_self_service_addboolean

    Whether members can add the subscription themselves.

  • sub_self_service_deleteboolean

    Whether members can cancel the subscription themselves.

  • sub_self_service_add_fixed_pricenumber (float)

    Fixed price charged when members add the subscription themselves.

  • sub_self_service_delete_fixed_pricenumber (float)

    Fixed price charged when members cancel the subscription themselves.

  • sub_pre_paidboolean

    Whether the subscription is paid in advance.

  • sub_only_billed_after_startboolean

    Whether the subscription is only billed after its start date.

  • sub_people_age_group_oneinteger

    Upper age limit of age group one.

  • sub_people_age_group_one_discountinteger

    Discount in percent for age group one.

  • sub_people_age_group_one_freeinteger

    Number of free places for age group one.

  • sub_people_age_group_twointeger

    Upper age limit of age group two.

  • sub_people_age_group_two_discountinteger

    Discount in percent for age group two.

  • sub_people_age_group_two_freeinteger

    Number of free places for age group two.

  • sub_people_age_group_threeinteger

    Upper age limit of age group three.

  • sub_people_age_group_three_discountinteger

    Discount in percent for age group three.

  • sub_people_age_group_three_freeinteger

    Number of free places for age group three.

  • sub_people_age_group_fourinteger

    Upper age limit of age group four.

  • sub_people_age_group_four_discountinteger

    Discount in percent for age group four.

  • sub_people_age_group_four_freeinteger

    Number of free places for age group four.

  • price_is_bruttoboolean

    Whether the prices are gross prices including tax.

  • skustring

    Artikelnummer (Stock Keeping Unit)

  • barcodestring

    Barcode (ISBN, UPC, GTIN usw.)

  • baseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • secondaryBaseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • baseEventBaseEvent7
    Show fields (22)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable3
    • secondaryBaseBookableBaseBookable3
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • … 78 more fields
  • … 45 more fields
Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/invoice/predefinedbillingitems/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "predefinedbillingitem": {
    "name": "Beispiel",
    "description": "Text",
    "internal_description": "Text",
    "fixed_hours": 1.5,
    "fixed_price": 49.9,
    "fixed_price_base_unit": 49.9
  }
}
'
Response 200 application/json
{
  "name": "Beispiel",
  "description": "Text",
  "id": 42,
  "internal_description": "Text",
  "fixed_hours": 1.5,
  "fixed_price": 49.9,
  "fixed_price_base_unit": 49.9,
  "price_fixed_hours": 49.9,
  "price_additional_hours": 49.9,
  "name_additional_hours": "string"
}

This method will update a PredefinedBillingItem Object

PATCH/api/invoice/predefinedbillingitems/{id}

Path parameters

idrequiredstring

Request body application/json

  • predefinedbillingitemPredefinedBillingItem2
    Show fields (23)
    • namestringrequired

      Name of the billing item.

    • descriptionstringrequired

      Description of the billing item shown to the customer.

    • internal_descriptionstring

      Internal description of the billing item, not shown to the customer.

    • fixed_hoursnumber (float)

      Fixed number of hours billed.

    • fixed_pricenumber (float)

      Fixed price billed.

    • fixed_price_base_unitnumber (float)

      Base unit for the fixed price.

    • billing_typeBillingItemType4

      Billing item type.

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

    • deletedboolean

      Whether the billing item is deleted.

    • sub_self_service_addboolean

      Whether members can add the subscription themselves.

    • sub_self_service_add_fixed_pricenumber (float)

      Fixed price charged when members add the subscription themselves.

    • price_is_bruttoboolean

      Whether the prices are gross prices including tax.

    • skustring

      Artikelnummer (Stock Keeping Unit)

    • barcodestring

      Barcode (ISBN, UPC, GTIN usw.)

    • producer_guarantee_yearsnumber (float)

      Herstellergarantie in Jahren (ganze Jahre oder ,5-Schritte, siehe ProductGuaranteeYears). Grundlage fuer das EU GARAN Label (nur bei Garantie > 2 Jahre zulaessig). Producer guarantee of durability in years (whole or .5 steps), basis for the EU GARAN label.

    • producer_brandstring

      Hersteller / Marke, die die Haltbarkeitsgarantie gibt - editierbares Feld "Brand/Trademark" des EU GARAN Labels. Producer / brand offering the commercial guarantee of durability.

    • energy_label_attachmentAttachment12

      Energielabel (EU Energieverbrauchskennzeichnung) als Bild/PDF fuer Shop, Warenkorb und Mail. EU energy label image/PDF of this product.

    • garan_label_attachmentAttachment12

      Grosses EU GARAN Label (DVO 2025/1960): kostenlose Haltbarkeitsgarantie des Herstellers von mehr als zwei Jahren, mit Jahren, Marke und Modell. Full EU GARAN label (commercial guarantee of durability > 2 years).

    • garan_label_pictogram_attachmentAttachment12

      "Nested label" / Piktogramm des EU GARAN Labels: zeigt nur die Jahre, beim Klick/Hover muss das grosse Label (garanLabelAttachment) erscheinen. EU GARAN "nested label" pictogram showing only the years; links to the full label online.

    • ucatsarray<UnifiedCategory11>

      Unified categories of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • accounting_software_numberstring

      Number of the entity in the accounting software.

Responses

200Update a PredefinedBillingItemPredefinedBillingItem

Show fields (53)
  • idinteger

    Primary key of the mapped billing item. Internal ID.

  • namestringrequired

    Name of the billing item.

  • descriptionstringrequired

    Description of the billing item shown to the customer.

  • internal_descriptionstring

    Internal description of the billing item, not shown to the customer.

  • fixed_hoursnumber (float)

    Fixed number of hours billed.

  • fixed_pricenumber (float)

    Fixed price billed.

  • fixed_price_base_unitnumber (float)

    Base unit for the fixed price.

  • price_fixed_hoursnumber (float)

    Price for the fixed hours.

  • price_additional_hoursnumber (float)

    Price for each additional hour.

  • name_additional_hoursstring

    Name of the additional hours item.

  • description_additional_hoursstring

    Description of the additional hours item.

  • time_billed_on_ticket_closeboolean

    Whether the time is billed when the ticket is closed.

  • billing_typeBillingItemType

    Billing item type.

    Show fields (12)
    • idinteger

      Primary key of the billing item type. Internal ID.

    • namestring

      Name of the billing item type.

    • fixed_price_addon_one_namestring

      Name of the first fixed price addon.

    • fixed_price_addon_two_namestring

      Name of the second fixed price addon.

    • fixed_price_addon_one_name_personstring

      Name of the first fixed price addon for persons.

    • fixed_price_addon_two_name_personstring

      Name of the second fixed price addon for persons.

    • categorystringrequired

      Category of the billing item type.

      Allowed: project subscription bookable event shipping location

    • typestringrequired

      Type of the billing item type.

      Allowed: subscription bookable-hour event-fixed sla hours days fixed internal

    • unitstring

      Unit of the billing item type, for example piece or hour.

    • force_repeatingboolean

      Items of this type always repeat.

    • can_repeatboolean

      Items of this type can repeat.

    • deletedboolean

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

  • buying_pricenumber (float)

    Purchase price of the item.

  • recurrenceCRMRecurrence

    Recurrence the billing item follows.

    Show fields (9)
    • idinteger

      Primary key of the recurrence. Internal ID.

    • namestring

      Name of the recurrence, for example monthly.

    • onceboolean

      The recurrence happens only once.

    • allow_partial_on_eq_start_billingboolean

      Allows partial billing if start and billed date are equal. primarily used for the first billing of a yearly contract

    • date_stringstring

      Date pattern of the recurrence as text.

    • tolerancenumber (float)

      Tolerance in days around the recurrence date.

    • deletedboolean

      The recurrence is deleted.

    • rounding_stepsinteger

      Steps used to round the recurrence.

    • month_factorinteger

      Number of months between two recurrences.

  • deletedboolean

    Whether the billing item is deleted.

  • condition_date_afterstring (date-time)

    The item applies only to dates after this date.

  • condition_date_beforestring (date-time)

    The item applies only to dates before this date.

  • condition_country_codestring

    Country code the item applies to.

  • condition_zip_code_fromstring

    Start of the postal code range the item applies to.

  • condition_zip_code_tostring

    End of the postal code range the item applies to.

  • condition_time_after_hourinteger

    The item applies only after this hour of the day.

  • condition_max_lengthinteger

    Maximum length the item applies to.

  • condition_time_before_hourinteger

    The item applies only before this hour of the day.

  • condition_sub_access_tagAccessTag

    Access tag a subscription must have for the item to apply.

    Show fields (6)
    • idinteger

      Primary key of the access tag. Internal ID, used as the reference in access rights.

    • 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

    • short_identifierstring

      Short identifier of the entity.

  • condition_show_despite_missing_access_tagboolean

    Whether the item is shown even if the access tag is missing.

  • condition_sub_free_logicstring

    Free-form condition logic for the subscription.

  • fixed_price_logicstring

    Free-form logic that calculates the fixed price.

  • sub_self_service_addboolean

    Whether members can add the subscription themselves.

  • sub_self_service_deleteboolean

    Whether members can cancel the subscription themselves.

  • sub_self_service_add_fixed_pricenumber (float)

    Fixed price charged when members add the subscription themselves.

  • sub_self_service_delete_fixed_pricenumber (float)

    Fixed price charged when members cancel the subscription themselves.

  • sub_pre_paidboolean

    Whether the subscription is paid in advance.

  • sub_only_billed_after_startboolean

    Whether the subscription is only billed after its start date.

  • sub_people_age_group_oneinteger

    Upper age limit of age group one.

  • sub_people_age_group_one_discountinteger

    Discount in percent for age group one.

  • sub_people_age_group_one_freeinteger

    Number of free places for age group one.

  • sub_people_age_group_twointeger

    Upper age limit of age group two.

  • sub_people_age_group_two_discountinteger

    Discount in percent for age group two.

  • sub_people_age_group_two_freeinteger

    Number of free places for age group two.

  • sub_people_age_group_threeinteger

    Upper age limit of age group three.

  • sub_people_age_group_three_discountinteger

    Discount in percent for age group three.

  • sub_people_age_group_three_freeinteger

    Number of free places for age group three.

  • sub_people_age_group_fourinteger

    Upper age limit of age group four.

  • sub_people_age_group_four_discountinteger

    Discount in percent for age group four.

  • sub_people_age_group_four_freeinteger

    Number of free places for age group four.

  • price_is_bruttoboolean

    Whether the prices are gross prices including tax.

  • skustring

    Artikelnummer (Stock Keeping Unit)

  • barcodestring

    Barcode (ISBN, UPC, GTIN usw.)

  • baseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • secondaryBaseBookableBaseBookable3
    Show fields (50)
    • ticketSeatingPlanIdinteger

      Id of the seating plan of the room, also for the public serialization.

    • idinteger

      Primary key of the bookable. Internal ID.

    • tokenstring

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

    • bookable_typestring

      Type of the bookable, for example room, court or vehicle.

    • floor_levelstring

      Floor the bookable is on.

    • floor_sizeinteger

      Floor size in square meters.

    • pets_allowedboolean

      Pets are allowed.

    • barrier_freeboolean

      The bookable is barrier-free.

    • cargo_volumeinteger

      Cargo volume in liters.

    • fuel_typestring

      Fuel type of the vehicle.

    • seating_capacityinteger

      Number of seats.

    • has_wait_listboolean

      The bookable has a waiting list once it is fully booked.

    • booking_limitinteger

      Maximum number of bookings.

    • billing_modestring

      How bookings on this bookable are billed: BILLING_MODE_UPFRONT (null = upfront, invoice at booking time) or BILLING_MODE_USAGE (free reservation, deferred billing from real usage data) Also in Default: the member app shows "Nutzung erfassen" only for usage-billed bookables.

    • max_active_bookings_per_userinteger

      Maximum number of active (future, not cancelled) self-service bookings one person may hold on this bookable at the same time. Null = unlimited. Admin bookings are not limited.

    • max_advance_booking_hoursinteger

      Maximum number of hours a self-service booking may start in the future. Null = unlimited. Admin bookings are not limited.

    • inventory_managedboolean

      Kept as inventory (Inventar-Ausleihe): the office hands the item over and takes it back, with deposit and reminders. Only used while the setting event_inventory_enabled is on.

    • inventory_depositnumber (float)

      Deposit (Kaution) per piece asked on hand-over. Null = no deposit.

    • require_addressboolean

      The address must be entered when booking.

    • require_contactboolean

      Contact details must be entered when booking.

    • require_billingboolean

      Billing details must be entered when booking.

    • require_booking_titleboolean

      A title must be entered when booking.

    • allow_direct_billingboolean
    • require_ageboolean

      The age must be entered when booking.

    • counter_update_modestring

      How the usage counters of the bookable are updated.

    • 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.

    • ucatsarray<UnifiedCategory16>

      Unified categories of the entity.

  • baseEventBaseEvent7
    Show fields (22)
    • ticketSeatingPlanIdinteger

      Id of the seating plan, also for the public and the customer serialization.

    • bib_numbers_enabledboolean
    • timing_enabledboolean
    • baseBookableBaseBookable3
    • secondaryBaseBookableBaseBookable3
    • idinteger

      Primary key of the event. Internal ID.

    • tokenstring

      Public token of the event. Used in links and QR codes instead of the ID.

    • moments_modestring

      Controls the event moments (digital guestbook) feature: DISABLED = feature off, PARTICIPANTS_ONLY = only via participant-bound moments tokens, ALL = additionally open via the anonymous event moments token

    • moments_designstring

      Visual theme of the moments (digital guestbook) pages and exports.

    • public_keywordsstring

      Keywords shown in the public event listing.

    • public_subtitlestring

      Subtitle shown in the public event listing.

    • event_typestring

      Type of the event, for example course, trip or tournament.

    • age_groupstring

      Age group the event is intended for, for example children or adults.

    • min_ageinteger

      Minimum age in years of participants.

    • max_ageinteger

      Maximum age in years of participants.

    • min_age_monthsinteger

      Minimum age in months of participants, for events for infants.

    • max_age_monthsinteger

      Maximum age in months of participants, for events for infants.

    • min_grade_levelinteger

      Minimum school grade level of participants.

    • max_grade_levelinteger

      Maximum school grade level of participants.

    • age_toleranceinteger

      Years by which participants may be outside the age range and still sign up.

    • event_people_limitinteger

      maximum number of people that can attend the event

    • … 78 more fields
  • … 45 more fields
Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/invoice/predefinedbillingitems/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "predefinedbillingitem": {
    "name": "Beispiel",
    "description": "Text",
    "internal_description": "Text",
    "fixed_hours": 1.5,
    "fixed_price": 49.9,
    "fixed_price_base_unit": 49.9
  }
}
'
Response 200 application/json
{
  "name": "Beispiel",
  "description": "Text",
  "id": 42,
  "internal_description": "Text",
  "fixed_hours": 1.5,
  "fixed_price": 49.9,
  "fixed_price_base_unit": 49.9,
  "price_fixed_hours": 49.9,
  "price_additional_hours": 49.9,
  "name_additional_hours": "string"
}