BokaMera.API.Host

<back to all web services

GetVossCustomerInvoiceBalance

The following routes are available for this service:
GET/voss/invoice/balanceget 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
Imports BokaMera.VossIntegration.Dtos
Imports BokaMera.VossIntegration.ApiTools.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class GetVossCustomerInvoiceBalance
            Inherits VossPagination
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As 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
        End Class
    End Namespace

    Namespace BokaMera.VossIntegration.ApiTools.Enums

        Public Enum SortDirectionEnum
            Ascending
            Descending
        End Enum
    End Namespace

    Namespace BokaMera.VossIntegration.Dtos

        Public Partial Class VossPagination
            Public Overridable Property SearchText As String
            Public Overridable Property PageIndex As Integer
            Public Overridable Property PageSize As Integer
            Public Overridable Property SortField As String
            Public Overridable Property SortDirection As SortDirectionEnum
        End Class
    End Namespace
End Namespace

VB.NET GetVossCustomerInvoiceBalance 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.

GET /voss/invoice/balance HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}