Server

<back to all web services

PutNebenkosten

Nebenkosten
Requires Authentication
The following routes are available for this service:
PUT/api/v1/nebenkosten

export class PutNebenkostenResponse
{
    public responseStatus: ResponseStatus;

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

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); }
}

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

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

export class PutNebenkosten implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="body")
    public nebenkosten: Nebenkosten;

    // @ApiMember(IsRequired=true, ParameterType="body")
    public relatedToObjekt: RelatedTo;

    // @ApiMember(IsRequired=true, ParameterType="body")
    public relatedToBillingInformation: RelatedTo;

    // @ApiMember(IsRequired=true, ParameterType="body")
    public bearerToken: string;

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

TypeScript PutNebenkosten DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/v1/nebenkosten HTTP/1.1 
Host: eca-abrechnungsservice-servdesk.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutNebenkosten xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Put">
  <BearerToken>String</BearerToken>
  <Nebenkosten xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:BillingInformation>
      <d2p1:From>0001-01-01T00:00:00</d2p1:From>
      <d2p1:Guid>String</d2p1:Guid>
      <d2p1:HasNebenkosten>false</d2p1:HasNebenkosten>
      <d2p1:IsCompleted>false</d2p1:IsCompleted>
      <d2p1:To>0001-01-01T00:00:00</d2p1:To>
    </d2p1:BillingInformation>
    <d2p1:Brutto>0</d2p1:Brutto>
    <d2p1:BruttoLastYear>0</d2p1:BruttoLastYear>
    <d2p1:Comment>String</d2p1:Comment>
    <d2p1:From>0001-01-01T00:00:00</d2p1:From>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:HaushaltsnahediensteBrutto>0</d2p1:HaushaltsnahediensteBrutto>
    <d2p1:HaushaltsnahediensteLabel>String</d2p1:HaushaltsnahediensteLabel>
    <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:Kostenart>String</d2p1:Kostenart>
    <d2p1:KostenartUnit>String</d2p1:KostenartUnit>
    <d2p1:NebenkostenKind>String</d2p1:NebenkostenKind>
    <d2p1:NebenkostenNutzeinheiten>
      <d2p1:NebenkostenNutzeinheit>
        <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:NutzeinheitGuid>00000000-0000-0000-0000-000000000000</d2p1:NutzeinheitGuid>
        <d2p1:RelativeAmount>0</d2p1:RelativeAmount>
      </d2p1:NebenkostenNutzeinheit>
    </d2p1:NebenkostenNutzeinheiten>
    <d2p1:NebenkostenNutzer>
      <d2p1:NebenkostenNutzer>
        <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
        <d2p1:IsDeleted>false</d2p1:IsDeleted>
        <d2p1:NutzerGuid>00000000-0000-0000-0000-000000000000</d2p1:NutzerGuid>
        <d2p1:RelativeAmount>0</d2p1:RelativeAmount>
      </d2p1:NebenkostenNutzer>
    </d2p1:NebenkostenNutzer>
    <d2p1:Number>0</d2p1:Number>
    <d2p1:ReduzierungsartType>String</d2p1:ReduzierungsartType>
    <d2p1:SalesTax>0</d2p1:SalesTax>
    <d2p1:TargetAllocation>Null</d2p1:TargetAllocation>
    <d2p1:TargetAllocationIn>Nebenkosten</d2p1:TargetAllocationIn>
    <d2p1:To>0001-01-01T00:00:00</d2p1:To>
  </Nebenkosten>
  <RelatedToBillingInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToBillingInformation>
  <RelatedToObjekt xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToObjekt>
</PutNebenkosten>

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

<PutNebenkostenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Put">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PutNebenkostenResponse>