Zum Inhalt springen
Developer

BillingDryRun

Abrechnung8 EndpunkteBilling / BillingDryRun

Diese Methode liefert alle BillingDryRun-Objekte – ohne die simulierten Rechnungen

GET/api/invoice/billing_dry_run

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der BillingDryRun-Objekte.array<BillingDryRun>

Felder anzeigen (22)
  • idinteger

    Primärschlüssel des Abrechnungs-Probelaufs. Interne ID.

  • billing_payment_profileBillingPaymentProfile10

    Zahlungsprofil, das für den Probelauf verwendet wird.

    Felder anzeigen (15)
    • idinteger

      Primärschlüssel des Zahlungsprofils. Interne ID.

    • payout_typestring

      Art der Auszahlung, zum Beispiel SEPA-Lastschrift oder Überweisung.

    • auto_modeboolean

      Zahlungen werden automatisch angelegt.

    • is_defaultboolean

      Standard-Zahlungsprofil.

    • is_event_defaultboolean

      Standard-Zahlungsprofil für Veranstaltungen.

    • is_donation_defaultboolean

      Standard-Zahlungsprofil für Spenden.

    • execution_daystring

      Tag des Monats, an dem die Zahlungen ausgeführt werden.

    • next_execution_datestring (date-time)

      Datum der nächsten Ausführung.

    • booking_daystring

      Tag des Monats, an dem die Zahlungen gebucht werden.

    • next_booking_datestring (date-time)

      Datum der nächsten Buchung.

    • force_billing_due_date_to_next_booking_dateboolean

      Fälligkeitsdatum der Rechnung auf den nächsten Buchungstermin setzen.

    • deletedboolean

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

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

  • statusstring

    Status des Probelaufs, zum Beispiel laufend oder beendet.

  • billing_datestring (date-time)

    Für den Probelauf verwendetes Abrechnungsdatum.

  • started_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf gestartet wurde.

  • finished_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf beendet wurde.

  • company_countinteger

    Anzahl der geprüften Firmen.

  • invoice_countinteger

    Anzahl der Rechnungen, die erstellt würden.

  • saved_invoice_countinteger

    Anzahl der gespeicherten Rechnungen.

  • skipped_invoice_countinteger

    Anzahl der übersprungenen Rechnungen.

  • position_countinteger

    Anzahl der Positionen auf allen Rechnungen.

  • mail_countinteger

    Anzahl der per E-Mail versandten Rechnungen.

  • postal_countinteger

    Anzahl der per Post versandten Rechnungen.

  • sum_nettonumber (float)

    Summe der Nettowerte.

  • sum_bruttonumber (float)

    Summe der Bruttowerte.

  • sum_taxnumber (float)

    Summe der Steuerbeträge.

  • log_lengthinteger

    Länge des Protokolls des Testlaufs.

  • stored_item_countinteger

    Anzahl der Gegenstände, die der Probelauf eingelagert hat.

  • error_messagestring

    Fehlermeldung des Probelaufs.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "billing_payment_profile": {
      "id": 42,
      "name": "Beispiel",
      "payout_type": "string",
      "auto_mode": true,
      "is_default": true,
      "is_event_default": true,
      "is_donation_default": true,
      "execution_day": "string",
      "next_execution_date": "2026-10-15T09:30:00+02:00",
      "booking_day": "string"
    },
    "status": "string",
    "billing_date": "2026-10-15T09:30:00+02:00",
    "started_at": "2026-10-15T09:30:00+02:00",
    "finished_at": "2026-10-15T09:30:00+02:00",
    "company_count": 1,
    "invoice_count": 1,
    "saved_invoice_count": 1,
    "skipped_invoice_count": 1
  }
]

Einen neuen simulierten Abrechnungslauf („Probelauf“) starten.

POST/api/invoice/billing_dry_run

Der Lauf wird im Hintergrund ausgeführt. Die Simulation selbst speichert nichts – nur der daraus entstehende BillingDryRun-Datensatz mit seinen Positionen wird gespeichert. Den zurückgegebenen Datensatz so lange abfragen, bis sein Status done oder failed ist.

