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 Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class ExportPayableEntityReport : ICompany, Codable
{
    /**
    * 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.")
    public var companyId:String?

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

    public var sendReceiptMethod:SendReceiptMethod
    /**
    * Article type (Could be Service, rebate code types, etc..
    */
    // @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
    public var articleTypeId:Int

    required public init(){}
}

public enum SendReceiptMethod : Int, Codable
{
    case Email = 1
    case PdfExport = 2
}


Swift ExportPayableEntityReport DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}