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
Imports System
Imports System.IO
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
            '''<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) = New 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 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 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 .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/invoice HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateVossInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </CompanyIds>
  <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
  <OnlyUsage>false</OnlyUsage>
  <RecurringSchedule>String</RecurringSchedule>
  <ScheduledStartTime>0001-01-01T00:00:00</ScheduledStartTime>
</CreateVossInvoice>

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

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />