ProformaInvoice

Abrechnung3 EndpunkteBilling / ProformaInvoice

Liefert eine Liste der Proforma-Rechnungs-Einträge.

GET/api/invoice/proforma_invoices

Query-Parameter

`searchString`string	Text, nach dem in der Liste gesucht wird
`orderFieldName`string	Name des Bestellfelds
`orderFieldSort`string	SortiermodusErlaubt: `DESCASC`
`page`integer	Seite der Liste
`pageSize`integer	Anzahl der Einträge je Seite
`withMaxPageNumber`string	gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der ProformaInvoice-Objekte.array<ProformaInvoice>

Felder anzeigen (34)

idinteger
Primärschlüssel des Rechnungsdokuments. Interne ID.
tokenstring
Token, das das Dokument für den öffentlichen Zugriff identifiziert.
numberinteger
Laufende Belegnummer.
manual_number_prefixstring
Präfix einer manuell eingegebenen Dokumentnummer.
manual_numberinteger
Manuell eingegebene Dokumentnummer.
number_stringstring
Belegnummer, wie sie den Benutzern angezeigt wird.
generation_datestring (date-time)
Datum, an dem das Dokument erstellt wurde.
number_datestring (date-time)
Datum, das für die Belegnummer verwendet wird.
messagestring
Auf dem Dokument gedruckte Nachricht.
currencystring
Währung des Dokuments.
namestring
Name des Dokuments.
due_datestring (date-time)
Fälligkeitsdatum des Dokuments.
netto_valuenumber (float)
Nettosumme des Dokuments.
brutto_valuenumber (float)
Bruttogesamtbetrag des Dokuments.
tax_valuenumber (float)
Gesamter Steuerbetrag des Dokuments.
taxTaxPflicht
Auf das Dokument angewendeter Steuersatz.
Felder anzeigen (6)
- idinteger
  Primärschlüssel des Steuersatzes. Interne ID.
- namestringPflicht
  Name des Steuersatzes, zum Beispiel 19 Prozent.
- valuenumber (float)
  Steuersatz in Prozent.
- deletedboolean
  Der Steuersatz wird gelöscht.
- global_defaultboolean
  Standard-Steuersatz für neue Artikel.
- 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
Titel der verknüpften Dokumentnummer.
linked_numberstring
Nummer des verknüpften Belegs.
statusstring
Status des Dokuments.
previous_statusstring
Status vor der letzten Änderung.
status_updatedstring (date-time)
Zeitpunkt, zu dem der Status zuletzt geändert wurde.
archivedboolean
Ob das Dokument archiviert ist.
last_pdf_exportstring (date-time)
Zeitpunkt, zu dem das PDF zuletzt exportiert wurde.
last_status_exportstring
Status beim letzten Export.
search_stringstring
Text, unter dem die Entität gesucht werden kann.
accounting_typeAccountingTypePflicht
Buchungsart der Proforma-Rechnung.
Felder anzeigen (6)
- idinteger
  Primärschlüssel des Buchungstyps. Interne ID.
- namestringPflicht
  Name der Buchungsart, zum Beispiel Kursgebühr.
- cancelled_namestring
  Name, der verwendet wird, wenn eine Rechnung dieses Typs storniert wird.
- typestringPflicht
  Art des Buchungstyps, zum Beispiel Rechnung oder Gutschrift.
- deletedboolean
  Die Buchungsart wird gelöscht.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Zahlungsart der Proforma-Rechnung.
Felder anzeigen (10)
- idinteger
  Primärschlüssel des Zahlungstyps. Interne ID.
- namestring
  Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.
- autoboolean
  Zahlungen dieses Typs werden automatisch zugeordnet.
- conditionsstring
  Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.
- linked_keywordsstring
  Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.
- global_defaultboolean
  Standard-Zahlungsart für neue Rechnungen.
- bank_import_defaultboolean
  Standard-Zahlungsart für Bankimporte.
- is_direct_debitboolean
  Die Zahlungsart ist ein Lastschriftverfahren.
