| GET,OPTIONS | /v1/billing/runs |
|---|
<?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 BillingRunsResponse implements JsonSerializable
{
public function __construct(
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null,
/** @var array<BillingRun>|null */
public ?array $Runs=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
if (isset($o['Runs'])) $this->Runs = JsonConverters::fromArray('BillingRun', $o['Runs']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
if (isset($this->Runs)) $o['Runs'] = JsonConverters::toArray('BillingRun', $this->Runs);
return empty($o) ? new class(){} : $o;
}
}
class BillingRunsRequest implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Top=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Top'])) $this->Top = $o['Top'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Top)) $o['Top'] = $this->Top;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/billing/runs HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Runs":[{"BillingRunID":0,"TenantId":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000","BranchName":"String","RunType":"String","PeriodKey":"String","Status":"String","InvoicesCreated":0,"CreditsApplied":0,"Error":"String","CreatedBy":"String","StartedAt":"0001-01-01T00:00:00.0000000","CompletedAt":"0001-01-01T00:00:00.0000000"}]}