Server

<back to all web services

GetNebenkosten

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten/{Guid}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetNebenkosten : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null

    @ApiMember(IsRequired=true, ParameterType="path")
    var guid:UUID? = null
}

open class GetNebenkostenResponse
{
    var nebenkosten:Nebenkosten? = null
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class Nebenkosten
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var number:Long? = null

    @DataMember
    var from:Date? = null

    @DataMember
    var to:Date? = null

    @DataMember
    var targetAllocation:NebenkostenTargetAllocation? = null

    @DataMember
    var targetAllocationIn:NebenkostenTargetAllocationIn? = null

    @DataMember
    var nebenkostenKind:String? = null

    /**
    * Freitext
    */
    @DataMember
    @ApiMember(Description="Freitext")
    var kostenart:String? = null

    @DataMember
    var brutto:BigDecimal? = null

    @DataMember
    var bruttoLastYear:BigDecimal? = null

    @DataMember
    var salesTax:BigDecimal? = null

    @DataMember
    var haushaltsnahediensteLabel:String? = null

    @DataMember
    var haushaltsnahediensteBrutto:BigDecimal? = null

    /**
    * Freitext
    */
    @DataMember
    @ApiMember(Description="Freitext")
    var kostenartUnit:String? = null

    @DataMember
    var reduzierungsartType:String? = null

    @DataMember
    var comment:String? = null

    @DataMember
    var isDeleted:Boolean? = null

    @DataMember
    var isCreatedByApp:Boolean? = null

    @DataMember
    var nebenkostenNutzeinheiten:ArrayList<NebenkostenNutzeinheit> = ArrayList<NebenkostenNutzeinheit>()

    @DataMember
    var nebenkostenNutzer:ArrayList<NebenkostenNutzer> = ArrayList<NebenkostenNutzer>()

    @DataMember
    var billingInformation:BillingInformation? = null
}

enum class NebenkostenTargetAllocation
{
    Null,
    AlleNutzer,
    ZugeordneteNutzer,
    ZugeordneteNutzeinheiten,
    ZugeordneteNutzerDiff,
    ZugeordneteNutzeinheitenDiff,
}

enum class NebenkostenTargetAllocationIn
{
    Nebenkosten,
    Heizkosten,
    Warmwasserkosten,
}

@DataContract
open class NebenkostenNutzeinheit
{
    @DataMember
    var relativeAmount:BigDecimal? = null

    @DataMember
    var isDeleted:Boolean? = null

    @DataMember
    var isCreatedByApp:Boolean? = null

    @DataMember
    var nutzeinheitGuid:UUID? = null
}

@DataContract
open class NebenkostenNutzer
{
    @DataMember
    var relativeAmount:BigDecimal? = null

    @DataMember
    var isDeleted:Boolean? = null

    @DataMember
    var isCreatedByApp:Boolean? = null

    @DataMember
    var nutzerGuid:UUID? = null
}

@DataContract
open class BillingInformation
{
    @DataMember
    var guid:String? = null

    @DataMember
    var from:Date? = null

    @DataMember
    var to:Date? = null

    @DataMember
    var isCompleted:Boolean? = null

    @DataMember
    var hasNebenkosten:Boolean? = null
}

Kotlin GetNebenkosten DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/v1/nebenkosten/{Guid} HTTP/1.1 
Host: messtechnik-horb-servdesk.eras-online.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"nebenkosten":{"guid":"00000000000000000000000000000000","number":0,"from":"0001-01-01T00:00:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z","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:00.0000000Z","to":"0001-01-01T00:00:00.0000000Z","isCompleted":false,"hasNebenkosten":false}},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}