Zum Inhalt springen
Developer

BillingPaymentProfile

Abrechnung5 EndpunkteBilling / BillingPaymentProfile

Diese Methode liefert alle BillingPaymentProfile-Objekte

GET/api/invoice/billing_payment_profile

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 BillingPaymentProfile-Objekte.array<BillingPaymentProfile>

Felder anzeigen (16)
  • 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.

  • billing_payout_accountBillingPayoutAccount3

    Auszahlungskonto, das für die Zahlungen verwendet wird.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Auszahlungskontos. Interne ID.

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

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_payment_profile \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "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"
  }
]

BillingPaymentProfile neu anlegen

POST/api/invoice/billing_payment_profile

Request-Body application/json

  • dataBillingPaymentProfile2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200BillingPaymentProfile neu anlegenBillingPaymentProfile

Felder anzeigen (16)
  • 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.

  • billing_payout_accountBillingPayoutAccount3

    Auszahlungskonto, das für die Zahlungen verwendet wird.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Auszahlungskontos. Interne ID.

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

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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_payment_profile \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "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"
}

Diese Methode liefert ein einzelnes BillingPaymentProfile mit der angegebenen ID

GET/api/invoice/billing_payment_profile/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert ein einzelnes BillingPaymentProfile-Objekt.BillingPaymentProfile

Felder anzeigen (16)
  • 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.

  • billing_payout_accountBillingPayoutAccount3

    Auszahlungskonto, das für die Zahlungen verwendet wird.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Auszahlungskontos. Interne ID.

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

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_payment_profile/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "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"
}

BillingPaymentProfile aktualisieren

PUT/api/invoice/billing_payment_profile/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBillingPaymentProfile2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200BillingPaymentProfile aktualisierenBillingPaymentProfile

Felder anzeigen (16)
  • 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.

  • billing_payout_accountBillingPayoutAccount3

    Auszahlungskonto, das für die Zahlungen verwendet wird.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Auszahlungskontos. Interne ID.

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

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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_payment_profile/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "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"
}

BillingPaymentProfile aktualisieren

PATCH/api/invoice/billing_payment_profile/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataBillingPaymentProfile2
    Felder anzeigen (1)
    • deletedboolean

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

Antworten

200BillingPaymentProfile aktualisierenBillingPaymentProfile

Felder anzeigen (16)
  • 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.

  • billing_payout_accountBillingPayoutAccount3

    Auszahlungskonto, das für die Zahlungen verwendet wird.

    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Auszahlungskontos. Interne ID.

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

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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/invoice/billing_payment_profile/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "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"
}