ImportedPaymentTransaction

Accounting5 EndpointsBilling / ImportedPaymentTransaction

Returns a list of all ImportedPaymentTransaction

GET/api/invoice/imported_payment_transaction

Query parameters

`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 a list of all ImportedPaymentTransactionarray<ImportedPaymentTransaction>

Show fields (19)

ignoredboolean
The transaction is ignored in the matching.
linkedboolean
The transaction is linked to a document.
auto_linkedboolean
The transaction was linked automatically.
is_duplicateboolean
The transaction is a duplicate of an earlier import.
incomingboolean
The transaction is incoming money.
currencystring
Currency of the transaction, for example EUR.
brutto_valuenumber (float)
Gross amount of the transaction.
transaction_groupImportedPaymentTransactionGroup
Group the transaction belongs to.
Show fields (6)
- linkedboolean
  The group is linked to a document.
- auto_linkedboolean
  The group was linked automatically.
- 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.
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.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/imported_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/imported_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/imported_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/imported_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/imported_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/imported_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/imported_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_imported_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 BillingImportedPaymentTransactionController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "currency": "EUR",
    "name": "Beispiel",
    "payment_bic": "BYLADEM1001",
    "payment_iban": "DE02120300000000202051",
    "ignored": true,
    "linked": true,
    "auto_linked": true,
    "is_duplicate": true,
    "incoming": true,
    "brutto_value": 1.5
  }
]

Add a new ImportedPaymentTransaction

POST/api/invoice/imported_payment_transaction

Request body application/json

dataImportedPaymentTransaction2
Show fields (28)
- companyCRMCompany23
- ignoredboolean
  The transaction is ignored in the matching.
- linkedboolean
  The transaction is linked to a document.
- auto_linkedboolean
  The transaction was linked automatically.
- is_duplicateboolean
  The transaction is a duplicate of an earlier import.
- incomingboolean
  The transaction is incoming money.
- currencystring
  Currency of the transaction, for example EUR.
- brutto_valuenumber (float)
  Gross amount of the transaction.
- linked_sepa_payment_transactionSepaPaymentTransaction2
  SEPA transaction the import is linked to.
- linked_payment_transactionPaymentTransaction3
  Payment transaction the import is linked to.
- linked_fee_payment_transactionPaymentTransaction3
  Fee transaction the import is linked to.
- linked_invoiceInvoice20
  Invoice the import is linked to.
- linked_incoming_invoiceIncomingInvoice4
  Incoming invoice the import is linked to.
- linked_incoming_invoice_transactionIncomingInvoiceTransaction2
  Incoming invoice transaction the import is linked to.
- linked_donationDonation
  Donation the import is linked to.
- transaction_groupImportedPaymentTransactionGroup2
  Group the transaction belongs to.
- 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

Responses

200Add a new ImportedPaymentTransactionImportedPaymentTransaction2

Show fields (14)

companyCRMCompany23
Show fields (62)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- 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.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
ignoredboolean
The transaction is ignored in the matching.
linkedboolean
The transaction is linked to a document.
auto_linkedboolean
The transaction was linked automatically.
is_duplicateboolean
The transaction is a duplicate of an earlier import.
incomingboolean
The transaction is incoming money.
currencystring
Currency of the transaction, for example EUR.
brutto_valuenumber (float)
Gross amount of the transaction.
linked_sepa_payment_transactionSepaPaymentTransaction2
SEPA transaction the import is linked to.
Show fields (17)
- companyCRMCompany23
- 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.
- 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
linked_payment_transactionPaymentTransaction3
Payment transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_fee_payment_transactionPaymentTransaction3
Fee transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_invoiceInvoice20
Invoice the import is linked to.
Show fields (39)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- accounting_typeAccountingTyperequired
  Accounting type of the invoice.
- payment_typePaymentType
  Payment type of the invoice.
- payment_goalPaymentGoal
  Payment term of the invoice.
- expense_categoryExpenseCategory10
  EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
- buyerInvoiceBuyer19
  Buyer of the invoice.
- payment_datestring (date-time)
  Date the invoice was paid.
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
- is_payment_date_from_ext_serviceboolean
  The payment date comes from an external service.
- direct_debit_exportedboolean
  The invoice was exported for direct debit.
- cancel_datestring (date-time)
  Date the invoice was canceled.
- cancel_textstring
  Text of the cancellation.
- start_datestring (date-time)
  Start of the billed period.
- end_datestring (date-time)
  End of the billed period.
- billing_payment_profileBillingPaymentProfile10
linked_incoming_invoiceIncomingInvoice4
Incoming invoice the import is linked to.
Show fields (34)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- companyCRMCompany23
- external_invoice_numberstring
  Externe Rechnungsnummer des Lieferanten
- received_datestring (date-time)
  Eingangsdatum (wann wurde die Rechnung empfangen)
- payment_datestring (date-time)
  Zahlungsdatum
- service_date_startstring (date-time)
  Leistungszeitraum Start
- service_date_endstring (date-time)
  Leistungszeitraum Ende
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Auf der Eingangsseite entscheidet er darüber, ob die Vorsteuer unter Kennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61 (innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder unter 67 (§ 13b UStG). Beim Erwerb und bei § 13b kommt eine zweite Zeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand berechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im Vordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig. Ohne Angabe der Regelfall.
- vat_self_assessed_ratenumber (float)
  Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist. Beim innergemeinschaftlichen Erwerb und bei § 13b UStG berechnet der Lieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden wir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist der Satz, der im Inland auf diese Leistung anzuwenden wäre. Ohne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den Hinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu raten wäre in einer Steueranmeldung das Falsche.
- … 11 more fields
… 15 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "currency": "EUR",
    "name": "Beispiel",
    "payment_bic": "BYLADEM1001",
    "payment_iban": "DE02120300000000202051",
    "company": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "secondary_name": "Beispiel",
      "invoice_email": "lena.hartmann@example.org",
      "send_invoice_email": true
    },
    "ignored": true
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      currency: 'EUR',
      name: 'Beispiel',
      payment_bic: 'BYLADEM1001',
      payment_iban: 'DE02120300000000202051',
      company: {
        id: 42,
        short_name: 'Beispiel',
        company_name: 'Beispiel',
        secondary_name: 'Beispiel',
        invoice_email: 'lena.hartmann@example.org',
        send_invoice_email: true
      },
      ignored: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/invoice/imported_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/imported_payment_transaction"

payload = { "data": {
    "currency": "EUR",
    "name": "Beispiel",
    "payment_bic": "BYLADEM1001",
    "payment_iban": "DE02120300000000202051",
    "company": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "secondary_name": "Beispiel",
      "invoice_email": "lena.hartmann@example.org",
      "send_invoice_email": True
    },
    "ignored": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction', [
  'body' => '{"data":{"currency":"EUR","name":"Beispiel","payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","company":{"id":42,"short_name":"Beispiel","company_name":"Beispiel","secondary_name":"Beispiel","invoice_email":"lena.hartmann@example.org","send_invoice_email":true},"ignored":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"currency\":\"EUR\",\"name\":\"Beispiel\",\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"company\":{\"id\":42,\"short_name\":\"Beispiel\",\"company_name\":\"Beispiel\",\"secondary_name\":\"Beispiel\",\"invoice_email\":\"lena.hartmann@example.org\",\"send_invoice_email\":true},\"ignored\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"currency\":\"EUR\",\"name\":\"Beispiel\",\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"company\":{\"id\":42,\"short_name\":\"Beispiel\",\"company_name\":\"Beispiel\",\"secondary_name\":\"Beispiel\",\"invoice_email\":\"lena.hartmann@example.org\",\"send_invoice_email\":true},\"ignored\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

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

package main

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

func main() {

	url := "https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction"

	payload := strings.NewReader("{\"data\":{\"currency\":\"EUR\",\"name\":\"Beispiel\",\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"company\":{\"id\":42,\"short_name\":\"Beispiel\",\"company_name\":\"Beispiel\",\"secondary_name\":\"Beispiel\",\"invoice_email\":\"lena.hartmann@example.org\",\"send_invoice_email\":true},\"ignored\":true}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	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_imported_payment_transaction_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/imported_payment_transaction.dart';

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

final result = await BillingImportedPaymentTransactionController.post(ImportedPaymentTransaction.fromJson({
  "currency": "EUR",
  "name": "Beispiel",
  "payment_bic": "BYLADEM1001",
  "payment_iban": "DE02120300000000202051",
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true
  },
  "ignored": true
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "currency": "EUR",
  "name": "Beispiel",
  "payment_bic": "BYLADEM1001",
  "payment_iban": "DE02120300000000202051",
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "ignored": true,
  "linked": true,
  "auto_linked": true,
  "is_duplicate": true,
  "incoming": true
}

Get a single ImportedPaymentTransaction

GET/api/invoice/imported_payment_transaction/{identifier}

Path parameters

identifierrequiredstring

Responses

200Get a single ImportedPaymentTransactionImportedPaymentTransaction2

Show fields (14)

companyCRMCompany23
Show fields (62)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- 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.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
ignoredboolean
The transaction is ignored in the matching.
linkedboolean
The transaction is linked to a document.
auto_linkedboolean
The transaction was linked automatically.
is_duplicateboolean
The transaction is a duplicate of an earlier import.
incomingboolean
The transaction is incoming money.
currencystring
Currency of the transaction, for example EUR.
brutto_valuenumber (float)
Gross amount of the transaction.
linked_sepa_payment_transactionSepaPaymentTransaction2
SEPA transaction the import is linked to.
Show fields (17)
- companyCRMCompany23
- 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.
- 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
linked_payment_transactionPaymentTransaction3
Payment transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_fee_payment_transactionPaymentTransaction3
Fee transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_invoiceInvoice20
Invoice the import is linked to.
Show fields (39)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- accounting_typeAccountingTyperequired
  Accounting type of the invoice.
- payment_typePaymentType
  Payment type of the invoice.
- payment_goalPaymentGoal
  Payment term of the invoice.
- expense_categoryExpenseCategory10
  EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
- buyerInvoiceBuyer19
  Buyer of the invoice.
- payment_datestring (date-time)
  Date the invoice was paid.
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
- is_payment_date_from_ext_serviceboolean
  The payment date comes from an external service.
- direct_debit_exportedboolean
  The invoice was exported for direct debit.
- cancel_datestring (date-time)
  Date the invoice was canceled.
- cancel_textstring
  Text of the cancellation.
- start_datestring (date-time)
  Start of the billed period.
- end_datestring (date-time)
  End of the billed period.
- billing_payment_profileBillingPaymentProfile10
linked_incoming_invoiceIncomingInvoice4
Incoming invoice the import is linked to.
Show fields (34)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- companyCRMCompany23
- external_invoice_numberstring
  Externe Rechnungsnummer des Lieferanten
- received_datestring (date-time)
  Eingangsdatum (wann wurde die Rechnung empfangen)
- payment_datestring (date-time)
  Zahlungsdatum
- service_date_startstring (date-time)
  Leistungszeitraum Start
- service_date_endstring (date-time)
  Leistungszeitraum Ende
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Auf der Eingangsseite entscheidet er darüber, ob die Vorsteuer unter Kennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61 (innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder unter 67 (§ 13b UStG). Beim Erwerb und bei § 13b kommt eine zweite Zeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand berechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im Vordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig. Ohne Angabe der Regelfall.
- vat_self_assessed_ratenumber (float)
  Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist. Beim innergemeinschaftlichen Erwerb und bei § 13b UStG berechnet der Lieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden wir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist der Satz, der im Inland auf diese Leistung anzuwenden wäre. Ohne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den Hinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu raten wäre in einer Steueranmeldung das Falsche.
- … 11 more fields
… 15 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42 \
  --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/imported_payment_transaction/42', 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/imported_payment_transaction/42"

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/imported_payment_transaction/42', [
  '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/imported_payment_transaction/42"),
  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/imported_payment_transaction/42")
  .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/imported_payment_transaction/42"

	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_imported_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 BillingImportedPaymentTransactionController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "currency": "EUR",
  "name": "Beispiel",
  "payment_bic": "BYLADEM1001",
  "payment_iban": "DE02120300000000202051",
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "ignored": true,
  "linked": true,
  "auto_linked": true,
  "is_duplicate": true,
  "incoming": true
}

Update a ImportedPaymentTransaction

PUT/api/invoice/imported_payment_transaction/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataImportedPaymentTransaction2
Show fields (28)
- companyCRMCompany23
- ignoredboolean
  The transaction is ignored in the matching.
- linkedboolean
  The transaction is linked to a document.
- auto_linkedboolean
  The transaction was linked automatically.
- is_duplicateboolean
  The transaction is a duplicate of an earlier import.
- incomingboolean
  The transaction is incoming money.
- currencystring
  Currency of the transaction, for example EUR.
- brutto_valuenumber (float)
  Gross amount of the transaction.
- linked_sepa_payment_transactionSepaPaymentTransaction2
  SEPA transaction the import is linked to.
- linked_payment_transactionPaymentTransaction3
  Payment transaction the import is linked to.
- linked_fee_payment_transactionPaymentTransaction3
  Fee transaction the import is linked to.
- linked_invoiceInvoice20
  Invoice the import is linked to.
- linked_incoming_invoiceIncomingInvoice4
  Incoming invoice the import is linked to.
- linked_incoming_invoice_transactionIncomingInvoiceTransaction2
  Incoming invoice transaction the import is linked to.
- linked_donationDonation
  Donation the import is linked to.
- transaction_groupImportedPaymentTransactionGroup2
  Group the transaction belongs to.
- 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

Responses

200Update a ImportedPaymentTransactionImportedPaymentTransaction2

Show fields (14)

companyCRMCompany23
Show fields (62)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- 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.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
ignoredboolean
The transaction is ignored in the matching.
linkedboolean
The transaction is linked to a document.
auto_linkedboolean
The transaction was linked automatically.
is_duplicateboolean
The transaction is a duplicate of an earlier import.
incomingboolean
The transaction is incoming money.
currencystring
Currency of the transaction, for example EUR.
brutto_valuenumber (float)
Gross amount of the transaction.
linked_sepa_payment_transactionSepaPaymentTransaction2
SEPA transaction the import is linked to.
Show fields (17)
- companyCRMCompany23
- 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.
- 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
linked_payment_transactionPaymentTransaction3
Payment transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_fee_payment_transactionPaymentTransaction3
Fee transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_invoiceInvoice20
Invoice the import is linked to.
Show fields (39)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- accounting_typeAccountingTyperequired
  Accounting type of the invoice.
- payment_typePaymentType
  Payment type of the invoice.
- payment_goalPaymentGoal
  Payment term of the invoice.
- expense_categoryExpenseCategory10
  EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
- buyerInvoiceBuyer19
  Buyer of the invoice.
- payment_datestring (date-time)
  Date the invoice was paid.
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
- is_payment_date_from_ext_serviceboolean
  The payment date comes from an external service.
- direct_debit_exportedboolean
  The invoice was exported for direct debit.
- cancel_datestring (date-time)
  Date the invoice was canceled.
- cancel_textstring
  Text of the cancellation.
- start_datestring (date-time)
  Start of the billed period.
- end_datestring (date-time)
  End of the billed period.
- billing_payment_profileBillingPaymentProfile10
linked_incoming_invoiceIncomingInvoice4
Incoming invoice the import is linked to.
Show fields (34)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- companyCRMCompany23
- external_invoice_numberstring
  Externe Rechnungsnummer des Lieferanten
- received_datestring (date-time)
  Eingangsdatum (wann wurde die Rechnung empfangen)
- payment_datestring (date-time)
  Zahlungsdatum
- service_date_startstring (date-time)
  Leistungszeitraum Start
- service_date_endstring (date-time)
  Leistungszeitraum Ende
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Auf der Eingangsseite entscheidet er darüber, ob die Vorsteuer unter Kennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61 (innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder unter 67 (§ 13b UStG). Beim Erwerb und bei § 13b kommt eine zweite Zeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand berechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im Vordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig. Ohne Angabe der Regelfall.
- vat_self_assessed_ratenumber (float)
  Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist. Beim innergemeinschaftlichen Erwerb und bei § 13b UStG berechnet der Lieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden wir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist der Satz, der im Inland auf diese Leistung anzuwenden wäre. Ohne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den Hinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu raten wäre in einer Steueranmeldung das Falsche.
- … 11 more fields
… 15 more fields

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "currency": "EUR",
    "name": "Beispiel",
    "payment_bic": "BYLADEM1001",
    "payment_iban": "DE02120300000000202051",
    "company": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "secondary_name": "Beispiel",
      "invoice_email": "lena.hartmann@example.org",
      "send_invoice_email": true
    },
    "ignored": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      currency: 'EUR',
      name: 'Beispiel',
      payment_bic: 'BYLADEM1001',
      payment_iban: 'DE02120300000000202051',
      company: {
        id: 42,
        short_name: 'Beispiel',
        company_name: 'Beispiel',
        secondary_name: 'Beispiel',
        invoice_email: 'lena.hartmann@example.org',
        send_invoice_email: true
      },
      ignored: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42', 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/imported_payment_transaction/42"

payload = { "data": {
    "currency": "EUR",
    "name": "Beispiel",
    "payment_bic": "BYLADEM1001",
    "payment_iban": "DE02120300000000202051",
    "company": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "secondary_name": "Beispiel",
      "invoice_email": "lena.hartmann@example.org",
      "send_invoice_email": True
    },
    "ignored": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42', [
  'body' => '{"data":{"currency":"EUR","name":"Beispiel","payment_bic":"BYLADEM1001","payment_iban":"DE02120300000000202051","company":{"id":42,"short_name":"Beispiel","company_name":"Beispiel","secondary_name":"Beispiel","invoice_email":"lena.hartmann@example.org","send_invoice_email":true},"ignored":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"currency\":\"EUR\",\"name\":\"Beispiel\",\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"company\":{\"id\":42,\"short_name\":\"Beispiel\",\"company_name\":\"Beispiel\",\"secondary_name\":\"Beispiel\",\"invoice_email\":\"lena.hartmann@example.org\",\"send_invoice_email\":true},\"ignored\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"currency\":\"EUR\",\"name\":\"Beispiel\",\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"company\":{\"id\":42,\"short_name\":\"Beispiel\",\"company_name\":\"Beispiel\",\"secondary_name\":\"Beispiel\",\"invoice_email\":\"lena.hartmann@example.org\",\"send_invoice_email\":true},\"ignored\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

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

package main

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

func main() {

	url := "https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42"

	payload := strings.NewReader("{\"data\":{\"currency\":\"EUR\",\"name\":\"Beispiel\",\"payment_bic\":\"BYLADEM1001\",\"payment_iban\":\"DE02120300000000202051\",\"company\":{\"id\":42,\"short_name\":\"Beispiel\",\"company_name\":\"Beispiel\",\"secondary_name\":\"Beispiel\",\"invoice_email\":\"lena.hartmann@example.org\",\"send_invoice_email\":true},\"ignored\":true}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	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_imported_payment_transaction_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/imported_payment_transaction.dart';

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

final result = await BillingImportedPaymentTransactionController.put(ImportedPaymentTransaction.fromJson({
  "currency": "EUR",
  "name": "Beispiel",
  "payment_bic": "BYLADEM1001",
  "payment_iban": "DE02120300000000202051",
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true
  },
  "ignored": true
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "currency": "EUR",
  "name": "Beispiel",
  "payment_bic": "BYLADEM1001",
  "payment_iban": "DE02120300000000202051",
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "ignored": true,
  "linked": true,
  "auto_linked": true,
  "is_duplicate": true,
  "incoming": true
}

Unlink an ImportedPaymentTransaction so the amount can be re-assigned.

POST/api/invoice/imported_payment_transaction/{identifier}/unlink

Reverts auto-generated payment transactions, re-opens linked invoices and restores consumed SEPA transactions. Query params: keep_company (bool, default false) keeps the linked company, relink (bool, default false) lets the auto-link process pick the transaction up again, mode ("revert" default, or "storno" to neutralize with counter bookings instead of deleting - required for transactions already exported to the accounting software or in closed periods).

Path parameters

identifierrequiredstring

Responses

200Unlink an ImportedPaymentTransaction so the amount can be re-assignedImportedPaymentTransaction2

Show fields (14)

companyCRMCompany23
Show fields (62)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- 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.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
ignoredboolean
The transaction is ignored in the matching.
linkedboolean
The transaction is linked to a document.
auto_linkedboolean
The transaction was linked automatically.
is_duplicateboolean
The transaction is a duplicate of an earlier import.
incomingboolean
The transaction is incoming money.
currencystring
Currency of the transaction, for example EUR.
brutto_valuenumber (float)
Gross amount of the transaction.
linked_sepa_payment_transactionSepaPaymentTransaction2
SEPA transaction the import is linked to.
Show fields (17)
- companyCRMCompany23
- 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.
- 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
linked_payment_transactionPaymentTransaction3
Payment transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_fee_payment_transactionPaymentTransaction3
Fee transaction the import is linked to.
Show fields (18)
- companyCRMCompany23
- autoboolean
  The transaction was created automatically.
- incomingboolean
  The transaction is incoming money.
- bank_transactionboolean
  The transaction comes from a bank account.
- currencystring
  Currency of the transaction, for example EUR.
- payment_typePaymentType
  Payment type of the transaction.
- invoicesarray<Invoice20>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- unified_categoryUnifiedCategory37
  Category the transaction belongs to.
- personCRMPerson10
  Person the transaction belongs to.
- is_feeboolean
  The transaction is a fee, for example a bank fee.
- due_datestring (date-time)
  This is used for negative transactions to exclude them from potential bill reminders until they are due.
- cash_discountboolean
  Skonto: dieser Teil der Forderung erlischt durch Abzug, nicht durch Zahlung. Kein Geldeingang - Ist-Versteuerung und Mindest-Ist zählen ihn nicht; bei Sollversteuerung mindert er die Bemessungsgrundlage im Zeitraum des Abzugs (§ 17 Abs. 1 UStG).
- 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.
- billing_payment_profileBillingPaymentProfile10
linked_invoiceInvoice20
Invoice the import is linked to.
Show fields (39)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- accounting_typeAccountingTyperequired
  Accounting type of the invoice.
- payment_typePaymentType
  Payment type of the invoice.
- payment_goalPaymentGoal
  Payment term of the invoice.
- expense_categoryExpenseCategory10
  EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
- buyerInvoiceBuyer19
  Buyer of the invoice.
- payment_datestring (date-time)
  Date the invoice was paid.
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
- is_payment_date_from_ext_serviceboolean
  The payment date comes from an external service.
- direct_debit_exportedboolean
  The invoice was exported for direct debit.
- cancel_datestring (date-time)
  Date the invoice was canceled.
- cancel_textstring
  Text of the cancellation.
- start_datestring (date-time)
  Start of the billed period.
- end_datestring (date-time)
  End of the billed period.
- billing_payment_profileBillingPaymentProfile10
linked_incoming_invoiceIncomingInvoice4
Incoming invoice the import is linked to.
Show fields (34)
- idinteger
  Primary key of the invoice document. Internal ID.
- tokenstring
  Token that identifies the document for public access.
- numberinteger
  Running document number.
- manual_number_prefixstring
  Prefix of a manually entered document number.
- manual_numberinteger
  Manually entered document number.
- number_stringstring
  Document number as displayed to users.
- generation_datestring (date-time)
  Date the document was generated.
- number_datestring (date-time)
  Date used for the document number.
- messagestring
  Message printed on the document.
- currencystring
  Currency of the document.
- namestring
  Name of the document.
- due_datestring (date-time)
  Due date of the document.
- netto_valuenumber (float)
  Net total of the document.
- brutto_valuenumber (float)
  Gross total of the document.
- tax_valuenumber (float)
  Total tax amount of the document.
- taxTaxrequired
  Tax rate applied to the document.
- linked_number_titlestring
  Title of the linked document number.
- linked_numberstring
  Number of the linked document.
- statusstring
  Status of the document.
- previous_statusstring
  Status before the last change.
- status_updatedstring (date-time)
  Point in time the status was last changed.
- archivedboolean
  Whether the document is archived.
- last_pdf_exportstring (date-time)
  Point in time the PDF was last exported.
- last_status_exportstring
  Status at the last export.
- search_stringstring
  Text that the entity can be searched by.
- companyCRMCompany23
- external_invoice_numberstring
  Externe Rechnungsnummer des Lieferanten
- received_datestring (date-time)
  Eingangsdatum (wann wurde die Rechnung empfangen)
- payment_datestring (date-time)
  Zahlungsdatum
- service_date_startstring (date-time)
  Leistungszeitraum Start
- service_date_endstring (date-time)
  Leistungszeitraum Ende
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Auf der Eingangsseite entscheidet er darüber, ob die Vorsteuer unter Kennzahl 66 steht (Rechnung eines anderen Unternehmers), unter 61 (innergemeinschaftlicher Erwerb), unter 62 (Einfuhrumsatzsteuer) oder unter 67 (§ 13b UStG). Beim Erwerb und bei § 13b kommt eine zweite Zeile hinzu: die Steuer schulden wir selbst, obwohl sie uns niemand berechnet hat, und sie steht deshalb zugleich als Umsatzsteuer im Vordruck. Wer nur eine der beiden bucht, zahlt zu viel oder zu wenig. Ohne Angabe der Regelfall.
- vat_self_assessed_ratenumber (float)
  Der Steuersatz, mit dem die selbst geschuldete Steuer zu rechnen ist. Beim innergemeinschaftlichen Erwerb und bei § 13b UStG berechnet der Lieferant keine Steuer - die Rechnung ist netto, und die Steuer schulden wir. Womit sie zu rechnen ist, steht deshalb auf keinem Beleg: es ist der Satz, der im Inland auf diese Leistung anzuwenden wäre. Ohne Angabe rechnet die Voranmeldung mit dem Regelsatz und sagt in den Hinweisen, bei wie vielen Belegen sie das getan hat. Stillschweigend zu raten wäre in einer Steueranmeldung das Falsche.
- … 11 more fields
… 15 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42/unlink \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42/unlink', 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/imported_payment_transaction/42/unlink"

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42/unlink', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/invoice/imported_payment_transaction/42/unlink"),
  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/imported_payment_transaction/42/unlink")
  .post(null)
  .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/imported_payment_transaction/42/unlink"

	req, _ := http.NewRequest("POST", 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_imported_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 BillingImportedPaymentTransactionController.unlink(42);
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "currency": "EUR",
  "name": "Beispiel",
  "payment_bic": "BYLADEM1001",
  "payment_iban": "DE02120300000000202051",
  "company": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "ignored": true,
  "linked": true,
  "auto_linked": true,
  "is_duplicate": true,
  "incoming": true
}