| PUT | /services/{Id}/calculateprice | Calculate price on service | Calculate an price on a service. |
|---|
"use strict";
export class RebateCodeTypeItem {
/** @param {{Id?:number,Name?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Name;
/** @type {string} */
Description;
}
export class AppliedRebateCodesResponse {
/** @param {{RebateCodeSign?:string,RebateCodeValue?:number,RebateCodeType?:RebateCodeTypeItem,RebateCodeId?:number,RebateAmount?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RebateCodeSign;
/** @type {number} */
RebateCodeValue;
/** @type {RebateCodeTypeItem} */
RebateCodeType;
/** @type {number} */
RebateCodeId;
/** @type {number} */
RebateAmount;
}
export class TotalPricePriceDetail {
/** @param {{Quantity?:number,Price?:number,VatAmount?:number,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Quantity;
/** @type {number} */
Price;
/** @type {number} */
VatAmount;
/** @type {string} */
Description;
}
export class TotalPriceInformationResponse {
/** @param {{PriceSign?:string,CurrencyId?:string,TotalPrice?:number,TotalVatAmount?:number,TotalPriceBeforeRebate?:number,AppliedCodes?:AppliedRebateCodesResponse[],PriceDetails?:TotalPricePriceDetail[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PriceSign;
/** @type {string} */
CurrencyId;
/** @type {number} */
TotalPrice;
/** @type {number} */
TotalVatAmount;
/** @type {number} */
TotalPriceBeforeRebate;
/** @type {AppliedRebateCodesResponse[]} */
AppliedCodes;
/** @type {TotalPricePriceDetail[]} */
PriceDetails;
}
export class PriceInterval {
/** @param {{From?:string,To?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The start date and time for the price to be calculated. Normally the booking start datetime. */
From;
/**
* @type {?string}
* @description The end date and time for the price to be calculated.Normally the booking end datetime. If nothing entered it will use the service length. */
To;
}
export class CalculateTotalPriceOnService {
/** @param {{CompanyId?:string,Id?:number,Interval?:PriceInterval,RebateCodeIds?:number[],Quantities?:QuantityToBook[]}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {number}
* @description Id of the service */
Id;
/**
* @type {PriceInterval}
* @description The price interval to be used for calculations */
Interval;
/**
* @type {number[]}
* @description If you have selected to include the prices, here you can include the rebate codes */
RebateCodeIds;
/**
* @type {QuantityToBook[]}
* @description If you have selected to include the prices, here you can include the quantities to book to get the correct total price. */
Quantities;
}
export class QuantityToBook {
/** @param {{PriceId?:number,Quantity?:number,OccupiesSpot?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book) */
PriceId;
/**
* @type {number}
* @description Set the number of spots or resources you want to book on the specific price category */
Quantity;
/**
* @type {boolean}
* @description If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information. */
OccupiesSpot;
}
JavaScript CalculateTotalPriceOnService DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /services/{Id}/calculateprice HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CalculateTotalPriceOnService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<Interval>
<From>0001-01-01T00:00:00</From>
<To>0001-01-01T00:00:00</To>
</Interval>
<Quantities>
<QuantityToBook>
<OccupiesSpot>false</OccupiesSpot>
<PriceId>0</PriceId>
<Quantity>0</Quantity>
</QuantityToBook>
</Quantities>
<RebateCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</RebateCodeIds>
</CalculateTotalPriceOnService>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TotalPriceInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AppliedCodes>
<AppliedRebateCodesResponse>
<RebateAmount>0</RebateAmount>
<RebateCodeId>0</RebateCodeId>
<RebateCodeSign>String</RebateCodeSign>
<RebateCodeType>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</RebateCodeType>
<RebateCodeValue>0</RebateCodeValue>
</AppliedRebateCodesResponse>
</AppliedCodes>
<CurrencyId>String</CurrencyId>
<PriceDetails>
<TotalPricePriceDetail>
<Description>String</Description>
<Price>0</Price>
<Quantity>0</Quantity>
<VatAmount>0</VatAmount>
</TotalPricePriceDetail>
</PriceDetails>
<PriceSign>String</PriceSign>
<TotalPrice>0</TotalPrice>
<TotalPriceBeforeRebate>0</TotalPriceBeforeRebate>
<TotalVatAmount>0</TotalVatAmount>
</TotalPriceInformationResponse>