Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /licenses/company | Add product to company invoicing | Add new product to company invoicing. Sends that product to VOSS System. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid? | No | The company id |
InvoiceArticleId | body | int | Yes | Invoice article No in Db. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProductGroupType | form | ProductGroupTypeEnum | No | |
Status | form | StatusEnum | No | |
Id | form | Guid | No | |
Name | form | string | Yes | |
Products | form | List<SubscriptionProductGroupProductResultDto> | Yes | |
Termination | form | SubscriptionItemTerminationDto | Yes | |
Created | form | DateTime | No | |
CustomerBalanceChange | form | CustomerBalanceChangeDto | Yes |
Name | Value | |
---|---|---|
Optional | 1 | |
Included | 2 |
Name | Value | |
---|---|---|
Active | 1 | |
Terminated | 2 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Name | form | string | Yes | |
ExternalId | form | string | Yes | |
ArticleNumber | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | TypeEnum | No | |
Source | form | SourceEnum | No | |
ScheduledDate | form | DateTime | No | |
Reason | form | SubscriptionItemTerminationReasonDto | Yes | |
CreditOptions | form | CreditOptionsDto | Yes |
Name | Value | |
---|---|---|
AtSubscriptionBillingPeriodEnd | 1 | |
AtBindingPeriodEnd | 2 | |
Immediately | 3 |
Name | Value | |
---|---|---|
Direct | 1 | |
Plan | 2 | |
CustomerExpiration | 3 | |
Update | 4 | |
Unpaid | 5 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReasonId | form | Guid | No | |
ReasonName | form | string | Yes | |
ReasonExternalId | form | string | Yes | |
SubReasonId | form | Guid? | No | |
SubReasonName | form | string | Yes | |
SubReasonExternalId | form | string | Yes | |
Comment | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Behaviour | form | BehaviourEnum | No | |
CreditKind | form | CreditKindEnum | No | |
ProrateTimeAnchor | form | DateTime? | No |
Name | Value | |
---|---|---|
Prorate | 1 | |
Full | 2 | |
None | 3 |
Name | Value | |
---|---|---|
Normal | 1 | |
Internal | 2 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Items | form | List<CustomerBalanceChangeItemDto> | Yes | |
TotalAmount | form | double | No | |
TotalDiscountAmount | form | double | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Type | form | TypeEnum | No | |
Id | form | Guid | No | |
Name | form | string | Yes | |
ProductGroupId | form | Guid | No | |
ProductGroupName | form | string | Yes | |
Quantity | form | double | No | |
Amount | form | double | No | |
DiscountAmount | form | double | No | |
TotalAmount | form | double | No | |
InvoiceRecipientCustomerId | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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'.