BokaMera.API.Host

<back to all web services

ExportPayableEntityReport

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/articles/{InternalReferenceId}/reportsGet a report as a PDF fileGet a PDF report.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class ExportPayableEntityReport
            Implements ICompany
            '''<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 Nullable(Of Guid)

            '''<Summary>
            '''Id of the internal reference (booking, rebate code, etc)
            '''</Summary>
            <ApiMember(Description:="Id of the internal reference (booking, rebate code, etc)", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property InternalReferenceId As String

            Public Overridable Property SendReceiptMethod As SendReceiptMethod
            '''<Summary>
            '''Article type (Could be Service, rebate code types, etc..
            '''</Summary>
            <ApiMember(Description:="Article type (Could be Service, rebate code types, etc..", IsRequired:=true)>
            Public Overridable Property ArticleTypeId As Integer
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum SendReceiptMethod
            Email = 1
            PdfExport = 2
        End Enum
    End Namespace
End Namespace

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

GET /articles/{InternalReferenceId}/reports HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	
}