regis

FinanceCreateSaleRequest

**Requires Authentication**
Required permission:	CreatePayments

The following routes are available for this service:
POST	/Dynamics/CreateSale/{regent_id}

<?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 FinanceCreateSaleItemsRequest implements JsonSerializable
{
    public function __construct(
        /** @var float */
        public float $amount=0.0,
        /** @var string|null */
        public ?string $code=null
    ) {
    }

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

class FinanceCreateSaleRequest implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $regent_id=0,
        /** @var float */
        public float $amount=0.0,
        /** @var string|null */
        public ?string $code=null,
        /** @var string|null */
        public ?string $rebate_code=null,
        /** @var float|null */
        public ?float $rebate_amount=null,
        /** @var string|null */
        public ?string $payment_id=null,
        /** @var string|null */
        public ?string $reporting_term=null,
        /** @var array<FinanceCreateSaleItemsRequest>|null */
        public ?array $sale_items=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['regent_id'])) $this->regent_id = $o['regent_id'];
        if (isset($o['amount'])) $this->amount = $o['amount'];
        if (isset($o['code'])) $this->code = $o['code'];
        if (isset($o['rebate_code'])) $this->rebate_code = $o['rebate_code'];
        if (isset($o['rebate_amount'])) $this->rebate_amount = $o['rebate_amount'];
        if (isset($o['payment_id'])) $this->payment_id = $o['payment_id'];
        if (isset($o['reporting_term'])) $this->reporting_term = $o['reporting_term'];
        if (isset($o['sale_items'])) $this->sale_items = JsonConverters::fromArray('FinanceCreateSaleItemsRequest', $o['sale_items']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->regent_id)) $o['regent_id'] = $this->regent_id;
        if (isset($this->amount)) $o['amount'] = $this->amount;
        if (isset($this->code)) $o['code'] = $this->code;
        if (isset($this->rebate_code)) $o['rebate_code'] = $this->rebate_code;
        if (isset($this->rebate_amount)) $o['rebate_amount'] = $this->rebate_amount;
        if (isset($this->payment_id)) $o['payment_id'] = $this->payment_id;
        if (isset($this->reporting_term)) $o['reporting_term'] = $this->reporting_term;
        if (isset($this->sale_items)) $o['sale_items'] = JsonConverters::toArray('FinanceCreateSaleItemsRequest', $this->sale_items);
        return empty($o) ? new class(){} : $o;
    }
}

PHP FinanceCreateSaleRequest 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 /Dynamics/CreateSale/{regent_id} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceCreateSaleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <amount>0</amount>
  <code>String</code>
  <payment_id>String</payment_id>
  <rebate_amount>0</rebate_amount>
  <rebate_code>String</rebate_code>
  <regent_id>0</regent_id>
  <reporting_term>String</reporting_term>
  <sale_items>
    <FinanceCreateSaleItemsRequest>
      <amount>0</amount>
      <code>String</code>
    </FinanceCreateSaleItemsRequest>
  </sale_items>
</FinanceCreateSaleRequest>

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

<ResponseStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <ErrorCode>String</ErrorCode>
  <Message>String</Message>
  <StackTrace>String</StackTrace>
  <Errors>
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
      <Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Meta>
    </ResponseError>
  </Errors>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</ResponseStatus>