BokaMera.API.Host

ExportPayableEntityReport

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/articles/{InternalReferenceId}/reports	Get a report as a PDF file	Get a PDF report.

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum SendReceiptMethod : int
{
    case Email = 1;
    case PdfExport = 2;
}

// @ValidateRequest(Validator="IsAuthenticated")
class ExportPayableEntityReport implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description 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 string|null */
        public ?string $CompanyId=null,

        /** @description 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 string */
        public string $InternalReferenceId='',

        /** @var SendReceiptMethod|null */
        public ?SendReceiptMethod $SendReceiptMethod=null,
        /** @description Article type (Could be Service, rebate code types, etc.. */
        // @ApiMember(Description="Article type (Could be Service, rebate code types, etc..", IsRequired=true)
        /** @var int */
        public int $ArticleTypeId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['InternalReferenceId'])) $this->InternalReferenceId = $o['InternalReferenceId'];
        if (isset($o['SendReceiptMethod'])) $this->SendReceiptMethod = JsonConverters::from('SendReceiptMethod', $o['SendReceiptMethod']);
        if (isset($o['ArticleTypeId'])) $this->ArticleTypeId = $o['ArticleTypeId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->InternalReferenceId)) $o['InternalReferenceId'] = $this->InternalReferenceId;
        if (isset($this->SendReceiptMethod)) $o['SendReceiptMethod'] = JsonConverters::to('SendReceiptMethod', $this->SendReceiptMethod);
        if (isset($this->ArticleTypeId)) $o['ArticleTypeId'] = $this->ArticleTypeId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ExportPayableEntityReport DTOs

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}