- is_externalboolean
  Die Zahlung wird über einen externen Dienst abgewickelt.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
payment_goalPaymentGoal
Zahlungsbedingung der Proforma-Rechnung.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Zahlungsziels. Interne ID.
- namestring
  Name der Zahlungsbedingung, zum Beispiel 14 Tage.
- date_stringstring
  Datumsmuster der Zahlungsfrist als Text.
- deletedboolean
  Die Zahlungsfrist wird gelöscht.
- global_defaultboolean
  Standard-Zahlungsziel für neue Rechnungen.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Proformarechnung (Einnahmen-Zuordnung) Wird beim Anlegen der echten Rechnung übernommen, damit die Sphäre an der Veranstaltung hängt und nicht am Zahlweg
Felder anzeigen (19)
- idinteger
  Primärschlüssel der Ausgabenkategorie. Interne 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
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- namestring
  Name der Einheit.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
buyerProformaInvoiceBuyer
Käufer der Proforma-Rechnung.
Felder anzeigen (22)
- idinteger
  Primärschlüssel des Clients. Interne ID.
- namestring
  Name des Kunden auf der Rechnung.
- vat_idstring
  USt-IdNr. des Kunden.
- taxnumberstring
  Steuernummer des Kunden.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- secondary_namestring
  Zweite Namenszeile des Kunden auf der Rechnung.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- numberstring
  Kundennummer des Käufers.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- invoiceProformaInvoice
  Proforma-Rechnung, zu der der Käufer gehört.
payment_datestring (date-time)
Datum, an dem die Proforma-Rechnung bezahlt wurde.
is_payment_date_from_ext_serviceboolean
Das Zahlungsdatum stammt von einem externen Dienst.
cancel_datestring (date-time)
Datum, an dem die Proforma-Rechnung storniert wurde.
cancel_textstring
Text der Stornierung.

Anfrage

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

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

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

import requests

url = "https://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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 mit dem Package iw_erp_api

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

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

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

Antwort 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"
  }
]

Liefert das PDF-Dokument.

GET/api/invoice/proforma_invoices/{identifier}/pdf

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert die Proforma-Rechnung als PDF

Anfrage

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

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

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

import requests

url = "https://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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 mit dem Package iw_erp_api

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

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

final result = await BillingProformaInvoiceController.getDownloadLinkPdf('42');
print(result);

Liefert einen einzelnen Proforma-Rechnungs-Eintrag.

GET/api/invoice/proforma_invoices/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Liefert eine ProformaInvoice.ProformaInvoice2

Felder anzeigen (42)

idinteger
Primärschlüssel des Rechnungsdokuments. Interne ID.
tokenstring
Token, das das Dokument für den öffentlichen Zugriff identifiziert.
numberinteger
Laufende Belegnummer.
manual_number_prefixstring
Präfix einer manuell eingegebenen Dokumentnummer.
manual_numberinteger
Manuell eingegebene Dokumentnummer.
number_stringstring
Belegnummer, wie sie den Benutzern angezeigt wird.
generation_datestring (date-time)
Datum, an dem das Dokument erstellt wurde.
number_datestring (date-time)
Datum, das für die Belegnummer verwendet wird.
messagestring
Auf dem Dokument gedruckte Nachricht.
currencystring
Währung des Dokuments.
namestring
Name des Dokuments.
due_datestring (date-time)
Fälligkeitsdatum des Dokuments.
netto_valuenumber (float)
Nettosumme des Dokuments.
brutto_valuenumber (float)
Bruttogesamtbetrag des Dokuments.
tax_valuenumber (float)
Gesamter Steuerbetrag des Dokuments.
taxTaxPflicht
Auf das Dokument angewendeter Steuersatz.
Felder anzeigen (6)
- idinteger
  Primärschlüssel des Steuersatzes. Interne ID.
- namestringPflicht
  Name des Steuersatzes, zum Beispiel 19 Prozent.
- valuenumber (float)
  Steuersatz in Prozent.
- deletedboolean
  Der Steuersatz wird gelöscht.
