Invoice

Billing23 EndpointsBilling / Invoice

This method will get all Invoice Objects

GET/api/invoice/invoices

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 Invoice objectsarray<Invoice>

Show fields (38)

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.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
buyerInvoiceBuyer
Buyer of the invoice.
Show fields (22)
- 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.
- invoiceInvoice
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
start_datestring (date-time)
Start of the billed period.
end_datestring (date-time)
End of the billed period.

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.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
    },
    "accounting_type": {
      "name": "Beispiel",
      "type": "string",
      "id": 42,
      "cancelled_name": "Beispiel",
      "deleted": true
    },
    "id": 42,
    "currency": "EUR",
    "name": "Beispiel",
    "linked_number_title": "Beispiel",
    "cancel_text": "Text",
    "token": "string",
    "number": 1,
    "manual_number_prefix": "string"
  }
]

Creates a single Invoice

POST/api/invoice/invoices

Request body application/json

invoiceInvoice2
Show fields (9)
- accounting_typeAccountingTyperequired
  Accounting type of the invoice.
- payment_typePaymentType6
  Payment type of the invoice.
- payment_goalPaymentGoal
  Payment term of the invoice.
- itemsarray<InvoiceItem2>
  Items of the invoice.
- buyerInvoiceBuyer2
  Buyer of the invoice.
- vat_categorystring
  Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
- start_datestring (date-time)
  Start of the billed period.
- end_datestring (date-time)
  End of the billed period.
- billing_payment_profileBillingPaymentProfile9

Responses

200Creates a single InvoiceInvoice3

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem3>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice3
  Invoice the item belongs to.
- project_itemCRMProjectItem8
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem15
  Product of the item.
buyerInvoiceBuyer3
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice3
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer9
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem8>
  Items of the offer.
- buyerOfferBuyer8
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject17
  Project the offer belongs to.
- invoicesarray<Invoice3>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport4>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject17
  Project the time report belongs to.
- invoiceInvoice3
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 8 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/invoices \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "invoice": {
    "accounting_type": {
      "name": "Beispiel",
      "type": "string",
      "id": 42,
      "cancelled_name": "Beispiel",
      "deleted": true
    },
    "payment_type": {
      "deleted": true
    },
    "payment_goal": {
      "id": 42,
      "name": "Beispiel",
      "date_string": "string",
      "deleted": true,
      "global_default": true
    },
    "buyer": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "payment_bic": "BYLADEM1001"
    },
    "vat_category": "string",
    "start_date": "2026-10-15T09:30:00+02:00"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    invoice: {
      accounting_type: {
        name: 'Beispiel',
        type: 'string',
        id: 42,
        cancelled_name: 'Beispiel',
        deleted: true
      },
      payment_type: {deleted: true},
      payment_goal: {
        id: 42,
        name: 'Beispiel',
        date_string: 'string',
        deleted: true,
        global_default: true
      },
      buyer: {
        address_street: 'Jakobistr. 39',
        address_city: 'Hannover',
        address_zip: '30163',
        address_country: 'DE',
        address_full_country: 'DE',
        payment_bic: 'BYLADEM1001'
      },
      vat_category: 'string',
      start_date: '2026-10-15T09:30:00+02:00'
    }
  })
};

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

