Trendsic Platform Service

<back to all web services

QboPendingRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/qbo/pending
<?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 QboPendingInvoice implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $InvoiceID=0,
        /** @var string */
        public string $InvoiceUID='',
        /** @var string|null */
        public ?string $InvoiceNumber=null,
        /** @var DateTime|null */
        public ?DateTime $InvoiceDate=null,
        /** @var float|null */
        public ?float $Total=null,
        /** @var string|null */
        public ?string $CustomerName=null,
        /** @var bool|null */
        public ?bool $IsPaid=null,
        /** @var string|null */
        public ?string $SyncStatus=null,
        /** @var string|null */
        public ?string $ExternalRef=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['InvoiceID'])) $this->InvoiceID = $o['InvoiceID'];
        if (isset($o['InvoiceUID'])) $this->InvoiceUID = $o['InvoiceUID'];
        if (isset($o['InvoiceNumber'])) $this->InvoiceNumber = $o['InvoiceNumber'];
        if (isset($o['InvoiceDate'])) $this->InvoiceDate = JsonConverters::from('DateTime', $o['InvoiceDate']);
        if (isset($o['Total'])) $this->Total = $o['Total'];
        if (isset($o['CustomerName'])) $this->CustomerName = $o['CustomerName'];
        if (isset($o['IsPaid'])) $this->IsPaid = $o['IsPaid'];
        if (isset($o['SyncStatus'])) $this->SyncStatus = $o['SyncStatus'];
        if (isset($o['ExternalRef'])) $this->ExternalRef = $o['ExternalRef'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->InvoiceID)) $o['InvoiceID'] = $this->InvoiceID;
        if (isset($this->InvoiceUID)) $o['InvoiceUID'] = $this->InvoiceUID;
        if (isset($this->InvoiceNumber)) $o['InvoiceNumber'] = $this->InvoiceNumber;
        if (isset($this->InvoiceDate)) $o['InvoiceDate'] = JsonConverters::to('DateTime', $this->InvoiceDate);
        if (isset($this->Total)) $o['Total'] = $this->Total;
        if (isset($this->CustomerName)) $o['CustomerName'] = $this->CustomerName;
        if (isset($this->IsPaid)) $o['IsPaid'] = $this->IsPaid;
        if (isset($this->SyncStatus)) $o['SyncStatus'] = $this->SyncStatus;
        if (isset($this->ExternalRef)) $o['ExternalRef'] = $this->ExternalRef;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

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

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

<QboPendingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Invoices>
    <QboPendingInvoice>
      <CustomerName>String</CustomerName>
      <ExternalRef>String</ExternalRef>
      <InvoiceDate>0001-01-01T00:00:00</InvoiceDate>
      <InvoiceID>0</InvoiceID>
      <InvoiceNumber>String</InvoiceNumber>
      <InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
      <IsPaid>false</IsPaid>
      <SyncStatus>String</SyncStatus>
      <Total>0</Total>
    </QboPendingInvoice>
  </Invoices>
  <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>
</QboPendingResponse>