Trendsic Platform Service

<back to all web services

BillingRunStatusRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/billing/run/{BillingRunID}
<?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 BillingRun implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $BillingRunID=0,
        /** @var string|null */
        public ?string $TenantId=null,
        /** @var string|null */
        public ?string $BranchId=null,
        /** @var string|null */
        public ?string $BranchName=null,
        /** @var string|null */
        public ?string $RunType=null,
        /** @var string|null */
        public ?string $PeriodKey=null,
        /** @var string|null */
        public ?string $Status=null,
        /** @var int */
        public int $InvoicesCreated=0,
        /** @var int */
        public int $CreditsApplied=0,
        /** @var string|null */
        public ?string $Error=null,
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var DateTime|null */
        public ?DateTime $StartedAt=null,
        /** @var DateTime|null */
        public ?DateTime $CompletedAt=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['BillingRunID'])) $this->BillingRunID = $o['BillingRunID'];
        if (isset($o['TenantId'])) $this->TenantId = $o['TenantId'];
        if (isset($o['BranchId'])) $this->BranchId = $o['BranchId'];
        if (isset($o['BranchName'])) $this->BranchName = $o['BranchName'];
        if (isset($o['RunType'])) $this->RunType = $o['RunType'];
        if (isset($o['PeriodKey'])) $this->PeriodKey = $o['PeriodKey'];
        if (isset($o['Status'])) $this->Status = $o['Status'];
        if (isset($o['InvoicesCreated'])) $this->InvoicesCreated = $o['InvoicesCreated'];
        if (isset($o['CreditsApplied'])) $this->CreditsApplied = $o['CreditsApplied'];
        if (isset($o['Error'])) $this->Error = $o['Error'];
        if (isset($o['CreatedBy'])) $this->CreatedBy = $o['CreatedBy'];
        if (isset($o['StartedAt'])) $this->StartedAt = JsonConverters::from('DateTime', $o['StartedAt']);
        if (isset($o['CompletedAt'])) $this->CompletedAt = JsonConverters::from('DateTime', $o['CompletedAt']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->BillingRunID)) $o['BillingRunID'] = $this->BillingRunID;
        if (isset($this->TenantId)) $o['TenantId'] = $this->TenantId;
        if (isset($this->BranchId)) $o['BranchId'] = $this->BranchId;
        if (isset($this->BranchName)) $o['BranchName'] = $this->BranchName;
        if (isset($this->RunType)) $o['RunType'] = $this->RunType;
        if (isset($this->PeriodKey)) $o['PeriodKey'] = $this->PeriodKey;
        if (isset($this->Status)) $o['Status'] = $this->Status;
        if (isset($this->InvoicesCreated)) $o['InvoicesCreated'] = $this->InvoicesCreated;
        if (isset($this->CreditsApplied)) $o['CreditsApplied'] = $this->CreditsApplied;
        if (isset($this->Error)) $o['Error'] = $this->Error;
        if (isset($this->CreatedBy)) $o['CreatedBy'] = $this->CreatedBy;
        if (isset($this->StartedAt)) $o['StartedAt'] = JsonConverters::to('DateTime', $this->StartedAt);
        if (isset($this->CompletedAt)) $o['CompletedAt'] = JsonConverters::to('DateTime', $this->CompletedAt);
        return empty($o) ? new class(){} : $o;
    }
}

class BillingRunStatusResponse implements JsonSerializable
{
    public function __construct(
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null,
        /** @var BillingRun|null */
        public ?BillingRun $BillingRun=null
    ) {
    }

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

class BillingRunStatusRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $BillingRunID=0
    ) {
    }

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

PHP BillingRunStatusRequest 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/billing/run/{BillingRunID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BillingRunStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BillingRun>
    <BillingRunID>0</BillingRunID>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <BranchName>String</BranchName>
    <CompletedAt>0001-01-01T00:00:00</CompletedAt>
    <CreatedBy>String</CreatedBy>
    <CreditsApplied>0</CreditsApplied>
    <Error>String</Error>
    <InvoicesCreated>0</InvoicesCreated>
    <PeriodKey>String</PeriodKey>
    <RunType>String</RunType>
    <StartedAt>0001-01-01T00:00:00</StartedAt>
    <Status>String</Status>
    <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
  </BillingRun>
  <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>
</BillingRunStatusResponse>