payload = { "invoice": {
    "accounting_type": {
      "name": "Beispiel",
      "type": "string",
      "id": 42,
      "cancelled_name": "Beispiel",
      "deleted": True
    },
    "payment_type": { "deleted": True },
    "payment_goal": {
      "id": 42,
      "name": "Beispiel",
      "date_string": "string",
      "deleted": True,
      "global_default": True
    },
    "buyer": {
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "payment_bic": "BYLADEM1001"
    },
    "vat_category": "string",
    "start_date": "2026-10-15T09:30:00+02:00"
  } }
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/invoices', [
  'body' => '{"invoice":{"accounting_type":{"name":"Beispiel","type":"string","id":42,"cancelled_name":"Beispiel","deleted":true},"payment_type":{"deleted":true},"payment_goal":{"id":42,"name":"Beispiel","date_string":"string","deleted":true,"global_default":true},"buyer":{"address_street":"Jakobistr. 39","address_city":"Hannover","address_zip":"30163","address_country":"DE","address_full_country":"DE","payment_bic":"BYLADEM1001"},"vat_category":"string","start_date":"2026-10-15T09:30:00+02:00"}}',
  '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/invoices"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"invoice\":{\"accounting_type\":{\"name\":\"Beispiel\",\"type\":\"string\",\"id\":42,\"cancelled_name\":\"Beispiel\",\"deleted\":true},\"payment_type\":{\"deleted\":true},\"payment_goal\":{\"id\":42,\"name\":\"Beispiel\",\"date_string\":\"string\",\"deleted\":true,\"global_default\":true},\"buyer\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"payment_bic\":\"BYLADEM1001\"},\"vat_category\":\"string\",\"start_date\":\"2026-10-15T09:30:00+02:00\"}}")
  {
    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, "{\"invoice\":{\"accounting_type\":{\"name\":\"Beispiel\",\"type\":\"string\",\"id\":42,\"cancelled_name\":\"Beispiel\",\"deleted\":true},\"payment_type\":{\"deleted\":true},\"payment_goal\":{\"id\":42,\"name\":\"Beispiel\",\"date_string\":\"string\",\"deleted\":true,\"global_default\":true},\"buyer\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"payment_bic\":\"BYLADEM1001\"},\"vat_category\":\"string\",\"start_date\":\"2026-10-15T09:30:00+02:00\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/invoices")
  .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/invoices"

	payload := strings.NewReader("{\"invoice\":{\"accounting_type\":{\"name\":\"Beispiel\",\"type\":\"string\",\"id\":42,\"cancelled_name\":\"Beispiel\",\"deleted\":true},\"payment_type\":{\"deleted\":true},\"payment_goal\":{\"id\":42,\"name\":\"Beispiel\",\"date_string\":\"string\",\"deleted\":true,\"global_default\":true},\"buyer\":{\"address_street\":\"Jakobistr. 39\",\"address_city\":\"Hannover\",\"address_zip\":\"30163\",\"address_country\":\"DE\",\"address_full_country\":\"DE\",\"payment_bic\":\"BYLADEM1001\"},\"vat_category\":\"string\",\"start_date\":\"2026-10-15T09:30:00+02:00\"}}")

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_invoice_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/invoice.dart';

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

final result = await BillingInvoiceController.post(Invoice.fromJson({
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true
  },
  "payment_type": {
    "deleted": true
  },
  "payment_goal": {
    "id": 42,
    "name": "Beispiel",
    "date_string": "string",
    "deleted": true,
    "global_default": true
  },
  "buyer": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "payment_bic": "BYLADEM1001"
  },
  "vat_category": "string",
  "start_date": "2026-10-15T09:30:00+02:00"
}));
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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

Returns the default values used for creating free invoices.

GET/api/invoice/invoices/creation_defaults

All fields are optional and only populated when configured via settings.

Responses

200Returns the invoice creation defaultsobject

Show fields (5)

default_accounting_typestring
Type string of the default AccountingType (e.g. 'general'). Null if not configured.
default_multiple_tax_ratesboolean
Whether 'apply multiple tax rates' should be enabled by default.
default_unitstring
Default unit for free positions (e.g. 'pauschal'). Null if not configured.
default_quantitynumber (float)
Default quantity for free positions. Null if not configured.
default_price_is_bruttoboolean
Whether price should default to brutto instead of netto.

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getCreationDefaults();
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "default_accounting_type": "string",
  "default_multiple_tax_rates": true,
  "default_unit": "string",
  "default_quantity": 1.5,
  "default_price_is_brutto": true
}

This method will print an Invoice as PDF (optional with ZUGFeRD XML)

GET/api/invoice/invoices/{id}/pdf

Path parameters

idrequiredstring

Responses

200Returns the Invoice as PDF file

Request

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

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/invoices/42/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.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/invoice/invoices/42/pdf"),
  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/invoices/42/pdf")
  .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/invoices/42/pdf"

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getDownloadLinkPdf('42');
print(result);

This method will return the GiroCode (EPC QR code) of an open Invoice for a bank transfer

GET/api/invoice/invoices/{id}/girocode

Requires the setting inwendo_invoice_girocode_enabled. Fails with 400 if the invoice gets no code (cancelled, paid, nothing to pay, direct debit or no valid IBAN in the company data).

Path parameters

idrequiredstring

Responses

200Returns payload, SVG, amount and remittance of the GiroCode

Request

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

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

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

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

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

This method will print an ZUGFeRD XML

GET/api/invoice/invoices/{id}/zugferd

Path parameters

