digitaluapi

<back to all web services

PaymentPlanDetailsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/payment_plan_details
<?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};


// @DataContract
class PaymentPlanDetailsLookup implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=2)
        /** @var int */
        public int $PaymentPlansId=0,

        // @DataMember(Order=3)
        /** @var DateTime */
        public DateTime $PlannedDate=new DateTime(),

        // @DataMember(Order=4)
        /** @var float */
        public float $PlannedAmount=0.0,

        // @DataMember(Order=5)
        /** @var int */
        public int $PlannedCurrenciesId=0,

        // @DataMember(Order=6)
        /** @var int */
        public int $PaymentsId=0,

        // @DataMember(Order=7)
        /** @var int */
        public int $StatusCodesId=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PaymentPlansId'])) $this->PaymentPlansId = $o['PaymentPlansId'];
        if (isset($o['PlannedDate'])) $this->PlannedDate = JsonConverters::from('DateTime', $o['PlannedDate']);
        if (isset($o['PlannedAmount'])) $this->PlannedAmount = $o['PlannedAmount'];
        if (isset($o['PlannedCurrenciesId'])) $this->PlannedCurrenciesId = $o['PlannedCurrenciesId'];
        if (isset($o['PaymentsId'])) $this->PaymentsId = $o['PaymentsId'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PaymentPlansId)) $o['PaymentPlansId'] = $this->PaymentPlansId;
        if (isset($this->PlannedDate)) $o['PlannedDate'] = JsonConverters::to('DateTime', $this->PlannedDate);
        if (isset($this->PlannedAmount)) $o['PlannedAmount'] = $this->PlannedAmount;
        if (isset($this->PlannedCurrenciesId)) $o['PlannedCurrenciesId'] = $this->PlannedCurrenciesId;
        if (isset($this->PaymentsId)) $o['PaymentsId'] = $this->PaymentsId;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PaymentPlanDetailsLookup 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 /payment_plan_details HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfPaymentPlanDetailsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <PaymentPlanDetailsLookupResponse>
    <PaymentPlansId>0</PaymentPlansId>
    <PaymentsId>0</PaymentsId>
    <PlannedAmount>0</PlannedAmount>
    <PlannedCurrenciesId>0</PlannedCurrenciesId>
    <PlannedDate>0001-01-01T00:00:00</PlannedDate>
    <ResponseStatus xmlns:d3p1="http://schemas.servicestack.net/types">
      <d3p1:ErrorCode>String</d3p1:ErrorCode>
      <d3p1:Message>String</d3p1:Message>
      <d3p1:StackTrace>String</d3p1:StackTrace>
      <d3p1:Errors>
        <d3p1:ResponseError>
          <d3p1:ErrorCode>String</d3p1:ErrorCode>
          <d3p1:FieldName>String</d3p1:FieldName>
          <d3p1:Message>String</d3p1:Message>
          <d3p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d3p1:Meta>
        </d3p1:ResponseError>
      </d3p1:Errors>
      <d3p1: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>
      </d3p1:Meta>
    </ResponseStatus>
    <StatusCodesId>0</StatusCodesId>
  </PaymentPlanDetailsLookupResponse>
</ArrayOfPaymentPlanDetailsLookupResponse>