BokaMera.API.Host

CreateVossDiscountAgreement

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/voss/discountAgreements	Create discount agreement	Create discount agreement in VOSS System.

**CreateVossDiscountAgreement** Parameters:
Name	Parameter	Data Type	Required	Description
Name	body	string	Yes	Discount agreement name
ChargePlanDiscounts	body	List<CreateChargePlanDiscountRequestDto>	Yes	Discount agreement name
Description	body	string	Yes
ValidFrom	body	DateTime	Yes	Discount agreement name
ValidTo	body	DateTime?	No	Discount agreement name
DiscountPeriod	body	CreateDiscountPeriodRequestDto	Yes	Discount agreement name

**CreateChargePlanDiscountRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
ChargePlanId	form	Guid	No
ProductGroupDiscounts	form	List<CreateProductGroupDiscountRequestDto>	Yes

**CreateProductGroupDiscountRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
ProductGroupId	form	Guid	No
ProductPricingDiscounts	form	List<ProductPricingDiscountRequestDto>	Yes

**ProductPricingDiscountRequestDto** Parameters:
Name	Parameter	Data Type	Required
DiscountType	form	DiscountTypeEnum	No
ProductId	form	Guid	No
UnitPriceDiscount	form	double	No
TierPricingDiscounts	form	List<CreatePricingTierDiscountRequestDto>	Yes

**DiscountTypeEnum** Enum:
FlatPrice
Percentage

**CreatePricingTierDiscountRequestDto** Parameters:
Name	Parameter	Data Type	Required
DiscountType	form	DiscountTypeEnum	No
Index	form	int	No
UnitPriceDiscount	form	double	No
FlatPriceDiscount	form	double	No

**CreateDiscountPeriodRequestDto** Parameters:
Name	Parameter	Data Type	Required
PeriodKind	form	PeriodKindEnum	No
Length	form	DiscountAgreementTimeLengthRequestDto	Yes
PeriodIterationCount	form	int?	No

**PeriodKindEnum** Enum:
FixedTime
AlignedToBindingPeriod
AlignedToSubscriptionBillingPeriod

**DiscountAgreementTimeLengthRequestDto** Parameters:
Name	Parameter	Data Type	Required	Description
Unit	form	UnitEnum	No
Value	form	int	No

**UnitEnum** Enum:
Day
Month
Year

**DiscountAgreementResult** Parameters:
Name	Parameter	Data Type	Required
DiscountAgreementStatus	form	DiscountAgreementStatusEnum	No
ApplicationScope	form	ApplicationScopeEnum	No
Id	form	Guid	No
VersionId	form	Guid	No
SourceVersionId	form	Guid?	No
ExternalId	form	string	Yes
Name	form	string	Yes
Description	form	string	Yes
ValidFrom	form	DateTime	No
ValidTo	form	DateTime?	No
DiscountPeriod	form	DiscountPeriodDto	Yes
Package	form	DiscountPackageDto	Yes
Customers	form	List<DiscountAgreementCustomerResultDto>	Yes
CustomerGroups	form	List<DiscountAgreementCustomerGroupResultDto>	Yes
ChargePlanDiscounts	form	List<ChargePlanDiscountResultDto>	Yes

**DiscountAgreementStatusEnum** Enum:
Draft
Staged
Published
Archived
Discarded

**ApplicationScopeEnum** Enum:
Any
SubscriptionCustomer
NonSubscriptionCustomerInvoiceRecipient

**DiscountPeriodDto** Parameters:
Name	Parameter	Data Type	Required
PeriodKind	form	PeriodKindEnum	No
Length	form	TimeLengthDto	Yes
PeriodIterationCount	form	int?	No

**TimeLengthDto** Parameters:
Name	Parameter	Data Type	Required	Description
Unit	form	UnitEnum	No
Value	form	int	No

**DiscountPackageDto** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	Guid	No
Name	form	string	Yes

**DiscountAgreementCustomerResultDto** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerId	form	Guid	No

**DiscountAgreementCustomerGroupResultDto** Parameters:
Name	Parameter	Data Type	Required	Description
IntervalStart	form	int	No
IntervalEnd	form	int	No

**ChargePlanDiscountResultDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
ChargePlanId	form	Guid	No
ProductGroupDiscounts	form	List<ProductGroupDiscountResultDto>	Yes

**ProductGroupDiscountResultDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
ProductGroupId	form	Guid	No
ProductPricingDiscounts	form	List<ProductPricingDiscountResultDto>	Yes

**ProductPricingDiscountResultDto** Parameters:
Name	Parameter	Data Type	Required
DiscountType	form	DiscountTypeEnum	No
Id	form	Guid	No
ProductId	form	Guid	No
UnitPriceDiscount	form	double	No
TierPricingDiscounts	form	List<PricingTierDiscountResultDto>	Yes

**PricingTierDiscountResultDto** Parameters:
Name	Parameter	Data Type	Required
DiscountType	form	DiscountTypeEnum	No
Id	form	Guid	No
Index	form	int	No
UnitPriceDiscount	form	double	No
FlatPriceDiscount	form	double	No

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.

POST /voss/discountAgreements HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateVossDiscountAgreement xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ChargePlanDiscounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
    <d2p1:CreateChargePlanDiscountRequestDto i:nil="true" />
  </ChargePlanDiscounts>
  <Description>String</Description>
  <DiscountPeriod xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model" i:nil="true" />
  <Name>String</Name>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</CreateVossDiscountAgreement>

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

<DiscountAgreementResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <applicationScope>Any</applicationScope>
  <chargePlanDiscounts>
    <ChargePlanDiscountResultDto i:nil="true" />
  </chargePlanDiscounts>
  <customerGroups>
    <DiscountAgreementCustomerGroupResultDto i:nil="true" />
  </customerGroups>
  <customers>
    <DiscountAgreementCustomerResultDto i:nil="true" />
  </customers>
  <description>String</description>
  <externalId>String</externalId>
  <id>00000000-0000-0000-0000-000000000000</id>
  <name>String</name>
  <package i:nil="true" />
  <sourceVersionId>00000000-0000-0000-0000-000000000000</sourceVersionId>
  <status>Draft</status>
  <validFrom>0001-01-01T00:00:00</validFrom>
  <validTo>0001-01-01T00:00:00</validTo>
  <versionId>00000000-0000-0000-0000-000000000000</versionId>
</DiscountAgreementResult>