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.

**CreateVossUsage** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid	Yes	The company id
ArticleNumber	body	string	Yes	Article number. Can be fetched from products
Quantity	body	int	Yes	Example: developer worked 6 hours

**CreateSubscriptionProductGroupResult** Parameters:
Name	Parameter	Data Type	Required
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

**ProductGroupTypeEnum** Enum:
Optional
Included

**StatusEnum** Enum:
Active
Terminated

**SubscriptionProductGroupProductResultDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	Yes
ExternalId	form	string	Yes
ArticleNumber	form	string	Yes

**SubscriptionItemTerminationDto** Parameters:
Name	Parameter	Data Type	Required
Type	form	TypeEnum	No
Source	form	SourceEnum	No
ScheduledDate	form	DateTime	No
Reason	form	SubscriptionItemTerminationReasonDto	Yes
CreditOptions	form	CreditOptionsDto	Yes

**TypeEnum** Enum:
AtSubscriptionBillingPeriodEnd
AtBindingPeriodEnd
Immediately

**SourceEnum** Enum:
Direct
Plan
CustomerExpiration
Update
Unpaid

**SubscriptionItemTerminationReasonDto** Parameters:
Name	Parameter	Data Type	Required
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

**CreditOptionsDto** Parameters:
Name	Parameter	Data Type	Required
SubscriptionBehaviour	form	SubscriptionBehaviourEnum	No
CreditKind	form	CreditKindEnum	No
ProrateTimeAnchor	form	DateTime?	No

**SubscriptionBehaviourEnum** Enum:
Prorate
Full
None

**CreditKindEnum** Enum:
Normal
Internal

**CustomerBalanceChangeDto** Parameters:
Name	Parameter	Data Type	Required
Items	form	List<CustomerBalanceChangeItemDto>	Yes
TotalAmount	form	double	No
TotalDiscountAmount	form	double	No

**CustomerBalanceChangeItemDto** Parameters:
Name	Parameter	Data Type	Required
ProductType	form	ProductTypeEnum	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

**ProductTypeEnum** Enum:
Main
Addon
License
Usage

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<CreateVossUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <ArticleNumber>String</ArticleNumber>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Quantity>0</Quantity>
</CreateVossUsage>

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

<CreateSubscriptionProductGroupResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
  <created>0001-01-01T00:00:00</created>
  <customerBalanceChange i:nil="true" />
  <id>00000000-0000-0000-0000-000000000000</id>
  <name>String</name>
  <productGroupType>Optional</productGroupType>
  <products>
    <SubscriptionProductGroupProductResultDto i:nil="true" />
  </products>
  <status>Active</status>
  <termination i:nil="true" />
</CreateSubscriptionProductGroupResult>