Trendsic Platform Service

RunBillingRequest

The following routes are available for this service:
POST,OPTIONS	/v1/billing/run

<?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};


class RunBillingResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var int */
        public int $BillingRunID=0,
        /** @var string|null */
        public ?string $Status=null,
        /** @var bool|null */
        public ?bool $Started=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

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

class RunBillingRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $RunType=null,
        /** @var string|null */
        public ?string $PeriodKey=null
    ) {
    }

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

PHP RunBillingRequest 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.

POST /v1/billing/run HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RunType: String,
	PeriodKey: String
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BillingRunID: 0,
	Status: String,
	Started: False,
	Message: String
}