Shipping

Billing1 EndpointsBilling / Shipping

Returns a dummy offer with calculated shipping price

GET/api/invoice/shipping_price/calculate/{countryCode}/{zipCode}/{shippingType}

Path parameters

`countryCode`requiredstring
`zipCode`requiredstring
`shippingType`requiredstring

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 dummy offer with calculated shipping priceOffer5

Show fields (33)

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.
offer_accounting_typeOfferAccountingTyperequired
Accounting type of the offer.
Show fields (7)
- idinteger
  Primary key of the offer accounting type. Internal ID.
- namestringrequired
  Name of the accounting type.
- cancelled_namestring
  Name used when an offer of this type is canceled.
- typestringrequired
  Type of the accounting type, for example offer or contract.
- conditionsstring
  Conditions printed on the offer.
- number_descriptionstring
  Description of the number format of the offer.
- deletedboolean
  The accounting type is deleted.
itemsarray<OfferItem5>
Items of the offer.
Show fields (16)
- idinteger
  Primary key of the invoice item. Internal ID.
- descriptionstring
  Description of the invoice item.
- price_is_bruttoboolean
  Whether the price is a gross price including tax.
- skustring
  Artikelnummer (Stock Keeping Unit)
- barcodestring
  Barcode (ISBN, UPC, GTIN usw.)
- item_typestring
  Typ (Item, Shipping)
- netto_valuenumber (float)
  Net value of the invoice item.
- brutto_valuenumber (float)
  Gross value of the invoice item.
- tax_valuenumber (float)
  Tax amount of the invoice item.
- quantitynumber (float)required
  Quantity of the invoice item.
- pricenumber (float)required
  Unit price of the invoice item.
- namestringrequired
  Name of the invoice item.
- unitstringrequired
  Unit of the invoice item.
- taxTax
  Tax rate applied to the invoice item.
- offerOffer5
  Offer the item belongs to.
- custom_productCustomizedBillingItem4
  Customized product used for the item.
buyerOfferBuyer5
Buyer of the offer.
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.
- offerOffer5
  Offer the buyer belongs to.
accepted_datestring (date-time)
Date the offer was accepted.
is_accepted_date_from_ext_serviceboolean
The acceptance date comes from an external service.
projectCRMProject13
Project the offer belongs to.
Show fields (19)
- idinteger
  Primary key of the project. Internal ID.
- namestring
  Name of the project.
- closedstring (date-time)
  Time the project was closed.
- billedstring (date-time)
  Time the project was billed.
- numberstring
  Number of the project.
- startstring (date-time)
  Start of the project.
- endstring (date-time)
  End of the project.
- descriptionstring
  Description of the project.
- companyCRMCompany
  Company the project belongs to.
- internal_main_contactUser14
  Internal login user who is the main contact.
- categoryCRMProjectCategory
  Category of the project.
- archivedboolean
  The project is archived.
- visible_for_customerboolean
  The project is visible in the customer app.
- name_for_customerstring
  Name of the project shown to customers.
- invoice_emailstring
  E-mail address for invoices of the project.
- time_report_emailstring
  E-mail address for time reports of the project.
- search_stringstring
  Text that the entity can be searched by.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
invoicesarray<Invoice21>
Invoices created from the offer.
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.
- 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.
- payment_typePaymentType
  Payment type of the invoice.
- payment_goalPaymentGoal
  Payment term of the invoice.
- expense_categoryExpenseCategory10
  EÜR-Kategorie für diese Rechnung (Einnahmen-Zuordnung) Wenn nicht gesetzt, wird die Default-Kategorie des AccountingTypes verwendet
- buyerInvoiceBuyer20
  Buyer of the invoice.
- 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.
base_event_sign_upBaseEventSignUp10
Sign-up the offer 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.

Request

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

import 'package:iw_erp_api/clients/billing_shipping_price_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 BillingShippingPriceController.get('42', '30163', '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
  },
  "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
}