Trendsic Platform Service

AdjustmentReportRequest

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

The following routes are available for this service:
GET	/v1/AdjustmentReport/{ParamStartDate}/{ParamEndDate}

<?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 Adjustment implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $ID=0,
        /** @var DateTime */
        public DateTime $AdjustmentDate=new DateTime(),
        /** @var string|null */
        public ?string $Agent=null,
        /** @var string|null */
        public ?string $Reason=null,
        /** @var float */
        public float $Amount=0.0,
        /** @var string|null */
        public ?string $Approved=null,
        /** @var string|null */
        public ?string $AdjType=null,
        /** @var string|null */
        public ?string $Income=null,
        /** @var string|null */
        public ?string $Paid=null,
        /** @var string|null */
        public ?string $BalanceForward=null,
        /** @var string|null */
        public ?string $BalanceDate=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ID'])) $this->ID = $o['ID'];
        if (isset($o['AdjustmentDate'])) $this->AdjustmentDate = JsonConverters::from('DateTime', $o['AdjustmentDate']);
        if (isset($o['Agent'])) $this->Agent = $o['Agent'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['Approved'])) $this->Approved = $o['Approved'];
        if (isset($o['AdjType'])) $this->AdjType = $o['AdjType'];
        if (isset($o['Income'])) $this->Income = $o['Income'];
        if (isset($o['Paid'])) $this->Paid = $o['Paid'];
        if (isset($o['BalanceForward'])) $this->BalanceForward = $o['BalanceForward'];
        if (isset($o['BalanceDate'])) $this->BalanceDate = $o['BalanceDate'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ID)) $o['ID'] = $this->ID;
        if (isset($this->AdjustmentDate)) $o['AdjustmentDate'] = JsonConverters::to('DateTime', $this->AdjustmentDate);
        if (isset($this->Agent)) $o['Agent'] = $this->Agent;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->Approved)) $o['Approved'] = $this->Approved;
        if (isset($this->AdjType)) $o['AdjType'] = $this->AdjType;
        if (isset($this->Income)) $o['Income'] = $this->Income;
        if (isset($this->Paid)) $o['Paid'] = $this->Paid;
        if (isset($this->BalanceForward)) $o['BalanceForward'] = $this->BalanceForward;
        if (isset($this->BalanceDate)) $o['BalanceDate'] = $this->BalanceDate;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AdjustmentReportRequest implements JsonSerializable
{
    public function __construct(
        /** @var DateTime */
        public DateTime $ParamStartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $ParamEndDate=new DateTime()
    ) {
    }

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

PHP AdjustmentReportRequest 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 /v1/AdjustmentReport/{ParamStartDate}/{ParamEndDate} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AdjustmentReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ReportData>
    <Adjustment>
      <AdjType>String</AdjType>
      <AdjustmentDate>0001-01-01T00:00:00</AdjustmentDate>
      <Agent>String</Agent>
      <Amount>0</Amount>
      <Approved>String</Approved>
      <BalanceDate>String</BalanceDate>
      <BalanceForward>String</BalanceForward>
      <ID>0</ID>
      <Income>String</Income>
      <Paid>String</Paid>
      <Reason>String</Reason>
    </Adjustment>
  </ReportData>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</AdjustmentReportResponse>