BokaMera.API.Host

<back to all web services

CreateVossUsageTermination

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/voss/usage/{Id}/terminationCreate voss usage terminationAdd new product to company invoicing. Sends that product to VOSS System.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.VossIntegration.ApiTools.Enums;
using BokaMera.VossIntegration.ApiTools.Model;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class CreateVossUsageTermination
    {
        ///<summary>
        ///The company id
        ///</summary>
        [ApiMember(Description="The company id", IsRequired=true)]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///Usage Id
        ///</summary>
        [ApiMember(Description="Usage Id", IsRequired=true)]
        public virtual string Id { get; set; }

        public virtual List<string> InvoiceLineTexts { get; set; } = [];
        public virtual string TerminationReasonComment { get; set; }
        public virtual Guid TerminationReasonId { get; set; }
        ///<summary>
        ///Credit behaviour:  <br /> 1. Full - usage will be credited in full  <br /> 2. None - no credit will be created
        ///</summary>
        [ApiMember(Description="Credit behaviour:  <br /> 1. Full - usage will be credited in full  <br /> 2. None - no credit will be created", IsRequired=true)]
        public virtual UsageBehaviourEnum Behaviour { get; set; }

        ///<summary>
        ///Credit kind:  <br /> 1. Normal - default credit type  <br /> 2. Internal - corresponding credit will be marked as internal in invoice file line
        ///</summary>
        [ApiMember(Description="Credit kind:  <br /> 1. Normal - default credit type  <br /> 2. Internal - corresponding credit will be marked as internal in invoice file line", IsRequired=true)]
        public virtual CreditKindEnum CreditKind { get; set; }
    }

}

namespace BokaMera.VossIntegration.ApiTools.Enums
{
    public enum CreditKindEnum
    {
        Normal,
        Internal,
    }

    public enum ProductTypeEnum
    {
        Main,
        Addon,
        License,
        Usage,
    }

    public enum UsageBehaviourEnum
    {
        Full,
        None,
    }

}

namespace BokaMera.VossIntegration.ApiTools.Model
{
    [DataContract(Name="CreateUsageTerminationResult")]
    public partial class CreateUsageTerminationResult
    {
        [DataMember(Name="scheduledDate", IsRequired=true)]
        public virtual DateTime ScheduledDate { get; set; }

        [DataMember(Name="reason")]
        public virtual SubscriptionItemTerminationReasonDto Reason { get; set; }

        [DataMember(Name="creditOptions", IsRequired=true)]
        public virtual UsageCreditOptionsDto CreditOptions { get; set; }

        [DataMember(Name="customerBalanceChange", IsRequired=true)]
        public virtual CustomerBalanceChangeDto CustomerBalanceChange { get; set; }
    }

    [DataContract(Name="CustomerBalanceChangeDto")]
    public partial class CustomerBalanceChangeDto
    {
        [DataMember(Name="items", EmitDefaultValue=false)]
        public virtual List<CustomerBalanceChangeItemDto> Items { get; set; } = [];

        [DataMember(Name="totalAmount", EmitDefaultValue=false)]
        public virtual double TotalAmount { get; set; }

        [DataMember(Name="totalDiscountAmount", EmitDefaultValue=false)]
        public virtual double TotalDiscountAmount { get; set; }
    }

    [DataContract(Name="CustomerBalanceChangeItemDto")]
    public partial class CustomerBalanceChangeItemDto
    {
        [DataMember(Name="type", IsRequired=true)]
        public virtual ProductTypeEnum ProductType { get; set; }

        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

        [DataMember(Name="name", IsRequired=true)]
        public virtual string Name { get; set; }

        [DataMember(Name="productGroupId", IsRequired=true)]
        public virtual Guid ProductGroupId { get; set; }

        [DataMember(Name="productGroupName", IsRequired=true)]
        public virtual string ProductGroupName { get; set; }

        [DataMember(Name="quantity", IsRequired=true)]
        public virtual double Quantity { get; set; }

        [DataMember(Name="amount", IsRequired=true)]
        public virtual double Amount { get; set; }

        [DataMember(Name="discountAmount", IsRequired=true)]
        public virtual double DiscountAmount { get; set; }

        [DataMember(Name="totalAmount", EmitDefaultValue=false)]
        public virtual double TotalAmount { get; set; }

        [DataMember(Name="invoiceRecipientCustomerId", IsRequired=true)]
        public virtual Guid InvoiceRecipientCustomerId { get; set; }
    }

    [DataContract(Name="SubscriptionItemTerminationReasonDto")]
    public partial class SubscriptionItemTerminationReasonDto
    {
        [DataMember(Name="reasonId", IsRequired=true)]
        public virtual Guid ReasonId { get; set; }

        [DataMember(Name="reasonName", IsRequired=true)]
        public virtual string ReasonName { get; set; }

        [DataMember(Name="reasonExternalId")]
        public virtual string ReasonExternalId { get; set; }

        [DataMember(Name="subReasonId")]
        public virtual Guid? SubReasonId { get; set; }

        [DataMember(Name="subReasonName")]
        public virtual string SubReasonName { get; set; }

        [DataMember(Name="subReasonExternalId")]
        public virtual string SubReasonExternalId { get; set; }

        [DataMember(Name="comment", IsRequired=true)]
        public virtual string Comment { get; set; }
    }

    [DataContract(Name="UsageCreditOptionsDto")]
    public partial class UsageCreditOptionsDto
    {
        [DataMember(Name="behaviour", IsRequired=true)]
        public virtual UsageBehaviourEnum UsageBehaviour { get; set; }

        [DataMember(Name="creditKind", IsRequired=true)]
        public virtual CreditKindEnum CreditKind { get; set; }
    }

}

C# CreateVossUsageTermination 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.

POST /voss/usage/{Id}/termination HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateVossUsageTermination xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Behaviour>Full</Behaviour>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreditKind>Normal</CreditKind>
  <Id>String</Id>
  <InvoiceLineTexts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvoiceLineTexts>
  <TerminationReasonComment>String</TerminationReasonComment>
  <TerminationReasonId>00000000-0000-0000-0000-000000000000</TerminationReasonId>
</CreateVossUsageTermination>

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

<CreateUsageTerminationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <creditOptions i:nil="true" />
  <customerBalanceChange i:nil="true" />
  <reason i:nil="true" />
  <scheduledDate>0001-01-01T00:00:00</scheduledDate>
</CreateUsageTerminationResult>