BokaMera.API.Host

<back to all web services

CreateNonLicenseProduct

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/licenses/companyAdd product to company invoicingAdd new product to company invoicing. Sends that product to VOSS System.
CreateNonLicenseProduct Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id
InvoiceArticleIdbodyintYesInvoice article No in Db.
CreateSubscriptionProductGroupResult Parameters:
NameParameterData TypeRequiredDescription
ProductGroupTypeformProductGroupTypeEnumNo
StatusformStatusEnumNo
IdformGuidNo
NameformstringYes
ProductsformList<SubscriptionProductGroupProductResultDto>Yes
TerminationformSubscriptionItemTerminationDtoYes
CreatedformDateTimeNo
CustomerBalanceChangeformCustomerBalanceChangeDtoYes
ProductGroupTypeEnum Enum:
NameValue
Optional1
Included2
StatusEnum Enum:
NameValue
Active1
Terminated2
SubscriptionProductGroupProductResultDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
ExternalIdformstringYes
ArticleNumberformstringYes
SubscriptionItemTerminationDto Parameters:
NameParameterData TypeRequiredDescription
TypeformTypeEnumNo
SourceformSourceEnumNo
ScheduledDateformDateTimeNo
ReasonformSubscriptionItemTerminationReasonDtoYes
CreditOptionsformCreditOptionsDtoYes
TypeEnum Enum:
NameValue
AtSubscriptionBillingPeriodEnd1
AtBindingPeriodEnd2
Immediately3
SourceEnum Enum:
NameValue
Direct1
Plan2
CustomerExpiration3
Update4
Unpaid5
SubscriptionItemTerminationReasonDto Parameters:
NameParameterData TypeRequiredDescription
ReasonIdformGuidNo
ReasonNameformstringYes
ReasonExternalIdformstringYes
SubReasonIdformGuid?No
SubReasonNameformstringYes
SubReasonExternalIdformstringYes
CommentformstringYes
CreditOptionsDto Parameters:
NameParameterData TypeRequiredDescription
BehaviourformBehaviourEnumNo
CreditKindformCreditKindEnumNo
ProrateTimeAnchorformDateTime?No
BehaviourEnum Enum:
NameValue
Prorate1
Full2
None3
CreditKindEnum Enum:
NameValue
Normal1
Internal2
CustomerBalanceChangeDto Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<CustomerBalanceChangeItemDto>Yes
TotalAmountformdoubleNo
TotalDiscountAmountformdoubleNo
CustomerBalanceChangeItemDto Parameters:
NameParameterData TypeRequiredDescription
TypeformTypeEnumNo
IdformGuidNo
NameformstringYes
ProductGroupIdformGuidNo
ProductGroupNameformstringYes
QuantityformdoubleNo
AmountformdoubleNo
DiscountAmountformdoubleNo
TotalAmountformdoubleNo
InvoiceRecipientCustomerIdformGuidNo

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

HTTP + OTHER

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

PUT /licenses/company HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","InvoiceArticleId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{Unable to show example output for type 'CreateSubscriptionProductGroupResult' using the custom 'other' filter}No parameterless constructor defined for type 'VossIntegration.ApiTools.Model.CreateSubscriptionProductGroupResult'.