Skip to content
Developer

BillReminder

Billing5 EndpointsBilling / BillReminder

This method will get all BillReminder Objects

GET/api/invoice/bill_reminder

Query parameters

idstring
namestring
globalDefaultboolean
billReminderCountstring
templatestring
predefinedBillingItemstring
deletedbooleanThis property is used to mark an entity as deleted / archived
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 BillReminder objectsarray<BillReminder>

Show fields (7)
  • idinteger

    Primary key of the bill reminder. Internal ID.

  • namestring

    Name of the reminder level, for example first reminder.

  • global_defaultboolean

    Default reminder for all companies.

  • bill_reminder_countinteger

    Level of the reminder, starting at 1.

  • templateFlexibleLatexTemplate

    Document template of the reminder.

    Show fields (35)
    • predefinedboolean

      True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.

    • data_typestring

      Data type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.

    • data_type_labelstring

      Human readable name of the assigned data type, null for tags that are not a known data type.

    • template_modestring

      Serialized mode so clients do not have to know that null means standard.

    • last_check_statusstring

      Summary of the last template check for list views, the full result is admin detail only.

    • idstring

      Primary key of the template. Internal ID. Used as a string identifier.

    • namestring

      Name of the template.

    • tagstring

      Tag used to group templates.

    • mass_messageboolean

      Whether the template is used for mass messages.

    • default_store_as_pdfboolean

      Whether the generated document is stored as PDF by default.

    • security_scopestring

      Scope that controls who can use the template.

    • security_user_access_typeinteger

      Access type required to use the template.

    • param1string

      Value of parameter 1 used in the template.

    • param2string

      Value of parameter 2 used in the template.

    • param3string

      Value of parameter 3 used in the template.

    • param4string

      Value of parameter 4 used in the template.

    • param5string

      Value of parameter 5 used in the template.

    • param6string

      Value of parameter 6 used in the template.

    • param7string

      Value of parameter 7 used in the template.

    • param8string

      Value of parameter 8 used in the template.

    • param9string

      Value of parameter 9 used in the template.

    • param10string

      Value of parameter 10 used in the template.

    • default_value_param1string

      Default value of parameter 1.

    • default_value_param2string

      Default value of parameter 2.

    • default_value_param3string

      Default value of parameter 3.

    • default_value_param4string

      Default value of parameter 4.

    • default_value_param5string

      Default value of parameter 5.

    • default_value_param6string

      Default value of parameter 6.

    • default_value_param7string

      Default value of parameter 7.

    • default_value_param8string

      Default value of parameter 8.

    • default_value_param9string

      Default value of parameter 9.

    • default_value_param10string

      Default value of parameter 10.

    • deletedboolean

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

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • predefined_billing_itemPredefinedBillingItem11

    Billing item charged with the reminder fee.

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

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

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

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

    • companyCRMCompany

      Company the billing item belongs to.

    • parentPredefinedBillingItem11

      Parent billing item, for example for variants.

    • is_preferredboolean

      The item is preferred and shown first.

    • is_defaultboolean

      The item is the default for its type.

    • is_discountboolean

      The item is a discount.

    • is_freeboolean

      The item is free of charge.

    • is_passiveboolean

      The item is passive and cannot be selected anymore.

    • is_globalboolean

      The item is available for all companies.

    • inventory_countinteger

      Number of pieces in stock, if the item is a product.

    • stock_itemboolean

      This is flag for items that can be ordered at any time

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

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

    • garan_label_attachmentAttachment10

      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_attachmentAttachment10

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

    • public_categorystring

      Category of the item shown publicly.

    • condition_booking_content_typeBookingContentType17

      Item applies only to bookings with this content type (e.g. flight type). Null = all content types.

    • usage_time_baseinteger

      Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.

    • base_locationBaseLocation10

      Location this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.

    • condition_first_usage_onlyboolean

      Charge applies only once per usage record (first matching section, quantity 1)

    • budget_grant_countinteger

      Number of event sign-ups this product grants when purchased (null = no budget)

    • budget_create_onceboolean

      If true, budget is only created once per person+product combination. For recurring subscriptions: monthly payment but yearly budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit des Events zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Allowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Comma separated list of fixed cancellation dates in DD.MM format, e.g. "31.03,30.06,30.09,31.12". Only used when cancellationTermUnit is CUSTOM.

    • cancellation_notice_valueinteger

      Numeric value of the notice period before the cancellation term. Null = inherit from settings.

    • cancellation_notice_unitstring

      Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.

    • … 6 more fields
  • deletedboolean

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

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/bill_reminder \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "global_default": true,
    "bill_reminder_count": 1,
    "template": {
      "id": "42",
      "name": "Beispiel",
      "predefined": true,
      "data_type": "string",
      "data_type_label": "string",
      "template_mode": "string",
      "last_check_status": "string",
      "tag": "string",
      "mass_message": true,
      "default_store_as_pdf": true
    },
    "predefined_billing_item": {
      "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"
    },
    "deleted": true
  }
]

