Server

<back to all web services

CreateCustomers

Requires Authentication
The following routes are available for this service:
POST/Customers/Create
CreateCustomers Parameters:
NameParameterData TypeRequiredDescription
CustomersbodyList<Customer>No
ObjektebodyList<Objekt>No
AddressesbodyList<Address>No
NutzerbodyList<Nutzer>No
NutzerCoOwnershipbodyList<NutzerCoOwnership>No
NutzerPersonenbodyList<NutzerPersonen>No
NutzerQuadratmeterbodyList<NutzerQuadratmeter>No
OwnerNutzeinheitenbodyList<OwnerNutzeinheit>No
NutzeinheitenbodyList<Nutzeinheit>No
DirektkostenbodyList<Direktkosten>No
PrepaymentsbodyList<Prepayment>No
EnergieVerwerterbodyList<EnergieVerwerter>No
BrennstofflieferungenbodyList<Brennstofflieferung>No
NebenkostenbodyList<Nebenkosten>No
HeizbetriebskostenbodyList<Heizbetriebskosten>No
NutzeinheitDevicesbodyList<NutzeinheitDevice>No
DevicesbodyList<Device>No
DeviceConsumptionsbodyList<DeviceConsumption>No
BillingInformationsbodyList<BillingInformation>No
Customer Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
Name1formstringNo
Name2formstringNo
Name3formstringNo
NumberformstringNo
SalutationformstringNo
CustomerAddressesformList<CustomerAddress>No
CustomerObjekteformList<CustomerObjekt>No
CustomerAddress Parameters:
NameParameterData TypeRequiredDescription
AddressGuidformstringNo
IsPrimaryformboolNo
AddressKindLabelformstringNo
AddressKindTypformstringNo
CustomerObjekt Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
RangeFromformDateTimeNo
RangeToformDateTime?No
IsCustomerformboolNo
IsOwnerformboolNo
IsOwnerPseudoformboolNo
ObjektGuidformstringNo
CustomerGuidformstringNo
Objekt Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
NumberformstringNo
IsCompletedformstringNo
UviformstringNo
IsUviDisabledformstringNo
CompletedDateformDateTime?No
AddressGuidformstringNo
AnmerkungKundenportalformstringNo
KundenportalMarkedDoneformboolNo
MarkedDoneAtformDateTime?No
Address Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
StreetformstringNo
Street2formstringNo
StreetNumberformstringNo
ZipcodeformstringNo
CityformstringNo
MailboxformstringNo
AdditionalformstringNo
Nutzer Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
Name1formstringNo
Name2formstringNo
Name3formstringNo
Name4formstringNo
NutzerTypeformNutzerType?Yes

Allowable Values

  • Leerstand
  • Gewerblich
  • Privat
  • AllgemeineNutzung
NutzeinheitNumberExternalformstringNo
NutzerInNutzeinheitSequenceformuintYes
RangeFromformDateTimeYes
RangeToformDateTime?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
IsUviRecievedformstringNo
IsNutzerOwnerformstringNo
EmailformstringNo
MobilePhoneformstringNo
TitleformstringNo
SalutationbodystringYes
NutzerType Enum:
Leerstand
Gewerblich
Privat
AllgemeineNutzung
NutzerCoOwnership Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
ShareValueformdecimal?No
RangeFromformDateTimeNo
RangeToformDateTime?No
NutzerGuidformstringNo
IsCreatedByAppformboolNo
IsDeletedformboolNo
NutzerPersonen Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
NumberOfPeopleformint?No
RangeFromformDateTimeNo
RangeToformDateTime?No
NutzerGuidformstringNo
IsCreatedByAppformboolNo
IsDeletedformboolNo
NutzerQuadratmeter Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
SquareMeters_Hzgformdecimal?No
SquareMeters_Wwformdecimal?No
SquareMeters_Nkformdecimal?No
RangeFromformDateTimeNo
RangeToformDateTime?No
NutzerGuidformstringNo
IsCreatedByAppformboolNo
IsDeletedformboolNo
OwnerNutzeinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
Name1formstringNo
Name2formstringNo
Name3formstringNo
Name4formstringNo
RangeFromformDateTimeNo
RangeToformDateTime?No
TitleformstringNo
SalutationformstringNo
AddressGuidformstringNo
NutzeinheitGuidformstringNo
Nutzeinheit Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
NumberformstringNo
LocationformstringNo
ObjektGuidformstringNo
AddressGuidformstringNo
Direktkosten Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
LabelformstringNo
DateformDateTimeNo
BruttoformdecimalNo
SalesTaxformdecimalNo
QuantityformdecimalNo
TypeformstringNo

Allowable Values

  • Heizkosten
  • Nebenkosten