idrequiredstring

Responses

200Returns the Invoice as ZUGFeRD XML

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getDownloadLinkZUGFeRD('42');
print(result);

This method will get a single Invoice Object with the given id

GET/api/invoice/invoices/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single InvoiceInvoice4

Show fields (50)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
mit_last_send_emailstring (date-time)
Point in time the last e-mail was sent.
mit_to_emailstring
E-mail address the mail is intended for.
mit_should_send_emailboolean
Whether an e-mail should be sent.
mit_last_send_postalstring (date-time)
Point in time the last letter was sent.
mit_to_address_namestring
Name of the postal recipient.
mit_to_address_street_levelstring
Street and house number of the postal recipient.
mit_to_address_citystring
City of the postal recipient.
mit_to_address_zipstring
Postal code of the postal recipient.
mit_to_address_countrystring
Country of the postal recipient.
mit_should_send_postalboolean
Whether a letter should be sent.
import_origin_idstring
ID of the record in the source system of the import.
import_origin_id_altstring
Alternative ID of the record in the source system of the import.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem4>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice4
  Invoice the item belongs to.
- project_itemCRMProjectItem10
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem17
  Product of the item.
buyerInvoiceBuyer4
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice4
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer10
Offer the invoice was created from.
Show fields (43)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- mit_last_send_emailstring (date-time)
  Point in time the last e-mail was sent.
- mit_to_emailstring
  E-mail address the mail is intended for.
- mit_should_send_emailboolean
  Whether an e-mail should be sent.
- mit_last_send_postalstring (date-time)
  Point in time the last letter was sent.
- mit_to_address_namestring
  Name of the postal recipient.
- mit_to_address_street_levelstring
  Street and house number of the postal recipient.
- mit_to_address_citystring
  City of the postal recipient.
- mit_to_address_zipstring
  Postal code of the postal recipient.
- mit_to_address_countrystring
  Country of the postal recipient.
- mit_should_send_postalboolean
  Whether a letter should be sent.
- import_origin_idstring
  ID of the record in the source system of the import.
- import_origin_id_altstring
  Alternative ID of the record in the source system of the import.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem9>
  Items of the offer.
- buyerOfferBuyer9
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- … 6 more fields
… 15 more fields

Request

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "mit_last_send_email": "2026-10-15T09:30:00+02:00",
  "mit_to_email": "lena.hartmann@example.org",
  "mit_should_send_email": true,
  "mit_to_address_name": "Beispiel"
}

This method will get a new Invoice Object for the given offer id

GET/api/invoice/invoices/{offerIdentifier}/offers/{percentage}

Path parameters

`offerIdentifier`requiredstring
`percentage`requiredstring

Responses

