Server

GetNebenkostenList

Nebenkosten

The following routes are available for this service:
GET	/api/v1/nebenkosten

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


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

    /**
    * Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*
    */
    @DataMember(Name="filter[ObjektGuid]")
    @SerializedName("filter[ObjektGuid]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[ObjektGuid]=*", ParameterType="query")
    var filterByObjektGuid:String? = null

    /**
    * Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*
    */
    @DataMember(Name="filter[BillingInformationGuid]")
    @SerializedName("filter[BillingInformationGuid]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/nebenkosten?filter[BillingInformationGuid]=*", ParameterType="query")
    var filterByBillingInformationGuid:String? = null
}

open class GetNebenkostenListResponse
{
    var nebenkostenList:ArrayList<Nebenkosten> = ArrayList<Nebenkosten>()
    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 GetNebenkostenList 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 HTTP/1.1 
Host: faabrechnungen-servdesk.eras-online.de 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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