SepaPaymentTransaction

Billing3 EndpointsBilling / SepaPaymentTransaction

Returns the names of the generated sepa exports together with the numbers needed to pick one: how many transactions it holds, what they add up to and when it was generated. This is the first step of the review - a name is picked here and passed to the list endpoint.

GET/api/invoice/sepa_payment_transaction/execution_names

Query parameters

`payment_profile`integer	billing payment profile of the generated sepa exports
`searchString`string	filter the names by a substring

Responses

default

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Returns the duplicate warnings of one generated sepa export: the groups of transactions that debit the same value from the same payment owner or from the same iban, together with the totals of the export. Computed over the whole export, independent of list pagination.

GET/api/invoice/sepa_payment_transaction/warnings

Query parameters

`name`requiredstring	name of the generated sepa export
`payment_profile`integer	billing payment profile of the generated sepa export

Responses

default

Request

curl --request GET \
  --url 'https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Returns the transactions of one generated sepa export. The export is selected by its name, so `name` is required - without it the endpoint would return every transaction ever generated. Each row carries the duplicate warning flags for the whole export, and `duplicates` restricts the list to the flagged rows.

GET/api/invoice/sepa_payment_transaction

Query parameters

`id`string
`deleted`boolean	This property is used to mark an entity as deleted / archived \| Default value: 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 to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns the transactions of one generated sepa exportarray<SepaPaymentTransaction>

Show fields (19)

duplicate_warningboolean
autoboolean
The transaction was created automatically.
incomingboolean
The transaction is incoming money.
currencystring
Currency of the transaction, for example EUR.
brutto_valuenumber (float)
Gross amount of the transaction.
duplicate_owner_value_warningboolean
Not persisted. Set by the api when another transaction of the same generated sepa export debits the same value from the same payment owner.
duplicate_iban_value_warningboolean
Not persisted. Set by the api when another transaction of the same generated sepa export debits the same value from the same iban.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
payment_ownerstring
Account owner of the direct debit.
payment_institutionstring
Name of the bank of the direct debit.
payment_bicstring
BIC of the bank account.
payment_ibanstring
IBAN of the bank account.
payment_mandatestring
Reference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)
Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)
Date until which the SEPA mandate is valid.
billing_payment_profileBillingPaymentProfile10
Show fields (15)
- idinteger
  Primary key of the payment profile. Internal ID.
- payout_typestring
  Type of payout, for example SEPA direct debit or transfer.
- auto_modeboolean
  Payments are created automatically.
- is_defaultboolean
  Default payment profile.
- is_event_defaultboolean
  Default payment profile for events.
- is_donation_defaultboolean
  Default payment profile for donations.
- execution_daystring
  Day of the month the payments are executed.
- next_execution_datestring (date-time)
  Date of the next execution.
- booking_daystring
  Day of the month the payments are booked.
- next_booking_datestring (date-time)
  Date of the next booking.
- force_billing_due_date_to_next_booking_dateboolean
  Force the due date of the invoice to the next booking date.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.

Request

curl --request GET \
  --url https://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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://your-instance.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 with the iw_erp_api package

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

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

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

Response 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
  }
]