Zum Inhalt springen
Developer

PaymentType

Abrechnung6 EndpunkteBilling / PaymentType

Liefert eine Liste aller PaymentType-Objekte.

GET/api/invoice/paymenttypes

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 aller PaymentType-Objekte.array<PaymentType>

Felder anzeigen (10)
  • idinteger

    Primärschlüssel des Zahlungstyps. Interne ID.

  • namestring

    Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

  • autoboolean

    Zahlungen dieses Typs werden automatisch zugeordnet.

  • conditionsstring

    Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

  • linked_keywordsstring

    Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

  • global_defaultboolean

    Standard-Zahlungsart für neue Rechnungen.

  • bank_import_defaultboolean

    Standard-Zahlungsart für Bankimporte.

  • is_direct_debitboolean

    Die Zahlungsart ist ein Lastschriftverfahren.

  • is_externalboolean

    Die Zahlung wird über einen externen Dienst abgewickelt.

  • deletedboolean

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

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

Liefert eine Liste aller PaymentType-Objekte.

GET/api/invoice/payment_type

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 aller PaymentType-Objekte.array<PaymentType>

Felder anzeigen (10)
  • idinteger

    Primärschlüssel des Zahlungstyps. Interne ID.

  • namestring

    Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

  • autoboolean

    Zahlungen dieses Typs werden automatisch zugeordnet.

  • conditionsstring

    Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

  • linked_keywordsstring

    Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

  • global_defaultboolean

    Standard-Zahlungsart für neue Rechnungen.

  • bank_import_defaultboolean

    Standard-Zahlungsart für Bankimporte.

  • is_direct_debitboolean

    Die Zahlungsart ist ein Lastschriftverfahren.

  • is_externalboolean

    Die Zahlung wird über einen externen Dienst abgewickelt.

  • deletedboolean

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

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

PaymentType neu anlegen

POST/api/invoice/payment_type

Request-Body application/json

  • dataPaymentType
    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Zahlungstyps. Interne ID.

    • namestring

      Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

    • autoboolean

      Zahlungen dieses Typs werden automatisch zugeordnet.

    • conditionsstring

      Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

    • linked_keywordsstring

      Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

    • global_defaultboolean

      Standard-Zahlungsart für neue Rechnungen.

    • bank_import_defaultboolean

      Standard-Zahlungsart für Bankimporte.

    • is_direct_debitboolean

      Die Zahlungsart ist ein Lastschriftverfahren.

    • is_externalboolean

      Die Zahlung wird über einen externen Dienst abgewickelt.

    • deletedboolean

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

Antworten

200PaymentType neu anlegenPaymentType

Felder anzeigen (10)
  • idinteger

    Primärschlüssel des Zahlungstyps. Interne ID.

  • namestring

    Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

  • autoboolean

    Zahlungen dieses Typs werden automatisch zugeordnet.

  • conditionsstring

    Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

  • linked_keywordsstring

    Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

  • global_defaultboolean

    Standard-Zahlungsart für neue Rechnungen.

  • bank_import_defaultboolean

    Standard-Zahlungsart für Bankimporte.

  • is_direct_debitboolean

    Die Zahlungsart ist ein Lastschriftverfahren.

  • is_externalboolean

    Die Zahlung wird über einen externen Dienst abgewickelt.

  • deletedboolean

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

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

Einzelnen PaymentType abrufen

GET/api/invoice/payment_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Einzelnen PaymentType abrufenPaymentType

Felder anzeigen (10)
  • idinteger

    Primärschlüssel des Zahlungstyps. Interne ID.

  • namestring

    Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

  • autoboolean

    Zahlungen dieses Typs werden automatisch zugeordnet.

  • conditionsstring

    Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

  • linked_keywordsstring

    Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

  • global_defaultboolean

    Standard-Zahlungsart für neue Rechnungen.

  • bank_import_defaultboolean

    Standard-Zahlungsart für Bankimporte.

  • is_direct_debitboolean

    Die Zahlungsart ist ein Lastschriftverfahren.

  • is_externalboolean

    Die Zahlung wird über einen externen Dienst abgewickelt.

  • deletedboolean

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

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

PaymentType aktualisieren

PUT/api/invoice/payment_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataPaymentType
    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Zahlungstyps. Interne ID.

    • namestring

      Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

    • autoboolean

      Zahlungen dieses Typs werden automatisch zugeordnet.

    • conditionsstring

      Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

    • linked_keywordsstring

      Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

    • global_defaultboolean

      Standard-Zahlungsart für neue Rechnungen.

    • bank_import_defaultboolean

      Standard-Zahlungsart für Bankimporte.

    • is_direct_debitboolean

      Die Zahlungsart ist ein Lastschriftverfahren.

    • is_externalboolean

      Die Zahlung wird über einen externen Dienst abgewickelt.

    • deletedboolean

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

Antworten

200PaymentType aktualisierenPaymentType

Felder anzeigen (10)
  • idinteger

    Primärschlüssel des Zahlungstyps. Interne ID.

  • namestring

    Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

  • autoboolean

    Zahlungen dieses Typs werden automatisch zugeordnet.

  • conditionsstring

    Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

  • linked_keywordsstring

    Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

  • global_defaultboolean

    Standard-Zahlungsart für neue Rechnungen.

  • bank_import_defaultboolean

    Standard-Zahlungsart für Bankimporte.

  • is_direct_debitboolean

    Die Zahlungsart ist ein Lastschriftverfahren.

  • is_externalboolean

    Die Zahlung wird über einen externen Dienst abgewickelt.

  • deletedboolean

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

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

PaymentType aktualisieren

PATCH/api/invoice/payment_type/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataPaymentType
    Felder anzeigen (10)
    • idinteger

      Primärschlüssel des Zahlungstyps. Interne ID.

    • namestring

      Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

    • autoboolean

      Zahlungen dieses Typs werden automatisch zugeordnet.

    • conditionsstring

      Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

    • linked_keywordsstring

      Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

    • global_defaultboolean

      Standard-Zahlungsart für neue Rechnungen.

    • bank_import_defaultboolean

      Standard-Zahlungsart für Bankimporte.

    • is_direct_debitboolean

      Die Zahlungsart ist ein Lastschriftverfahren.

    • is_externalboolean

      Die Zahlung wird über einen externen Dienst abgewickelt.

    • deletedboolean

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

Antworten

200PaymentType aktualisierenPaymentType

Felder anzeigen (10)
  • idinteger

    Primärschlüssel des Zahlungstyps. Interne ID.

  • namestring

    Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.

  • autoboolean

    Zahlungen dieses Typs werden automatisch zugeordnet.

  • conditionsstring

    Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.

  • linked_keywordsstring

    Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.

  • global_defaultboolean

    Standard-Zahlungsart für neue Rechnungen.

  • bank_import_defaultboolean

    Standard-Zahlungsart für Bankimporte.

  • is_direct_debitboolean

    Die Zahlungsart ist ein Lastschriftverfahren.

  • is_externalboolean

    Die Zahlung wird über einen externen Dienst abgewickelt.

  • deletedboolean

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

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