Request-Body application/json

  • dataBillingDryRun2
    Felder anzeigen (3)
    • billing_payment_profileBillingPaymentProfile6

      Zahlungsprofil, das für den Probelauf verwendet wird.

    • billing_datestring (date-time)

      Für den Probelauf verwendetes Abrechnungsdatum.

    • deletedboolean

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

Antworten

200Der geplante ProbelaufBillingDryRun3

Felder anzeigen (23)
  • idinteger

    Primärschlüssel des Abrechnungs-Probelaufs. Interne ID.

  • billing_payment_profileBillingPaymentProfile10

    Zahlungsprofil, das für den Probelauf verwendet wird.

    Felder anzeigen (15)
    • idinteger

      Primärschlüssel des Zahlungsprofils. Interne ID.

    • payout_typestring

      Art der Auszahlung, zum Beispiel SEPA-Lastschrift oder Überweisung.

    • auto_modeboolean

      Zahlungen werden automatisch angelegt.

    • is_defaultboolean

      Standard-Zahlungsprofil.

    • is_event_defaultboolean

      Standard-Zahlungsprofil für Veranstaltungen.

    • is_donation_defaultboolean

      Standard-Zahlungsprofil für Spenden.

    • execution_daystring

      Tag des Monats, an dem die Zahlungen ausgeführt werden.

    • next_execution_datestring (date-time)

      Datum der nächsten Ausführung.

    • booking_daystring

      Tag des Monats, an dem die Zahlungen gebucht werden.

    • next_booking_datestring (date-time)

      Datum der nächsten Buchung.

    • force_billing_due_date_to_next_booking_dateboolean

      Fälligkeitsdatum der Rechnung auf den nächsten Buchungstermin setzen.

    • deletedboolean

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

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

  • triggered_by_userUser14

    Benutzer, der den Testlauf gestartet hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • statusstring

    Status des Probelaufs, zum Beispiel laufend oder beendet.

  • billing_datestring (date-time)

    Für den Probelauf verwendetes Abrechnungsdatum.

  • started_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf gestartet wurde.

  • finished_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf beendet wurde.

  • company_countinteger

    Anzahl der geprüften Firmen.

  • invoice_countinteger

    Anzahl der Rechnungen, die erstellt würden.

  • saved_invoice_countinteger

    Anzahl der gespeicherten Rechnungen.

  • skipped_invoice_countinteger

    Anzahl der übersprungenen Rechnungen.

  • position_countinteger

    Anzahl der Positionen auf allen Rechnungen.

  • mail_countinteger

    Anzahl der per E-Mail versandten Rechnungen.

  • postal_countinteger

    Anzahl der per Post versandten Rechnungen.

  • sum_nettonumber (float)

    Summe der Nettowerte.

  • sum_bruttonumber (float)

    Summe der Bruttowerte.

  • sum_taxnumber (float)

    Summe der Steuerbeträge.

  • log_lengthinteger

    Länge des Protokolls des Testlaufs.

  • stored_item_countinteger

    Anzahl der Gegenstände, die der Probelauf eingelagert hat.

  • error_messagestring

    Fehlermeldung des Probelaufs.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "billing_payment_profile": {
      "deleted": true
    },
    "billing_date": "2026-10-15T09:30:00+02:00",
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "billing_payment_profile": {
    "id": 42,
    "name": "Beispiel",
    "payout_type": "string",
    "auto_mode": true,
    "is_default": true,
    "is_event_default": true,
    "is_donation_default": true,
    "execution_day": "string",
    "next_execution_date": "2026-10-15T09:30:00+02:00",
    "booking_day": "string"
  },
  "triggered_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "status": "string",
  "billing_date": "2026-10-15T09:30:00+02:00",
  "started_at": "2026-10-15T09:30:00+02:00",
  "finished_at": "2026-10-15T09:30:00+02:00",
  "company_count": 1,
  "invoice_count": 1,
  "saved_invoice_count": 1
}

Diese Methode liefert eine einzelne BillingDryRun mit der angegebenen ID einschließlich aller simulierten Rechnungen

GET/api/invoice/billing_dry_run/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BillingDryRun-Objekt.BillingDryRun3

