Trendsic Platform Service

QboSyncOrdersRequest

The following routes are available for this service:
POST,OPTIONS	/v1/qbo/sync-orders

<?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 QboSyncResult implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $InvoiceUID='',
        /** @var string|null */
        public ?string $InvoiceNumber=null,
        /** @var bool|null */
        public ?bool $Success=null,
        /** @var string|null */
        public ?string $QboId=null,
        /** @var string|null */
        public ?string $Message=null
    ) {
    }

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

class QboSyncResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Synced=0,
        /** @var int */
        public int $Failed=0,
        /** @var array<QboSyncResult>|null */
        public ?array $Results=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class QboSyncOrdersRequest implements JsonSerializable
{
    public function __construct(
        /** @var array<int>|null */
        public ?array $OrderIds=null
    ) {
    }

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

PHP QboSyncOrdersRequest 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.

POST /v1/qbo/sync-orders HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QboSyncOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <OrderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </OrderIds>
</QboSyncOrdersRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QboSyncResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Failed>0</Failed>
  <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>
  <Results>
    <QboSyncResult>
      <InvoiceNumber>String</InvoiceNumber>
      <InvoiceUID>00000000-0000-0000-0000-000000000000</InvoiceUID>
      <Message>String</Message>
      <QboId>String</QboId>
      <Success>false</Success>
    </QboSyncResult>
  </Results>
  <Synced>0</Synced>
</QboSyncResponse>