Server

<back to all web services

PostBrennstoff

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
POST/api/v1/brennstofflieferung
"use strict";
export class PostBrennstoffResponse {
    /** @param {{responseStatus?:ResponseStatus,checksumMD5?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    checksumMD5;
}
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 Brennstofflieferung {
    /** @param {{guid?:string,deliveryDate?:string,salexTax?:number,emisionsTax?:number,c02Taxes?:number,customsTax?:number,otherCharges?:number,c02Price?:number,c02Tons?:number,quantity?:number,amount?:number,startMeterReadingValue?:number,endMeterReadingValue?:number,heizwert?:number,brennwert?:boolean,energyReliefAmountDescription?:string,energyReliefAmount?:number,electricityReliefAmountDescription?:string,electricityReliefAmount?:number,cO2EmissionsFactor?:number,cO2Text?:string,cO2Active?:boolean,cO2PriceKnd?:boolean,cO2PriceLandlord?:number,cO2PriceRenter?:number,cO2Area?:number,isForCommercialUse?:boolean,isRenovationRequired?:boolean,isHeatingPadsImproved?:boolean,cO2KWh?:number,includedCO2SalesTax?:number,cO2Costs?:number,totalC02Weight?:number,noTotalDeductionC02Costs?:boolean,isDeleted?:boolean,isCreatedByApp?:boolean,brennstoffMediumGuid?:string,billingInformation?:BillingInformation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    deliveryDate;
    /** @type {?number} */
    salexTax;
    /** @type {?number} */
    emisionsTax;
    /** @type {?number} */
    c02Taxes;
    /** @type {?number} */
    customsTax;
    /** @type {?number} */
    otherCharges;
    /** @type {?number} */
    c02Price;
    /** @type {?number} */
    c02Tons;
    /** @type {?number} */
    quantity;
    /** @type {?number} */
    amount;
    /** @type {?number} */
    startMeterReadingValue;
    /** @type {?number} */
    endMeterReadingValue;
    /** @type {number} */
    heizwert;
    /** @type {boolean} */
    brennwert;
    /** @type {string} */
    energyReliefAmountDescription;
    /** @type {?number} */
    energyReliefAmount;
    /** @type {string} */
    electricityReliefAmountDescription;
    /** @type {?number} */
    electricityReliefAmount;
    /** @type {?number} */
    cO2EmissionsFactor;
    /** @type {string} */
    cO2Text;
    /** @type {?boolean} */
    cO2Active;
    /** @type {?boolean} */
    cO2PriceKnd;
    /** @type {?number} */
    cO2PriceLandlord;
    /** @type {?number} */
    cO2PriceRenter;
    /** @type {?number} */
    cO2Area;
    /** @type {?boolean} */
    isForCommercialUse;
    /** @type {?boolean} */
    isRenovationRequired;
    /** @type {?boolean} */
    isHeatingPadsImproved;
    /** @type {?number} */
    cO2KWh;
    /** @type {?number} */
    includedCO2SalesTax;
    /** @type {?number} */
    cO2Costs;
    /** @type {?number} */
    totalC02Weight;
    /** @type {?boolean} */
    noTotalDeductionC02Costs;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {string} */
    brennstoffMediumGuid;
    /** @type {BillingInformation} */
    billingInformation;
}
export class RelatedTo {
    /** @param {{guid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
}
export class PostBrennstoff {
    /** @param {{brennstofflieferung?:Brennstofflieferung,relatedToEnergieVerwerter?:RelatedTo,relatedToBrennstoffMedium?:RelatedTo,relatedToBillingInformation?:RelatedTo,bearerToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Brennstofflieferung} */
    brennstofflieferung;
    /** @type {RelatedTo} */
    relatedToEnergieVerwerter;
    /** @type {RelatedTo} */
    relatedToBrennstoffMedium;
    /** @type {RelatedTo} */
    relatedToBillingInformation;
    /** @type {string} */
    bearerToken;
}

JavaScript PostBrennstoff 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.

POST /api/v1/brennstofflieferung HTTP/1.1 
Host: stoetzer-servdesk.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	brennstofflieferung: 
	{
		guid: 00000000000000000000000000000000,
		deliveryDate: 0001-01-01T00:00:00Z,
		salexTax: 0,
		emisionsTax: 0,
		c02Taxes: 0,
		customsTax: 0,
		otherCharges: 0,
		c02Price: 0,
		c02Tons: 0,
		quantity: 0,
		amount: 0,
		startMeterReadingValue: 0,
		endMeterReadingValue: 0,
		heizwert: 0,
		brennwert: False,
		energyReliefAmountDescription: String,
		energyReliefAmount: 0,
		electricityReliefAmountDescription: String,
		electricityReliefAmount: 0,
		cO2EmissionsFactor: 0,
		cO2Text: String,
		cO2Active: False,
		cO2PriceKnd: False,
		cO2PriceLandlord: 0,
		cO2PriceRenter: 0,
		cO2Area: 0,
		isForCommercialUse: False,
		isRenovationRequired: False,
		isHeatingPadsImproved: False,
		cO2KWh: 0,
		includedCO2SalesTax: 0,
		cO2Costs: 0,
		totalC02Weight: 0,
		noTotalDeductionC02Costs: False,
		isDeleted: False,
		isCreatedByApp: False,
		brennstoffMediumGuid: 00000000000000000000000000000000,
		billingInformation: 
		{
			guid: String,
			from: 0001-01-01T00:00:00Z,
			to: 0001-01-01T00:00:00Z,
			isCompleted: False,
			hasNebenkosten: False
		}
	},
	relatedToEnergieVerwerter: 
	{
		guid: 00000000000000000000000000000000
	},
	relatedToBrennstoffMedium: 
	{
		guid: 00000000000000000000000000000000
	},
	relatedToBillingInformation: 
	{
		guid: 00000000000000000000000000000000
	},
	bearerToken: String
}
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
		}
	},
	checksumMD5: String
}