Felder anzeigen (23)
  • idinteger

    Primärschlüssel des Abrechnungs-Probelaufs. Interne ID.

  • billing_payment_profileBillingPaymentProfile10

    Zahlungsprofil, das für den Probelauf verwendet wird.

    Felder anzeigen (15)
    • idinteger

      Primärschlüssel des Zahlungsprofils. Interne ID.

    • payout_typestring

      Art der Auszahlung, zum Beispiel SEPA-Lastschrift oder Überweisung.

    • auto_modeboolean

      Zahlungen werden automatisch angelegt.

    • is_defaultboolean

      Standard-Zahlungsprofil.

    • is_event_defaultboolean

      Standard-Zahlungsprofil für Veranstaltungen.

    • is_donation_defaultboolean

      Standard-Zahlungsprofil für Spenden.

    • execution_daystring

      Tag des Monats, an dem die Zahlungen ausgeführt werden.

    • next_execution_datestring (date-time)

      Datum der nächsten Ausführung.

    • booking_daystring

      Tag des Monats, an dem die Zahlungen gebucht werden.

    • next_booking_datestring (date-time)

      Datum der nächsten Buchung.

    • force_billing_due_date_to_next_booking_dateboolean

      Fälligkeitsdatum der Rechnung auf den nächsten Buchungstermin setzen.

    • deletedboolean

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

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

  • triggered_by_userUser14

    Benutzer, der den Testlauf gestartet hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • statusstring

    Status des Probelaufs, zum Beispiel laufend oder beendet.

  • billing_datestring (date-time)

    Für den Probelauf verwendetes Abrechnungsdatum.

  • started_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf gestartet wurde.

  • finished_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf beendet wurde.

  • company_countinteger

    Anzahl der geprüften Firmen.

  • invoice_countinteger

    Anzahl der Rechnungen, die erstellt würden.

  • saved_invoice_countinteger

    Anzahl der gespeicherten Rechnungen.

  • skipped_invoice_countinteger

    Anzahl der übersprungenen Rechnungen.

  • position_countinteger

    Anzahl der Positionen auf allen Rechnungen.

  • mail_countinteger

    Anzahl der per E-Mail versandten Rechnungen.

  • postal_countinteger

    Anzahl der per Post versandten Rechnungen.

  • sum_nettonumber (float)

    Summe der Nettowerte.

  • sum_bruttonumber (float)

    Summe der Bruttowerte.

  • sum_taxnumber (float)

    Summe der Steuerbeträge.

  • log_lengthinteger

    Länge des Protokolls des Testlaufs.

  • stored_item_countinteger

    Anzahl der Gegenstände, die der Probelauf eingelagert hat.

  • error_messagestring

    Fehlermeldung des Probelaufs.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "billing_payment_profile": {
    "id": 42,
    "name": "Beispiel",
    "payout_type": "string",
    "auto_mode": true,
    "is_default": true,
    "is_event_default": true,
    "is_donation_default": true,
    "execution_day": "string",
    "next_execution_date": "2026-10-15T09:30:00+02:00",
    "booking_day": "string"
  },
  "triggered_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "status": "string",
  "billing_date": "2026-10-15T09:30:00+02:00",
  "started_at": "2026-10-15T09:30:00+02:00",
  "finished_at": "2026-10-15T09:30:00+02:00",
  "company_count": 1,
  "invoice_count": 1,
  "saved_invoice_count": 1
}

BillingDryRun archivieren, damit er aus der Liste verschwindet, ohne sein Ergebnis zu verlieren.

PUT/api/invoice/billing_dry_run/{identifier}

Das Löschen eines Laufs entfernt seine simulierten Rechnungen und sein Protokoll endgültig, was richtig ist, sobald ein Ergebnis geprüft wurde. Archivieren ist der umkehrbare Weg aus der Liste für ein Ergebnis, das man behalten möchte - es kann weiterhin geöffnet und exportiert werden, und das Kennzeichen lässt sich zurücknehmen. Alles andere an einem Lauf schreibt die Simulation selbst, daher ist das Lösch-Kennzeichen das einzige Feld, das hier akzeptiert wird.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBillingDryRun4
    Felder anzeigen (3)
    • billing_payment_profileBillingPaymentProfile8

      Zahlungsprofil, das für den Probelauf verwendet wird.

    • billing_datestring (date-time)

      Für den Probelauf verwendetes Abrechnungsdatum.

    • deletedboolean

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

