| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /voss/subscriptions | PUT voss subscription |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid | No | The company id. Subscription will be fetched of this company |
| DiscountAgreements | body | List<SubscriptionDiscountAgreementRequestDto> | Yes | Discount agreement data |
| DiscountAgreementsChangeType | body | DiscountAgreementsChangeTypeEnum | No | Discount agreements change type controls how already occured transactions are treated <br />Retrospective - all future and past not invoiced transactions will be recalculated with new discount agreements <br />Prospective - discounts will apply only for future transactions |
| CompanyOwnerId | body | int | No | The company id. Subscription will be fetched of this company |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DiscountAgreementId | form | Guid | No | |
| Period | form | SubscriptionDiscountPeriodRequestDto | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PeriodKind | form | PeriodKindEnum | No | |
| Length | form | DiscountAgreementTimeLengthRequestDto | Yes | |
| PeriodIterationCount | form | int? | No |
| FixedTime | |
| AlignedToBindingPeriod | |
| AlignedToSubscriptionBillingPeriod |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Unit | form | UnitEnum | No | |
| Value | form | int | No |
| Day | |
| Month | |
| Year |
| Prospective | |
| Retrospective |
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 /voss/subscriptions HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateVossSubscriptions 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>
<CompanyOwnerId>0</CompanyOwnerId>
<DiscountAgreements xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
<d2p1:SubscriptionDiscountAgreementRequestDto i:nil="true" />
</DiscountAgreements>
<DiscountAgreementsChangeType>Prospective</DiscountAgreementsChangeType>
</UpdateVossSubscriptions>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />