Shipping
Liefert ein Dummy-Angebot mit berechnetem Versandpreis.
GET/api/invoice/shipping_price/calculate/{countryCode}/{zipCode}/{shippingType}
Pfad-Parameter
countryCodePflichtstring | |
zipCodePflichtstring | |
shippingTypePflichtstring |
Query-Parameter
searchStringstring | Text, nach dem in der Liste gesucht wird |
orderFieldNamestring | Name des Bestellfelds |
orderFieldSortstring | SortiermodusErlaubt: DESCASC |
pageinteger | Seite der Liste |
pageSizeinteger | Anzahl der Einträge je Seite |
withMaxPageNumberstring | gibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist |
Antworten
200Liefert ein Dummy-Angebot mit berechnetem Versandpreis.Offer5
Felder anzeigen (33)
idintegerPrimärschlüssel des Rechnungsdokuments. Interne ID.
tokenstringToken, das das Dokument für den öffentlichen Zugriff identifiziert.
numberintegerLaufende Belegnummer.
manual_number_prefixstringPräfix einer manuell eingegebenen Dokumentnummer.
manual_numberintegerManuell eingegebene Dokumentnummer.
number_stringstringBelegnummer, 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.
messagestringAuf dem Dokument gedruckte Nachricht.
currencystringWährung des Dokuments.
namestringName 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.
taxTaxPflichtAuf das Dokument angewendeter Steuersatz.
Felder anzeigen (6)
idintegerPrimärschlüssel des Steuersatzes. Interne ID.
namestringPflichtName des Steuersatzes, zum Beispiel 19 Prozent.
valuenumber (float)Steuersatz in Prozent.
deletedbooleanDer Steuersatz wird gelöscht.
global_defaultbooleanStandard-Steuersatz für neue Artikel.
datev_tax_keyintegerDATEV 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_titlestringTitel der verknüpften Dokumentnummer.
linked_numberstringNummer des verknüpften Belegs.
statusstringStatus des Dokuments.
previous_statusstringStatus vor der letzten Änderung.
status_updatedstring (date-time)Zeitpunkt, zu dem der Status zuletzt geändert wurde.
archivedbooleanOb das Dokument archiviert ist.
last_pdf_exportstring (date-time)Zeitpunkt, zu dem das PDF zuletzt exportiert wurde.
last_status_exportstringStatus beim letzten Export.
search_stringstringText, unter dem die Entität gesucht werden kann.
offer_accounting_typeOfferAccountingTypePflichtBuchungsart des Angebots.
Felder anzeigen (7)
idintegerPrimärschlüssel des Angebots-Buchungstyps. Interne ID.
namestringPflichtName der Buchungsart.
cancelled_namestringName, der verwendet wird, wenn ein Angebot dieses Typs storniert wird.
typestringPflichtArt des Buchungstyps, zum Beispiel Angebot oder Vertrag.
conditionsstringAuf dem Angebot abgedruckte Bedingungen.
number_descriptionstringBeschreibung des Zahlenformats des Angebots.
deletedbooleanDie Buchungsart wird gelöscht.
itemsarray<OfferItem5>Positionen des Angebots.
Felder anzeigen (16)
idintegerPrimärschlüssel der Rechnungsposition. Interne ID.
descriptionstringBeschreibung der Rechnungsposition.
price_is_bruttobooleanOb der Preis ein Bruttopreis inklusive Steuer ist.
skustringArtikelnummer (Stock Keeping Unit)
barcodestringBarcode (ISBN, UPC, GTIN usw.)
item_typestringTyp (Item, Shipping)
netto_valuenumber (float)Nettowert der Rechnungsposition.
brutto_valuenumber (float)Bruttowert der Rechnungsposition.
tax_valuenumber (float)Steuerbetrag der Rechnungsposition.
quantitynumber (float)PflichtMenge der Rechnungsposition.
pricenumber (float)PflichtEinzelpreis der Rechnungsposition.
namestringPflichtName der Rechnungsposition.
unitstringPflichtEinheit der Rechnungsposition.
taxTaxAuf die Rechnungsposition angewendeter Steuersatz.
offerOffer5Angebot, zu dem der Gegenstand gehört.
custom_productCustomizedBillingItem4Angepasstes Produkt, das für den Posten verwendet wird.
buyerOfferBuyer5Käufer des Angebots.
Felder anzeigen (22)
idintegerPrimärschlüssel des Clients. Interne ID.
namestringName des Kunden auf der Rechnung.
vat_idstringUSt-IdNr. des Kunden.
taxnumberstringSteuernummer des Kunden.
buyer_reference_idstringLeitweg-ID oder vom Kunden definierte individuelle Referenz-ID
secondary_namestringZweite Namenszeile des Kunden auf der Rechnung.
addressstringAdresse als Text.
address_streetstringStraße der Adresse.
address_house_numberstringHausnummer der Adresse.
address_street_levelstringStraße und Hausnummer der Adresse.
address_costringCare-of-Zeile der Adresse.
address_citystringOrt der Adresse.
address_zipstringPostleitzahl der Adresse.
address_admin_level1stringErste Verwaltungsebene der Adresse, z. B. das Bundesland.
address_countrystringLändercode der Adresse.
address_full_countrystringVollständiger Name des Landes der Adresse.
address_geo_latstringBreitengrad der Adresse.
address_geo_lngstringLängengrad der Adresse.
address_external_provider_idstringFeld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
numberstringKundennummer des Käufers.
search_stringstringText, unter dem die Entität gesucht werden kann.
offerOffer5Angebot, zu dem der Käufer gehört.
accepted_datestring (date-time)Datum, an dem das Angebot angenommen wurde.
is_accepted_date_from_ext_servicebooleanDas Annahmedatum stammt von einem externen Dienst.
projectCRMProject13Projekt, zu dem das Angebot gehört.
Felder anzeigen (19)
idintegerPrimärschlüssel des Projekts. Interne ID.
namestringName des Projekts.
closedstring (date-time)Zeitpunkt, zu dem das Projekt geschlossen wurde.
billedstring (date-time)Zeitpunkt, zu dem das Projekt abgerechnet wurde.
numberstringNummer des Projekts.
startstring (date-time)Beginn des Projekts.
endstring (date-time)Ende des Projekts.
descriptionstringBeschreibung des Projekts.
companyCRMCompanyUnternehmen, zu dem das Projekt gehört.
internal_main_contactUser14Interner Benutzer, der Hauptansprechpartner ist.
categoryCRMProjectCategoryKategorie des Projekts.
archivedbooleanDas Projekt ist archiviert.
visible_for_customerbooleanDas Projekt ist in der Kunden-App sichtbar.
name_for_customerstringName des Projekts, das Kunden angezeigt wird.
invoice_emailstringE-Mail-Adresse für Rechnungen des Projekts.
time_report_emailstringE-Mail-Adresse für Zeitberichte des Projekts.
search_stringstringText, unter dem die Entität gesucht werden kann.
createdstring (date-time)Zeitpunkt, zu dem der Datensatz angelegt wurde.
updatedstring (date-time)Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.
invoicesarray<Invoice21>Aus dem Angebot erstellte Rechnungen.
Felder anzeigen (38)
idintegerPrimärschlüssel des Rechnungsdokuments. Interne ID.
tokenstringToken, das das Dokument für den öffentlichen Zugriff identifiziert.
numberintegerLaufende Belegnummer.
manual_number_prefixstringPräfix einer manuell eingegebenen Dokumentnummer.
manual_numberintegerManuell eingegebene Dokumentnummer.
number_stringstringBelegnummer, 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.
messagestringAuf dem Dokument gedruckte Nachricht.
currencystringWährung des Dokuments.
namestringName 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.
taxTaxPflichtAuf das Dokument angewendeter Steuersatz.
linked_number_titlestringTitel der verknüpften Dokumentnummer.
linked_numberstringNummer des verknüpften Belegs.
statusstringStatus des Dokuments.
previous_statusstringStatus vor der letzten Änderung.
status_updatedstring (date-time)Zeitpunkt, zu dem der Status zuletzt geändert wurde.
archivedbooleanOb das Dokument archiviert ist.
last_pdf_exportstring (date-time)Zeitpunkt, zu dem das PDF zuletzt exportiert wurde.
last_status_exportstringStatus beim letzten Export.
search_stringstringText, unter dem die Entität gesucht werden kann.
accounting_typeAccountingTypePflichtBuchungsart der Rechnung.
payment_typePaymentTypeZahlungsart der Rechnung.
payment_goalPaymentGoalZahlungsbedingung der Rechnung.
expense_categoryExpenseCategory10EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
buyerInvoiceBuyer20Käufer der Rechnung.
payment_datestring (date-time)Datum, an dem die Rechnung bezahlt wurde.
vat_categorystringDer 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 weiß: 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_servicebooleanDas Zahlungsdatum stammt von einem externen Dienst.
direct_debit_exportedbooleanDie Rechnung wurde für das Lastschriftverfahren exportiert.
cancel_datestring (date-time)Datum, an dem die Rechnung storniert wurde.
cancel_textstringText der Stornierung.
start_datestring (date-time)Beginn des abgerechneten Zeitraums.
end_datestring (date-time)Ende des abgerechneten Zeitraums.
base_event_sign_upBaseEventSignUp10Anmeldung, für die das Angebot angelegt wurde.
Felder anzeigen (54)
bib_range_idintegerage_classstringAltersklasse nach DLV, z. B. M40 – berechnet aus Geburtstag, Geschlecht und Veranstaltungsdatum.
idintegerPrimärschlüssel der Anmeldung. Interne ID.
genderstringGeschlecht des Teilnehmers.
tokenstringÖffentlicher Token der Anmeldung. In Links anstelle der ID verwendet.
moments_tokenstringTeilnehmerbezogenes Momente-Token: erlaubt dieser Person die Nutzung der Veranstaltungs-Momente (digitales Gästebuch); Uploads über dieses Token werden der Person zugeordnet.
waitingbooleanDie Anmeldung steht auf der Warteliste.
confirmedbooleanDie Anmeldung ist bestätigt.
externalbooleanDie Anmeldung wurde von einer externen Stelle vorgenommen.
deletion_reasonstringGrund für die Stornierung der Anmeldung.
billedbooleanDie Anmeldung wurde abgerechnet.
direct_billingbooleandirect_billing_check_datestring (date-time)direct_billing_tokenstringwait_list_confirmation_tokenstringwait_list_confirmation_sent_atstring (date-time)wait_list_confirmation_deadlinestring (date-time)wait_list_confirmed_atstring (date-time)wait_list_pending_confirmationbooleanwait_list_sort_orderintegerbirthdaystring (date-time)Geburtstag des Teilnehmers.
trialbooleanSchnuppertermin-Anmeldung (Schnuppern): eine Terminanmeldung ohne Kursplatz, die eine Einheit des Schnupper-Kontingents der Person verbraucht (eventAccessBudget mit sourceType trial)
trial_channelstringWer den Probetermin gebucht hat: App, Trainer, Büro
trial_session_numberintegerNummer dieses Probetermins innerhalb des Durchgangs (1 = erster), für "Schnuppern 2/3"
trial_session_maxintegerSchnuppertermine des Passes, für "Schnuppern 2/3"
nace_sectionstringNACE-Abschnittscode (Buchstabe A-U)
nace_codestringNACE-Code (numerisch, z. B. 01.11, 62.01)
bib_numberintegerStartnummer (Zähler). Bei PER_PREFIX nur zusammen mit dem Präfix eindeutig. Wird nur über BibNumberAssigner gesetzt, stornierte Anmeldungen behalten sie.
bib_labelstringAngezeigte Startnummer inkl. Präfix, z. B. W0123. Pro Veranstaltung eindeutig.
bib_number_assigned_atstring (date-time)Zeitpunkt, zu dem die Startnummer vergeben wurde.
chip_codestringTransponder- oder QR-Kennung fuer die Zeitmessung. Pro Event eindeutig.
timing_tracking_consentbooleanEinwilligung 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.
addressstringAdresse als Text.
address_streetstringStraße der Adresse.
address_house_numberstringHausnummer der Adresse.
address_street_levelstringStraße und Hausnummer der Adresse.
address_costringCare-of-Zeile der Adresse.
address_citystringOrt der Adresse.
address_zipstringPostleitzahl der Adresse.
address_admin_level1stringErste Verwaltungsebene der Adresse, z. B. das Bundesland.
address_countrystringLändercode der Adresse.
address_full_countrystringVollständiger Name des Landes der Adresse.
address_geo_latstringBreitengrad der Adresse.
address_geo_lngstringLängengrad der Adresse.
address_external_provider_idstringFeld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE
namestringName der Einheit.
main_phonestringHaupttelefonnummer.
main_faxstringHaupt-Faxnummer.
main_emailstringHaupt-E-Mail-Adresse.
websitestringWebsite-Adresse.
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert
orderintegerPosition des Datensatzes in der Reihenfolge.
curl --request GET \
--url https://eure-instanz.iw-erp.de/api/invoice/shipping_price/calculate/42/30163/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/shipping_price/calculate/42/30163/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/shipping_price/calculate/42/30163/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/shipping_price/calculate/42/30163/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/shipping_price/calculate/42/30163/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/shipping_price/calculate/42/30163/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/shipping_price/calculate/42/30163/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_shipping_price_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 BillingShippingPriceController.get('42', '30163', '42');
if (result.success) {
print(result.data);
}{
"tax": {
"name": "Beispiel",
"id": 42,
"value": 1.5,
"deleted": true,
"global_default": true,
"datev_tax_key": 1
},
"offer_accounting_type": {
"name": "Beispiel",
"type": "string",
"id": 42,
"cancelled_name": "Beispiel",
"number_description": "Text",
"conditions": "string",
"deleted": true
},
"id": 42,
"currency": "EUR",
"name": "Beispiel",
"linked_number_title": "Beispiel",
"token": "string",
"number": 1,
"manual_number_prefix": "string",
"manual_number": 1
}