Antworten

200Die aktualisierte BillingDryRunBillingDryRun3

Felder anzeigen (23)
  • idinteger

    Primärschlüssel des Abrechnungs-Probelaufs. Interne ID.

  • billing_payment_profileBillingPaymentProfile10

    Zahlungsprofil, das für den Probelauf verwendet wird.

    Felder anzeigen (15)
    • idinteger

      Primärschlüssel des Zahlungsprofils. Interne ID.

    • payout_typestring

      Art der Auszahlung, zum Beispiel SEPA-Lastschrift oder Überweisung.

    • auto_modeboolean

      Zahlungen werden automatisch angelegt.

    • is_defaultboolean

      Standard-Zahlungsprofil.

    • is_event_defaultboolean

      Standard-Zahlungsprofil für Veranstaltungen.

    • is_donation_defaultboolean

      Standard-Zahlungsprofil für Spenden.

    • execution_daystring

      Tag des Monats, an dem die Zahlungen ausgeführt werden.

    • next_execution_datestring (date-time)

      Datum der nächsten Ausführung.

    • booking_daystring

      Tag des Monats, an dem die Zahlungen gebucht werden.

    • next_booking_datestring (date-time)

      Datum der nächsten Buchung.

    • force_billing_due_date_to_next_booking_dateboolean

      Fälligkeitsdatum der Rechnung auf den nächsten Buchungstermin setzen.

    • deletedboolean

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

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

  • triggered_by_userUser14

    Benutzer, der den Testlauf gestartet hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • statusstring

    Status des Probelaufs, zum Beispiel laufend oder beendet.

  • billing_datestring (date-time)

    Für den Probelauf verwendetes Abrechnungsdatum.

  • started_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf gestartet wurde.

  • finished_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf beendet wurde.

  • company_countinteger

    Anzahl der geprüften Firmen.

  • invoice_countinteger

    Anzahl der Rechnungen, die erstellt würden.

  • saved_invoice_countinteger

    Anzahl der gespeicherten Rechnungen.

  • skipped_invoice_countinteger

    Anzahl der übersprungenen Rechnungen.

  • position_countinteger

    Anzahl der Positionen auf allen Rechnungen.

  • mail_countinteger

    Anzahl der per E-Mail versandten Rechnungen.

  • postal_countinteger

    Anzahl der per Post versandten Rechnungen.

  • sum_nettonumber (float)

    Summe der Nettowerte.

  • sum_bruttonumber (float)

    Summe der Bruttowerte.

  • sum_taxnumber (float)

    Summe der Steuerbeträge.

  • log_lengthinteger

    Länge des Protokolls des Testlaufs.

  • stored_item_countinteger

    Anzahl der Gegenstände, die der Probelauf eingelagert hat.

  • error_messagestring

    Fehlermeldung des Probelaufs.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "billing_payment_profile": {
      "deleted": true
    },
    "billing_date": "2026-10-15T09:30:00+02:00",
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "billing_payment_profile": {
    "id": 42,
    "name": "Beispiel",
    "payout_type": "string",
    "auto_mode": true,
    "is_default": true,
    "is_event_default": true,
    "is_donation_default": true,
    "execution_day": "string",
    "next_execution_date": "2026-10-15T09:30:00+02:00",
    "booking_day": "string"
  },
  "triggered_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "status": "string",
  "billing_date": "2026-10-15T09:30:00+02:00",
  "started_at": "2026-10-15T09:30:00+02:00",
  "finished_at": "2026-10-15T09:30:00+02:00",
  "company_count": 1,
  "invoice_count": 1,
  "saved_invoice_count": 1
}

BillingDryRun archivieren, damit er aus der Liste verschwindet, ohne sein Ergebnis zu verlieren.

PATCH/api/invoice/billing_dry_run/{identifier}