Add a new BillReminder

POST/api/invoice/bill_reminder

Request body application/json

  • dataBillReminder2
    Show fields (5)
    • idinteger

      Primary key of the bill reminder. Internal ID.

    • namestring

      Name of the reminder level, for example first reminder.

    • global_defaultboolean

      Default reminder for all companies.

    • bill_reminder_countinteger

      Level of the reminder, starting at 1.

    • deletedboolean

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

Responses

200Add a new BillReminderBillReminder

Show fields (7)
  • idinteger

    Primary key of the bill reminder. Internal ID.

  • namestring

    Name of the reminder level, for example first reminder.

  • global_defaultboolean

    Default reminder for all companies.

  • bill_reminder_countinteger

    Level of the reminder, starting at 1.

  • templateFlexibleLatexTemplate

    Document template of the reminder.

    Show fields (35)
    • predefinedboolean

      True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.

    • data_typestring

      Data type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.

    • data_type_labelstring

      Human readable name of the assigned data type, null for tags that are not a known data type.

    • template_modestring

      Serialized mode so clients do not have to know that null means standard.

    • last_check_statusstring

      Summary of the last template check for list views, the full result is admin detail only.

    • idstring

      Primary key of the template. Internal ID. Used as a string identifier.

    • namestring

      Name of the template.

    • tagstring

      Tag used to group templates.

    • mass_messageboolean

      Whether the template is used for mass messages.

    • default_store_as_pdfboolean

      Whether the generated document is stored as PDF by default.

    • security_scopestring

      Scope that controls who can use the template.

    • security_user_access_typeinteger

      Access type required to use the template.

    • param1string

      Value of parameter 1 used in the template.

    • param2string

      Value of parameter 2 used in the template.

    • param3string

      Value of parameter 3 used in the template.

    • param4string

      Value of parameter 4 used in the template.

    • param5string

      Value of parameter 5 used in the template.

    • param6string

      Value of parameter 6 used in the template.

    • param7string

      Value of parameter 7 used in the template.

    • param8string

      Value of parameter 8 used in the template.

    • param9string

      Value of parameter 9 used in the template.

    • param10string

      Value of parameter 10 used in the template.

    • default_value_param1string

      Default value of parameter 1.

    • default_value_param2string

      Default value of parameter 2.

    • default_value_param3string

      Default value of parameter 3.

    • default_value_param4string

      Default value of parameter 4.

    • default_value_param5string

      Default value of parameter 5.

    • default_value_param6string

      Default value of parameter 6.

    • default_value_param7string

      Default value of parameter 7.

    • default_value_param8string

      Default value of parameter 8.

    • default_value_param9string

      Default value of parameter 9.

    • default_value_param10string

      Default value of parameter 10.

    • deletedboolean

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

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • predefined_billing_itemPredefinedBillingItem11

    Billing item charged with the reminder fee.

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

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

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

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

    • companyCRMCompany

      Company the billing item belongs to.

    • parentPredefinedBillingItem11

      Parent billing item, for example for variants.

    • is_preferredboolean

      The item is preferred and shown first.

    • is_defaultboolean

      The item is the default for its type.

    • is_discountboolean

      The item is a discount.

    • is_freeboolean

      The item is free of charge.

    • is_passiveboolean

      The item is passive and cannot be selected anymore.

    • is_globalboolean

      The item is available for all companies.

    • inventory_countinteger

      Number of pieces in stock, if the item is a product.

    • stock_itemboolean

      This is flag for items that can be ordered at any time

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

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

    • garan_label_attachmentAttachment10

      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_attachmentAttachment10

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

    • public_categorystring

      Category of the item shown publicly.

    • condition_booking_content_typeBookingContentType17

      Item applies only to bookings with this content type (e.g. flight type). Null = all content types.

    • usage_time_baseinteger

      Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.

    • base_locationBaseLocation10

      Location this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.

    • condition_first_usage_onlyboolean

      Charge applies only once per usage record (first matching section, quantity 1)

    • budget_grant_countinteger

      Number of event sign-ups this product grants when purchased (null = no budget)

    • budget_create_onceboolean

      If true, budget is only created once per person+product combination. For recurring subscriptions: monthly payment but yearly budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit des Events zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Allowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Comma separated list of fixed cancellation dates in DD.MM format, e.g. "31.03,30.06,30.09,31.12". Only used when cancellationTermUnit is CUSTOM.

    • cancellation_notice_valueinteger

      Numeric value of the notice period before the cancellation term. Null = inherit from settings.

    • cancellation_notice_unitstring

      Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.

    • … 6 more fields
  • deletedboolean

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

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/bill_reminder \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "global_default": true,
    "bill_reminder_count": 1,
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "global_default": true,
  "bill_reminder_count": 1,
  "template": {
    "id": "42",
    "name": "Beispiel",
    "predefined": true,
    "data_type": "string",
    "data_type_label": "string",
    "template_mode": "string",
    "last_check_status": "string",
    "tag": "string",
    "mass_message": true,
    "default_store_as_pdf": true
  },
  "predefined_billing_item": {
    "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"
  },
  "deleted": true
}

