| PUT | /Customers |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Customer | body | Customer | No | |
| Objekte | body | List<Objekt> | No | |
| Addresses | body | List<Address> | No | |
| Nutzer | body | List<Nutzer> | No | |
| NutzerCoOwnership | body | List<NutzerCoOwnership> | No | |
| NutzerPersonen | body | List<NutzerPersonen> | No | |
| NutzerQuadratmeter | body | List<NutzerQuadratmeter> | No | |
| OwnerNutzeinheiten | body | List<OwnerNutzeinheit> | No | |
| Nutzeinheiten | body | List<Nutzeinheit> | No | |
| Direktkosten | body | List<Direktkosten> | No | |
| Prepayments | body | List<Prepayment> | No | |
| EnergieVerwerter | body | List<EnergieVerwerter> | No | |
| Brennstofflieferungen | body | List<Brennstofflieferung> | No | |
| Nebenkosten | body | List<Nebenkosten> | No | |
| Heizbetriebskosten | body | List<Heizbetriebskosten> | No | |
| NutzeinheitDevices | body | List<NutzeinheitDevice> | No | |
| Devices | body | List<Device> | No | |
| DeviceConsumptions | body | List<DeviceConsumption> | No | |
| BillingInformations | body | List<BillingInformation> | No | |
| DeleteUVI | body | bool | No | |
| KundenObjekteImObjektSync | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Name1 | form | string | No | |
| Name2 | form | string | No | |
| Name3 | form | string | No | |
| Number | form | string | No | |
| Salutation | form | string | No | |
| CustomerAddresses | form | List<CustomerAddress> | No | |
| CustomerObjekte | form | List<CustomerObjekt> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AddressGuid | form | string | No | |
| IsPrimary | form | bool | No | |
| AddressKindLabel | form | string | No | |
| AddressKindTyp | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| RangeFrom | form | DateTime | No | |
| RangeTo | form | DateTime? | No | |
| IsCustomer | form | bool | No | |
| IsOwner | form | bool | No | |
| IsOwnerPseudo | form | bool | No | |
| ObjektGuid | form | string | No | |
| CustomerGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Number | form | string | No | |
| IsCompleted | form | string | No | |
| Uvi | form | string | No | |
| IsUviDisabled | form | string | No | |
| CompletedDate | form | DateTime? | No | |
| AddressGuid | form | string | No | |
| AnmerkungKundenportal | form | string | No | |
| KundenportalMarkedDone | form | bool | No | |
| MarkedDoneAt | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Street | form | string | No | |
| Street2 | form | string | No | |
| StreetNumber | form | string | No | |
| Zipcode | form | string | No | |
| City | form | string | No | |
| Mailbox | form | string | No | |
| Additional | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| Name1 | form | string | No | |
| Name2 | form | string | No | |
| Name3 | form | string | No | |
| Name4 | form | string | No | |
| NutzerType | form | NutzerType? | Yes | Allowable Values
|
| NutzeinheitNumberExternal | form | string | No | |
| NutzerInNutzeinheitSequence | form | uint | Yes | |
| RangeFrom | form | DateTime | Yes | |
| RangeTo | form | DateTime? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| IsUviRecieved | form | string | No | |
| IsNutzerOwner | form | string | No | |
| form | string | No | ||
| MobilePhone | form | string | No | |
| Title | form | string | No | |
| Salutation | body | string | Yes |
| Leerstand | |
| Gewerblich | |
| Privat | |
| AllgemeineNutzung |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| ShareValue | form | decimal? | No | |
| RangeFrom | form | DateTime | No | |
| RangeTo | form | DateTime? | No | |
| NutzerGuid | form | string | No | |
| IsCreatedByApp | form | bool | No | |
| IsDeleted | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| NumberOfPeople | form | int? | No | |
| RangeFrom | form | DateTime | No | |
| RangeTo | form | DateTime? | No | |
| NutzerGuid | form | string | No | |
| IsCreatedByApp | form | bool | No | |
| IsDeleted | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| SquareMeters_Hzg | form | decimal? | No | |
| SquareMeters_Ww | form | decimal? | No | |
| SquareMeters_Nk | form | decimal? | No | |
| RangeFrom | form | DateTime | No | |
| RangeTo | form | DateTime? | No | |
| NutzerGuid | form | string | No | |
| IsCreatedByApp | form | bool | No | |
| IsDeleted | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Name1 | form | string | No | |
| Name2 | form | string | No | |
| Name3 | form | string | No | |
| Name4 | form | string | No | |
| RangeFrom | form | DateTime | No | |
| RangeTo | form | DateTime? | No | |
| Title | form | string | No | |
| Salutation | form | string | No | |
| AddressGuid | form | string | No | |
| NutzeinheitGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Number | form | string | No | |
| Location | form | string | No | |
| ObjektGuid | form | string | No | |
| AddressGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| Label | form | string | No | |
| Date | form | DateTime | No | |
| Brutto | form | decimal | No | |
| SalesTax | form | decimal | No | |
| Quantity | form | decimal | No | |
| Type | form | string | No | Allowable Values
|
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NutzerGuid | form | Guid | No | |
| BillingInformation | form | BillingInformation | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| IsCompleted | form | bool | No | |
| HasNebenkosten | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| Amount_Nk | form | decimal? | No | |
| Amount_HK | form | decimal? | No | |
| Amount_Ww | form | decimal? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| ObjektGuid | form | string | No | |
| NutzerGuid | form | string | No | |
| BillingInformationGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Label | form | string | No | |
| EfficiencyFactor | form | decimal? | No | |
| AssemblyDate | form | DateTime | No | |
| DisassemblyDate | form | DateTime? | No | |
| BuildYear | form | uint? | No | |
| Temperature | form | uint? | No | |
| CommercialSupply | form | bool | No | |
| Brennwert | form | bool | No | |
| ObjektGuid | form | string | No | |
| BrennstoffMediumGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| DeliveryDate | form | DateTime | No | |
| SalexTax | form | decimal? | No | |
| EmisionsTax | form | decimal? | No | |
| C02Taxes | form | decimal? | No | |
| CustomsTax | form | decimal? | No | |
| OtherCharges | form | decimal? | No | |
| C02Price | form | decimal? | No | |
| C02Tons | form | decimal? | No | |
| Quantity | form | decimal? | No | |
| Amount | form | decimal? | No | |
| StartMeterReadingValue | form | decimal? | No | |
| EndMeterReadingValue | form | decimal? | No | |
| Heizwert | form | decimal | No | |
| Brennwert | form | bool | No | |
| EnergyReliefAmountDescription | form | string | No | |
| EnergyReliefAmount | form | decimal? | No | |
| ElectricityReliefAmountDescription | form | string | No | |
| ElectricityReliefAmount | form | decimal? | No | |
| CO2EmissionsFactor | form | decimal? | No | |
| CO2Text | form | string | No | |
| CO2Active | form | bool? | No | |
| CO2PriceKnd | form | bool? | No | |
| CO2PriceLandlord | form | decimal? | No | |
| CO2PriceRenter | form | decimal? | No | |
| CO2Area | form | decimal? | No | |
| IsForCommercialUse | form | bool? | No | |
| IsRenovationRequired | form | bool? | No | |
| IsHeatingPadsImproved | form | bool? | No | |
| CO2KWh | form | decimal? | No | |
| IncludedCO2SalesTax | form | decimal? | No | |
| CO2Costs | form | decimal? | No | |
| TotalC02Weight | form | decimal? | No | |
| NoTotalDeductionC02Costs | form | bool? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| BrennstoffMediumGuid | form | Guid | No | |
| BillingInformation | form | BillingInformation | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| Number | form | uint | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| TargetAllocation | form | NebenkostenTargetAllocation? | No | Allowable Values
|
| TargetAllocationIn | form | NebenkostenTargetAllocationIn? | No | Allowable Values
|
| NebenkostenKind | form | string | No | Allowable Values
|
| Kostenart | form | string | No | Freitext |
| Brutto | form | decimal? | No | |
| BruttoLastYear | form | decimal? | No | |
| SalesTax | form | decimal? | No | |
| HaushaltsnahediensteLabel | form | string | No | |
| HaushaltsnahediensteBrutto | form | decimal? | No | |
| KostenartUnit | form | string | No | Freitext |
| ReduzierungsartType | form | string | No | Allowable Values
|
| Comment | form | string | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NebenkostenNutzeinheiten | form | List<NebenkostenNutzeinheit> | No | |
| NebenkostenNutzer | form | List<NebenkostenNutzer> | No | |
| BillingInformation | form | BillingInformation | No |
| Null | |
| AlleNutzer | |
| ZugeordneteNutzer | |
| ZugeordneteNutzeinheiten | |
| ZugeordneteNutzerDiff | |
| ZugeordneteNutzeinheitenDiff |
| Nebenkosten | |
| Heizkosten | |
| Warmwasserkosten |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RelativeAmount | form | decimal? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NutzeinheitGuid | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RelativeAmount | form | decimal? | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No | |
| NutzerGuid | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| SalesTax | form | decimal | No | |
| HaushatlsnahediensteBrutto | form | decimal? | No | |
| Brutto | form | decimal? | No | |
| HaushatlsnahediensteLabel | form | string | No | |
| Description | form | string | No | |
| IsDeleted | form | bool | No | |
| IsCreatedByApp | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| AssignedFromDate | form | DateTime | No | |
| AssignedToDate | form | DateTime? | No | |
| Room | form | string | No | |
| OngoingNumber | form | string | No | |
| IsRented | form | bool | No | |
| IsMaintained | form | bool | No | |
| DeviceGuid | form | string | No | |
| NutzeinheitGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| Number | form | string | No | |
| Label | form | string | No | |
| Description | form | string | No | |
| InstallationDate | form | DateTime | No | |
| DeinstallationDate | form | DateTime? | No | |
| CalibrationDate | form | DateTime? | No | |
| Unit | form | string | No | |
| Note | form | string | No | |
| DeviceCatalogGuid | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No | |
| DeviceReading | form | double? | No | |
| DeviceReadingDate | form | DateTime? | No | |
| DeviceReadingKind | form | DeviceReadingKind | No | Allowable Values
|
| ChangeDate | form | DateTime? | No | |
| Note | form | string | No | |
| AmpouleColour | form | string | No | |
| DeviceGuid | form | string | No |
| ZA | |
| HA | |
| MO | |
| EB | |
| AB |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | string | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| IsCompleted | form | bool | No | |
| HasNebenkosten | form | bool | No | |
| ObjektGuid | form | string | No | |
| AnmerkungKundenportal | form | string | No | |
| KundenportalMarkedDone | form | bool | No | |
| MarkedDoneAt | form | DateTime? | No | |
| KundenportalMarkedClosed | form | bool | No | |
| MarkedClosedAt | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /Customers HTTP/1.1
Host: mar-rr-servdesk.eras-online.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Kunde:
{
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:00Z,
ZeitraumBis: 0001-01-01T00:00:00Z,
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:00Z,
AdressGuid: String,
AnmerkungKundenportal: String,
KundenportalMarkedDone: False,
MarkedDoneAt: 0001-01-01T00:00:00Z
}
],
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:00Z,
ZeitraumBis: 0001-01-01T00:00:00Z,
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:00Z,
Bis: 0001-01-01T00:00:00Z,
NutzerGuid: String,
IsCreatedByApp: False,
IsDeleted: False
}
],
NutzerPersonen:
[
{
Guid: String,
Personen: 0,
Von: 0001-01-01T00:00:00Z,
Bis: 0001-01-01T00:00:00Z,
NutzerGuid: String,
IsCreatedByApp: False,
IsDeleted: False
}
],
NutzerQuadratmeter:
[
{
Guid: String,
Quadratmeter_Hzg: 0,
Quadratmeter_Ww: 0,
Quadratmeter_Nk: 0,
Von: 0001-01-01T00:00:00Z,
Bis: 0001-01-01T00:00:00Z,
NutzerGuid: String,
IsCreatedByApp: False,
IsDeleted: False
}
],
EigentuemerNutzeinheit:
[
{
Guid: String,
Name1: String,
Name2: String,
Name3: String,
Name4: String,
ZeitraumVon: 0001-01-01T00:00:00Z,
ZeitraumBis: 0001-01-01T00:00:00Z,
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:00Z,
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:00Z,
Bis: 0001-01-01T00:00:00Z,
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:00Z,
Ausbau: 0001-01-01T00:00:00Z,
Baujahr: 0,
Temperatur: 0,
EigenstGewerbLieferung: False,
Brennwert: False,
ObjektGuid: String,
BrennstoffMediumGuid: String
}
],
Brennstofflieferungen:
[
{
Guid: String,
Lieferdatum: 0001-01-01T00:00:00Z,
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:00Z,
Bis: 0001-01-01T00:00:00Z,
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:00Z,
Bis: 0001-01-01T00:00:00Z,
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:00Z,
ZuordnungBis: 0001-01-01T00:00:00Z,
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:00Z,
Ausbaudatum: 0001-01-01T00:00:00Z,
Eichdatum: 0001-01-01T00:00:00Z,
Einheit: String,
Memo: String,
DeviceCatalogGuid: String
}
],
Geraeteverbraeuche:
[
{
Guid: String,
Ablesung: 0,
Ablesedatum: 0001-01-01T00:00:00Z,
Ableseart: String,
Aenderungsdatum: 0001-01-01T00:00:00Z,
Anmerkung: String,
Ampullenfarbe: String,
DeviceGuid: String
}
],
BillingInformations:
[
{
Guid: String,
Von: 0001-01-01T00:00:00Z,
Bis: 0001-01-01T00:00:00Z,
IstAbgeschlossen: False,
HatNebenkosten: False,
ObjektGuid: String,
AnmerkungKundenportal: String,
KundenportalMarkedDone: False,
MarkedDoneAt: 0001-01-01T00:00:00Z,
KundenportalMarkedClosed: False,
MarkedClosedAt: 0001-01-01T00:00:00Z
}
],
DeleteUvi: False,
KundenObjekteImObjektSync: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}