BokaMera.API.Host

<back to all web services

CreateVossInvoice

The following routes are available for this service:
POST/voss/invoiceinit voss invoice
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateVossInvoice:
    # @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
    company_ids: Optional[List[str]] = None
    """
    Company ids to create invoice. If none added invoice for all will be created
    """


    # @ApiMember(Description="Controls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead")
    invoice_date: Optional[datetime.datetime] = None
    """
    Controls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead
    """


    # @ApiMember(Description="If present the operation will start only after this date")
    scheduled_start_time: Optional[datetime.datetime] = None
    """
    If present the operation will start only after this date
    """


    # @ApiMember(Description="Optional CRON expression for recurring operations.")
    recurring_schedule: Optional[str] = None
    """
    Optional CRON expression for recurring operations.
    """


    # @ApiMember(Description="Only usage.")
    only_usage: bool = False
    """
    Only usage.
    """

Python CreateVossInvoice DTOs

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

HTTP + JSV

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

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

{
	CompanyIds: 
	[
		00000000-0000-0000-0000-000000000000
	],
	InvoiceDate: "0001-01-01T00:00:00",
	ScheduledStartTime: "0001-01-01T00:00:00",
	RecurringSchedule: String,
	OnlyUsage: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}