- global_defaultboolean
  Standard-Steuersatz für neue Artikel.
- 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
Titel der verknüpften Dokumentnummer.
linked_numberstring
Nummer des verknüpften Belegs.
statusstring
Status des Dokuments.
previous_statusstring
Status vor der letzten Änderung.
status_updatedstring (date-time)
Zeitpunkt, zu dem der Status zuletzt geändert wurde.
archivedboolean
Ob das Dokument archiviert ist.
last_pdf_exportstring (date-time)
Zeitpunkt, zu dem das PDF zuletzt exportiert wurde.
last_status_exportstring
Status beim letzten Export.
base_booking_groupBaseBookingGroup10
Buchungsgruppe, auf der das Dokument basiert.
Felder anzeigen (16)
- idinteger
  Primärschlüssel der Buchungsgruppe. Interne ID.
- start_timestring (date-time)
  Beginn der Buchungsgruppe.
- end_timestring (date-time)
  Ende der Buchungsgruppe.
- booking_typestring
  Art der Buchungen in der Gruppe.
- booking_statusstring
  Status der Buchungen in der Gruppe.
- externalboolean
  Die Gruppe wurde von einer externen Stelle erstellt.
- billing_typestring
  Abrechnungsart der Gruppe, zum Beispiel je Buchung oder je Gruppe.
- people_countinteger
  Anzahl der Personen in der Gruppe.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- namestring
  Name der Einheit.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- deletion_reasonstring
  Grund der Löschung.
- deletion_datestring (date-time)
  Zeitpunkt der Löschung.
- colorstring
  Hintergrundfarbe als Hexwert.
- fg_colorstring
  Vordergrundfarbe als Hex-Wert.
search_stringstring
Text, unter dem die Entität gesucht werden kann.
accounting_typeAccountingTypePflicht
Buchungsart der Proforma-Rechnung.
Felder anzeigen (6)
- idinteger
  Primärschlüssel des Buchungstyps. Interne ID.
- namestringPflicht
  Name der Buchungsart, zum Beispiel Kursgebühr.
- cancelled_namestring
  Name, der verwendet wird, wenn eine Rechnung dieses Typs storniert wird.
- typestringPflicht
  Art des Buchungstyps, zum Beispiel Rechnung oder Gutschrift.
- deletedboolean
  Die Buchungsart wird gelöscht.
- default_expense_categoryExpenseCategory10
  Standard-EÜR-Kategorie für diesen Rechnungstyp (für Einnahmen-Mapping)
payment_typePaymentType
Zahlungsart der Proforma-Rechnung.
Felder anzeigen (10)
- idinteger
  Primärschlüssel des Zahlungstyps. Interne ID.
- namestring
  Name der Zahlungsart, zum Beispiel Überweisung oder Barzahlung.
- autoboolean
  Zahlungen dieses Typs werden automatisch zugeordnet.
- conditionsstring
  Bedingungen für die Zuordnung von Zahlungen zu diesem Typ.
- linked_keywordsstring
  Schlüsselwörter in Banktransaktionen, die mit dieser Zahlungsart verknüpft werden.
- global_defaultboolean
  Standard-Zahlungsart für neue Rechnungen.
- bank_import_defaultboolean
  Standard-Zahlungsart für Bankimporte.
- is_direct_debitboolean
  Die Zahlungsart ist ein Lastschriftverfahren.
- is_externalboolean
  Die Zahlung wird über einen externen Dienst abgewickelt.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
payment_goalPaymentGoal
Zahlungsbedingung der Proforma-Rechnung.
Felder anzeigen (5)
- idinteger
  Primärschlüssel des Zahlungsziels. Interne ID.
- namestring
  Name der Zahlungsbedingung, zum Beispiel 14 Tage.
- date_stringstring
  Datumsmuster der Zahlungsfrist als Text.
- deletedboolean
  Die Zahlungsfrist wird gelöscht.
- global_defaultboolean
  Standard-Zahlungsziel für neue Rechnungen.
