Trendsic Platform Service

CashFlowRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/CashFlowReport/{FromDate}/{ToDate}

<?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 CashFlow implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $AgentID=0,
        /** @var string|null */
        public ?string $AgentName=null,
        /** @var float */
        public float $PersonalCashFlow=0.0,
        /** @var float */
        public float $DownlineCashFlow=0.0
    ) {
    }

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

class CashFlowResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var array<CashFlow>|null */
        public ?array $CashFlow=null
    ) {
    }

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

class CashFlowRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $FromDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ToDate=new DateTime()
    ) {
    }

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

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

GET /v1/CashFlowReport/{FromDate}/{ToDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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
		}
	},
	CashFlow: 
	[
		{
			AgentID: 0,
			AgentName: String,
			PersonalCashFlow: 0,
			DownlineCashFlow: 0
		}
	]
}