Get a single BillReminder

GET/api/invoice/bill_reminder/{identifier}

Path parameters

identifierrequiredstring

Responses

200Get a single BillReminderBillReminder

Show fields (7)
  • idinteger

    Primary key of the bill reminder. Internal ID.

  • namestring

    Name of the reminder level, for example first reminder.

  • global_defaultboolean

    Default reminder for all companies.

  • bill_reminder_countinteger

    Level of the reminder, starting at 1.

  • templateFlexibleLatexTemplate

    Document template of the reminder.

    Show fields (35)
    • predefinedboolean

      True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.

    • data_typestring

      Data type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.

    • data_type_labelstring

      Human readable name of the assigned data type, null for tags that are not a known data type.

    • template_modestring

      Serialized mode so clients do not have to know that null means standard.

    • last_check_statusstring

      Summary of the last template check for list views, the full result is admin detail only.

    • idstring

      Primary key of the template. Internal ID. Used as a string identifier.

    • namestring

      Name of the template.

    • tagstring

      Tag used to group templates.

    • mass_messageboolean

      Whether the template is used for mass messages.

    • default_store_as_pdfboolean

      Whether the generated document is stored as PDF by default.

    • security_scopestring

      Scope that controls who can use the template.

    • security_user_access_typeinteger

      Access type required to use the template.

    • param1string

      Value of parameter 1 used in the template.

    • param2string

      Value of parameter 2 used in the template.

    • param3string

      Value of parameter 3 used in the template.

    • param4string

      Value of parameter 4 used in the template.

    • param5string

      Value of parameter 5 used in the template.

    • param6string

      Value of parameter 6 used in the template.

    • param7string

      Value of parameter 7 used in the template.

    • param8string

      Value of parameter 8 used in the template.

    • param9string

      Value of parameter 9 used in the template.

    • param10string

      Value of parameter 10 used in the template.

    • default_value_param1string

      Default value of parameter 1.

    • default_value_param2string

      Default value of parameter 2.

    • default_value_param3string

      Default value of parameter 3.

    • default_value_param4string

      Default value of parameter 4.

    • default_value_param5string

      Default value of parameter 5.

    • default_value_param6string

      Default value of parameter 6.

    • default_value_param7string

      Default value of parameter 7.

    • default_value_param8string

      Default value of parameter 8.

    • default_value_param9string

      Default value of parameter 9.

    • default_value_param10string

      Default value of parameter 10.

    • deletedboolean

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

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • predefined_billing_itemPredefinedBillingItem11

    Billing item charged with the reminder fee.

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

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

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

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

    • companyCRMCompany

      Company the billing item belongs to.

    • parentPredefinedBillingItem11

      Parent billing item, for example for variants.

    • is_preferredboolean

      The item is preferred and shown first.

    • is_defaultboolean

      The item is the default for its type.

    • is_discountboolean

      The item is a discount.

    • is_freeboolean

      The item is free of charge.

    • is_passiveboolean

      The item is passive and cannot be selected anymore.

    • is_globalboolean

      The item is available for all companies.

    • inventory_countinteger

      Number of pieces in stock, if the item is a product.

    • stock_itemboolean

      This is flag for items that can be ordered at any time

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

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

    • garan_label_attachmentAttachment10

      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_attachmentAttachment10

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

    • public_categorystring

      Category of the item shown publicly.

    • condition_booking_content_typeBookingContentType17

      Item applies only to bookings with this content type (e.g. flight type). Null = all content types.

    • usage_time_baseinteger

      Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.

    • base_locationBaseLocation10

      Location this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.

    • condition_first_usage_onlyboolean

      Charge applies only once per usage record (first matching section, quantity 1)

    • budget_grant_countinteger

      Number of event sign-ups this product grants when purchased (null = no budget)

    • budget_create_onceboolean

      If true, budget is only created once per person+product combination. For recurring subscriptions: monthly payment but yearly budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit des Events zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Allowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Comma separated list of fixed cancellation dates in DD.MM format, e.g. "31.03,30.06,30.09,31.12". Only used when cancellationTermUnit is CUSTOM.

    • cancellation_notice_valueinteger

      Numeric value of the notice period before the cancellation term. Null = inherit from settings.

    • cancellation_notice_unitstring

      Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.

    • … 6 more fields
  • deletedboolean

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

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/bill_reminder/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "global_default": true,
  "bill_reminder_count": 1,
  "template": {
    "id": "42",
    "name": "Beispiel",
    "predefined": true,
    "data_type": "string",
    "data_type_label": "string",
    "template_mode": "string",
    "last_check_status": "string",
    "tag": "string",
    "mass_message": true,
    "default_store_as_pdf": true
  },
  "predefined_billing_item": {
    "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"
  },
  "deleted": true
}

