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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		PaymentPlansId: 0,
		PlannedDate: 0001-01-01,
		PlannedAmount: 0,
		PlannedCurrenciesId: 0,
		PaymentsId: 0,
		StatusCodesId: 0,
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		}
	}
]