BokaMera.API.Host

CreateVossUsage

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

The following routes are available for this service:
POST	/voss/usage	Add product to company invoicing	Add 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.Model;
using BokaMera.VossIntegration.ApiTools.Enums;

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

        ///<summary>
        ///Article number. Can be fetched from products
        ///</summary>
        [ApiMember(Description="Article number. Can be fetched from products", IsRequired=true)]
        public virtual string ArticleNumber { get; set; }

        ///<summary>
        ///Example: developer worked 6 hours
        ///</summary>
        [ApiMember(Description="Example: developer worked 6 hours", IsRequired=true)]
        public virtual int Quantity { get; set; }
    }

}

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

    public enum ProductGroupTypeEnum
    {
        Optional,
        Included,
    }

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

    public enum SubscriptionBehaviourEnum
    {
        Prorate,
        Full,
        None,
    }

}

namespace BokaMera.VossIntegration.ApiTools.Model
{
    [DataContract(Name="CreateSubscriptionProductGroupResult")]
    public partial class CreateSubscriptionProductGroupResult
    {
        [DataMember(Name="productGroupType", IsRequired=true)]
        public virtual ProductGroupTypeEnum ProductGroupType { get; set; }

        [DataMember(Name="status", IsRequired=true)]
        public virtual StatusEnum Status { 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="products", EmitDefaultValue=false)]
        public virtual List<SubscriptionProductGroupProductResultDto> Products { get; set; } = [];

        [DataMember(Name="termination")]
        public virtual SubscriptionItemTerminationDto Termination { get; set; }

        [DataMember(Name="created", IsRequired=true)]
        public virtual DateTime Created { get; set; }

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

    }

    [DataContract(Name="CreditOptionsDto")]
    public partial class CreditOptionsDto
    {
        [DataMember(Name="behaviour", IsRequired=true)]
        public virtual SubscriptionBehaviourEnum SubscriptionBehaviour { get; set; }

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

        [DataMember(Name="prorateTimeAnchor")]
        public virtual DateTime? ProrateTimeAnchor { 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="SubscriptionItemTerminationDto")]
    public partial class SubscriptionItemTerminationDto
    {
        [DataMember(Name="type")]
        public virtual TypeEnum Type { get; set; }

        [DataMember(Name="source", IsRequired=true)]
        public virtual SourceEnum Source { get; set; }

        [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 CreditOptionsDto CreditOptions { get; set; }
        public enum TypeEnum
        {
            AtSubscriptionBillingPeriodEnd,
            AtBindingPeriodEnd,
            Immediately,
        }

        public enum SourceEnum
        {
            Direct,
            Plan,
            CustomerExpiration,
            Update,
            Unpaid,
        }

    }

    [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="SubscriptionProductGroupProductResultDto")]
    public partial class SubscriptionProductGroupProductResultDto
    {
        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

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

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

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

}

C# CreateVossUsage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /voss/usage HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ArticleNumber":"String","Quantity":0}

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

{"productGroupType":"Optional","status":"Active","name":"String","products":[{}]}