| GET | /api/v1/nebenkosten |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BearerToken | query | string | Yes | |
| FilterByObjektGuid | query | string | No | Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=* |
| FilterByBillingInformationGuid | query | string | No | Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=* |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| NebenkostenList | form | IEnumerable<Nebenkosten> | No | |
| ResponseStatus | form | ResponseStatus | 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 | string | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No | |
| IsCompleted | form | bool | No | |
| HasNebenkosten | form | bool | 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.
GET /api/v1/nebenkosten HTTP/1.1 Host: andreiuologmbh-servdesk.eras-online.de Accept: text/jsv
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
}
}
}