IncomingInvoice

Accounting11 EndpointsBilling / IncomingInvoice

Returns a list of all IncomingInvoice

GET/api/invoice/incoming_invoice

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 IncomingInvoicearray<IncomingInvoice>

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

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

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

	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/incoming_invoice_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 IncomingInvoiceController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "tax": {
      "name": "Beispiel",
      "id": 42,
      "value": 1.5,
      "deleted": true,
      "global_default": true,
      "datev_tax_key": 1
    },
    "id": 42,
    "currency": "EUR",
    "name": "Beispiel",
    "linked_number_title": "Beispiel",
    "token": "string",
    "number": 1,
    "manual_number_prefix": "string",
    "manual_number": 1,
    "number_string": "string"
  }
]

Import an IncomingInvoice from file upload (ZUGFeRD PDF/XML or regular PDF)

POST/api/invoice/incoming_invoice

Request body multipart/form-data

data[file]string (binary)
Invoice file (PDF or XML)

Responses

200Import IncomingInvoice from fileIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/incoming_invoice \
  --header 'content-type: multipart/form-data' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --form data[file]='@datei.pdf'

const form = new FormData();
form.append('data[file]', 'datei.pdf');

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

options.body = form;

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

files = { "data[file]": ("datei.pdf", open("datei.pdf", "rb"), "application/pdf") }
headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.post(url, files=files, 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/incoming_invoice', [
  'multipart' => [
    [
        'name' => 'data[file]',
        'filename' => 'datei.pdf',
        'contents' => null,
        'headers' => [
                'Content-Type' => 'application/pdf'
        ]
    ]
  ]
  '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/incoming_invoice"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new MultipartFormDataContent
  {
    new StringContent("")
    {
      Headers =
      {
        ContentType = new MediaTypeHeaderValue("application/pdf"),
        ContentDisposition = new ContentDispositionHeaderValue("form-data")
        {
          Name = "data[file]",
          FileName = "datei.pdf",
        }
      }
    },
  },
};
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("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[file]\"; filename=\"datei.pdf\"\r\nContent-Type: application/pdf\r\n\r\n\r\n-----011000010111000001101001--");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/incoming_invoice")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .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/incoming_invoice"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[file]\"; filename=\"datei.pdf\"\r\nContent-Type: application/pdf\r\n\r\n\r\n-----011000010111000001101001--")

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

	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/incoming_invoice_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 IncomingInvoiceController.postFile(Stream<List<int>>.fromJson({}), 42, '…');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Get a single IncomingInvoice

GET/api/invoice/incoming_invoice/{identifier}

Path parameters

identifierrequiredstring

Responses

200Get a single IncomingInvoiceIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/invoice/incoming_invoice/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/incoming_invoice/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/incoming_invoice/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/incoming_invoice/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/incoming_invoice/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/incoming_invoice/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/incoming_invoice/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/incoming_invoice_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 IncomingInvoiceController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Update an IncomingInvoice

PUT/api/invoice/incoming_invoice/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataIncomingInvoice
Show fields (46)
- 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.
- 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.
- import_vat_amountstring
  Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
- paid_valuenumber (float)
  Bereits bezahlter Betrag (für Teilzahlungen)
- itemsarray<IncomingInvoiceItem>
  Rechnungspositionen
- sellerIncomingInvoiceSeller
  Verkäufer/Lieferant Informationen (Snapshot)
- expense_categoryExpenseCategory10
  Hauptkategorie für EÜR
- payment_transactionsarray<PaymentTransaction4>
  Verknüpfte Zahlungstransaktionen
- incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
  Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
- document_pathstring
  Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
- document_filenamestring
  Original Dateiname
- document_mime_typestring
  MIME Type des Dokuments
- notesstring
  Notizen/Bemerkungen
- is_deductibleboolean
  Ist die Rechnung für den Vorsteuerabzug relevant?
- is_approvedboolean
  Wurde die Rechnung geprüft/freigegeben?
- approved_atstring (date-time)
  Time the incoming invoice was approved.

Responses

