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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<AllowNullLiteral>]
    type CreateVossInvoice() = 
        ///<summary>
        ///Company ids to create invoice. If none added invoice for all will be created
        ///</summary>
        [<ApiMember(Description="Company ids to create invoice. If none added invoice for all will be created")>]
        member val CompanyIds:ResizeArray<Guid> = null with get,set

        ///<summary>
        ///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
        ///</summary>
        [<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")>]
        member val InvoiceDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///If present the operation will start only after this date
        ///</summary>
        [<ApiMember(Description="If present the operation will start only after this date")>]
        member val ScheduledStartTime:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        ///<summary>
        ///Optional CRON expression for recurring operations.
        ///</summary>
        [<ApiMember(Description="Optional CRON expression for recurring operations.")>]
        member val RecurringSchedule:String = null with get,set

        ///<summary>
        ///Only usage.
        ///</summary>
        [<ApiMember(Description="Only usage.")>]
        member val OnlyUsage:Boolean = new Boolean() with get,set

F# 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

{
	
}