BokaMera.API.Host

<back to all web services

CreatePresetBehaviour

The following routes are available for this service:
POST/voss/presetBehaviourcreate preset behaviour in voss
CreatePresetBehaviour Parameters:
NameParameterData TypeRequiredDescription
ChangeTypebodyChangeTypeEnumNoCompany ids to create invoice. If none added invoice for all will be created
ChangeOperationbodyChangeOperationEnumNo
TimingbodySubscriptionTimingEnumNo
PeriodAnchorbodyPeriodAnchorEnumNo
RenewalTimingbodyRenewalTimingEnumNo
DebitBehaviourbodySubscriptionBehaviourEnum?No
CreditBehaviourbodySubscriptionBehaviourEnum?No
CreditKindbodyCreditKindEnum?No
PeriodIterationCountbodyint?No
ChangeTypeEnum Enum:
Subscription
ProductGroup
License
ChangeOperationEnum Enum:
Create
Terminate
Upgrade
Sidegrade
Downgrade
Migration
SubscriptionTimingEnum Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately
PeriodAnchorEnum Enum:
LatestPeriod
CurrentPeriod
RenewalTimingEnum Enum:
UseCurrentPlanRenewalDate
UseScheduledPlanRenewalDate
SubscriptionBehaviourEnum Enum:
Prorate
Full
None
CreditKindEnum Enum:
Normal
Internal

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

{}