expense_categoryExpenseCategory10
EÜR-Kategorie für diese Proformarechnung (Einnahmen-Zuordnung) Wird beim Anlegen der echten Rechnung übernommen, damit die Sphäre an der Veranstaltung hängt und nicht am Zahlweg
Felder anzeigen (19)
- idinteger
  Primärschlüssel der Ausgabenkategorie. Interne 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
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- namestring
  Name der Einheit.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
itemsarray<ProformaInvoiceItem>
Positionen der Proforma-Rechnung.
Felder anzeigen (18)
- idinteger
  Primärschlüssel der Rechnungsposition. Interne ID.
- descriptionstring
  Beschreibung der Rechnungsposition.
- price_is_bruttoboolean
  Ob der Preis ein Bruttopreis inklusive Steuer ist.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Nettowert der Rechnungsposition.
- brutto_valuenumber (float)
  Bruttowert der Rechnungsposition.
- tax_valuenumber (float)
  Steuerbetrag der Rechnungsposition.
- quantitynumber (float)Pflicht
  Menge der Rechnungsposition.
- pricenumber (float)Pflicht
  Einzelpreis der Rechnungsposition.
- namestringPflicht
  Name der Rechnungsposition.
- unitstringPflicht
  Einheit der Rechnungsposition.
- taxTax
  Auf die Rechnungsposition angewendeter Steuersatz.
- invoiceProformaInvoice2
  Proforma-Rechnung, zu der die Position gehört.
- project_itemCRMProjectItem9
  Projektposition, aus der die Position erstellt wurde.
- base_event_sign_upBaseEventSignUp10
  Anmeldung, für die die Position angelegt wurde.
- productPredefinedBillingItem16
  Produkt der Position.
buyerProformaInvoiceBuyer2
Käufer der Proforma-Rechnung.
Felder anzeigen (22)
- idinteger
  Primärschlüssel des Clients. Interne ID.
- namestring
  Name des Kunden auf der Rechnung.
- vat_idstring
  USt-IdNr. des Kunden.
- taxnumberstring
  Steuernummer des Kunden.
- buyer_reference_idstring
  Leitweg-ID oder vom Kunden definierte individuelle Referenz-ID
- secondary_namestring
  Zweite Namenszeile des Kunden auf der Rechnung.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- numberstring
  Kundennummer des Käufers.
- search_stringstring
  Text, unter dem die Entität gesucht werden kann.
- invoiceProformaInvoice2
  Proforma-Rechnung, zu der der Käufer gehört.
payment_datestring (date-time)
Datum, an dem die Proforma-Rechnung bezahlt wurde.
is_payment_date_from_ext_serviceboolean
Das Zahlungsdatum stammt von einem externen Dienst.
payment_provider_statusstring
Status beim Zahlungsanbieter.
payment_provider_referencestring
Referenz beim Zahlungsanbieter.
payment_provider_transaction_referencestring
Transaktionsreferenz beim Zahlungsanbieter.
cancel_datestring (date-time)
Datum, an dem die Proforma-Rechnung storniert wurde.
cancel_textstring
Text der Stornierung.
base_event_sign_upBaseEventSignUp10
Anmeldung, für die die Proforma-Rechnung angelegt wurde.
Felder anzeigen (54)
- bib_range_idinteger
- age_classstring
  Altersklasse nach DLV, z. B. M40 – berechnet aus Geburtstag, Geschlecht und Veranstaltungsdatum.
- idinteger
  Primärschlüssel der Anmeldung. Interne ID.
- genderstring
  Geschlecht des Teilnehmers.
- tokenstring
  Öffentlicher Token der Anmeldung. In Links anstelle der ID verwendet.
- moments_tokenstring
  Teilnehmerbezogenes Momente-Token: erlaubt dieser Person die Nutzung der Veranstaltungs-Momente (digitales Gästebuch); Uploads über dieses Token werden der Person zugeordnet.
- waitingboolean
  Die Anmeldung steht auf der Warteliste.
- confirmedboolean
  Die Anmeldung ist bestätigt.