200Update an IncomingInvoiceIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/invoice/incoming_invoice/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "tax": {
      "name": "Beispiel",
      "id": 42,
      "value": 1.5,
      "deleted": true,
      "global_default": true,
      "datev_tax_key": 1
    },
    "id": 42,
    "currency": "EUR",
    "name": "Beispiel",
    "linked_number_title": "Beispiel",
    "token": "string"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      tax: {
        name: 'Beispiel',
        id: 42,
        value: 1.5,
        deleted: true,
        global_default: true,
        datev_tax_key: 1
      },
      id: 42,
      currency: 'EUR',
      name: 'Beispiel',
      linked_number_title: 'Beispiel',
      token: 'string'
    }
  })
};

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

payload = { "data": {
    "tax": {
      "name": "Beispiel",
      "id": 42,
      "value": 1.5,
      "deleted": True,
      "global_default": True,
      "datev_tax_key": 1
    },
    "id": 42,
    "currency": "EUR",
    "name": "Beispiel",
    "linked_number_title": "Beispiel",
    "token": "string"
  } }
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/incoming_invoice/42', [
  'body' => '{"data":{"tax":{"name":"Beispiel","id":42,"value":1.5,"deleted":true,"global_default":true,"datev_tax_key":1},"id":42,"currency":"EUR","name":"Beispiel","linked_number_title":"Beispiel","token":"string"}}',
  '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/incoming_invoice/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"tax\":{\"name\":\"Beispiel\",\"id\":42,\"value\":1.5,\"deleted\":true,\"global_default\":true,\"datev_tax_key\":1},\"id\":42,\"currency\":\"EUR\",\"name\":\"Beispiel\",\"linked_number_title\":\"Beispiel\",\"token\":\"string\"}}")
  {
    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\":{\"tax\":{\"name\":\"Beispiel\",\"id\":42,\"value\":1.5,\"deleted\":true,\"global_default\":true,\"datev_tax_key\":1},\"id\":42,\"currency\":\"EUR\",\"name\":\"Beispiel\",\"linked_number_title\":\"Beispiel\",\"token\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/incoming_invoice/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/incoming_invoice/42"

	payload := strings.NewReader("{\"data\":{\"tax\":{\"name\":\"Beispiel\",\"id\":42,\"value\":1.5,\"deleted\":true,\"global_default\":true,\"datev_tax_key\":1},\"id\":42,\"currency\":\"EUR\",\"name\":\"Beispiel\",\"linked_number_title\":\"Beispiel\",\"token\":\"string\"}}")

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

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

final result = await IncomingInvoiceController.put(IncomingInvoice.fromJson({
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string"
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Delete an IncomingInvoice (soft delete - archive)

DELETE/api/invoice/incoming_invoice/{identifier}

Path parameters

identifierrequiredstring

Responses

200Delete an IncomingInvoiceIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

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

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

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

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

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

print(response.text)

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

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/invoice/incoming_invoice/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.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/invoice/incoming_invoice/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/incoming_invoice/42")
  .delete(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/incoming_invoice/42"

	req, _ := http.NewRequest("DELETE", 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/incoming_invoice_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 IncomingInvoiceController.delete('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Import all PDF/XML invoices from a ZIP archive.

POST/api/invoice/incoming_invoice/archive

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

200Import IncomingInvoices from a ZIP archivearray<IncomingInvoice>

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

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

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/incoming_invoice/archive', [
  '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/incoming_invoice/archive"),
  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/incoming_invoice/archive")
  .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/incoming_invoice/archive"

	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/incoming_invoice_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 IncomingInvoiceController.postArchive(Stream<List<int>>.fromJson({}), 42, '…');
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "tax": {
      "name": "Beispiel",
      "id": 42,
      "value": 1.5,
      "deleted": true,
      "global_default": true,
      "datev_tax_key": 1
    },
    "id": 42,
    "currency": "EUR",
    "name": "Beispiel",
    "linked_number_title": "Beispiel",
    "token": "string",
    "number": 1,
    "manual_number_prefix": "string",
    "manual_number": 1,
    "number_string": "string"
  }
]

Mark an IncomingInvoice as approved

POST/api/invoice/incoming_invoice/{identifier}/approve

Path parameters

identifierrequiredstring

Responses

200Approve an IncomingInvoiceIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

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

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

	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/incoming_invoice_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 IncomingInvoiceController.approve('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Ask the AI decision model for a booking suggestion (expense category, VAT case).

POST/api/invoice/incoming_invoice/{identifier}/ai_category

Opt-in (inwendo_invoice_ai_expense_category_enabled). The category is only pre-filled when the invoice has none and the probability reaches the threshold; the VAT case stays a hint. Nothing is approved or posted.

Path parameters

identifierrequiredstring

Responses

200AI booking suggestion for an IncomingInvoiceIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

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

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

	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/incoming_invoice_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 IncomingInvoiceController.aiCategory('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Mark an IncomingInvoice as paid

POST/api/invoice/incoming_invoice/{identifier}/paid

Path parameters

identifierrequiredstring

Request body application/json

dataobject
Show fields (2)
- paidValuenumber
  Defaults to the invoice total
- paymentDatestring
  Defaults to today

Responses

200Mark IncomingInvoice as paidIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/incoming_invoice/42/paid \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "paidValue": 119,
    "paymentDate": "2026-07-30"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {paidValue: 119, paymentDate: '2026-07-30'}})
};

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

payload = { "data": {
    "paidValue": 119,
    "paymentDate": "2026-07-30"
  } }
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/incoming_invoice/42/paid', [
  'body' => '{"data":{"paidValue":119,"paymentDate":"2026-07-30"}}',
  '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/incoming_invoice/42/paid"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"paidValue\":119,\"paymentDate\":\"2026-07-30\"}}")
  {
    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\":{\"paidValue\":119,\"paymentDate\":\"2026-07-30\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/incoming_invoice/42/paid")
  .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/incoming_invoice/42/paid"

	payload := strings.NewReader("{\"data\":{\"paidValue\":119,\"paymentDate\":\"2026-07-30\"}}")

	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/incoming_invoice_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 IncomingInvoiceController.markAsPaid('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Push an IncomingInvoice to BuchhaltungsButler (manual transfer / re-transfer)

POST/api/invoice/incoming_invoice/{identifier}/buchhaltungsbutler_push

Path parameters

identifierrequiredstring

Responses

200Push an IncomingInvoice to BuchhaltungsButlerIncomingInvoice

Show fields (46)

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.
Show fields (6)
- idinteger
  Primary key of the tax rate. Internal ID.
- namestringrequired
  Name of the tax rate, for example 19 percent.
- valuenumber (float)
  Tax rate in percent.
- deletedboolean
  The tax rate is deleted.
- global_defaultboolean
  Default tax rate for new items.
- datev_tax_keyinteger
  DATEV Steuerschlüssel für Umsatzsteuer (Ausgangsrechnungen). Wird von BuchhaltungsButler und DATEV-Export genutzt. Standardwerte: 0 = Kein Steuerausweis (0%) 2 = Umsatzsteuer 7% (ermäßigt) 3 = Umsatzsteuer 19% (Regelsteuersatz) Für Vorsteuer (Eingangsrechnungen) gibt es eine spiegelbildliche Zuordnung: 0 = Keine Vorsteuer (0%) 5 = Vorsteuer 7% 8 = Vorsteuer 19%
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.
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.
import_vat_amountstring
Die Einfuhrumsatzsteuer aus dem Zollbescheid. Sie steht NICHT auf der Rechnung des Lieferanten - die ist bei einer Einfuhr ohne deutsche Steuer. Entrichtet wird sie an den Zoll, und nur der entrichtete Betrag ist als Vorsteuer abziehbar (§ 15 Abs. 1 Satz 1 Nr. 2 UStG, Kennzahl 62 der Voranmeldung). Den Steuerbetrag der Lieferantenrechnung dafür zu nehmen war schlicht der falsche Beleg.
paid_valuenumber (float)
Bereits bezahlter Betrag (für Teilzahlungen)
itemsarray<IncomingInvoiceItem>
Rechnungspositionen
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- expense_categoryExpenseCategory10
  Kostenkategorie für EÜR (kann von der Hauptkategorie der Rechnung abweichen)
- positioninteger
  Position/Reihenfolge
sellerIncomingInvoiceSeller
Verkäufer/Lieferant Informationen (Snapshot)
Show fields (25)
- idinteger
  Primary key of the client. Internal ID.
- namestring
  Name of the client on the invoice.
- vat_idstring
  VAT ID of the client.
- taxnumberstring
  Tax number of the client.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- secondary_namestring
  Second name line of the client on the invoice.
- 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
- numberstring
  Customer number of the buyer.
- search_stringstring
  Text that the entity can be searched by.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
expense_categoryExpenseCategory10
Hauptkategorie für EÜR
Show fields (19)
- idinteger
  Primary key of the expense category. Internal ID.
- codestring
  Kurzbezeichnung/Code (z.B. "WAREN", "PERSONAL", "MIETE")
- eur_line_numberinteger
  Zeile in der Anlage EÜR (z.B. 23 für Wareneinkauf)
- eur_line_namestring
  Bezeichnung der EÜR-Zeile (z.B. "Waren, Rohstoffe und Hilfsstoffe")
- category_typestring
  Typ der Kategorie (expense, income, neutral, asset, private)
- default_taxTax
  Standard-Steuersatz für diese Kategorie
- cost_centerCostCenter
  Kostenstelle der Kategorie - bei Vereinen die steuerliche Sphäre. Ein Beleg trägt keine eigene Sphäre; über seine Kategorie bekommt er eine. Die EÜR des wirtschaftlichen Geschäftsbetriebs liest sie (billing_euer_commercial_sphere_only), die automatische Buchung setzt sie auf die Buchungszeilen (billing_accounting_cost_center_from_category).
- is_vat_deductibleboolean
  Ist Vorsteuerabzug möglich?
- is_immediate_deductionboolean
  Ist die Kategorie sofort abzugsfähig? (vs. Abschreibung über mehrere Jahre)
- depreciation_yearsinteger
  Abschreibungsdauer in Jahren (für Anlagevermögen)
- sort_orderinteger
  Sortierreihenfolge
- is_activeboolean
  Ist die Kategorie aktiv/sichtbar?
- colorstring
  Farbe für UI-Darstellung (Hex-Code)
- iconstring
  Icon-Name für UI-Darstellung
- is_systemboolean
  Ist dies eine System-Kategorie? (nicht löschbar)
- 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_transactionsarray<PaymentTransaction4>
Verknüpfte Zahlungstransaktionen
Show fields (14)
- 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<Invoice31>
- brutto_valuenumber (float)
  Gross amount of the transaction.
- 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.
incoming_invoice_transactionsarray<IncomingInvoiceTransaction2>
Spezialisierte Zahlungen, die nur dieser Eingangsrechnung zugeordnet sind.
Show fields (5)
- amountnumber (float)
  Positiver Betrag dieser konkreten Zahlung.
- payment_datestring (date-time)
  Date of the payment.
- currencystring
  Currency of the payment.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
document_pathstring
Pfad zur gespeicherten Rechnungsdatei (PDF/Bild)
document_filenamestring
Original Dateiname
document_mime_typestring
MIME Type des Dokuments
notesstring
Notizen/Bemerkungen
is_deductibleboolean
Ist die Rechnung für den Vorsteuerabzug relevant?
is_approvedboolean
Wurde die Rechnung geprüft/freigegeben?
approved_atstring (date-time)
Time the incoming invoice was approved.

Request

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

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

	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 package:http (no controller in the iw_erp_api package)

import 'package:http/http.dart' as http;

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/invoice/incoming_invoice/42/buchhaltungsbutler_push'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string",
  "manual_number": 1,
  "number_string": "string"
}

Download the document file of an IncomingInvoice

GET/api/invoice/incoming_invoice/{identifier}/document

Path parameters

identifierrequiredstring

Responses

200Returns the document file

Request

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

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

	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/incoming_invoice_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 IncomingInvoiceController.getDocumentDownloadLink('42');
print(result);