Server

<back to all web services

GetNebenkosten

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

export enum NebenkostenTargetAllocation
{
    Null = 'Null',
    AlleNutzer = 'AlleNutzer',
    ZugeordneteNutzer = 'ZugeordneteNutzer',
    ZugeordneteNutzeinheiten = 'ZugeordneteNutzeinheiten',
    ZugeordneteNutzerDiff = 'ZugeordneteNutzerDiff',
    ZugeordneteNutzeinheitenDiff = 'ZugeordneteNutzeinheitenDiff',
}

export enum NebenkostenTargetAllocationIn
{
    Nebenkosten = 'Nebenkosten',
    Heizkosten = 'Heizkosten',
    Warmwasserkosten = 'Warmwasserkosten',
}

// @DataContract
export class NebenkostenNutzeinheit
{
    // @DataMember
    public relativeAmount?: number;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember
    public nutzeinheitGuid: string;

    public constructor(init?: Partial<NebenkostenNutzeinheit>) { (Object as any).assign(this, init); }
}

// @DataContract
export class NebenkostenNutzer
{
    // @DataMember
    public relativeAmount?: number;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember
    public nutzerGuid: string;

    public constructor(init?: Partial<NebenkostenNutzer>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BillingInformation
{
    // @DataMember
    public guid: string;

    // @DataMember
    public from: string;

    // @DataMember
    public to: string;

    // @DataMember
    public isCompleted: boolean;

    // @DataMember
    public hasNebenkosten: boolean;

    public constructor(init?: Partial<BillingInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Nebenkosten
{
    // @DataMember
    public guid: string;

    // @DataMember
    public number: number;

    // @DataMember
    public from: string;

    // @DataMember
    public to: string;

    // @DataMember
    public targetAllocation?: NebenkostenTargetAllocation;

    // @DataMember
    public targetAllocationIn?: NebenkostenTargetAllocationIn;

    // @DataMember
    public nebenkostenKind: string;

    /** @description Freitext */
    // @DataMember
    // @ApiMember(Description="Freitext")
    public kostenart: string;

    // @DataMember
    public brutto?: number;

    // @DataMember
    public bruttoLastYear?: number;

    // @DataMember
    public salesTax?: number;

    // @DataMember
    public haushaltsnahediensteLabel: string;

    // @DataMember
    public haushaltsnahediensteBrutto?: number;

    /** @description Freitext */
    // @DataMember
    // @ApiMember(Description="Freitext")
    public kostenartUnit: string;

    // @DataMember
    public reduzierungsartType: string;

    // @DataMember
    public comment: string;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember
    public nebenkostenNutzeinheiten: NebenkostenNutzeinheit[];

    // @DataMember
    public nebenkostenNutzer: NebenkostenNutzer[];

    // @DataMember
    public billingInformation: BillingInformation;

    public constructor(init?: Partial<Nebenkosten>) { (Object as any).assign(this, init); }
}

export class GetNebenkostenResponse
{
    public nebenkosten: Nebenkosten;
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetNebenkostenResponse>) { (Object as any).assign(this, init); }
}

export class GetNebenkosten implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    // @ApiMember(IsRequired=true, ParameterType="path")
    public guid: string;

    public constructor(init?: Partial<GetNebenkosten>) { (Object as any).assign(this, init); }
}

TypeScript 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: demo-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"}}}