Das Löschen eines Laufs entfernt seine simulierten Rechnungen und sein Protokoll endgültig, was richtig ist, sobald ein Ergebnis geprüft wurde. Archivieren ist der umkehrbare Weg aus der Liste für ein Ergebnis, das man behalten möchte - es kann weiterhin geöffnet und exportiert werden, und das Kennzeichen lässt sich zurücknehmen. Alles andere an einem Lauf schreibt die Simulation selbst, daher ist das Lösch-Kennzeichen das einzige Feld, das hier akzeptiert wird.

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBillingDryRun4
    Felder anzeigen (3)
    • billing_payment_profileBillingPaymentProfile8

      Zahlungsprofil, das für den Probelauf verwendet wird.

    • billing_datestring (date-time)

      Für den Probelauf verwendetes Abrechnungsdatum.

    • deletedboolean

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

Antworten

200Die aktualisierte BillingDryRunBillingDryRun3

Felder anzeigen (23)
  • idinteger

    Primärschlüssel des Abrechnungs-Probelaufs. Interne ID.

  • billing_payment_profileBillingPaymentProfile10

    Zahlungsprofil, das für den Probelauf verwendet wird.

    Felder anzeigen (15)
    • idinteger

      Primärschlüssel des Zahlungsprofils. Interne ID.

    • payout_typestring

      Art der Auszahlung, zum Beispiel SEPA-Lastschrift oder Überweisung.

    • auto_modeboolean

      Zahlungen werden automatisch angelegt.

    • is_defaultboolean

      Standard-Zahlungsprofil.

    • is_event_defaultboolean

      Standard-Zahlungsprofil für Veranstaltungen.

    • is_donation_defaultboolean

      Standard-Zahlungsprofil für Spenden.

    • execution_daystring

      Tag des Monats, an dem die Zahlungen ausgeführt werden.

    • next_execution_datestring (date-time)

      Datum der nächsten Ausführung.

    • booking_daystring

      Tag des Monats, an dem die Zahlungen gebucht werden.

    • next_booking_datestring (date-time)

      Datum der nächsten Buchung.

    • force_billing_due_date_to_next_booking_dateboolean

      Fälligkeitsdatum der Rechnung auf den nächsten Buchungstermin setzen.

    • deletedboolean

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

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

  • triggered_by_userUser14

    Benutzer, der den Testlauf gestartet hat.

    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Benutzers. Interne ID des Anmeldebenutzers.

    • namestring

      Anzeigename des Benutzers. Wird in der Oberfläche und in Protokolleinträgen angezeigt.

    • usernamestring

      Anmeldename des Benutzers. Muss über alle Benutzer hinweg eindeutig sein.

    • emailstring

      E-Mail-Adresse des Benutzers. Wird für Anmeldebenachrichtigungen, Passwort-Zurücksetzen und als Anmeldealias verwendet.

    • positioningeneralstring

      Freitext zur Position oder Rolle des Benutzers.

    • crm_personCRMPerson10

      CRM-Person, die mit diesem Anmeldebenutzer verknüpft ist. Verbindet das Anmeldekonto mit dem Personendatensatz.

    • profile_picture_urlstring

      URL des Profilbilds des Benutzers.

    • archivedboolean

      Markiert den Benutzer als archiviert. Archivierte Benutzer bleiben zur Historie erhalten und sind nicht aktiv.

    • require2faboolean

      Für diesen Benutzer ist die Zwei-Faktor-Authentifizierung Pflicht.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • statusstring

    Status des Probelaufs, zum Beispiel laufend oder beendet.

  • billing_datestring (date-time)

    Für den Probelauf verwendetes Abrechnungsdatum.

  • started_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf gestartet wurde.

  • finished_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf beendet wurde.

  • company_countinteger

    Anzahl der geprüften Firmen.

  • invoice_countinteger

    Anzahl der Rechnungen, die erstellt würden.

  • saved_invoice_countinteger

    Anzahl der gespeicherten Rechnungen.

  • skipped_invoice_countinteger

    Anzahl der übersprungenen Rechnungen.

  • position_countinteger

    Anzahl der Positionen auf allen Rechnungen.

  • mail_countinteger

    Anzahl der per E-Mail versandten Rechnungen.

  • postal_countinteger

    Anzahl der per Post versandten Rechnungen.

  • sum_nettonumber (float)

    Summe der Nettowerte.

  • sum_bruttonumber (float)

    Summe der Bruttowerte.

  • sum_taxnumber (float)

    Summe der Steuerbeträge.

  • log_lengthinteger

    Länge des Protokolls des Testlaufs.

  • stored_item_countinteger

    Anzahl der Gegenstände, die der Probelauf eingelagert hat.

  • error_messagestring

    Fehlermeldung des Probelaufs.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "billing_payment_profile": {
      "deleted": true
    },
    "billing_date": "2026-10-15T09:30:00+02:00",
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "billing_payment_profile": {
    "id": 42,
    "name": "Beispiel",
    "payout_type": "string",
    "auto_mode": true,
    "is_default": true,
    "is_event_default": true,
    "is_donation_default": true,
    "execution_day": "string",
    "next_execution_date": "2026-10-15T09:30:00+02:00",
    "booking_day": "string"
  },
  "triggered_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "status": "string",
  "billing_date": "2026-10-15T09:30:00+02:00",
  "started_at": "2026-10-15T09:30:00+02:00",
  "finished_at": "2026-10-15T09:30:00+02:00",
  "company_count": 1,
  "invoice_count": 1,
  "saved_invoice_count": 1
}

