Trendsic Platform Service

PayrollBatchRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/PayrollBatch

<?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 CommissionBatch implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $CommissionBatchId=0,
        /** @var DateTime */
        public DateTime $DateCreated=new DateTime(),
        /** @var string|null */
        public ?string $CreatedBy=null,
        /** @var string|null */
        public ?string $CommissionTitle=null,
        /** @var DateTime */
        public DateTime $CommissionStartDate=new DateTime(),
        /** @var DateTime */
        public DateTime $CommissionEndDate=new DateTime()
    ) {
    }

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

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

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

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

PHP PayrollBatchRequest 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/PayrollBatch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<PayrollBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Payroll>
    <CommissionBatch>
      <CommissionBatchId>0</CommissionBatchId>
      <CommissionEndDate>0001-01-01T00:00:00</CommissionEndDate>
      <CommissionStartDate>0001-01-01T00:00:00</CommissionStartDate>
      <CommissionTitle>String</CommissionTitle>
      <CreatedBy>String</CreatedBy>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
    </CommissionBatch>
  </Payroll>
  <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>
</PayrollBatchResponse>