Server

<back to all web services

GetNebenkostenList

Nebenkosten
Requires Authentication
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.*;

public class dtos
{

    public static class GetNebenkostenList implements IHasBearerToken
    {
        @ApiMember(IsRequired=true, ParameterType="query")
        public String bearerToken = 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")
        public String filterByObjektGuid = 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")
        public String filterByBillingInformationGuid = null;
        
        public String getBearerToken() { return bearerToken; }
        public GetNebenkostenList setBearerToken(String value) { this.bearerToken = value; return this; }
        public String getFilterByObjektGuid() { return filterByObjektGuid; }
        public GetNebenkostenList setFilterByObjektGuid(String value) { this.filterByObjektGuid = value; return this; }
        public String getFilterByBillingInformationGuid() { return filterByBillingInformationGuid; }
        public GetNebenkostenList setFilterByBillingInformationGuid(String value) { this.filterByBillingInformationGuid = value; return this; }
    }

    public static class GetNebenkostenListResponse
    {
        public ArrayList<Nebenkosten> nebenkostenList = null;
        public ResponseStatus responseStatus = null;
        
        public ArrayList<Nebenkosten> getNebenkostenList() { return nebenkostenList; }
        public GetNebenkostenListResponse setNebenkostenList(ArrayList<Nebenkosten> value) { this.nebenkostenList = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetNebenkostenListResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class Nebenkosten
    {
        @DataMember
        public UUID guid = null;

        @DataMember
        public Long number = null;

        @DataMember
        public Date from = null;

        @DataMember
        public Date to = null;

        @DataMember
        public NebenkostenTargetAllocation targetAllocation = null;

        @DataMember
        public NebenkostenTargetAllocationIn targetAllocationIn = null;

        @DataMember
        public String nebenkostenKind = null;

        /**
        * Freitext
        */
        @DataMember
        @ApiMember(Description="Freitext")
        public String kostenart = null;

        @DataMember
        public BigDecimal brutto = null;

        @DataMember
        public BigDecimal bruttoLastYear = null;

        @DataMember
        public BigDecimal salesTax = null;

        @DataMember
        public String haushaltsnahediensteLabel = null;

        @DataMember
        public BigDecimal haushaltsnahediensteBrutto = null;

        /**
        * Freitext
        */
        @DataMember
        @ApiMember(Description="Freitext")
        public String kostenartUnit = null;

        @DataMember
        public String reduzierungsartType = null;

        @DataMember
        public String comment = null;

        @DataMember
        public Boolean isDeleted = null;

        @DataMember
        public Boolean isCreatedByApp = null;

        @DataMember
        public ArrayList<NebenkostenNutzeinheit> nebenkostenNutzeinheiten = null;

        @DataMember
        public ArrayList<NebenkostenNutzer> nebenkostenNutzer = null;

        @DataMember
        public BillingInformation billingInformation = null;
        
        public UUID getGuid() { return guid; }
        public Nebenkosten setGuid(UUID value) { this.guid = value; return this; }
        public Long getNumber() { return number; }
        public Nebenkosten setNumber(Long value) { this.number = value; return this; }
        public Date getFrom() { return from; }
        public Nebenkosten setFrom(Date value) { this.from = value; return this; }
        public Date getTo() { return to; }
        public Nebenkosten setTo(Date value) { this.to = value; return this; }
        public NebenkostenTargetAllocation getTargetAllocation() { return targetAllocation; }
        public Nebenkosten setTargetAllocation(NebenkostenTargetAllocation value) { this.targetAllocation = value; return this; }
        public NebenkostenTargetAllocationIn getTargetAllocationIn() { return targetAllocationIn; }
        public Nebenkosten setTargetAllocationIn(NebenkostenTargetAllocationIn value) { this.targetAllocationIn = value; return this; }
        public String getNebenkostenKind() { return nebenkostenKind; }
        public Nebenkosten setNebenkostenKind(String value) { this.nebenkostenKind = value; return this; }
        public String getKostenart() { return kostenart; }
        public Nebenkosten setKostenart(String value) { this.kostenart = value; return this; }
        public BigDecimal getBrutto() { return brutto; }
        public Nebenkosten setBrutto(BigDecimal value) { this.brutto = value; return this; }
        public BigDecimal getBruttoLastYear() { return bruttoLastYear; }
        public Nebenkosten setBruttoLastYear(BigDecimal value) { this.bruttoLastYear = value; return this; }
        public BigDecimal getSalesTax() { return salesTax; }
        public Nebenkosten setSalesTax(BigDecimal value) { this.salesTax = value; return this; }
        public String getHaushaltsnahediensteLabel() { return haushaltsnahediensteLabel; }
        public Nebenkosten setHaushaltsnahediensteLabel(String value) { this.haushaltsnahediensteLabel = value; return this; }
        public BigDecimal getHaushaltsnahediensteBrutto() { return haushaltsnahediensteBrutto; }
        public Nebenkosten setHaushaltsnahediensteBrutto(BigDecimal value) { this.haushaltsnahediensteBrutto = value; return this; }
        public String getKostenartUnit() { return kostenartUnit; }
        public Nebenkosten setKostenartUnit(String value) { this.kostenartUnit = value; return this; }
        public String getReduzierungsartType() { return reduzierungsartType; }
        public Nebenkosten setReduzierungsartType(String value) { this.reduzierungsartType = value; return this; }
        public String getComment() { return comment; }
        public Nebenkosten setComment(String value) { this.comment = value; return this; }
        public Boolean getIsDeleted() { return isDeleted; }
        public Nebenkosten setIsDeleted(Boolean value) { this.isDeleted = value; return this; }
        public Boolean getIsCreatedByApp() { return isCreatedByApp; }
        public Nebenkosten setIsCreatedByApp(Boolean value) { this.isCreatedByApp = value; return this; }
        public ArrayList<NebenkostenNutzeinheit> getNebenkostenNutzeinheiten() { return nebenkostenNutzeinheiten; }
        public Nebenkosten setNebenkostenNutzeinheiten(ArrayList<NebenkostenNutzeinheit> value) { this.nebenkostenNutzeinheiten = value; return this; }
        public ArrayList<NebenkostenNutzer> getNebenkostenNutzer() { return nebenkostenNutzer; }
        public Nebenkosten setNebenkostenNutzer(ArrayList<NebenkostenNutzer> value) { this.nebenkostenNutzer = value; return this; }
        public BillingInformation getBillingInformation() { return billingInformation; }
        public Nebenkosten setBillingInformation(BillingInformation value) { this.billingInformation = value; return this; }
    }

    public static enum NebenkostenTargetAllocation
    {
        Null,
        AlleNutzer,
        ZugeordneteNutzer,
        ZugeordneteNutzeinheiten,
        ZugeordneteNutzerDiff,
        ZugeordneteNutzeinheitenDiff;
    }

    public static enum NebenkostenTargetAllocationIn
    {
        Nebenkosten,
        Heizkosten,
        Warmwasserkosten;
    }

    @DataContract
    public static class NebenkostenNutzeinheit
    {
        @DataMember
        public BigDecimal relativeAmount = null;

        @DataMember
        public Boolean isDeleted = null;

        @DataMember
        public Boolean isCreatedByApp = null;

        @DataMember
        public UUID nutzeinheitGuid = null;
        
        public BigDecimal getRelativeAmount() { return relativeAmount; }
        public NebenkostenNutzeinheit setRelativeAmount(BigDecimal value) { this.relativeAmount = value; return this; }
        public Boolean getIsDeleted() { return isDeleted; }
        public NebenkostenNutzeinheit setIsDeleted(Boolean value) { this.isDeleted = value; return this; }
        public Boolean getIsCreatedByApp() { return isCreatedByApp; }
        public NebenkostenNutzeinheit setIsCreatedByApp(Boolean value) { this.isCreatedByApp = value; return this; }
        public UUID getNutzeinheitGuid() { return nutzeinheitGuid; }
        public NebenkostenNutzeinheit setNutzeinheitGuid(UUID value) { this.nutzeinheitGuid = value; return this; }
    }

    @DataContract
    public static class NebenkostenNutzer
    {
        @DataMember
        public BigDecimal relativeAmount = null;

        @DataMember
        public Boolean isDeleted = null;

        @DataMember
        public Boolean isCreatedByApp = null;

        @DataMember
        public UUID nutzerGuid = null;
        
        public BigDecimal getRelativeAmount() { return relativeAmount; }
        public NebenkostenNutzer setRelativeAmount(BigDecimal value) { this.relativeAmount = value; return this; }
        public Boolean getIsDeleted() { return isDeleted; }
        public NebenkostenNutzer setIsDeleted(Boolean value) { this.isDeleted = value; return this; }
        public Boolean getIsCreatedByApp() { return isCreatedByApp; }
        public NebenkostenNutzer setIsCreatedByApp(Boolean value) { this.isCreatedByApp = value; return this; }
        public UUID getNutzerGuid() { return nutzerGuid; }
        public NebenkostenNutzer setNutzerGuid(UUID value) { this.nutzerGuid = value; return this; }
    }

    @DataContract
    public static class BillingInformation
    {
        @DataMember
        public String guid = null;

        @DataMember
        public Date from = null;

        @DataMember
        public Date to = null;

        @DataMember
        public Boolean isCompleted = null;

        @DataMember
        public Boolean hasNebenkosten = null;
        
        public String getGuid() { return guid; }
        public BillingInformation setGuid(String value) { this.guid = value; return this; }
        public Date getFrom() { return from; }
        public BillingInformation setFrom(Date value) { this.from = value; return this; }
        public Date getTo() { return to; }
        public BillingInformation setTo(Date value) { this.to = value; return this; }
        public Boolean getIsCompleted() { return isCompleted; }
        public BillingInformation setIsCompleted(Boolean value) { this.isCompleted = value; return this; }
        public Boolean isHasNebenkosten() { return hasNebenkosten; }
        public BillingInformation setHasNebenkosten(Boolean value) { this.hasNebenkosten = value; return this; }
    }

}

Java GetNebenkostenList DTOs

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

HTTP + 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: elotesch-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
		}
	}
}