IsDeletedformboolNo
IsCreatedByAppformboolNo
NutzerGuidformGuidNo
BillingInformationformBillingInformationNo
BillingInformation Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
FromformDateTimeNo
ToformDateTimeNo
IsCompletedformboolNo
HasNebenkostenformboolNo
Prepayment Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
FromformDateTimeNo
ToformDateTimeNo
Amount_Nkformdecimal?No
Amount_HKformdecimal?No
Amount_Wwformdecimal?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
ObjektGuidformstringNo
NutzerGuidformstringNo
BillingInformationGuidformstringNo
EnergieVerwerter Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
LabelformstringNo
EfficiencyFactorformdecimal?No
AssemblyDateformDateTimeNo
DisassemblyDateformDateTime?No
BuildYearformuint?No
Temperatureformuint?No
CommercialSupplyformboolNo
BrennwertformboolNo
ObjektGuidformstringNo
BrennstoffMediumGuidformstringNo
Brennstofflieferung Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
DeliveryDateformDateTimeNo
SalexTaxformdecimal?No
EmisionsTaxformdecimal?No
C02Taxesformdecimal?No
CustomsTaxformdecimal?No
OtherChargesformdecimal?No
C02Priceformdecimal?No
C02Tonsformdecimal?No
Quantityformdecimal?No
Amountformdecimal?No
StartMeterReadingValueformdecimal?No
EndMeterReadingValueformdecimal?No
HeizwertformdecimalNo
BrennwertformboolNo
EnergyReliefAmountDescriptionformstringNo
EnergyReliefAmountformdecimal?No
ElectricityReliefAmountDescriptionformstringNo
ElectricityReliefAmountformdecimal?No
CO2EmissionsFactorformdecimal?No
CO2TextformstringNo
CO2Activeformbool?No
CO2PriceKndformbool?No
CO2PriceLandlordformdecimal?No
CO2PriceRenterformdecimal?No
CO2Areaformdecimal?No
IsForCommercialUseformbool?No
IsRenovationRequiredformbool?No
IsHeatingPadsImprovedformbool?No
CO2KWhformdecimal?No
IncludedCO2SalesTaxformdecimal?No
CO2Costsformdecimal?No
TotalC02Weightformdecimal?No
NoTotalDeductionC02Costsformbool?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
BrennstoffMediumGuidformGuidNo
BillingInformationformBillingInformationNo
Nebenkosten Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
NumberformuintNo
FromformDateTimeNo
ToformDateTimeNo
TargetAllocationformNebenkostenTargetAllocation?No

Allowable Values

  • Null
  • AlleNutzer
  • ZugeordneteNutzer
  • ZugeordneteNutzeinheiten
  • ZugeordneteNutzerDiff
  • ZugeordneteNutzeinheitenDiff
TargetAllocationInformNebenkostenTargetAllocationIn?No

Allowable Values

  • Nebenkosten
  • Heizkosten
  • Warmwasserkosten
NebenkostenKindformstringNo

Allowable Values

  • Nebenkosten
  • Heizkosten
  • Warmwasserkosten
KostenartformstringNoFreitext
Bruttoformdecimal?No
BruttoLastYearformdecimal?No
SalesTaxformdecimal?No
HaushaltsnahediensteLabelformstringNo
HaushaltsnahediensteBruttoformdecimal?No
KostenartUnitformstringNoFreitext
ReduzierungsartTypeformstringNo

Allowable Values

  • KeineReduzierung
  • NachTagen
  • NachGradtagen
CommentformstringNo
IsDeletedformboolNo
IsCreatedByAppformboolNo
NebenkostenNutzeinheitenformList<NebenkostenNutzeinheit>No
NebenkostenNutzerformList<NebenkostenNutzer>No
BillingInformationformBillingInformationNo
NebenkostenTargetAllocation Enum:
Null
AlleNutzer
ZugeordneteNutzer
ZugeordneteNutzeinheiten
ZugeordneteNutzerDiff
ZugeordneteNutzeinheitenDiff
NebenkostenTargetAllocationIn Enum:
Nebenkosten
Heizkosten
Warmwasserkosten
NebenkostenNutzeinheit Parameters:
NameParameterData TypeRequiredDescription
RelativeAmountformdecimal?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
NutzeinheitGuidformGuidNo
NebenkostenNutzer Parameters:
NameParameterData TypeRequiredDescription
RelativeAmountformdecimal?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
NutzerGuidformGuidNo
Heizbetriebskosten Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
FromformDateTimeNo
ToformDateTimeNo
SalesTaxformdecimalNo
HaushatlsnahediensteBruttoformdecimal?No
Bruttoformdecimal?No
HaushatlsnahediensteLabelformstringNo
DescriptionformstringNo
IsDeletedformboolNo
IsCreatedByAppformboolNo
NutzeinheitDevice Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
AssignedFromDateformDateTimeNo
AssignedToDateformDateTime?No
RoomformstringNo
OngoingNumberformstringNo
IsRentedformboolNo
IsMaintainedformboolNo
DeviceGuidformstringNo
NutzeinheitGuidformstringNo
Device Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
NumberformstringNo
LabelformstringNo
DescriptionformstringNo
InstallationDateformDateTimeNo
DeinstallationDateformDateTime?No
CalibrationDateformDateTime?No
UnitformstringNo
NoteformstringNo
DeviceCatalogGuidformstringNo
DeviceConsumption Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
DeviceReadingformdouble?No
DeviceReadingDateformDateTime?No
DeviceReadingKindformDeviceReadingKindNo

