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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class ExportPayableEntityReport : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * Id of the internal reference (booking, rebate code, etc)
    */
    @ApiMember(Description="Id of the internal reference (booking, rebate code, etc)", IsRequired=true, ParameterType="path")
    var InternalReferenceId:String? = null

    var SendReceiptMethod:SendReceiptMethod? = null
    /**
    * Article type (Could be Service, rebate code types, etc..
    */
    @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    var ArticleTypeId:Int? = null
}

enum class SendReceiptMethod(val value:Int)
{
    Email(1),
    PdfExport(2),
}

Kotlin 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

{
	
}