| POST | /api/v1/nebenkosten |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Nebenkosten | body | Nebenkosten | Yes | |
| RelatedToObjekt | body | RelatedTo | Yes | |
| RelatedToBillingInformation | body | RelatedTo | Yes | |
| BearerToken | body | string | Yes |
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Guid | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| ChecksumMD5 | form | string | 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.
POST /api/v1/nebenkosten HTTP/1.1
Host: bdl-servdesk.eras-online.de
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
nebenkosten:
{
guid: 00000000000000000000000000000000,
number: 0,
from: 0001-01-01T00:00:00Z,
to: 0001-01-01T00:00:00Z,
targetAllocation: Null,
targetAllocationIn: Nebenkosten,
nebenkostenKind: String,
kostenart: String,
brutto: 0,
bruttoLastYear: 0,
salesTax: 0,
haushaltsnahediensteLabel: String,
haushaltsnahediensteBrutto: 0,
kostenartUnit: String,
reduzierungsartType: String,
comment: String,
isDeleted: False,
isCreatedByApp: False,
nebenkostenNutzeinheiten:
[
{
relativeAmount: 0,
isDeleted: False,
isCreatedByApp: False,
nutzeinheitGuid: 00000000000000000000000000000000
}
],
nebenkostenNutzer:
[
{
relativeAmount: 0,
isDeleted: False,
isCreatedByApp: False,
nutzerGuid: 00000000000000000000000000000000
}
],
billingInformation:
{
guid: String,
from: 0001-01-01T00:00:00Z,
to: 0001-01-01T00:00:00Z,
isCompleted: False,
hasNebenkosten: False
}
},
relatedToObjekt:
{
guid: 00000000000000000000000000000000
},
relatedToBillingInformation:
{
guid: 00000000000000000000000000000000
},
bearerToken: String
}
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
}
},
checksumMD5: String
}