BokaMera.API.Host

CreatePresetBehaviour

The following routes are available for this service:
POST	/voss/presetBehaviour	create preset behaviour in voss

import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class CreatePresetBehaviour
{
    /**
    * Company ids to create invoice. If none added invoice for all will be created
    */
    @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
    var ChangeType:ChangeTypeEnum? = null

    var ChangeOperation:ChangeOperationEnum? = null
    var Timing:SubscriptionTimingEnum? = null
    var PeriodAnchor:PeriodAnchorEnum? = null
    var RenewalTiming:RenewalTimingEnum? = null
    var DebitBehaviour:SubscriptionBehaviourEnum? = null
    var CreditBehaviour:SubscriptionBehaviourEnum? = null
    var CreditKind:CreditKindEnum? = null
    var PeriodIterationCount:Int? = null
}

enum class ChangeTypeEnum
{
    Subscription,
    ProductGroup,
    License,
}

enum class ChangeOperationEnum
{
    Create,
    Terminate,
    Upgrade,
    Sidegrade,
    Downgrade,
    Migration,
}

enum class SubscriptionTimingEnum
{
    AtSubscriptionBillingPeriodEnd,
    AtBindingPeriodEnd,
    Immediately,
}

enum class PeriodAnchorEnum
{
    LatestPeriod,
    CurrentPeriod,
}

enum class RenewalTimingEnum
{
    UseCurrentPlanRenewalDate,
    UseScheduledPlanRenewalDate,
}

enum class SubscriptionBehaviourEnum
{
    Prorate,
    Full,
    None,
}

enum class CreditKindEnum
{
    Normal,
    Internal,
}

Kotlin CreatePresetBehaviour DTOs

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

HTTP + CSV

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

POST /voss/presetBehaviour HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ChangeType":"Subscription","ChangeOperation":"Create","Timing":"AtSubscriptionBillingPeriodEnd","PeriodAnchor":"LatestPeriod","RenewalTiming":"UseCurrentPlanRenewalDate","DebitBehaviour":"Prorate","CreditBehaviour":"Prorate","CreditKind":"Normal","PeriodIterationCount":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}