Einen BillingDryRun samt seinen simulierten Rechnungen löschen.

DELETE/api/invoice/billing_dry_run/{identifier}

Der Datensatz wird endgültig entfernt, statt als gelöscht markiert zu werden: Ein Lauf enthält bis zu BillingDryRunCollector::MAX_ITEMS simulierte Rechnungen mit ihren Positionen und einem Protokoll von einigen hundert Kilobyte, von denen nichts beschreibt, was tatsächlich passiert ist. Wird dies nach der Prüfung des Ergebnisses aufbewahrt, füllt es nur die Datenbank.

Ein Lauf, der noch geplant ist oder ausgeführt wird, bleibt erhalten – der Hintergrundprozess würde sonst an seinem eigenen Ergebnis scheitern.

Pfad-Parameter

identifierPflichtstring

Antworten

200Die gelöschte BillingDryRunBillingDryRun

Felder anzeigen (22)
  • idinteger

    Primärschlüssel des Abrechnungs-Probelaufs. Interne ID.

  • billing_payment_profileBillingPaymentProfile10

    Zahlungsprofil, das für den Probelauf verwendet wird.

    Felder anzeigen (15)
    • idinteger

      Primärschlüssel des Zahlungsprofils. Interne ID.

    • payout_typestring

      Art der Auszahlung, zum Beispiel SEPA-Lastschrift oder Überweisung.

    • auto_modeboolean

      Zahlungen werden automatisch angelegt.

    • is_defaultboolean

      Standard-Zahlungsprofil.

    • is_event_defaultboolean

      Standard-Zahlungsprofil für Veranstaltungen.

    • is_donation_defaultboolean

      Standard-Zahlungsprofil für Spenden.

    • execution_daystring

      Tag des Monats, an dem die Zahlungen ausgeführt werden.

    • next_execution_datestring (date-time)

      Datum der nächsten Ausführung.

    • booking_daystring

      Tag des Monats, an dem die Zahlungen gebucht werden.

    • next_booking_datestring (date-time)

      Datum der nächsten Buchung.

    • force_billing_due_date_to_next_booking_dateboolean

      Fälligkeitsdatum der Rechnung auf den nächsten Buchungstermin setzen.

    • deletedboolean

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

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • namestring

      Name der Einheit.

  • statusstring

    Status des Probelaufs, zum Beispiel laufend oder beendet.

  • billing_datestring (date-time)

    Für den Probelauf verwendetes Abrechnungsdatum.

  • started_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf gestartet wurde.

  • finished_atstring (date-time)

    Zeitpunkt, zu dem der Testlauf beendet wurde.

  • company_countinteger

    Anzahl der geprüften Firmen.

  • invoice_countinteger

    Anzahl der Rechnungen, die erstellt würden.

  • saved_invoice_countinteger

    Anzahl der gespeicherten Rechnungen.

  • skipped_invoice_countinteger

    Anzahl der übersprungenen Rechnungen.

  • position_countinteger

    Anzahl der Positionen auf allen Rechnungen.

  • mail_countinteger

    Anzahl der per E-Mail versandten Rechnungen.

  • postal_countinteger

    Anzahl der per Post versandten Rechnungen.

  • sum_nettonumber (float)

    Summe der Nettowerte.

  • sum_bruttonumber (float)

    Summe der Bruttowerte.

  • sum_taxnumber (float)

    Summe der Steuerbeträge.

  • log_lengthinteger

    Länge des Protokolls des Testlaufs.

  • stored_item_countinteger

    Anzahl der Gegenstände, die der Probelauf eingelagert hat.

  • error_messagestring

    Fehlermeldung des Probelaufs.

  • deletedboolean

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

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "billing_payment_profile": {
    "id": 42,
    "name": "Beispiel",
    "payout_type": "string",
    "auto_mode": true,
    "is_default": true,
    "is_event_default": true,
    "is_donation_default": true,
    "execution_day": "string",
    "next_execution_date": "2026-10-15T09:30:00+02:00",
    "booking_day": "string"
  },
  "status": "string",
  "billing_date": "2026-10-15T09:30:00+02:00",
  "started_at": "2026-10-15T09:30:00+02:00",
  "finished_at": "2026-10-15T09:30:00+02:00",
  "company_count": 1,
  "invoice_count": 1,
  "saved_invoice_count": 1,
  "skipped_invoice_count": 1
}

