Trendsic Platform Service

<back to all web services

AgreementCreditsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/serviceagreement/credits
<?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 CreditLedger implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CreditLedgerID=0,
        /** @var string */
        public string $TenantId='',
        /** @var string|null */
        public ?string $BranchId=null,
        /** @var int|null */
        public ?int $AgreementID=null,
        /** @var int|null */
        public ?int $ProjectID=null,
        /** @var int|null */
        public ?int $AgreementJobID=null,
        /** @var float|null */
        public ?float $Amount=null,
        /** @var string|null */
        public ?string $Reason=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $CreatedAt=null,
        /** @var DateTime|null */
        public ?DateTime $AppliedAt=null,
        /** @var string|null */
        public ?string $AgreementName=null,
        /** @var string|null */
        public ?string $ProjectName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CreditLedgerID'])) $this->CreditLedgerID = $o['CreditLedgerID'];
        if (isset($o['TenantId'])) $this->TenantId = $o['TenantId'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['AgreementID'])) $this->AgreementID = $o['AgreementID'];
        if (isset($o['ProjectID'])) $this->ProjectID = $o['ProjectID'];
        if (isset($o['AgreementJobID'])) $this->AgreementJobID = $o['AgreementJobID'];
        if (isset($o['Amount'])) $this->Amount = $o['Amount'];
        if (isset($o['Reason'])) $this->Reason = $o['Reason'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['CreatedAt'])) $this->CreatedAt = JsonConverters::from('DateTime', $o['CreatedAt']);
        if (isset($o['AppliedAt'])) $this->AppliedAt = JsonConverters::from('DateTime', $o['AppliedAt']);
        if (isset($o['AgreementName'])) $this->AgreementName = $o['AgreementName'];
        if (isset($o['ProjectName'])) $this->ProjectName = $o['ProjectName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CreditLedgerID)) $o['CreditLedgerID'] = $this->CreditLedgerID;
        if (isset($this->TenantId)) $o['TenantId'] = $this->TenantId;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->AgreementID)) $o['AgreementID'] = $this->AgreementID;
        if (isset($this->ProjectID)) $o['ProjectID'] = $this->ProjectID;
        if (isset($this->AgreementJobID)) $o['AgreementJobID'] = $this->AgreementJobID;
        if (isset($this->Amount)) $o['Amount'] = $this->Amount;
        if (isset($this->Reason)) $o['Reason'] = $this->Reason;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->CreatedAt)) $o['CreatedAt'] = JsonConverters::to('DateTime', $this->CreatedAt);
        if (isset($this->AppliedAt)) $o['AppliedAt'] = JsonConverters::to('DateTime', $this->AppliedAt);
        if (isset($this->AgreementName)) $o['AgreementName'] = $this->AgreementName;
        if (isset($this->ProjectName)) $o['ProjectName'] = $this->ProjectName;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class AgreementCreditsRequest implements JsonSerializable
{
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        return empty($o) ? new class(){} : $o;
    }
}

PHP AgreementCreditsRequest 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/serviceagreement/credits HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgreementCreditsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Credits>
    <CreditLedger>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <AgreementName>String</AgreementName>
      <Amount>0</Amount>
      <AppliedAt>0001-01-01T00:00:00</AppliedAt>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <CreditLedgerID>0</CreditLedgerID>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <Reason>String</Reason>
      <Status>String</Status>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
    </CreditLedger>
  </Credits>
  <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>
</AgreementCreditsResponse>