ProformaInvoice

Billing3 EndpointsBilling / ProformaInvoice

Returns a list of proforma invoice entries.

GET/api/invoice/proforma_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 ProformaInvoice objectsarray<ProformaInvoice>

Show fields (34)

idinteger
Primary key of the invoice document. Internal ID.
tokenstring
Token that identifies the document for public access.
numberinteger
Running document number.
manual_number_prefixstring
Prefix of a manually entered document number.
manual_numberinteger
Manually entered document number.
number_stringstring
Document number as displayed to users.
generation_datestring (date-time)
Date the document was generated.
number_datestring (date-time)
Date used for the document number.
messagestring
Message printed on the document.
currencystring
Currency of the document.
namestring
Name of the document.
due_datestring (date-time)
Due date of the document.
netto_valuenumber (float)
Net total of the document.
brutto_valuenumber (float)
Gross total of the document.
tax_valuenumber (float)
Total tax amount of the document.
taxTaxrequired
Tax rate applied to the document.
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 proforma 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 proforma 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 proforma 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 Proformarechnung (Einnahmen-Zuordnung) Wird beim Anlegen der echten Rechnung übernommen, damit die Sphäre an der Veranstaltung hängt und nicht am Zahlweg
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.
buyerProformaInvoiceBuyer
Buyer of the proforma 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.
- invoiceProformaInvoice
  Proforma invoice the buyer belongs to.
payment_datestring (date-time)
Date the proforma invoice was paid.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
cancel_datestring (date-time)
Date the proforma invoice was canceled.
cancel_textstring
Text of the cancellation.

Request

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

import 'package:iw_erp_api/clients/billing_proforma_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 BillingProformaInvoiceController.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"
  }
]

Returns the PDF document.

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

Path parameters

identifierrequiredstring

Responses

200Returns the ProformaInvoice as PDF

Request

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

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

Returns a single proforma invoice entry.

GET/api/invoice/proforma_invoices/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a ProformaInvoiceProformaInvoice2

Show fields (42)

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 proforma 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 proforma 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 proforma 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 Proformarechnung (Einnahmen-Zuordnung) Wird beim Anlegen der echten Rechnung übernommen, damit die Sphäre an der Veranstaltung hängt und nicht am Zahlweg
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<ProformaInvoiceItem>
Items of the proforma 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.
- invoiceProformaInvoice2
  Proforma invoice the item belongs to.
- project_itemCRMProjectItem9
  Project item the item was created from.
- base_event_sign_upBaseEventSignUp10
  Sign-up the item was created for.
- productPredefinedBillingItem16
  Product of the item.
buyerProformaInvoiceBuyer2
Buyer of the proforma 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.
- invoiceProformaInvoice2
  Proforma invoice the buyer belongs to.
payment_datestring (date-time)
Date the proforma invoice was paid.
is_payment_date_from_ext_serviceboolean
The payment date comes from an external service.
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 proforma invoice was canceled.
cancel_textstring
Text of the cancellation.
base_event_sign_upBaseEventSignUp10
Sign-up the proforma invoice was created for.
Show fields (54)
- 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.
- genderstring
  Gender of the participant.
- tokenstring
  Public token of the sign-up. Used in links instead of the ID.
- moments_tokenstring
  Participant-bound moments token: allows this participant to use the event moments (digital guestbook) page; uploads via this token are linked to the participant.
- waitingboolean
  The sign-up is on the waiting list.
- confirmedboolean
  The sign-up is confirmed.
- externalboolean
  The sign-up was made by an external party.
- deletion_reasonstring
  Reason the sign-up was cancelled.
- billedboolean
  The sign-up was billed.
- 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)
  Birthday of the participant.
- trialboolean
  Trial date sign-up (Schnuppern): a date sign-up without a course place that uses up one unit of the person's trial pass (eventAccessBudget with sourceType trial)
- trial_channelstring
  Who booked the trial date: app, trainer, office
- trial_session_numberinteger
  Number of this trial date within the pass (1 = first), for "Schnuppern 2/3"
- trial_session_maxinteger
  Trial dates of the pass, for "Schnuppern 2/3"
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- bib_numberinteger
  Startnummer (Zaehler). Bei PER_PREFIX nur zusammen mit dem Praefix eindeutig. Wird nur ueber BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
- bib_labelstring
  Angezeigte Startnummer inkl. Praefix, z. B. W0123. Pro Event eindeutig.
- bib_number_assigned_atstring (date-time)
  Time the bib number was assigned.
- chip_codestring
  Transponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
- timing_tracking_consentboolean
  Einwilligung in das GPS-Live-Tracking waehrend des Events.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- 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
- namestring
  Name of the entity.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- orderinteger
  Position of the entity in the order.
base_bookingBaseBooking13
Booking the proforma invoice was created for.
Show fields (4)
- idinteger
  Primary key of the booking. Internal ID.
- start_timestring (date-time)
  Start of the booking.
- end_timestring (date-time)
  End of the booking.
- … 14 more fields
… 3 more fields

Request

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

import 'package:iw_erp_api/clients/billing_proforma_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 BillingProformaInvoiceController.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",
  "cancel_text": "Text",
  "token": "string",
  "number": 1,
  "manual_number_prefix": "string"
}