- externalboolean
  Die Anmeldung wurde von einer externen Stelle vorgenommen.
- deletion_reasonstring
  Grund für die Stornierung der Anmeldung.
- billedboolean
  Die Anmeldung wurde abgerechnet.
- direct_billingboolean
- direct_billing_check_datestring (date-time)
- direct_billing_tokenstring
- wait_list_confirmation_tokenstring
- wait_list_confirmation_sent_atstring (date-time)
- wait_list_confirmation_deadlinestring (date-time)
- wait_list_confirmed_atstring (date-time)
- wait_list_pending_confirmationboolean
- wait_list_sort_orderinteger
- birthdaystring (date-time)
  Geburtstag des Teilnehmers.
- trialboolean
  Schnuppertermin-Anmeldung (Schnuppern): eine Terminanmeldung ohne Kursplatz, die eine Einheit des Schnupper-Kontingents der Person verbraucht (eventAccessBudget mit sourceType trial)
- trial_channelstring
  Wer den Probetermin gebucht hat: App, Trainer, Büro
- trial_session_numberinteger
  Nummer dieses Probetermins innerhalb des Durchgangs (1 = erster), für "Schnuppern 2/3"
- trial_session_maxinteger
  Schnuppertermine des Passes, für "Schnuppern 2/3"
- nace_sectionstring
  NACE-Abschnittscode (Buchstabe A-U)
- nace_codestring
  NACE-Code (numerisch, z. B. 01.11, 62.01)
- bib_numberinteger
  Startnummer (Zähler). Bei PER_PREFIX nur zusammen mit dem Präfix eindeutig. Wird nur über BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
- bib_labelstring
  Angezeigte Startnummer inkl. Präfix, z. B. W0123. Pro Veranstaltung eindeutig.
- bib_number_assigned_atstring (date-time)
  Zeitpunkt, zu dem die Startnummer vergeben wurde.
- chip_codestring
  Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
- timing_tracking_consentboolean
  Einwilligung in das GPS-Live-Tracking während des Events.
- createdstring (date-time)
  Zeitpunkt, zu dem der Datensatz angelegt wurde.
- updatedstring (date-time)
  Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
- addressstring
  Adresse als Text.
- address_streetstring
  Straße der Adresse.
- address_house_numberstring
  Hausnummer der Adresse.
- address_street_levelstring
  Straße und Hausnummer der Adresse.
- address_costring
  Care-of-Zeile der Adresse.
- address_citystring
  Ort der Adresse.
- address_zipstring
  Postleitzahl der Adresse.
- address_admin_level1string
  Erste Verwaltungsebene der Adresse, z. B. das Bundesland.
- address_countrystring
  Ländercode der Adresse.
- address_full_countrystring
  Vollständiger Name des Landes der Adresse.
- address_geo_latstring
  Breitengrad der Adresse.
- address_geo_lngstring
  Längengrad der Adresse.
- address_external_provider_idstring
  Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
- namestring
  Name der Einheit.
- main_phonestring
  Haupttelefonnummer.
- main_faxstring
  Haupt-Faxnummer.
- main_emailstring
  Haupt-E-Mail-Adresse.
- websitestring
  Website-Adresse.
- deletedboolean
  Diese Eigenschaft markiert eine Entität als gelöscht / archiviert
- orderinteger
  Position des Datensatzes in der Reihenfolge.
base_bookingBaseBooking13
Buchung, für die die Proforma-Rechnung erstellt wurde.
Felder anzeigen (4)
- idinteger
  Primärschlüssel der Buchung. Interne ID.
- start_timestring (date-time)
  Beginn der Buchung.
- end_timestring (date-time)
  Ende der Buchung.
- … 14 weitere Felder
… 3 weitere Felder

Anfrage

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

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

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

import requests

url = "https://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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://eure-instanz.iw-erp.de/api/invoice/proforma_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 mit dem Package iw_erp_api

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

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

final result = await BillingProformaInvoiceController.get('42');
if (result.success) {
  print(result.data);
}

Antwort 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"
}