Update a BillReminder

PUT/api/invoice/bill_reminder/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBillReminder2
    Show fields (5)
    • idinteger

      Primary key of the bill reminder. Internal ID.

    • namestring

      Name of the reminder level, for example first reminder.

    • global_defaultboolean

      Default reminder for all companies.

    • bill_reminder_countinteger

      Level of the reminder, starting at 1.

    • deletedboolean

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

Responses

200Update a BillReminderBillReminder

Show fields (7)
  • idinteger

    Primary key of the bill reminder. Internal ID.

  • namestring

    Name of the reminder level, for example first reminder.

  • global_defaultboolean

    Default reminder for all companies.

  • bill_reminder_countinteger

    Level of the reminder, starting at 1.

  • templateFlexibleLatexTemplate

    Document template of the reminder.

    Show fields (35)
    • predefinedboolean

      True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.

    • data_typestring

      Data type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.

    • data_type_labelstring

      Human readable name of the assigned data type, null for tags that are not a known data type.

    • template_modestring

      Serialized mode so clients do not have to know that null means standard.

    • last_check_statusstring

      Summary of the last template check for list views, the full result is admin detail only.

    • idstring

      Primary key of the template. Internal ID. Used as a string identifier.

    • namestring

      Name of the template.

    • tagstring

      Tag used to group templates.

    • mass_messageboolean

      Whether the template is used for mass messages.

    • default_store_as_pdfboolean

      Whether the generated document is stored as PDF by default.

    • security_scopestring

      Scope that controls who can use the template.

    • security_user_access_typeinteger

      Access type required to use the template.

    • param1string

      Value of parameter 1 used in the template.

    • param2string

      Value of parameter 2 used in the template.

    • param3string

      Value of parameter 3 used in the template.

    • param4string

      Value of parameter 4 used in the template.

    • param5string

      Value of parameter 5 used in the template.

    • param6string

      Value of parameter 6 used in the template.

    • param7string

      Value of parameter 7 used in the template.

    • param8string

      Value of parameter 8 used in the template.

    • param9string

      Value of parameter 9 used in the template.

    • param10string

      Value of parameter 10 used in the template.

    • default_value_param1string

      Default value of parameter 1.

    • default_value_param2string

      Default value of parameter 2.

    • default_value_param3string

      Default value of parameter 3.

    • default_value_param4string

      Default value of parameter 4.

    • default_value_param5string

      Default value of parameter 5.

    • default_value_param6string

      Default value of parameter 6.

    • default_value_param7string

      Default value of parameter 7.

    • default_value_param8string

      Default value of parameter 8.

    • default_value_param9string

      Default value of parameter 9.

    • default_value_param10string

      Default value of parameter 10.

    • deletedboolean

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

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • predefined_billing_itemPredefinedBillingItem11

    Billing item charged with the reminder fee.

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

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

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

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

    • companyCRMCompany

      Company the billing item belongs to.

    • parentPredefinedBillingItem11

      Parent billing item, for example for variants.

    • is_preferredboolean

      The item is preferred and shown first.

    • is_defaultboolean

      The item is the default for its type.

    • is_discountboolean

      The item is a discount.

    • is_freeboolean

      The item is free of charge.

    • is_passiveboolean

      The item is passive and cannot be selected anymore.

    • is_globalboolean

      The item is available for all companies.

    • inventory_countinteger

      Number of pieces in stock, if the item is a product.

    • stock_itemboolean

      This is flag for items that can be ordered at any time

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

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

    • garan_label_attachmentAttachment10

      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_attachmentAttachment10

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

    • public_categorystring

      Category of the item shown publicly.

    • condition_booking_content_typeBookingContentType17

      Item applies only to bookings with this content type (e.g. flight type). Null = all content types.

    • usage_time_baseinteger

      Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.

    • base_locationBaseLocation10

      Location this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.

    • condition_first_usage_onlyboolean

      Charge applies only once per usage record (first matching section, quantity 1)

    • budget_grant_countinteger

      Number of event sign-ups this product grants when purchased (null = no budget)

    • budget_create_onceboolean

      If true, budget is only created once per person+product combination. For recurring subscriptions: monthly payment but yearly budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit des Events zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Allowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Comma separated list of fixed cancellation dates in DD.MM format, e.g. "31.03,30.06,30.09,31.12". Only used when cancellationTermUnit is CUSTOM.

    • cancellation_notice_valueinteger

      Numeric value of the notice period before the cancellation term. Null = inherit from settings.

    • cancellation_notice_unitstring

      Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.

    • … 6 more fields
  • deletedboolean

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

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/invoice/bill_reminder/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "global_default": true,
    "bill_reminder_count": 1,
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "global_default": true,
  "bill_reminder_count": 1,
  "template": {
    "id": "42",
    "name": "Beispiel",
    "predefined": true,
    "data_type": "string",
    "data_type_label": "string",
    "template_mode": "string",
    "last_check_status": "string",
    "tag": "string",
    "mass_message": true,
    "default_store_as_pdf": true
  },
  "predefined_billing_item": {
    "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"
  },
  "deleted": true
}