200Returns a new Invoice for the given OfferInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForOffer('42', 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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will get a new Invoice Object for a single projectitem

GET/api/invoice/invoices/{projectItemIdentifier}/projectitem

Path parameters

projectItemIdentifierrequiredstring

Responses

200Returns a new Invoice for a single ProjectItemInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForProjectItem('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will get a new Invoice Object for the project

GET/api/invoice/invoices/{projectIdentifier}/project

Path parameters

projectIdentifierrequiredstring

Responses

200Returns a new Invoice for a ProjectInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForProject('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will get a new Invoice Object for the given event sign up

GET/api/invoice/invoices/{eventSignUpIdentifier}/eventsignup

Path parameters

eventSignUpIdentifierrequiredstring

Responses

200Returns a new Invoice for an EventSignUpInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForEventSignUp('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will get a new Invoice Object for the given booking

GET/api/invoice/invoices/{bookingIdentifier}/booking

Path parameters

bookingIdentifierrequiredstring

Responses

200Returns a new Invoice for a BookingInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForBaseBooking('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will get a new Invoice Object for the given booking group

GET/api/invoice/invoices/{bookingGroupIdentifier}/booking_group

Path parameters

bookingGroupIdentifierrequiredstring

Responses

200Returns a new Invoice for a BookingGroupInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForBaseBookingGroup('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will save new Invoice Objects for all entries of event

POST/api/invoice/invoices/{eventIdentifier}/events

Path parameters

eventIdentifierrequiredstring

Responses

200Creates Invoices for all entries of an Event

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.postForEvent('42');
if (result.success) {
  print(result.data);
}

This method will get a new Invoice Object for the given PersonLogBookEntry

GET/api/invoice/invoices/{logBookEntryIdentifier}/logbookentryadd

Path parameters

logBookEntryIdentifierrequiredstring

Responses

200Returns a new Invoice for a LogBookEntry (add)Invoice6

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem6>
Items of the invoice.
Show fields (19)
- 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.
- invoiceInvoice6
  Invoice the item belongs to.
- project_itemCRMProjectItem12
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- unified_categoryUnifiedCategory36
  Category the item belongs to.
- productPredefinedBillingItem19
  Product of the item.
buyerInvoiceBuyer6
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice6
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer12
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem11>
  Items of the offer.
- buyerOfferBuyer11
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject20
  Project the offer belongs to.
- invoicesarray<Invoice6>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport7>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject20
  Project the time report belongs to.
- invoiceInvoice6
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (3)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- … 59 more fields
… 8 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForLogBookEntryAdd('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

This method will get a new Invoice Object for the given PersonLogBookEntry

GET/api/invoice/invoices/{logBookEntryIdentifier}/logbookentrydelete

Path parameters

logBookEntryIdentifierrequiredstring

Responses

200Returns a new Invoice for a LogBookEntry (delete)Invoice6

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem6>
Items of the invoice.
Show fields (19)
- 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.
- invoiceInvoice6
  Invoice the item belongs to.
- project_itemCRMProjectItem12
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- unified_categoryUnifiedCategory36
  Category the item belongs to.
- productPredefinedBillingItem19
  Product of the item.
buyerInvoiceBuyer6
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice6
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer12
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem11>
  Items of the offer.
- buyerOfferBuyer11
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject20
  Project the offer belongs to.
- invoicesarray<Invoice6>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport7>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject20
  Project the time report belongs to.
- invoiceInvoice6
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (3)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- … 59 more fields
… 8 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_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 BillingInvoiceController.getForLogBookEntryDelete('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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

Add an Invoice to a CRMCompany

POST/api/invoice/invoice/{id}/add/to/company

Path parameters

idrequiredstring

Responses

200Add an Invoice to a CRMCompanyCRMCompany23

Show fields (62)

idinteger
Primary key of the company. Internal ID.
short_namestring
Short name of the company.
company_namestring
Legal name of the company.
secondary_namestring
Second name line of the company.
direct_dialstring
Direct dial number of the company.
invoice_emailstring
E-mail address for invoices.
send_invoice_emailboolean
Send invoices by e-mail.
send_invoice_letterboolean
Send invoices by letter.
time_report_emailstring
E-mail address for time reports.
payment_goalPaymentGoal
Payment term of the company.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
payment_intervalstring
Interval of the payments.
vatidstring
VAT identification number.
taxnumberstring
Tax number of the company.
buyer_reference_idstring
Leitweg-ID or custom reference ID defined by the customer
taxTax
Tax rate used for the company.
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%
infostring
Information about the company.
numberstring
Customer or supplier number of the company.
manual_numberinteger
Number set manually instead of the automatic number.
number_stringstring
Company number as text, including prefix.
is_customerboolean
The company is a customer.
is_supplierboolean
The company is a supplier.
is_otherboolean
The company is neither customer nor supplier.
is_memberboolean
The company is a member.
archivedboolean
The company is archived.
categoryCRMCompanyCategory
Category of the company.
Show fields (10)
- idinteger
  Primary key of the company category. Internal ID.
- namestring
  Name of the company category.
- descriptionstring
  Description of the company category.
- deletedboolean
  The category is deleted.
- global_defaultboolean
  Default category for new companies.
- enabled_customer_portalboolean
  Companies of this category may use the customer portal.
- g_drive_root_dirstring
  Root folder in Google Drive for companies of this category.
- g_drive_root_dir_archivedstring
  Root folder in Google Drive for archived companies of this category.
- require_company_addressboolean
  An address must be entered for companies of this category.
- require_company_billingboolean
  Billing details must be entered for companies of this category.
visible_for_customerboolean
Whether the company is visible to the customer.
founding_datestring (date-time)
Founding date of the company.
nace_sectionstring
NACE section code (letter A-U)
nace_codestring
NACE code (numeric like 01.11, 62.01)
search_stringstring
Text that the entity can be searched by.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
payment_ownerstring
Account owner of the direct debit.
payment_institutionstring
Name of the bank of the direct debit.
payment_bicstring
BIC of the bank account.
payment_ibanstring
IBAN of the bank account.
payment_mandatestring
Reference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)
Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)
Date until which the SEPA mandate is valid.
payment_typePaymentType
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
company_employee_countinteger
Number of employees of the company.
company_founding_yearinteger
Founding year of the company.
company_family_ownedboolean
Whether the company is family-owned.
company_sales_volumestring
Sales volume of the company.
company_segmentstring
Market segment of the company.

Request

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

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/invoice/42/add/to/company', [
  '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/invoice/42/add/to/company"),
  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/invoice/42/add/to/company")
  .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/invoice/42/add/to/company"

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_invoice_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/crm_company.dart';
import 'package:iw_erp_api/model/invoice.dart';

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

final result = await BillingInvoiceController.addToCrmCompany(Invoice.fromJson({}), CrmCompany.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "short_name": "Beispiel",
  "company_name": "Beispiel",
  "secondary_name": "Beispiel",
  "invoice_email": "lena.hartmann@example.org",
  "send_invoice_email": true,
  "time_report_email": "lena.hartmann@example.org",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163"
}

Delete an Invoice from a CRMCompany

POST/api/invoice/invoice/{id}/delete/from/company

Path parameters

idrequiredstring

Responses

200Remove an Invoice from a CRMCompanyCRMCompany23

Show fields (62)

idinteger
Primary key of the company. Internal ID.
short_namestring
Short name of the company.
company_namestring
Legal name of the company.
secondary_namestring
Second name line of the company.
direct_dialstring
Direct dial number of the company.
invoice_emailstring
E-mail address for invoices.
send_invoice_emailboolean
Send invoices by e-mail.
send_invoice_letterboolean
Send invoices by letter.
time_report_emailstring
E-mail address for time reports.
payment_goalPaymentGoal
Payment term of the company.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
payment_intervalstring
Interval of the payments.
vatidstring
VAT identification number.
taxnumberstring
Tax number of the company.
buyer_reference_idstring
Leitweg-ID or custom reference ID defined by the customer
taxTax
Tax rate used for the company.
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%
infostring
Information about the company.
numberstring
Customer or supplier number of the company.
manual_numberinteger
Number set manually instead of the automatic number.
number_stringstring
Company number as text, including prefix.
is_customerboolean
The company is a customer.
is_supplierboolean
The company is a supplier.
is_otherboolean
The company is neither customer nor supplier.
is_memberboolean
The company is a member.
archivedboolean
The company is archived.
categoryCRMCompanyCategory
Category of the company.
Show fields (10)
- idinteger
  Primary key of the company category. Internal ID.
- namestring
  Name of the company category.
- descriptionstring
  Description of the company category.
- deletedboolean
  The category is deleted.
- global_defaultboolean
  Default category for new companies.
- enabled_customer_portalboolean
  Companies of this category may use the customer portal.
- g_drive_root_dirstring
  Root folder in Google Drive for companies of this category.
- g_drive_root_dir_archivedstring
  Root folder in Google Drive for archived companies of this category.
- require_company_addressboolean
  An address must be entered for companies of this category.
- require_company_billingboolean
  Billing details must be entered for companies of this category.
visible_for_customerboolean
Whether the company is visible to the customer.
founding_datestring (date-time)
Founding date of the company.
nace_sectionstring
NACE section code (letter A-U)
nace_codestring
NACE code (numeric like 01.11, 62.01)
search_stringstring
Text that the entity can be searched by.
addressstring
Address as text.
address_streetstring
Street of the address.
address_house_numberstring
House number of the address.
address_street_levelstring
Street and house number of the address.
address_costring
Care-of line of the address.
address_citystring
City of the address.
address_zipstring
Postal code of the address.
address_admin_level1string
First administrative level of the address, e.g. the federal state.
address_countrystring
Country code of the address.
address_full_countrystring
Full name of the country of the address.
address_geo_latstring
Latitude of the address.
address_geo_lngstring
Longitude of the address.
address_external_provider_idstring
field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
main_phonestring
Main phone number.
main_faxstring
Main fax number.
main_emailstring
Main e-mail address.
websitestring
Website address.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
payment_ownerstring
Account owner of the direct debit.
payment_institutionstring
Name of the bank of the direct debit.
payment_bicstring
BIC of the bank account.
payment_ibanstring
IBAN of the bank account.
payment_mandatestring
Reference of the SEPA mandate.
payment_mandate_sign_datestring (date-time)
Date the SEPA mandate was signed.
payment_mandate_valid_until_datestring (date-time)
Date until which the SEPA mandate is valid.
payment_typePaymentType
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
company_employee_countinteger
Number of employees of the company.
company_founding_yearinteger
Founding year of the company.
company_family_ownedboolean
Whether the company is family-owned.
company_sales_volumestring
Sales volume of the company.
company_segmentstring
Market segment of the company.

Request

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

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/invoice/42/delete/from/company', [
  '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/invoice/42/delete/from/company"),
  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/invoice/42/delete/from/company")
  .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/invoice/42/delete/from/company"

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_invoice_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/crm_company.dart';
import 'package:iw_erp_api/model/invoice.dart';

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

final result = await BillingInvoiceController.removeFromCrmCompany(Invoice.fromJson({}), CrmCompany.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "short_name": "Beispiel",
  "company_name": "Beispiel",
  "secondary_name": "Beispiel",
  "invoice_email": "lena.hartmann@example.org",
  "send_invoice_email": true,
  "time_report_email": "lena.hartmann@example.org",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163"
}

Close an Invoice

POST/api/invoice/invoice/{id}/close

Path parameters

idrequiredstring

Responses

200Close an InvoiceInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_invoice_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/invoice.dart';

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

final result = await BillingInvoiceController.close(Invoice.fromJson({}));
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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

Record a partial payment of an open Invoice

POST/api/invoice/invoice/{id}/payment

Only with the setting billing_invoice_partial_payment. Once the payments reach the gross amount, the invoice counts as paid.

Path parameters

idrequiredstring

Request body application/json

dataobject
Show fields (3)
- amountnumber
  Paid amount (gross)
- paymentDatestring
  Defaults to today
- cashDiscountnumber
  Skonto (gross) deducted with the final payment; needs billing_invoice_cash_discount

Responses

200Record a partial payment of an InvoiceInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/invoice/42/payment \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "amount": 595,
    "paymentDate": "2026-02-20",
    "cashDiscount": 23.8
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({data: {amount: 595, paymentDate: '2026-02-20', cashDiscount: 23.8}})
};

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

payload = { "data": {
    "amount": 595,
    "paymentDate": "2026-02-20",
    "cashDiscount": 23.8
  } }
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/invoice/42/payment', [
  'body' => '{"data":{"amount":595,"paymentDate":"2026-02-20","cashDiscount":23.8}}',
  '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/invoice/42/payment"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"amount\":595,\"paymentDate\":\"2026-02-20\",\"cashDiscount\":23.8}}")
  {
    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\":{\"amount\":595,\"paymentDate\":\"2026-02-20\",\"cashDiscount\":23.8}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/invoice/invoice/42/payment")
  .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/invoice/42/payment"

	payload := strings.NewReader("{\"data\":{\"amount\":595,\"paymentDate\":\"2026-02-20\",\"cashDiscount\":23.8}}")

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

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

final response = await http.post(
  Uri.parse('https://your-instance.iw-erp.de/api/invoice/invoice/42/payment'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "amount": 595,
      "paymentDate": "2026-02-20",
      "cashDiscount": 23.8
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "tax": {
    "name": "Beispiel",
    "id": 42,
    "value": 1.5,
    "deleted": true,
    "global_default": true,
    "datev_tax_key": 1
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

Cancel an Invoice

POST/api/invoice/invoice/{id}/cancel

Path parameters

idrequiredstring

Responses

200Cancel an InvoiceInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_invoice_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/invoice.dart';

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

final result = await BillingInvoiceController.cancel(Invoice.fromJson({}));
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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}

Set mail intend for an Invoice

POST/api/invoice/invoice/{identifier}/mail_intend

Path parameters

identifierrequiredstring

Responses

200Set mail intend for an InvoiceInvoice7

Show fields (48)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
mit_last_send_emailstring (date-time)
Point in time the last e-mail was sent.
mit_to_emailstring
E-mail address the mail is intended for.
mit_should_send_emailboolean
Whether an e-mail should be sent.
mit_last_send_postalstring (date-time)
Point in time the last letter was sent.
mit_to_address_namestring
Name of the postal recipient.
mit_to_address_street_levelstring
Street and house number of the postal recipient.
mit_to_address_citystring
City of the postal recipient.
mit_to_address_zipstring
Postal code of the postal recipient.
mit_to_address_countrystring
Country of the postal recipient.
mit_should_send_postalboolean
Whether a letter should be sent.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem7>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice7
  Invoice the item belongs to.
- project_itemCRMProjectItem13
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem20
  Product of the item.
buyerInvoiceBuyer7
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice7
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer13
Offer the invoice was created from.
Show fields (45)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- mit_last_send_emailstring (date-time)
  Point in time the last e-mail was sent.
- mit_to_emailstring
  E-mail address the mail is intended for.
- mit_should_send_emailboolean
  Whether an e-mail should be sent.
- mit_last_send_postalstring (date-time)
  Point in time the last letter was sent.
- mit_to_address_namestring
  Name of the postal recipient.
- mit_to_address_street_levelstring
  Street and house number of the postal recipient.
- mit_to_address_citystring
  City of the postal recipient.
- mit_to_address_zipstring
  Postal code of the postal recipient.
- mit_to_address_countrystring
  Country of the postal recipient.
- mit_should_send_postalboolean
  Whether a letter should be sent.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem12>
  Items of the offer.
- buyerOfferBuyer12
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject21
  Project the offer belongs to.
- invoicesarray<Invoice7>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- … 2 more fields
… 14 more fields

Request

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

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

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

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

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

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

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/billing_invoice_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/invoice.dart';

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

final result = await BillingInvoiceController.updateMailIntend(Invoice.fromJson({}));
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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "mit_last_send_email": "2026-10-15T09:30:00+02:00",
  "mit_to_email": "lena.hartmann@example.org",
  "mit_should_send_email": true,
  "mit_to_address_name": "Beispiel"
}

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

POST/api/invoice/invoice/{id}/buchhaltungsbutler_push

Path parameters

idrequiredstring

Responses

200Push an Invoice to BuchhaltungsButlerInvoice5

Show fields (45)

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.
base_booking_groupBaseBookingGroup10
Booking group the document is based on.
Show fields (16)
- idinteger
  Primary key of the booking group. Internal ID.
- start_timestring (date-time)
  Start of the booking group.
- end_timestring (date-time)
  End of the booking group.
- booking_typestring
  Type of the bookings in the group.
- booking_statusstring
  Status of the bookings in the group.
- externalboolean
  The group was made by an external party.
- billing_typestring
  Billing type of the group, for example per booking or per group.
- people_countinteger
  Number of people in the group.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- deletion_reasonstring
  Reason for the deletion.
- deletion_datestring (date-time)
  Point in time of the deletion.
- colorstring
  Background color as hex value.
- fg_colorstring
  Foreground color as hex value.
search_stringstring
Text that the entity can be searched by.
accounting_typeAccountingTyperequired
Accounting type of the invoice.
Show fields (6)
- idinteger
  Primary key of the accounting type. Internal ID.
- namestringrequired
  Name of the accounting type, for example course fee.
- cancelled_namestring
  Name used when an invoice of this type is canceled.
- typestringrequired
  Type of the accounting type, for example invoice or credit note.
- deletedboolean
  The accounting type is deleted.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Payment type of the invoice.
Show fields (10)
- idinteger
  Primary key of the payment type. Internal ID.
- namestring
  Name of the payment type, for example transfer or cash.
- autoboolean
  Payments of this type are matched automatically.
- conditionsstring
  Conditions for matching payments to this type.
- linked_keywordsstring
  Keywords in bank transactions that link to this payment type.
- global_defaultboolean
  Default payment type for new invoices.
- bank_import_defaultboolean
  Default payment type for bank imports.
- is_direct_debitboolean
  The payment type is a direct debit.
- is_externalboolean
  The payment is handled by an external service.
- deletedboolean
  This property is used to mark an entity as deleted / archived
payment_goalPaymentGoal
Payment term of the invoice.
Show fields (5)
- idinteger
  Primary key of the payment goal. Internal ID.
- namestring
  Name of the payment term, for example 14 days.
- date_stringstring
  Date pattern of the payment term as text.
- deletedboolean
  The payment term is deleted.
- global_defaultboolean
  Default payment term for new invoices.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
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.
itemsarray<InvoiceItem5>
Items of the invoice.
Show fields (18)
- 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.
- invoiceInvoice5
  Invoice the item belongs to.
- project_itemCRMProjectItem11
  Project item the invoice item was created from.
- base_event_sign_upBaseEventSignUp11
  Sign-up the item was created for.
- productPredefinedBillingItem18
  Product of the item.
buyerInvoiceBuyer5
Buyer of the invoice.
Show fields (29)
- 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.
- payment_ownerstring
  Account owner of the direct debit.
- payment_institutionstring
  Name of the bank of the direct debit.
- payment_bicstring
  BIC of the bank account.
- payment_ibanstring
  IBAN of the bank account.
- payment_mandatestring
  Reference of the SEPA mandate.
- payment_mandate_sign_datestring (date-time)
  Date the SEPA mandate was signed.
- payment_mandate_valid_until_datestring (date-time)
  Date until which the SEPA mandate is valid.
- invoiceInvoice5
  Invoice the buyer belongs to.
payment_datestring (date-time)
Date the invoice was paid.
vat_categorystring
Der umsatzsteuerliche Sachverhalt. Der Steuersatz sagt nicht, in welche Zeile der Voranmeldung ein Umsatz gehört. Null Prozent stehen an einer innergemeinschaftlichen Lieferung (Kennzahl 41), an einer Ausfuhr (43), an einer Leistung nach § 13b UStG (60) und an einem steuerfreien Umsatz nach § 4 UStG (48) - vier verschiedene Zeilen, derselbe Steuersatz. Hier ist die einzige Stelle, an der jemand das weiss: beim Schreiben der Rechnung ist bekannt, ob der Kunde eine USt-IdNr. hat und wohin die Ware geht. Später ist es nicht mehr rekonstruierbar. Ohne Angabe der Regelfall - alles andere war bisher nicht erfassbar.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
direct_debit_exportedboolean
The invoice was exported for direct debit.
offerOffer11
Offer the invoice was created from.
Show fields (36)
- 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.
- base_booking_groupBaseBookingGroup10
  Booking group the document is based on.
- search_stringstring
  Text that the entity can be searched by.
- offer_accounting_typeOfferAccountingTyperequired
  Accounting type of the offer.
- itemsarray<OfferItem10>
  Items of the offer.
- buyerOfferBuyer10
  Buyer of the offer.
- accepted_datestring (date-time)
  Date the offer was accepted.
- is_accepted_date_from_ext_serviceboolean
  The acceptance date comes from an external service.
- projectCRMProject19
  Project the offer belongs to.
- invoicesarray<Invoice5>
  Invoices created from the offer.
- base_event_sign_upBaseEventSignUp11
  Sign-up the offer was created for.
- base_bookingBaseBooking12
  Booking the offer was created for.
- base_event_sign_up_groupBaseEventSignUpGroup2
  Sign-up group the offer was created for.
time_reportsarray<ProjectTimeReport6>
Time reports billed on the invoice.
Show fields (8)
- idinteger
  Primary key of the project time report. Internal ID.
- projectCRMProject19
  Project the time report belongs to.
- invoiceInvoice5
  Invoice the time report was billed on.
- time_billed_on_ticket_closeboolean
  Time is billed when the ticket is closed.
- startstring (date-time)
  Start of the reported period.
- endstring (date-time)
  End of the reported period.
- time_string_billablestring
  Billable time as text.
- time_string_not_billablestring
  Non-billable time as text.
payment_provider_statusstring
Status at the payment provider.
payment_provider_referencestring
Reference at the payment provider.
payment_provider_transaction_referencestring
Transaction reference at the payment provider.
cancel_datestring (date-time)
Date the invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp11
Sign-up the invoice was created for.
Show fields (4)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 - berechnet aus Geburtstag, Geschlecht und Eventdatum.
- idinteger
  Primary key of the sign-up. Internal ID.
- … 58 more fields
… 7 more fields

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/invoice/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/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/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/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/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/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/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/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
  },
  "accounting_type": {
    "name": "Beispiel",
    "type": "string",
    "id": 42,
    "cancelled_name": "Beispiel",
    "deleted": true,
    "default_expense_category": {
      "id": 42,
      "eur_line_name": "Beispiel",
      "color": "#3f5efb",
      "name": "Beispiel",
      "code": "string",
      "eur_line_number": 1,
      "category_type": "string",
      "is_vat_deductible": true,
      "is_immediate_deduction": true,
      "depreciation_years": 1
    }
  },
  "id": 42,
  "currency": "EUR",
  "name": "Beispiel",
  "linked_number_title": "Beispiel",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}