Server

<back to all web services

GetNebenkostenList

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten
GetNebenkostenList Parameters:
NameParameterData TypeRequiredDescription
BearerTokenquerystringYes
FilterByObjektGuidquerystringNoOptional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*
FilterByBillingInformationGuidquerystringNoOptional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*
GetNebenkostenListResponse Parameters:
NameParameterData TypeRequiredDescription
NebenkostenListformIEnumerable<Nebenkosten>No
ResponseStatusformResponseStatusNo
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
BillingInformation Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
FromformDateTimeNo
ToformDateTimeNo
IsCompletedformboolNo
HasNebenkostenformboolNo

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.

GET /api/v1/nebenkosten HTTP/1.1 
Host: kromer-servdesk.eras-online.de 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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