Server

GetNebenkosten

Nebenkosten

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

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
Imports Eras2Web.Service.Desktop.Server.ServiceModel.Enums

Namespace Global

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Enums

        Public Enum NebenkostenTargetAllocation
            Null
            AlleNutzer
            ZugeordneteNutzer
            ZugeordneteNutzeinheiten
            ZugeordneteNutzerDiff
            ZugeordneteNutzeinheitenDiff
        End Enum

        Public Enum NebenkostenTargetAllocationIn
            Nebenkosten
            Heizkosten
            Warmwasserkosten
        End Enum
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

        Public Partial Class GetNebenkosten
            Implements IHasBearerToken
            <ApiMember(IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BearerToken As String

            <ApiMember(IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Guid As Guid
        End Class

        Public Partial Class GetNebenkostenResponse
            Public Overridable Property Nebenkosten As Nebenkosten
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models

        <DataContract>
        Public Partial Class BillingInformation
            <DataMember>
            Public Overridable Property Guid As String

            <DataMember>
            Public Overridable Property From As Date

            <DataMember>
            Public Overridable Property To As Date

            <DataMember>
            Public Overridable Property IsCompleted As Boolean

            <DataMember>
            Public Overridable Property HasNebenkosten As Boolean
        End Class

        <DataContract>
        Public Partial Class Nebenkosten
            Public Sub New()
                NebenkostenNutzeinheiten = New List(Of NebenkostenNutzeinheit)
                NebenkostenNutzer = New List(Of NebenkostenNutzer)
            End Sub

            <DataMember>
            Public Overridable Property Guid As Guid

            <DataMember>
            Public Overridable Property Number As UInt32

            <DataMember>
            Public Overridable Property From As Date

            <DataMember>
            Public Overridable Property To As Date

            <DataMember>
            Public Overridable Property TargetAllocation As Nullable(Of NebenkostenTargetAllocation)

            <DataMember>
            Public Overridable Property TargetAllocationIn As Nullable(Of NebenkostenTargetAllocationIn)

            <DataMember>
            Public Overridable Property NebenkostenKind As String

            '''<Summary>
            '''Freitext
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Freitext")>
            Public Overridable Property Kostenart As String

            <DataMember>
            Public Overridable Property Brutto As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property BruttoLastYear As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property SalesTax As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property HaushaltsnahediensteLabel As String

            <DataMember>
            Public Overridable Property HaushaltsnahediensteBrutto As Nullable(Of Decimal)

            '''<Summary>
            '''Freitext
            '''</Summary>
            <DataMember>
            <ApiMember(Description:="Freitext")>
            Public Overridable Property KostenartUnit As String

            <DataMember>
            Public Overridable Property ReduzierungsartType As String

            <DataMember>
            Public Overridable Property Comment As String

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

            <DataMember>
            Public Overridable Property NebenkostenNutzeinheiten As List(Of NebenkostenNutzeinheit)

            <DataMember>
            Public Overridable Property NebenkostenNutzer As List(Of NebenkostenNutzer)

            <DataMember>
            Public Overridable Property BillingInformation As BillingInformation
        End Class

        <DataContract>
        Public Partial Class NebenkostenNutzeinheit
            <DataMember>
            Public Overridable Property RelativeAmount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

            <DataMember>
            Public Overridable Property NutzeinheitGuid As Guid
        End Class

        <DataContract>
        Public Partial Class NebenkostenNutzer
            <DataMember>
            Public Overridable Property RelativeAmount As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property IsDeleted As Boolean

            <DataMember>
            Public Overridable Property IsCreatedByApp As Boolean

            <DataMember>
            Public Overridable Property NutzerGuid As Guid
        End Class
    End Namespace
End Namespace

VB.NET GetNebenkosten 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/{Guid} HTTP/1.1 
Host: mitchell-servdesk.eras-online.de 
Accept: text/jsv

HTTP/1.1 200 OK
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
		}
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}