digitaluapi

<back to all web services

PaymentsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/payments/{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 PaymentsEditResponse implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        /** @var int */
        public int $ActionsId=0,

        // @DataMember(Order=4)
        /** @var int */
        public int $DebtsId=0,

        // @DataMember(Order=5)
        /** @var DateTime */
        public DateTime $PaymentDate=new DateTime(),

        // @DataMember(Order=6)
        /** @var float */
        public float $PaidAmount=0.0,

        // @DataMember(Order=7)
        /** @var float */
        public float $DiscountAmount=0.0,

        // @DataMember(Order=8)
        /** @var int */
        public int $CurrenciesId=0,

        // @DataMember(Order=9)
        /** @var int */
        public int $CurrencyRatesId=0,

        // @DataMember(Order=11)
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ActionsId'])) $this->ActionsId = $o['ActionsId'];
        if (isset($o['DebtsId'])) $this->DebtsId = $o['DebtsId'];
        if (isset($o['PaymentDate'])) $this->PaymentDate = JsonConverters::from('DateTime', $o['PaymentDate']);
        if (isset($o['PaidAmount'])) $this->PaidAmount = $o['PaidAmount'];
        if (isset($o['DiscountAmount'])) $this->DiscountAmount = $o['DiscountAmount'];
        if (isset($o['CurrenciesId'])) $this->CurrenciesId = $o['CurrenciesId'];
        if (isset($o['CurrencyRatesId'])) $this->CurrencyRatesId = $o['CurrencyRatesId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ActionsId)) $o['ActionsId'] = $this->ActionsId;
        if (isset($this->DebtsId)) $o['DebtsId'] = $this->DebtsId;
        if (isset($this->PaymentDate)) $o['PaymentDate'] = JsonConverters::to('DateTime', $this->PaymentDate);
        if (isset($this->PaidAmount)) $o['PaidAmount'] = $this->PaidAmount;
        if (isset($this->DiscountAmount)) $o['DiscountAmount'] = $this->DiscountAmount;
        if (isset($this->CurrenciesId)) $o['CurrenciesId'] = $this->CurrenciesId;
        if (isset($this->CurrencyRatesId)) $o['CurrencyRatesId'] = $this->CurrencyRatesId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class PaymentsEdit implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $TenantsId=0,

        // @DataMember(Order=3)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $ActionsId=0,

        // @DataMember(Order=4)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $DebtsId=0,

        // @DataMember(Order=5)
        // @Validate(Validator="NotNull")
        /** @var DateTime */
        public DateTime $PaymentDate=new DateTime(),

        // @DataMember(Order=6)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $PaidAmount=0.0,

        // @DataMember(Order=7)
        // @Validate(Validator="NotNull")
        /** @var float */
        public float $DiscountAmount=0.0,

        // @DataMember(Order=8)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CurrenciesId=0,

        // @DataMember(Order=9)
        // @Validate(Validator="NotNull")
        /** @var int */
        public int $CurrencyRatesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ActionsId'])) $this->ActionsId = $o['ActionsId'];
        if (isset($o['DebtsId'])) $this->DebtsId = $o['DebtsId'];
        if (isset($o['PaymentDate'])) $this->PaymentDate = JsonConverters::from('DateTime', $o['PaymentDate']);
        if (isset($o['PaidAmount'])) $this->PaidAmount = $o['PaidAmount'];
        if (isset($o['DiscountAmount'])) $this->DiscountAmount = $o['DiscountAmount'];
        if (isset($o['CurrenciesId'])) $this->CurrenciesId = $o['CurrenciesId'];
        if (isset($o['CurrencyRatesId'])) $this->CurrencyRatesId = $o['CurrencyRatesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ActionsId)) $o['ActionsId'] = $this->ActionsId;
        if (isset($this->DebtsId)) $o['DebtsId'] = $this->DebtsId;
        if (isset($this->PaymentDate)) $o['PaymentDate'] = JsonConverters::to('DateTime', $this->PaymentDate);
        if (isset($this->PaidAmount)) $o['PaidAmount'] = $this->PaidAmount;
        if (isset($this->DiscountAmount)) $o['DiscountAmount'] = $this->DiscountAmount;
        if (isset($this->CurrenciesId)) $o['CurrenciesId'] = $this->CurrenciesId;
        if (isset($this->CurrencyRatesId)) $o['CurrencyRatesId'] = $this->CurrencyRatesId;
        return empty($o) ? new class(){} : $o;
    }
}

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

PUT /payments/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <ActionsId>0</ActionsId>
  <DebtsId>0</DebtsId>
  <PaymentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PaymentDate>
  <PaidAmount>0</PaidAmount>
  <DiscountAmount>0</DiscountAmount>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
</PaymentsEdit>

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

<PaymentsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ActionsId>0</ActionsId>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
  <DebtsId>0</DebtsId>
  <DiscountAmount>0</DiscountAmount>
  <Id>0</Id>
  <PaidAmount>0</PaidAmount>
  <PaymentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </PaymentDate>
  <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>
  <TenantsId>0</TenantsId>
</PaymentsEditResponse>