Update a BillReminder

PATCH/api/invoice/bill_reminder/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataBillReminder2
    Show fields (5)
    • idinteger

      Primary key of the bill reminder. Internal ID.

    • namestring

      Name of the reminder level, for example first reminder.

    • global_defaultboolean

      Default reminder for all companies.

    • bill_reminder_countinteger

      Level of the reminder, starting at 1.

    • deletedboolean

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

Responses

200Update a BillReminderBillReminder

Show fields (7)
  • idinteger

    Primary key of the bill reminder. Internal ID.

  • namestring

    Name of the reminder level, for example first reminder.

  • global_defaultboolean

    Default reminder for all companies.

  • bill_reminder_countinteger

    Level of the reminder, starting at 1.

  • templateFlexibleLatexTemplate

    Document template of the reminder.

    Show fields (35)
    • predefinedboolean

      True for templates shipped by the servercontrolpanel (PredefinedFlexibleTemplateMap). Their IDs are referenced by code, so the UI offers to duplicate ("Vorlage anpassen") instead of editing them.

    • data_typestring

      Data type (reference class key) the template is rendered and checked with. For predefined templates (tag IW_PFLT) this is the data type of the code that uses them.

    • data_type_labelstring

      Human readable name of the assigned data type, null for tags that are not a known data type.

    • template_modestring

      Serialized mode so clients do not have to know that null means standard.

    • last_check_statusstring

      Summary of the last template check for list views, the full result is admin detail only.

    • idstring

      Primary key of the template. Internal ID. Used as a string identifier.

    • namestring

      Name of the template.

    • tagstring

      Tag used to group templates.

    • mass_messageboolean

      Whether the template is used for mass messages.

    • default_store_as_pdfboolean

      Whether the generated document is stored as PDF by default.

    • security_scopestring

      Scope that controls who can use the template.

    • security_user_access_typeinteger

      Access type required to use the template.

    • param1string

      Value of parameter 1 used in the template.

    • param2string

      Value of parameter 2 used in the template.

    • param3string

      Value of parameter 3 used in the template.

    • param4string

      Value of parameter 4 used in the template.

    • param5string

      Value of parameter 5 used in the template.

    • param6string

      Value of parameter 6 used in the template.

    • param7string

      Value of parameter 7 used in the template.

    • param8string

      Value of parameter 8 used in the template.

    • param9string

      Value of parameter 9 used in the template.

    • param10string

      Value of parameter 10 used in the template.

    • default_value_param1string

      Default value of parameter 1.

    • default_value_param2string

      Default value of parameter 2.

    • default_value_param3string

      Default value of parameter 3.

    • default_value_param4string

      Default value of parameter 4.

    • default_value_param5string

      Default value of parameter 5.

    • default_value_param6string

      Default value of parameter 6.

    • default_value_param7string

      Default value of parameter 7.

    • default_value_param8string

      Default value of parameter 8.

    • default_value_param9string

      Default value of parameter 9.

    • default_value_param10string

      Default value of parameter 10.

    • deletedboolean

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

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

  • predefined_billing_itemPredefinedBillingItem11

    Billing item charged with the reminder fee.

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

    • buying_pricenumber (float)

      Purchase price of the item.

    • recurrenceCRMRecurrence

      Recurrence the billing item follows.

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

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

    • companyCRMCompany

      Company the billing item belongs to.

    • parentPredefinedBillingItem11

      Parent billing item, for example for variants.

    • is_preferredboolean

      The item is preferred and shown first.

    • is_defaultboolean

      The item is the default for its type.

    • is_discountboolean

      The item is a discount.

    • is_freeboolean

      The item is free of charge.

    • is_passiveboolean

      The item is passive and cannot be selected anymore.

    • is_globalboolean

      The item is available for all companies.

    • inventory_countinteger

      Number of pieces in stock, if the item is a product.

    • stock_itemboolean

      This is flag for items that can be ordered at any time

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

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

    • garan_label_attachmentAttachment10

      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_attachmentAttachment10

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

    • public_categorystring

      Category of the item shown publicly.

    • condition_booking_content_typeBookingContentType17

      Item applies only to bookings with this content type (e.g. flight type). Null = all content types.

    • usage_time_baseinteger

      Section time pair used for usage billing: BaseBookingRealUsage::BILLING_TYPE_BLOCK_TIME or BILLING_TYPE_FLIGHT_TIME. Null = follow the usage record's billingType.

    • base_locationBaseLocation10

      Location this charge belongs to (e.g. airport landing/takeoff fee), category CATEGORY_LOCATION

    • condition_day_of_week_maskinteger

      Day-of-week bitmask (Mon=1 ... Sun=64, see DayOfWeekBitmaskHelper). Null = every day.

    • condition_first_usage_onlyboolean

      Charge applies only once per usage record (first matching section, quantity 1)

    • budget_grant_countinteger

      Number of event sign-ups this product grants when purchased (null = no budget)

    • budget_create_onceboolean

      If true, budget is only created once per person+product combination. For recurring subscriptions: monthly payment but yearly budget.

    • ticket_quotainteger

      Ticketverkauf (BaseEvent::isTicketSalesEnabled): Kontingent dieser Ticketart (Event-Preis). Null = nur das Teilnehmerlimit des Events zählt.

    • ticket_sale_startstring (date-time)

      Ticketverkauf: Verkaufsstart dieser Ticketart (z. B. Frühbucher ab), null = sofort.

    • ticket_sale_endstring (date-time)

      Ticketverkauf: Verkaufsende dieser Ticketart (z. B. Frühbucher bis), null = bis zum Anmeldeschluss.

    • ticket_seat_zonestring

      Ticketverkauf mit Sitzplan: Diese Ticketart gilt nur für Plätze dieser Preiszone (BaseLocationPlanItem::seatZone), null = für jeden Platz.

    • cancellation_term_unitstring

      Allowed cancellation terms for this subscription product. Null / empty = inherit the club default from settings. See CancellationTermCalculator::TERM_UNITS.

    • cancellation_term_datesstring

      Comma separated list of fixed cancellation dates in DD.MM format, e.g. "31.03,30.06,30.09,31.12". Only used when cancellationTermUnit is CUSTOM.

    • cancellation_notice_valueinteger

      Numeric value of the notice period before the cancellation term. Null = inherit from settings.

    • cancellation_notice_unitstring

      Unit of the notice period: DAYS, WEEKS or MONTHS. Null = inherit from settings.

    • … 6 more fields
  • deletedboolean

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

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/invoice/bill_reminder/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "global_default": true,
    "bill_reminder_count": 1,
    "deleted": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "global_default": true,
  "bill_reminder_count": 1,
  "template": {
    "id": "42",
    "name": "Beispiel",
    "predefined": true,
    "data_type": "string",
    "data_type_label": "string",
    "template_mode": "string",
    "last_check_status": "string",
    "tag": "string",
    "mass_message": true,
    "default_store_as_pdf": true
  },
  "predefined_billing_item": {
    "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"
  },
  "deleted": true
}