| GET | /api/InvoiceDetail |
|---|
<?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};
// @DataContract
class BaseRequest implements JsonSerializable
{
public function __construct(
/** @description This is your AIM API Key provided by Tri-Tech */
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
/** @var string */
public string $ApiKey='',
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
/** @var string|null */
public ?string $OAuthToken=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['ApiKey'])) $this->ApiKey = $o['ApiKey'];
if (isset($o['OAuthToken'])) $this->OAuthToken = $o['OAuthToken'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->ApiKey)) $o['ApiKey'] = $this->ApiKey;
if (isset($this->OAuthToken)) $o['OAuthToken'] = $this->OAuthToken;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseSecureRequest extends BaseRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
/** @var string|null */
public ?string $Token=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
/** @var string|null */
public ?string $DeviceId=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
/** @var string */
public string $AppId=''
) {
parent::__construct($ApiKey,$OAuthToken);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Token'])) $this->Token = $o['Token'];
if (isset($o['DeviceId'])) $this->DeviceId = $o['DeviceId'];
if (isset($o['AppId'])) $this->AppId = $o['AppId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Token)) $o['Token'] = $this->Token;
if (isset($this->DeviceId)) $o['DeviceId'] = $this->DeviceId;
if (isset($this->AppId)) $o['AppId'] = $this->AppId;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponseResult implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
/** @var string|null */
public ?string $StatusCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
/** @var string|null */
public ?string $Login=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
/** @var string|null */
public ?string $ErrorCode=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
/** @var string|null */
public ?string $ErrorDisplayText=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
/** @var string|null */
public ?string $ErrorMessage=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
/** @var string|null */
public ?string $DomainName=null,
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
/** @var string|null */
public ?string $IpAddress=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['Login'])) $this->Login = $o['Login'];
if (isset($o['ErrorCode'])) $this->ErrorCode = $o['ErrorCode'];
if (isset($o['ErrorDisplayText'])) $this->ErrorDisplayText = $o['ErrorDisplayText'];
if (isset($o['ErrorMessage'])) $this->ErrorMessage = $o['ErrorMessage'];
if (isset($o['DomainName'])) $this->DomainName = $o['DomainName'];
if (isset($o['IpAddress'])) $this->IpAddress = $o['IpAddress'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->Login)) $o['Login'] = $this->Login;
if (isset($this->ErrorCode)) $o['ErrorCode'] = $this->ErrorCode;
if (isset($this->ErrorDisplayText)) $o['ErrorDisplayText'] = $this->ErrorDisplayText;
if (isset($this->ErrorMessage)) $o['ErrorMessage'] = $this->ErrorMessage;
if (isset($this->DomainName)) $o['DomainName'] = $this->DomainName;
if (isset($this->IpAddress)) $o['IpAddress'] = $this->IpAddress;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class BaseResponse implements JsonSerializable
{
public function __construct(
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
/** @var BaseResponseResult|null */
public ?BaseResponseResult $Status=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Status'])) $this->Status = JsonConverters::from('BaseResponseResult', $o['Status']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Status)) $o['Status'] = JsonConverters::to('BaseResponseResult', $this->Status);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class InvoiceLineItem implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var float */
public float $Quantity=0.0,
// @DataMember
/** @var string|null */
public ?string $Sku=null,
// @DataMember
/** @var string|null */
public ?string $Description=null,
// @DataMember
/** @var float */
public float $PriceEach=0.0,
// @DataMember
/** @var float */
public float $Extended=0.0,
// @DataMember
/** @var float */
public float $Discount=0.0,
// @DataMember
/** @var float */
public float $Total=0.0,
// @DataMember
/** @var string|null */
public ?string $OriginalRef=null,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var string|null */
public ?string $Source=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Quantity'])) $this->Quantity = $o['Quantity'];
if (isset($o['Sku'])) $this->Sku = $o['Sku'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['PriceEach'])) $this->PriceEach = $o['PriceEach'];
if (isset($o['Extended'])) $this->Extended = $o['Extended'];
if (isset($o['Discount'])) $this->Discount = $o['Discount'];
if (isset($o['Total'])) $this->Total = $o['Total'];
if (isset($o['OriginalRef'])) $this->OriginalRef = $o['OriginalRef'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['Source'])) $this->Source = $o['Source'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Quantity)) $o['Quantity'] = $this->Quantity;
if (isset($this->Sku)) $o['Sku'] = $this->Sku;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->PriceEach)) $o['PriceEach'] = $this->PriceEach;
if (isset($this->Extended)) $o['Extended'] = $this->Extended;
if (isset($this->Discount)) $o['Discount'] = $this->Discount;
if (isset($this->Total)) $o['Total'] = $this->Total;
if (isset($this->OriginalRef)) $o['OriginalRef'] = $this->OriginalRef;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->Source)) $o['Source'] = $this->Source;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class InvoicePaymentItem implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $PayRef=null,
// @DataMember
/** @var DateTime */
public DateTime $DateTime=new DateTime(),
// @DataMember
/** @var float */
public float $Amount=0.0,
// @DataMember
/** @var string|null */
public ?string $Notes=null,
// @DataMember
/** @var string|null */
public ?string $Source=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PayRef'])) $this->PayRef = $o['PayRef'];
if (isset($o['DateTime'])) $this->DateTime = JsonConverters::from('DateTime', $o['DateTime']);
if (isset($o['Amount'])) $this->Amount = $o['Amount'];
if (isset($o['Notes'])) $this->Notes = $o['Notes'];
if (isset($o['Source'])) $this->Source = $o['Source'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PayRef)) $o['PayRef'] = $this->PayRef;
if (isset($this->DateTime)) $o['DateTime'] = JsonConverters::to('DateTime', $this->DateTime);
if (isset($this->Amount)) $o['Amount'] = $this->Amount;
if (isset($this->Notes)) $o['Notes'] = $this->Notes;
if (isset($this->Source)) $o['Source'] = $this->Source;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class InvoiceInfo implements JsonSerializable
{
public function __construct(
// @DataMember
/** @var string|null */
public ?string $InvoiceNumber=null,
// @DataMember
/** @var DateTime */
public DateTime $DateTime=new DateTime(),
// @DataMember
/** @var int */
public int $SoldToAcct=0,
// @DataMember
/** @var string|null */
public ?string $SoldToName=null,
// @DataMember
/** @var int */
public int $BillToAcct=0,
// @DataMember
/** @var string|null */
public ?string $BillToName=null,
// @DataMember
/** @var string|null */
public ?string $Type=null,
// @DataMember
/** @var string|null */
public ?string $PO=null,
// @DataMember
/** @var float */
public float $OriginalAmount=0.0,
// @DataMember
/** @var float */
public float $Balance=0.0,
// @DataMember
/** @var string|null */
public ?string $Location=null,
// @DataMember
/** @var string|null */
public ?string $ShipToName=null,
// @DataMember
/** @var string|null */
public ?string $ShipToAddress=null,
// @DataMember
/** @var int|null */
public ?int $ShipToId=null,
// @DataMember
/** @var array<InvoiceLineItem>|null */
public ?array $LineItems=null,
// @DataMember
/** @var array<InvoicePaymentItem>|null */
public ?array $Payments=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['InvoiceNumber'])) $this->InvoiceNumber = $o['InvoiceNumber'];
if (isset($o['DateTime'])) $this->DateTime = JsonConverters::from('DateTime', $o['DateTime']);
if (isset($o['SoldToAcct'])) $this->SoldToAcct = $o['SoldToAcct'];
if (isset($o['SoldToName'])) $this->SoldToName = $o['SoldToName'];
if (isset($o['BillToAcct'])) $this->BillToAcct = $o['BillToAcct'];
if (isset($o['BillToName'])) $this->BillToName = $o['BillToName'];
if (isset($o['Type'])) $this->Type = $o['Type'];
if (isset($o['PO'])) $this->PO = $o['PO'];
if (isset($o['OriginalAmount'])) $this->OriginalAmount = $o['OriginalAmount'];
if (isset($o['Balance'])) $this->Balance = $o['Balance'];
if (isset($o['Location'])) $this->Location = $o['Location'];
if (isset($o['ShipToName'])) $this->ShipToName = $o['ShipToName'];
if (isset($o['ShipToAddress'])) $this->ShipToAddress = $o['ShipToAddress'];
if (isset($o['ShipToId'])) $this->ShipToId = $o['ShipToId'];
if (isset($o['LineItems'])) $this->LineItems = JsonConverters::fromArray('InvoiceLineItem', $o['LineItems']);
if (isset($o['Payments'])) $this->Payments = JsonConverters::fromArray('InvoicePaymentItem', $o['Payments']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->InvoiceNumber)) $o['InvoiceNumber'] = $this->InvoiceNumber;
if (isset($this->DateTime)) $o['DateTime'] = JsonConverters::to('DateTime', $this->DateTime);
if (isset($this->SoldToAcct)) $o['SoldToAcct'] = $this->SoldToAcct;
if (isset($this->SoldToName)) $o['SoldToName'] = $this->SoldToName;
if (isset($this->BillToAcct)) $o['BillToAcct'] = $this->BillToAcct;
if (isset($this->BillToName)) $o['BillToName'] = $this->BillToName;
if (isset($this->Type)) $o['Type'] = $this->Type;
if (isset($this->PO)) $o['PO'] = $this->PO;
if (isset($this->OriginalAmount)) $o['OriginalAmount'] = $this->OriginalAmount;
if (isset($this->Balance)) $o['Balance'] = $this->Balance;
if (isset($this->Location)) $o['Location'] = $this->Location;
if (isset($this->ShipToName)) $o['ShipToName'] = $this->ShipToName;
if (isset($this->ShipToAddress)) $o['ShipToAddress'] = $this->ShipToAddress;
if (isset($this->ShipToId)) $o['ShipToId'] = $this->ShipToId;
if (isset($this->LineItems)) $o['LineItems'] = JsonConverters::toArray('InvoiceLineItem', $this->LineItems);
if (isset($this->Payments)) $o['Payments'] = JsonConverters::toArray('InvoicePaymentItem', $this->Payments);
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
class InvoiceDetailResponse extends BaseResponse implements JsonSerializable
{
/**
* @param BaseResponseResult|null $Status
*/
public function __construct(
?BaseResponseResult $Status=null,
// @DataMember
/** @var array<InvoiceInfo>|null */
public ?array $Invoices=null,
// @DataMember
/** @var int */
public int $RemainingRecords=0
) {
parent::__construct($Status);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Invoices'])) $this->Invoices = JsonConverters::fromArray('InvoiceInfo', $o['Invoices']);
if (isset($o['RemainingRecords'])) $this->RemainingRecords = $o['RemainingRecords'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Invoices)) $o['Invoices'] = JsonConverters::toArray('InvoiceInfo', $this->Invoices);
if (isset($this->RemainingRecords)) $o['RemainingRecords'] = $this->RemainingRecords;
return empty($o) ? new class(){} : $o;
}
}
/** @description InvoiceDetailRequires active-e Customer Service. */
// @DataContract
class InvoiceDetailRequest extends BaseSecureRequest implements JsonSerializable
{
/**
* @param string $ApiKey
* @param string|null $OAuthToken
* @param string|null $Token
* @param string|null $DeviceId
* @param string $AppId
*/
public function __construct(
string $ApiKey='',
?string $OAuthToken=null,
?string $Token=null,
?string $DeviceId=null,
string $AppId='',
// @DataMember
/** @var int|null */
public ?int $Acct=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $InvoiceStartDate=null,
// @DataMember
/** @var DateTime|null */
public ?DateTime $InvoiceEndDate=null,
/** @description The Starting Offset. Defaults to 0 if not sent. */
// @DataMember
// @ApiMember(DataType="integer", Description="The Starting Offset. Defaults to 0 if not sent.", Format="int64", Name="StartOffset")
/** @var int|null */
public ?int $StartOffset=null,
/** @description The # of records to be returned. Defaults to 100 if not sent. */
// @DataMember
// @ApiMember(DataType="integer", Description="The # of records to be returned. Defaults to 100 if not sent.", Format="int64", Name="RecordCount")
/** @var int|null */
public ?int $RecordCount=null,
/** @description The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount */
// @DataMember
// @ApiMember(DataType="string", Description="The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount", Name="AIMRef")
/** @var string|null */
public ?string $AIMRef=null,
/** @description The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount */
// @DataMember
// @ApiMember(DataType="string", Description="The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount", Name="WebRef")
/** @var string|null */
public ?string $WebRef=null
) {
parent::__construct($ApiKey,$OAuthToken,$Token,$DeviceId,$AppId);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['Acct'])) $this->Acct = $o['Acct'];
if (isset($o['InvoiceStartDate'])) $this->InvoiceStartDate = JsonConverters::from('DateTime', $o['InvoiceStartDate']);
if (isset($o['InvoiceEndDate'])) $this->InvoiceEndDate = JsonConverters::from('DateTime', $o['InvoiceEndDate']);
if (isset($o['StartOffset'])) $this->StartOffset = $o['StartOffset'];
if (isset($o['RecordCount'])) $this->RecordCount = $o['RecordCount'];
if (isset($o['AIMRef'])) $this->AIMRef = $o['AIMRef'];
if (isset($o['WebRef'])) $this->WebRef = $o['WebRef'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->Acct)) $o['Acct'] = $this->Acct;
if (isset($this->InvoiceStartDate)) $o['InvoiceStartDate'] = JsonConverters::to('DateTime', $this->InvoiceStartDate);
if (isset($this->InvoiceEndDate)) $o['InvoiceEndDate'] = JsonConverters::to('DateTime', $this->InvoiceEndDate);
if (isset($this->StartOffset)) $o['StartOffset'] = $this->StartOffset;
if (isset($this->RecordCount)) $o['RecordCount'] = $this->RecordCount;
if (isset($this->AIMRef)) $o['AIMRef'] = $this->AIMRef;
if (isset($this->WebRef)) $o['WebRef'] = $this->WebRef;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/InvoiceDetail HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Invoices":[{"InvoiceNumber":"String","SoldToAcct":0,"SoldToName":"String","BillToAcct":0,"BillToName":"String","Type":"String","PO":"String","OriginalAmount":0,"Balance":0,"Location":"String","ShipToName":"String","ShipToAddress":"String","ShipToId":0,"LineItems":[{"Quantity":0,"Sku":"String","Description":"String","PriceEach":0,"Extended":0,"Discount":0,"Total":0,"OriginalRef":"String","Notes":"String","Source":"String"}],"Payments":[{"PayRef":"String","Amount":0,"Notes":"String","Source":"String"}]}],"RemainingRecords":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}