Lädt die Konsolenausgabe eines simulierten Abrechnungslaufs als einfache Textdatei herunter.

GET/api/invoice/billing_dry_run/{identifier}/log

Das Protokoll enthält eine Zeile pro simulierter Rechnung und umfasst bei einer großen Installation mehrere Megabyte. Wurde es in der JSON-Detailantwort gesendet, lud sich die Ergebnisansicht bei jedem Neuladen langsam; daher wird es stattdessen als Datei angeboten.

Pfad-Parameter

identifierPflichtstring

Antworten

200Das Protokoll des BillingDryRun als Textdatei

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

Diese Methode liefert alle simulierten Rechnungen eines einzelnen BillingDryRun

GET/api/invoice/billing_dry_run_item

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der BillingDryRunItem-Objekte.array<BillingDryRunItem>

Felder anzeigen (21)
  • idinteger

    Primärschlüssel der Probelauf-Position. Interne ID.

  • company_idinteger

    ID der Firma, der in Rechnung gestellt wird.

  • company_numberstring

    Nummer der abzurechnenden Firma.

  • company_namestring

    Name der Firma, an die abgerechnet wird.

  • sourcestring

    Quelle der Position, zum Beispiel Veranstaltung oder Mitgliedschaft.

  • accounting_type_namestring

    Name der Buchungsart.

  • invoice_messagestring

    Nachricht, die auf der Rechnung gedruckt würde.

  • start_datestring (date-time)

    Beginn des abgerechneten Zeitraums.

  • end_datestring (date-time)

    Ende des abgerechneten Zeitraums.

  • due_datestring (date-time)

    Fälligkeitsdatum der Rechnung.

  • netto_valuenumber (float)

    Nettowert der Rechnung.

  • brutto_valuenumber (float)

    Bruttowert der Rechnung.

  • tax_valuenumber (float)

    Steuerwert der Rechnung.

  • position_countinteger

    Anzahl der Positionen auf der Rechnung.

  • time_report_countinteger

    Anzahl der enthaltenen Zeitberichte.

  • would_be_persistedboolean

    Die Rechnung würde in einem echten Lauf gespeichert.

  • skip_reasonstring

    Grund, warum die Rechnung übersprungen würde.

  • send_mailboolean

    Die Rechnung würde per E-Mail versendet.

  • send_postalboolean

    Die Rechnung würde per Post versendet.

  • recipient_emailstring

    E-Mail-Adresse, an die die Rechnung gesendet würde.

  • positionsarray<object>

    Positionen der Rechnung als JSON.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_dry_run_item \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "company_name": "Beispiel",
    "accounting_type_name": "Beispiel",
    "send_mail": true,
    "recipient_email": "lena.hartmann@example.org",
    "company_id": 42,
    "company_number": "string",
    "source": "string",
    "invoice_message": "string",
    "start_date": "2026-10-15T09:30:00+02:00"
  }
]