SepaPaymentTransaction

Abrechnung3 EndpunkteBilling / SepaPaymentTransaction

Liefert die Namen der erzeugten SEPA-Exporte zusammen mit den Angaben, die zur Auswahl eines Exports nötig sind: wie viele Transaktionen er enthält, deren Summe und wann er erzeugt wurde. Dies ist der erste Schritt der Prüfung - hier wird ein Name ausgewählt und an den Listen-Endpunkt übergeben.

GET/api/invoice/sepa_payment_transaction/execution_names

Query-Parameter

`payment_profile`integer	Abrechnungs-Zahlungsprofil der erzeugten SEPA-Exporte
`searchString`string	Namen nach einer Teilzeichenfolge filtern

Antworten

default

Anfrage

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

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/execution_names', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/execution_names"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/execution_names', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/execution_names"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/execution_names")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/execution_names"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/billing_sepa_payment_transaction_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await BillingSepaPaymentTransactionController.getExecutionNames();
if (result.success) {
  print(result.data);
}

Liefert die Dublettenhinweise eines erzeugten SEPA-Exports: die Gruppen von Transaktionen, die denselben Betrag vom selben Zahlungspflichtigen oder von derselben IBAN einziehen, zusammen mit den Summen des Exports. Berechnet über den gesamten Export, unabhängig von der Seitenaufteilung der Liste.

GET/api/invoice/sepa_payment_transaction/warnings

Query-Parameter

`name`Pflichtstring	Name des erzeugten SEPA-Exports
`payment_profile`integer	Abrechnungs-Zahlungsprofil des erzeugten SEPA-Exports

Antworten

default

Anfrage

curl --request GET \
  --url 'https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel' \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction/warnings?name=Beispiel"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/billing_sepa_payment_transaction_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await BillingSepaPaymentTransactionController.getWarnings();
if (result.success) {
  print(result.data);
}

Liefert die Transaktionen eines erzeugten SEPA-Exports. Der Export wird über seinen Namen gewählt, sodass `name` erforderlich ist - ohne ihn würde der Endpunkt jede jemals erzeugte Transaktion liefern. Jede Zeile enthält die Dubletten-Kennzeichen für den gesamten Export, und `duplicates` beschränkt die Liste auf die markierten Zeilen.

GET/api/invoice/sepa_payment_transaction

Query-Parameter

`id`string
`deleted`boolean	Diese Eigenschaft markiert eine Entität als gelöscht / archiviert \| Benötigtes Zugriffsrecht: SCOPE \| Standardwert: false
`auto`boolean
`incoming`boolean
`name`string
`company`string
`billingPaymentProfile`string
`bruttoValue`number
`currency`string
`paymentOwner`string
`paymentIban`string
`paymentBic`string
`paymentMandate`string
`created`string
`updated`string
`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert die Transaktionen eines erzeugten SEPA-Exportsarray<SepaPaymentTransaction>

Felder anzeigen (19)

duplicate_warningboolean
autoboolean
Die Transaktion wurde automatisch erstellt.
incomingboolean
Die Transaktion ist ein Zahlungseingang.
currencystring
Währung der Transaktion, zum Beispiel EUR.
brutto_valuenumber (float)
Bruttobetrag der Transaktion.
duplicate_owner_value_warningboolean
Nicht persistiert. Wird von der API gesetzt, wenn eine andere Transaktion desselben generierten SEPA-Exports denselben Betrag vom selben Zahlungspflichtigen einzieht.
duplicate_iban_value_warningboolean
Nicht persistiert. Wird von der API gesetzt, wenn eine andere Transaktion desselben generierten SEPA-Exports denselben Betrag von derselben IBAN einzieht.
deletedboolean
Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
namestring
Name der Einheit.
createdstring (date-time)
Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)
Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
payment_ownerstring
Kontoinhaber der Lastschrift.
payment_institutionstring
Name der Bank des Lastschrifteinzugs.
payment_bicstring
BIC des Bankkontos.
payment_ibanstring
IBAN des Bankkontos.
payment_mandatestring
Referenz des SEPA-Mandats.
payment_mandate_sign_datestring (date-time)
Datum, an dem das SEPA-Mandat unterschrieben wurde.
payment_mandate_valid_until_datestring (date-time)
Datum, bis zu dem das SEPA-Mandat gültig ist.
billing_payment_profileBillingPaymentProfile10
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.

Anfrage

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

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eure-instanz.iw-erp.de/api/invoice/sepa_payment_transaction"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart mit dem Package iw_erp_api

import 'package:iw_erp_api/clients/billing_sepa_payment_transaction_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'eure-instanz.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await BillingSepaPaymentTransactionController.getAll();
if (result.success) {
  print(result.data);
}

Antwort 200 application/json

[
  {
    "currency": "EUR",
    "name": "Beispiel",
    "payment_bic": "BYLADEM1001",
    "payment_iban": "DE02120300000000202051",
    "duplicate_warning": true,
    "auto": true,
    "incoming": true,
    "brutto_value": 1.5,
    "duplicate_owner_value_warning": true,
    "duplicate_iban_value_warning": true
  }
]