Release Notes
Version 1:
AddressService:
/v1/Address/{id}:
Description: Return address find by customerId.
API URL: /{version}/Address/{id}
id = customer id
Json response structure:
{
"id": 0,
"lastname": "string",
"firstname": "string",
"emails": [
"string"
],
"company": "string",
"function": "string",
"addressType": "string",
"street": "string",
"city": "string",
"zip": "string",
"country": "string",
"lastUpdate": "2024-12-10T12:52:47.639Z",
"adressZusatz": "string",
"kundeSeit": "2024-12-10T12:52:47.639Z",
"sprachId": 0,
"nrUndName": "string",
"ganzeAdresse": "string"
}Which attribute belongs to which
a <= company
b <= street
c <= zip
d <= city
e <= firstname
f <= lastname
g <=
h <= email (list)
i <= sprachId ?
/v1/Address/ByCompany:
Description: Return all addresses find by 'CompanyName' or in combination with street and zip.
API URL: /{version}/Address/ByCompany´?companyName={companyName}&street={street}&zip={zip}
Required attribute:
- companyName = company
Optional attribute:
- street = street
- zip = zip
Json response structure:
{
"id": 0,
"lastname": "string",
"firstname": "string",
"emails": [
"string"
],
"company": "string",
"function": "string",
"addressType": "string",
"street": "string",
"city": "string",
"zip": "string",
"country": "string",
"lastUpdate": "2024-12-10T12:52:47.639Z",
"adressZusatz": "string",
"kundeSeit": "2024-12-10T12:52:47.639Z",
"sprachId": 0,
"nrUndName": "string",
"ganzeAdresse": "string"
}a <= company
b <= street
c <= zip
d <= city
e <= firstname
f <= lastname
g <=
h <= email (list)
i <= sprachId ?
OrderService
/v1/Orders/{id}:
Description: Return all orders find by customerId.
Json response structure:
{
"id": 0,
"client": "string",
"invoiceAddress": "string",
"auftreage": [
{
"responsiblePersonName": "string",
"orderStatus": 0,
"invoiceNumber": "string",
"invoiceDate": "2024-12-10T12:54:08.034Z",
"reference": "string",
"orderNumber": "string",
"dueDate": "2024-12-10T12:54:08.034Z",
"paymentDate": "2024-12-10T12:54:08.034Z",
"auftragsPostens": [
{
"id": 0,
"customerId": 0,
"pickUpId": 0,
"auftragsBeschreibung": "string",
"postenArt": 0,
"anzahlStunden": 0,
"stundensatzs": [
{
"id": 0,
"beschreibung": "string",
"stundenansatz": 0,
"groupId": 0,
"preisInklMwst": 0,
"mwstSatz": 0,
"waehrungsId": 0,
"wirdVerwendet": true,
"sortierung": 0
}
],
"anzahlStueck": 0,
"preisProStueck": 0,
"products": [
{
"id": 0,
"parentId": 0,
"productFamilyId": 0,
"isProduct": true,
"hasChildren": true,
"produktNr": "string",
"produktName": "string",
"beschreibung": "string",
"bild": "string",
"einkaufsPreis": 0,
"einkaufsPreisInklMwst": true,
"verkaufsPreis": 0,
"verkaufsPreisInklMwst": true,
"mwstSatz": 0,
"wirdVerwendet": true,
"sortierung": 0,
"mwstSatzEur": 0,
"mwstSatzUsd": 0,
"einkaufsPreisEur": 0,
"einkaufsPreisUsd": 0,
"verkaufsPreisEur": 0,
"verkaufsPreisUsd": 0,
"ean": "string",
"chfkontoId": 0,
"eurkontoId": 0,
"usdkontoId": 0
}
],
"preis": 0,
"mwstSatz": 0,
"rechnungsdetail": "string",
"auftragErledigtAm": "2024-12-10T12:54:08.034Z",
"auftragErledigtVon": "string",
"preisInklMwst": 0,
"einheit": "string",
"sortierung": 0,
"versteckt": true,
"bemerkung": "string",
"docCrystalReportId": 0,
"einkaufsPreisProStück": 0,
"einkaufsPreisTotal": 0,
"einkaufsPreisInklMwst": 0,
"rabattVariante": 0,
"rabattProzent": 0,
"verantwortlicheId": 0,
"mietObjekts": [
{
"id": 0,
"einzelAuftragsObjektGruppeId": 0,
"name": "string",
"doc1CrystalReportId": 0,
"doc2CrystalReportId": 0,
"beschreibung": "string",
"nameEnglisch": "string",
"beschreibungEnglisch": "string",
"wirdVerwendet": true,
"einzelAuftragsObjektKlasseId": 0,
"isDefault": true,
"lieferantId": 0,
"garantieId": 0,
"kaufRechnungsNr": "string",
"seriennummer": "string",
"kaufPreis": 0,
"kaufDatum": "2024-12-10",
"garantieEnde": "2024-12-10",
"premiumMonate": 0,
"weitereMonate": 0,
"notizen": "string",
"treibstoffVerbrauch": 0
}
],
"mietBeginn": "2024-12-10T12:54:08.034Z",
"mietEnde": "2024-12-10T12:54:08.034Z",
"mietEinheiten": 0,
"mietPreisKlasses": [
{
"id": 0,
"objektId": 0,
"einheitId": 0,
"attributId": 0,
"währungsId": 0,
"preis": 0,
"mwstSatz": 0,
"preisInklMwst": true,
"sortierung": 0,
"einkaufsPreis": 0,
"einkaufsPreisInklMwst": true,
"wirdVerwendet": true,
"objektKlassenId": 0,
"paymentPeriodDuration": 0
}
],
"kurzTexts": [
{
"id": 0,
"gruppe": "string",
"text1": "string",
"text2": "string",
"sortierung": 0,
"text3": "string",
"wirdVerwendet": true,
"istStandard": true,
"text4": "string"
}
],
"doc2CrystalReportId": 0,
"mietReiseKosten": 0,
"schwesterAuftragsPostenId": 0,
"auftragsSprache": 0,
"mietdauerInklZeitangabe": true,
"verstecktInLieferschein": true,
"kontoId": 0,
"istGutschrift": true,
"istZahlungsAusgleich": true
}
],
"totalPrice": 0
}
]
}1 <= client
2 <= invoiceAddress
3 <= responsiblePersonName
4 <= orderstatus per auftreage (order)
5 <= invoiceNumber per auftreage (order)
6 <= invoiceDate per auftreage (order)
7 <= reference per auftreage (order)
8 <= orderNumber per auftreage (order)
9 <= dueDate per auftreage (order)
10 <= paymentDate per auftreage (order)
11 - 16 <= list of auftragpostens
17 <= totalPrice
Version 2:
What's New:
AddressService:
/v1/Address/ByCompany:
To find all addresses by a company or sole proprietorship another attribute are used than before. The attibute called "NrUndName" allow to not only search after company or person name, but after customer id.
Description: Return all addresses find by 'CompanyName' or in combination with street and zip.