BokaMera.API.Host

<back to all web services

EAccountingArticleQuery

The following routes are available for this service:
GET/eaccounting/articles
<?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};


// @DataContract
class QueryBase implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $Skip=null,

        // @DataMember(Order=2)
        /** @var int|null */
        public ?int $Take=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $OrderBy=null,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $OrderByDesc=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $Include=null,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $Fields=null,

        // @DataMember(Order=7)
        /** @var array<string,string>|null */
        public ?array $Meta=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Skip'])) $this->Skip = $o['Skip'];
        if (isset($o['Take'])) $this->Take = $o['Take'];
        if (isset($o['OrderBy'])) $this->OrderBy = $o['OrderBy'];
        if (isset($o['OrderByDesc'])) $this->OrderByDesc = $o['OrderByDesc'];
        if (isset($o['Include'])) $this->Include = $o['Include'];
        if (isset($o['Fields'])) $this->Fields = $o['Fields'];
        if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Skip)) $o['Skip'] = $this->Skip;
        if (isset($this->Take)) $o['Take'] = $this->Take;
        if (isset($this->OrderBy)) $o['OrderBy'] = $this->OrderBy;
        if (isset($this->OrderByDesc)) $o['OrderByDesc'] = $this->OrderByDesc;
        if (isset($this->Include)) $o['Include'] = $this->Include;
        if (isset($this->Fields)) $o['Fields'] = $this->Fields;
        if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template T
 */
class QueryData extends QueryBase implements JsonSerializable
{
    public array $genericArgs = [];
    public static function create(array $genericArgs=[]): QueryData {
        $to = new QueryData();
        $to->genericArgs = $genericArgs;
        return $to;
    }

    /**
     * @param int|null $Skip
     * @param int|null $Take
     * @param string|null $OrderBy
     * @param string|null $OrderByDesc
     * @param string|null $Include
     * @param string|null $Fields
     * @param array<string,string>|null $Meta
     */
    public function __construct(
        mixed $Skip=null,
        mixed $Take=null,
        mixed $OrderBy=null,
        mixed $OrderByDesc=null,
        mixed $Include=null,
        mixed $Fields=null,
        mixed $Meta=null
    ) {
        parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        return empty($o) ? new class(){} : $o;
    }
}

class BaseArticleDto implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ArticleId='',
        /** @var float */
        public float $ArticlePrice=0.0,
        /** @var string */
        public string $ArticleName='',
        /** @var DateTime */
        public DateTime $CreatedDate=new DateTime()
    ) {
    }

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

class EAccountingArticleQueryResponse extends BaseArticleDto implements JsonSerializable
{
    /**
     * @param string $ArticleId
     * @param float $ArticlePrice
     * @param string $ArticleName
     * @param DateTime $CreatedDate
     */
    public function __construct(
        string $ArticleId='',
        float $ArticlePrice=0.0,
        string $ArticleName='',
        DateTime $CreatedDate=new DateTime(),
        /** @var string */
        public string $UnitId='',
        /** @var string */
        public string $CodingId='',
        /** @var string */
        public string $VatRate='',
        /** @var string */
        public string $VatRatePercent='',
        /** @var string */
        public string $CurrencySign=''
    ) {
        parent::__construct($ArticleId,$ArticlePrice,$ArticleName,$CreatedDate);
    }

    /** @throws Exception */
    public function fromMap($o): void {
        parent::fromMap($o);
        if (isset($o['UnitId'])) $this->UnitId = $o['UnitId'];
        if (isset($o['CodingId'])) $this->CodingId = $o['CodingId'];
        if (isset($o['VatRate'])) $this->VatRate = $o['VatRate'];
        if (isset($o['VatRatePercent'])) $this->VatRatePercent = $o['VatRatePercent'];
        if (isset($o['CurrencySign'])) $this->CurrencySign = $o['CurrencySign'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = parent::jsonSerialize();
        if (isset($this->UnitId)) $o['UnitId'] = $this->UnitId;
        if (isset($this->CodingId)) $o['CodingId'] = $this->CodingId;
        if (isset($this->VatRate)) $o['VatRate'] = $this->VatRate;
        if (isset($this->VatRatePercent)) $o['VatRatePercent'] = $this->VatRatePercent;
        if (isset($this->CurrencySign)) $o['CurrencySign'] = $this->CurrencySign;
        return empty($o) ? new class(){} : $o;
    }
}

/**
 * @template QueryData of EAccountingArticleQueryResponse
 */
class EAccountingArticleQuery extends QueryData implements ICompany, JsonSerializable
{
    /**
     * @param int|null $Skip
     * @param int|null $Take
     * @param string|null $OrderBy
     * @param string|null $OrderByDesc
     * @param string|null $Include
     * @param string|null $Fields
     * @param array<string,string>|null $Meta
     */
    public function __construct(
        ?int $Skip=null,
        ?int $Take=null,
        ?string $OrderBy=null,
        ?string $OrderByDesc=null,
        ?string $Include=null,
        ?string $Fields=null,
        ?array $Meta=null,
        /** @var string|null */
        public ?string $CompanyId=null
    ) {
        parent::__construct($Skip,$Take,$OrderBy,$OrderByDesc,$Include,$Fields,$Meta);
    }

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

class AccessKeyTypeResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string */
        public string $KeyType='',
        /** @var string */
        public string $Description=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['KeyType'])) $this->KeyType = $o['KeyType'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->KeyType)) $o['KeyType'] = $this->KeyType;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
/**
 * @template T
 */
class QueryResponse implements JsonSerializable
{
    public array $genericArgs = [];
    public static function create(array $genericArgs=[]): QueryResponse {
        $to = new QueryResponse();
        $to->genericArgs = $genericArgs;
        return $to;
    }

    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public mixed $Offset=0,

        // @DataMember(Order=2)
        /** @var int */
        public mixed $Total=0,

        // @DataMember(Order=3)
        /** @var array<AccessKeyTypeResponse>|null */
        public mixed $Results=null,

        // @DataMember(Order=4)
        /** @var array<string,string>|null */
        public mixed $Meta=null,

        // @DataMember(Order=5)
        /** @var ResponseStatus|null */
        public mixed $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Offset'])) $this->Offset = $o['Offset'];
        if (isset($o['Total'])) $this->Total = $o['Total'];
        if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('AccessKeyTypeResponse', $o['Results']);
        if (isset($o['Meta'])) $this->Meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['Meta']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Offset)) $o['Offset'] = $this->Offset;
        if (isset($this->Total)) $o['Total'] = $this->Total;
        if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('AccessKeyTypeResponse', $this->Results);
        if (isset($this->Meta)) $o['Meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->Meta);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

PHP EAccountingArticleQuery DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /eaccounting/articles HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsonl

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

{"Offset":0,"Total":0,"Results":[{"UnitId":"String","CodingId":"String","VatRate":"String","VatRatePercent":"String","CurrencySign":"String","ArticlePrice":0,"ArticleName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}