Zum Inhalt springen
Developer

PaymentGoal

Abrechnung6 EndpunkteBilling / PaymentGoal

Liefert eine Liste aller PaymentGoal-Objekte.

GET/api/invoice/paymentgoals

Query-Parameter

idstring
namestring
dateStringstring
deletedboolean
globalDefaultboolean
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 PaymentGoal-Objekte.array<PaymentGoal>

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zahlungsziels. Interne ID.

  • namestring

    Name der Zahlungsbedingung, zum Beispiel 14 Tage.

  • date_stringstring

    Datumsmuster der Zahlungsfrist als Text.

  • deletedboolean

    Die Zahlungsfrist wird gelöscht.

  • global_defaultboolean

    Standard-Zahlungsziel für neue Rechnungen.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/paymentgoals \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "date_string": "string",
    "deleted": true,
    "global_default": true
  }
]

Liefert eine Liste aller PaymentGoal-Objekte.

GET/api/invoice/payment_goal

Query-Parameter

idstring
namestring
dateStringstring
deletedboolean
globalDefaultboolean
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 PaymentGoal-Objekte.array<PaymentGoal>

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zahlungsziels. Interne ID.

  • namestring

    Name der Zahlungsbedingung, zum Beispiel 14 Tage.

  • date_stringstring

    Datumsmuster der Zahlungsfrist als Text.

  • deletedboolean

    Die Zahlungsfrist wird gelöscht.

  • global_defaultboolean

    Standard-Zahlungsziel für neue Rechnungen.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/payment_goal \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "date_string": "string",
    "deleted": true,
    "global_default": true
  }
]

PaymentGoal neu anlegen

POST/api/invoice/payment_goal

Request-Body application/json

  • dataPaymentGoal
    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Zahlungsziels. Interne ID.

    • namestring

      Name der Zahlungsbedingung, zum Beispiel 14 Tage.

    • date_stringstring

      Datumsmuster der Zahlungsfrist als Text.

    • deletedboolean

      Die Zahlungsfrist wird gelöscht.

    • global_defaultboolean

      Standard-Zahlungsziel für neue Rechnungen.

Antworten

200PaymentGoal neu anlegenPaymentGoal

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zahlungsziels. Interne ID.

  • namestring

    Name der Zahlungsbedingung, zum Beispiel 14 Tage.

  • date_stringstring

    Datumsmuster der Zahlungsfrist als Text.

  • deletedboolean

    Die Zahlungsfrist wird gelöscht.

  • global_defaultboolean

    Standard-Zahlungsziel für neue Rechnungen.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/invoice/payment_goal \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "date_string": "string",
    "deleted": true,
    "global_default": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "date_string": "string",
  "deleted": true,
  "global_default": true
}

Einzelnes PaymentGoal abrufen

GET/api/invoice/payment_goal/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Einzelnes PaymentGoal abrufenPaymentGoal

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zahlungsziels. Interne ID.

  • namestring

    Name der Zahlungsbedingung, zum Beispiel 14 Tage.

  • date_stringstring

    Datumsmuster der Zahlungsfrist als Text.

  • deletedboolean

    Die Zahlungsfrist wird gelöscht.

  • global_defaultboolean

    Standard-Zahlungsziel für neue Rechnungen.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/invoice/payment_goal/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "date_string": "string",
  "deleted": true,
  "global_default": true
}

PaymentGoal aktualisieren

PUT/api/invoice/payment_goal/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataPaymentGoal
    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Zahlungsziels. Interne ID.

    • namestring

      Name der Zahlungsbedingung, zum Beispiel 14 Tage.

    • date_stringstring

      Datumsmuster der Zahlungsfrist als Text.

    • deletedboolean

      Die Zahlungsfrist wird gelöscht.

    • global_defaultboolean

      Standard-Zahlungsziel für neue Rechnungen.

Antworten

200PaymentGoal aktualisierenPaymentGoal

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zahlungsziels. Interne ID.

  • namestring

    Name der Zahlungsbedingung, zum Beispiel 14 Tage.

  • date_stringstring

    Datumsmuster der Zahlungsfrist als Text.

  • deletedboolean

    Die Zahlungsfrist wird gelöscht.

  • global_defaultboolean

    Standard-Zahlungsziel für neue Rechnungen.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/invoice/payment_goal/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "date_string": "string",
    "deleted": true,
    "global_default": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "date_string": "string",
  "deleted": true,
  "global_default": true
}

PaymentGoal aktualisieren

PATCH/api/invoice/payment_goal/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataPaymentGoal
    Felder anzeigen (5)
    • idinteger

      Primärschlüssel des Zahlungsziels. Interne ID.

    • namestring

      Name der Zahlungsbedingung, zum Beispiel 14 Tage.

    • date_stringstring

      Datumsmuster der Zahlungsfrist als Text.

    • deletedboolean

      Die Zahlungsfrist wird gelöscht.

    • global_defaultboolean

      Standard-Zahlungsziel für neue Rechnungen.

Antworten

200PaymentGoal aktualisierenPaymentGoal

Felder anzeigen (5)
  • idinteger

    Primärschlüssel des Zahlungsziels. Interne ID.

  • namestring

    Name der Zahlungsbedingung, zum Beispiel 14 Tage.

  • date_stringstring

    Datumsmuster der Zahlungsfrist als Text.

  • deletedboolean

    Die Zahlungsfrist wird gelöscht.

  • global_defaultboolean

    Standard-Zahlungsziel für neue Rechnungen.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/invoice/payment_goal/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "name": "Beispiel",
    "date_string": "string",
    "deleted": true,
    "global_default": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "date_string": "string",
  "deleted": true,
  "global_default": true
}