BokaMera.API.Host

<back to all web services

CreateVossInvoice

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/voss/invoiceinit voss invoice
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class CreateVossInvoice
{
    /**
    * Company ids to create invoice. If none added invoice for all will be created
    */
    @ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")
    open var CompanyIds:ArrayList<UUID> = ArrayList<UUID>()

    /**
    * 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="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")
    open var InvoiceDate:Date? = null

    /**
    * If present the operation will start only after this date
    */
    @ApiMember(Description="If present the operation will start only after this date")
    open var ScheduledStartTime:Date? = null

    /**
    * Optional CRON expression for recurring operations.
    */
    @ApiMember(Description="Optional CRON expression for recurring operations.")
    open var RecurringSchedule:String? = null

    /**
    * Only usage.
    */
    @ApiMember(Description="Only usage.")
    open var OnlyUsage:Boolean? = null
}

Kotlin 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: api.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

{
	
}