BokaMera.API.Host

CreateVossUsageTermination

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

The following routes are available for this service:
POST	/voss/usage/{Id}/termination	Create voss usage termination	Add new product to company invoicing. Sends that product to VOSS System.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CreateVossUsageTermination
{
    /**
    * The company id
    */
    @ApiMember(Description="The company id", IsRequired=true)
    open var CompanyId:UUID? = null

    /**
    * Usage Id
    */
    @ApiMember(Description="Usage Id", IsRequired=true)
    open var Id:String? = null

    open var InvoiceLineTexts:ArrayList<String> = ArrayList<String>()
    open var TerminationReasonComment:String? = null
    open var TerminationReasonId:UUID? = null
    /**
    * Credit behaviour:  <br /> 1. Full - usage will be credited in full  <br /> 2. None - no credit will be created
    */
    @ApiMember(Description="Credit behaviour:  <br /> 1. Full - usage will be credited in full  <br /> 2. None - no credit will be created", IsRequired=true)
    open var Behaviour:UsageBehaviourEnum? = null

    /**
    * Credit kind:  <br /> 1. Normal - default credit type  <br /> 2. Internal - corresponding credit will be marked as internal in invoice file line
    */
    @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)
    open var CreditKind:CreditKindEnum? = null
}

enum class UsageBehaviourEnum
{
    Full,
    None,
}

enum class CreditKindEnum
{
    Normal,
    Internal,
}

@DataContract(Name="CreateUsageTerminationResult")
open class CreateUsageTerminationResult
{
    @DataMember(Name="scheduledDate", IsRequired=true)
    @SerializedName("scheduledDate")
    open var ScheduledDate:Date? = null

    @DataMember(Name="reason")
    @SerializedName("reason")
    open var Reason:SubscriptionItemTerminationReasonDto? = null

    @DataMember(Name="creditOptions", IsRequired=true)
    @SerializedName("creditOptions")
    open var CreditOptions:UsageCreditOptionsDto? = null

    @DataMember(Name="customerBalanceChange", IsRequired=true)
    @SerializedName("customerBalanceChange")
    open var CustomerBalanceChange:CustomerBalanceChangeDto? = null
}

@DataContract(Name="SubscriptionItemTerminationReasonDto")
open class SubscriptionItemTerminationReasonDto
{
    @DataMember(Name="reasonId", IsRequired=true)
    @SerializedName("reasonId")
    open var ReasonId:UUID? = null

    @DataMember(Name="reasonName", IsRequired=true)
    @SerializedName("reasonName")
    open var ReasonName:String? = null

    @DataMember(Name="reasonExternalId")
    @SerializedName("reasonExternalId")
    open var ReasonExternalId:String? = null

    @DataMember(Name="subReasonId")
    @SerializedName("subReasonId")
    open var SubReasonId:UUID? = null

    @DataMember(Name="subReasonName")
    @SerializedName("subReasonName")
    open var SubReasonName:String? = null

    @DataMember(Name="subReasonExternalId")
    @SerializedName("subReasonExternalId")
    open var SubReasonExternalId:String? = null

    @DataMember(Name="comment", IsRequired=true)
    @SerializedName("comment")
    open var Comment:String? = null
}

@DataContract(Name="UsageCreditOptionsDto")
open class UsageCreditOptionsDto
{
    @DataMember(Name="behaviour", IsRequired=true)
    @SerializedName("behaviour")
    open var UsageBehaviour:UsageBehaviourEnum? = null

    @DataMember(Name="creditKind", IsRequired=true)
    @SerializedName("creditKind")
    open var CreditKind:CreditKindEnum? = null
}

@DataContract(Name="CustomerBalanceChangeDto")
open class CustomerBalanceChangeDto
{
    @DataMember(Name="items", EmitDefaultValue=false)
    @SerializedName("items")
    open var Items:ArrayList<CustomerBalanceChangeItemDto> = ArrayList<CustomerBalanceChangeItemDto>()

    @DataMember(Name="totalAmount", EmitDefaultValue=false)
    @SerializedName("totalAmount")
    open var TotalAmount:Double? = null

    @DataMember(Name="totalDiscountAmount", EmitDefaultValue=false)
    @SerializedName("totalDiscountAmount")
    open var TotalDiscountAmount:Double? = null
}

@DataContract(Name="CustomerBalanceChangeItemDto")
open class CustomerBalanceChangeItemDto
{
    @DataMember(Name="type", IsRequired=true)
    @SerializedName("type")
    open var ProductType:ProductTypeEnum? = null

    @DataMember(Name="id", IsRequired=true)
    @SerializedName("id")
    open var Id:UUID? = null

    @DataMember(Name="name", IsRequired=true)
    @SerializedName("name")
    open var Name:String? = null

    @DataMember(Name="productGroupId", IsRequired=true)
    @SerializedName("productGroupId")
    open var ProductGroupId:UUID? = null

    @DataMember(Name="productGroupName", IsRequired=true)
    @SerializedName("productGroupName")
    open var ProductGroupName:String? = null

    @DataMember(Name="quantity", IsRequired=true)
    @SerializedName("quantity")
    open var Quantity:Double? = null

    @DataMember(Name="amount", IsRequired=true)
    @SerializedName("amount")
    open var Amount:Double? = null

    @DataMember(Name="discountAmount", IsRequired=true)
    @SerializedName("discountAmount")
    open var DiscountAmount:Double? = null

    @DataMember(Name="totalAmount", EmitDefaultValue=false)
    @SerializedName("totalAmount")
    open var TotalAmount:Double? = null

    @DataMember(Name="invoiceRecipientCustomerId", IsRequired=true)
    @SerializedName("invoiceRecipientCustomerId")
    open var InvoiceRecipientCustomerId:UUID? = null
}

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

Kotlin 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>