Service Definition
Authentication:
OAuth 2.0
Read access
Status Code:
- 200 OK: Successful GET request.
- 201 Created: Successful creation of a resource.
- 400 Bad Request: Invalid request (e.g., missing parameters).
- 401 Unauthorized: Missing or incorrect authentication.
- 404 Not Found: Resource not found.
- 500 Internal Server Error: General server error.
Version 1:
AddressService:
/v1/Address/{id}:
Description: Retrieves an address based on the provided customerId
API URL: /{version}/Address/{id}
id: Represents the customerId
Json response structure:
{
"id": 0,
"lastname": "string",
"firstname": "string",
"communications": [
{
"address": "string",
"communicationMediumId": 0
}
],
"company": "string",
"function": "string",
"addressType": "string",
"street": "string",
"city": "string",
"zip": "string",
"country": "string",
"lastUpdate": "2024-12-11T07:26:36.434Z",
"adressZusatz": "string",
"kundeSeit": "2024-12-11T07:26:36.434Z",
"sprachId": 0,
"nrUndName": "string",
"ganzeAdresse": "string"
}he attributes map to the following text fields (see screenshot):
a <= company
b <= street
c <= zip
d <= city
e <= firstname
f <= lastname
g/h <= list of communications
- address <= like phone number or e-mail address
- communicationMediumId <= type of communication medium e.g privat phone number or business e-mail address
i <= sprachId
/v1/Address/ByCompany:
Description: Retrieves all addresses matching a CompanyName or a combination of street and zip.
API URL: /{version}/Address/ByCompany´?companyName={companyName}&street={street}&zip={zip}
Required attribute:
- companyName: The name of the company.
Optional attribute:
- street: Street name
- zip: ZIP code
Json response structure: (same as /v1/Address/{id}):
{
"id": 0,
"lastname": "string",
"firstname": "string",
"communications": [
{
"address": "string",
"communicationMediumId": 0
}
],
"company": "string",
"function": "string",
"addressType": "string",
"street": "string",
"city": "string",
"zip": "string",
"country": "string",
"lastUpdate": "2024-12-11T07:26:36.434Z",
"adressZusatz": "string",
"kundeSeit": "2024-12-11T07:26:36.434Z",
"sprachId": 0,
"nrUndName": "string",
"ganzeAdresse": "string"
}a <= company
b <= street
c <= zip
d <= city
e <= firstname
f <= lastname
g/h <= list of communications
- address <= like phone number or e-mail address
- communicationMediumId <= type of communication medium e.g privat phone number or business e-mail address
i <= sprachId
OrderService
/v1/Orders/{id}:
Description: Retrieves all orders associated with a customerId.
API URL: /{version}/Orders/{id}
id: Represents the 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
}
]
}The attributes map to the following text fields (see screenshot):
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:
Description: This endpoint allows you to find all addresses associated with a company or sole proprietorship.
Change: The required attribute has been updated. Instead of using the company attribute, the new NrUndName attribute is now used. This enhancement enables searching not only by company or person name but also by customer ID.
API URL: /{version}/Address/ByCompany´?companyName={companyName}&street={street}&zip={zip}
Required attribute:
Optional attribute: