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.
"use strict";
/** @typedef {number} */
export var SendReceiptMethod;
(function (SendReceiptMethod) {
    SendReceiptMethod[SendReceiptMethod["Email"] = 1] = "Email"
    SendReceiptMethod[SendReceiptMethod["PdfExport"] = 2] = "PdfExport"
})(SendReceiptMethod || (SendReceiptMethod = {}));
export class ExportPayableEntityReport {
    /** @param {{CompanyId?:string,InternalReferenceId?:string,SendReceiptMethod?:SendReceiptMethod,ArticleTypeId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description Id of the internal reference (booking, rebate code, etc) */
    InternalReferenceId;
    /** @type {SendReceiptMethod} */
    SendReceiptMethod;
    /**
     * @type {number}
     * @description Article type (Could be Service, rebate code types, etc.. */
    ArticleTypeId;
}

JavaScript ExportPayableEntityReport 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.

GET /articles/{InternalReferenceId}/reports HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
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/" />