Allowable Values

  • ZA
  • HA
  • MO
  • EB
  • AB
ChangeDateformDateTime?No
NoteformstringNo
AmpouleColourformstringNo
DeviceGuidformstringNo
DeviceReadingKind Enum:
ZA
HA
MO
EB
AB
BillingInformation Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
FromformDateTimeNo
ToformDateTimeNo
IsCompletedformboolNo
HasNebenkostenformboolNo
ObjektGuidformstringNo
AnmerkungKundenportalformstringNo
KundenportalMarkedDoneformboolNo
MarkedDoneAtformDateTime?No
KundenportalMarkedClosedformboolNo
MarkedClosedAtformDateTime?No
CreateCustomersResponse Parameters:
NameParameterData TypeRequiredDescription
CustomersCreatedformintNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Customers/Create HTTP/1.1 
Host: demo-servdesk.eras-online.de 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Kunden":[{"Guid":"String","Name1":"String","Name2":"String","Name3":"String","Kundennummer":"String","Anrede":"String","KundenAdressen":[{"AdresseGuid":"String","IstPrimaer":false,"AdressTypBezeichnung":"String","AdressTyp":"String"}],"KundenObjekte":[{"Guid":"String","ZeitraumVon":"0001-01-01T00:00:00.0000000Z","ZeitraumBis":"0001-01-01T00:00:00.0000000Z","IstKunde":false,"IstEigentümer":false,"IstEigentümerPseudo":false,"ObjektGuid":"String","KundeGuid":"String"}]}],"Objekte":[{"Guid":"String","Objektnummer":"String","IstAbgeschlossen":"String","Uvi":"String","IsUviDisabled":"String","AbgeschlossenDatum":"0001-01-01T00:00:00.0000000Z","AdressGuid":"String","AnmerkungKundenportal":"String","KundenportalMarkedDone":false,"MarkedDoneAt":"0001-01-01T00:00:00.0000000Z"}],"Adressen":[{"Guid":"String","Straße":"String","Straße2":"String","Hausnummer":"String","Postleitzahl":"String","Ort":"String","Postfach":"String","Adresszusatz":"String"}],"Nutzer":[{"Guid":"String","Name1":"String","Name2":"String","Name3":"String","Name4":"String","NutzerType":"String","NutzeinheitNummerExtern":"String","NutzerInNutzeinheitReihenfolge":0,"ZeitraumVon":"0001-01-01T00:00:00.0000000Z","ZeitraumBis":"0001-01-01T00:00:00.0000000Z","IstGeloescht":false,"IstErzeugtVonApp":false,"Uvi":"String","EigentuemerBewohnt":"String","Email":"String","Mobil":"String","Titel":"String","Anrede":"String","NutzeinheitGuid":"String"}],"NutzerCoOwnership":[{"Guid":"String","ShareValue":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","NutzerGuid":"String","IsCreatedByApp":false,"IsDeleted":false}],"NutzerPersonen":[{"Guid":"String","Personen":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","NutzerGuid":"String","IsCreatedByApp":false,"IsDeleted":false}],"NutzerQuadratmeter":[{"Guid":"String","Quadratmeter_Hzg":0,"Quadratmeter_Ww":0,"Quadratmeter_Nk":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","NutzerGuid":"String","IsCreatedByApp":false,"IsDeleted":false}],"EigentuemerNutzeinheit":[{"Guid":"String","Name1":"String","Name2":"String","Name3":"String","Name4":"String","ZeitraumVon":"0001-01-01T00:00:00.0000000Z","ZeitraumBis":"0001-01-01T00:00:00.0000000Z","Titel":"String","Anrede":"String","AdressGuid":"String","NutzeinheitGuid":"String"}],"Nutzeinheiten":[{"Guid":"String","Nummer":"String","Lage":"String","ObjektGuid":"String","AdressGuid":"String"}],"Direktkosten":[{"Guid":"String","Bezeichnung":"String","Datum":"0001-01-01T00:00:00.0000000Z","Brutto":0,"Mwst":0,"Menge":0,"Typ":"String","IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","NutzerGuid":"String","BillingInformationGuid":"String"}],"Prepayments":[{"Guid":"String","Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","VZ Nebenkosten":0,"VZ Heizkosten":0,"VZ Warmwasser":0,"IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","NutzerGuid":"String","BillingInformationGuid":"String"}],"EnergieVerwerter":[{"Guid":"String","Bezeichnung":"String","Wirkungsgrad":0,"Einbau":"0001-01-01T00:00:00.0000000Z","Ausbau":"0001-01-01T00:00:00.0000000Z","Baujahr":0,"Temperatur":0,"EigenstGewerbLieferung":false,"Brennwert":false,"ObjektGuid":"String","BrennstoffMediumGuid":"String"}],"Brennstofflieferungen":[{"Guid":"String","Lieferdatum":"0001-01-01T00:00:00.0000000Z","Mwst":0,"Emissionsangabe":0,"Steuern":0,"Zolle":0,"SonstigeAngaben":0,"C02Preis":0,"C02Tonnen":0,"Menge":0,"Betrag":0,"Anfangsstand":0,"Endstand":0,"Heizwert":0,"Brennwert":false,"IstGeloescht":false,"IstErzeugtVonApp":false,"EnergieEntlastungsbetragBezeichnung":"String","EnergieEntlastungsbetrag":0,"StromEntlastungsbetragBezeichnung":"String","StromEntlastungsbetrag":0,"CO2Emissionsfaktor":0,"CO2Text":"String","CO2Aktiv":false,"CO2PreisKnd":false,"CO2PreisVermieter":0,"CO2PreisMieter":0,"CO2Flaeche":0,"GewerblicheNutzung":false,"Sanierungsauflagen":false,"AuflagenHeizungsverbesserung":false,"CO2KWH":0,"EnthalteneMwst":0,"CO2KostenBrutto":0,"CO2GesamtKg":0,"KeinGesamtabzugC02Kosten":false,"EnergieVerwerterGuid":"String","BrennstoffMediumGuid":"String","BillingInformationGuid":"String"}],"Nebenkosten":[{"Guid":"String","Kostennummer":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","UmlageZiel":"String","UmlageZielIn":"String","NebenkostenArt":"String","Kostenart":"String","Brutto":0,"BruttoLetztesJahr":0,"Mwst":0,"HaushaltsnahediensteLabel":"String","HaushaltsnahediensteBrutto":0,"EinheitDerKostenart":"String","Reduzierungsart":"String","Kommentar":"String","IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","BillingInformationGuid":"String","NebenkostenNutzeinheiten":[{"Anteil":0,"IstGeloescht":false,"IstErzeugtVonApp":false,"NutzeinheitGuid":"String"}],"NebenkostenNutzer":[{"Anteil":0,"IstGeloescht":false,"IstErzeugtVonApp":false,"NutzerGuid":"String"}]}],"Heizbetriebskosten":[{"Guid":"String","Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","Mwst":0,"HaushatlsnahediensteBrutto":0,"Brutto":0,"HaushatlsnahediensteLabel":"String","Anmerkung":"String","IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","BillingInformationGuid":"String"}],"NutzeinheitGeraete":[{"Guid":"String","ZuordnungVon":"0001-01-01T00:00:00.0000000Z","ZuordnungBis":"0001-01-01T00:00:00.0000000Z","Raum":"String","LaufendeNummer":"String","gemietet":false,"gewartet":false,"DeviceGuid":"String","NutzeinheitGuid":"String"}],"Geraete":[{"Guid":"String","Geraetenummer":"String","Bezeichnung":"String","Beschreibung":"String","Einbaudatum":"0001-01-01T00:00:00.0000000Z","Ausbaudatum":"0001-01-01T00:00:00.0000000Z","Eichdatum":"0001-01-01T00:00:00.0000000Z","Einheit":"String","Memo":"String","DeviceCatalogGuid":"String"}],"Geraeteverbraeuche":[{"Guid":"String","Ablesung":0,"Ablesedatum":"0001-01-01T00:00:00.0000000Z","Ableseart":"String","Aenderungsdatum":"0001-01-01T00:00:00.0000000Z","Anmerkung":"String","Ampullenfarbe":"String","DeviceGuid":"String"}],"BillingInformations":[{"Guid":"String","Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","IstAbgeschlossen":false,"HatNebenkosten":false,"ObjektGuid":"String","AnmerkungKundenportal":"String","KundenportalMarkedDone":false,"MarkedDoneAt":"0001-01-01T00:00:00.0000000Z","KundenportalMarkedClosed":false,"MarkedClosedAt":"0001-01-01T00:00:00.0000000Z"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"customersCreated":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}