Server

<back to all web services

GetNebenkosten

Nebenkosten
Requires Authentication
The following routes are available for this service:
GET/api/v1/nebenkosten/{Guid}
"use strict";
/** @typedef {'Null'|'AlleNutzer'|'ZugeordneteNutzer'|'ZugeordneteNutzeinheiten'|'ZugeordneteNutzerDiff'|'ZugeordneteNutzeinheitenDiff'} */
export var NebenkostenTargetAllocation;
(function (NebenkostenTargetAllocation) {
    NebenkostenTargetAllocation["Null"] = "Null"
    NebenkostenTargetAllocation["AlleNutzer"] = "AlleNutzer"
    NebenkostenTargetAllocation["ZugeordneteNutzer"] = "ZugeordneteNutzer"
    NebenkostenTargetAllocation["ZugeordneteNutzeinheiten"] = "ZugeordneteNutzeinheiten"
    NebenkostenTargetAllocation["ZugeordneteNutzerDiff"] = "ZugeordneteNutzerDiff"
    NebenkostenTargetAllocation["ZugeordneteNutzeinheitenDiff"] = "ZugeordneteNutzeinheitenDiff"
})(NebenkostenTargetAllocation || (NebenkostenTargetAllocation = {}));
/** @typedef {'Nebenkosten'|'Heizkosten'|'Warmwasserkosten'} */
export var NebenkostenTargetAllocationIn;
(function (NebenkostenTargetAllocationIn) {
    NebenkostenTargetAllocationIn["Nebenkosten"] = "Nebenkosten"
    NebenkostenTargetAllocationIn["Heizkosten"] = "Heizkosten"
    NebenkostenTargetAllocationIn["Warmwasserkosten"] = "Warmwasserkosten"
})(NebenkostenTargetAllocationIn || (NebenkostenTargetAllocationIn = {}));
export class NebenkostenNutzeinheit {
    /** @param {{relativeAmount?:number,isDeleted?:boolean,isCreatedByApp?:boolean,nutzeinheitGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    relativeAmount;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {string} */
    nutzeinheitGuid;
}
export class NebenkostenNutzer {
    /** @param {{relativeAmount?:number,isDeleted?:boolean,isCreatedByApp?:boolean,nutzerGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    relativeAmount;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {string} */
    nutzerGuid;
}
export class BillingInformation {
    /** @param {{guid?:string,from?:string,to?:string,isCompleted?:boolean,hasNebenkosten?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    from;
    /** @type {string} */
    to;
    /** @type {boolean} */
    isCompleted;
    /** @type {boolean} */
    hasNebenkosten;
}
export class Nebenkosten {
    /** @param {{guid?:string,number?:number,from?:string,to?:string,targetAllocation?:NebenkostenTargetAllocation,targetAllocationIn?:NebenkostenTargetAllocationIn,nebenkostenKind?:string,kostenart?:string,brutto?:number,bruttoLastYear?:number,salesTax?:number,haushaltsnahediensteLabel?:string,haushaltsnahediensteBrutto?:number,kostenartUnit?:string,reduzierungsartType?:string,comment?:string,isDeleted?:boolean,isCreatedByApp?:boolean,nebenkostenNutzeinheiten?:NebenkostenNutzeinheit[],nebenkostenNutzer?:NebenkostenNutzer[],billingInformation?:BillingInformation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {number} */
    number;
    /** @type {string} */
    from;
    /** @type {string} */
    to;
    /** @type {?NebenkostenTargetAllocation} */
    targetAllocation;
    /** @type {?NebenkostenTargetAllocationIn} */
    targetAllocationIn;
    /** @type {string} */
    nebenkostenKind;
    /**
     * @type {string}
     * @description Freitext */
    kostenart;
    /** @type {?number} */
    brutto;
    /** @type {?number} */
    bruttoLastYear;
    /** @type {?number} */
    salesTax;
    /** @type {string} */
    haushaltsnahediensteLabel;
    /** @type {?number} */
    haushaltsnahediensteBrutto;
    /**
     * @type {string}
     * @description Freitext */
    kostenartUnit;
    /** @type {string} */
    reduzierungsartType;
    /** @type {string} */
    comment;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {NebenkostenNutzeinheit[]} */
    nebenkostenNutzeinheiten;
    /** @type {NebenkostenNutzer[]} */
    nebenkostenNutzer;
    /** @type {BillingInformation} */
    billingInformation;
}
export class GetNebenkostenResponse {
    /** @param {{nebenkosten?:Nebenkosten,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Nebenkosten} */
    nebenkosten;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetNebenkosten {
    /** @param {{bearerToken?:string,guid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /** @type {string} */
    guid;
}

JavaScript GetNebenkosten DTOs

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

HTTP + CSV

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: dumpro-servdesk.eras-online.de 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}