BokaMera.API.Host

<back to all web services

CreateVossInvoice

The following routes are available for this service:
POST/voss/invoiceinit voss invoice
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class CreateVossInvoice
            Public Sub New()
                CompanyIds = New List(Of Guid)
            End Sub

            '''<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")>
            Public Overridable Property CompanyIds As List(Of Guid)

            '''<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")>
            Public Overridable Property InvoiceDate As Nullable(Of Date)

            '''<Summary>
            '''If present the operation will start only after this date
            '''</Summary>
            <ApiMember(Description:="If present the operation will start only after this date")>
            Public Overridable Property ScheduledStartTime As Nullable(Of Date)

            '''<Summary>
            '''Optional CRON expression for recurring operations.
            '''</Summary>
            <ApiMember(Description:="Optional CRON expression for recurring operations.")>
            Public Overridable Property RecurringSchedule As String

            '''<Summary>
            '''Only usage.
            '''</Summary>
            <ApiMember(Description:="Only usage.")>
            Public Overridable Property OnlyUsage As Boolean
        End Class
    End Namespace
End Namespace

VB.NET CreateVossInvoice DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

{}