digitaluapi

<back to all web services

PaymentPlanActionsAdd

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

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

        // @DataMember(Order=4)
        /** @var bool|null */
        public ?bool $FirstPaymentOnly=null,

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

        // @DataMember(Order=6)
        /** @var float|null */
        public ?float $PaymentValue=null,

        // @DataMember(Order=7)
        /** @var float|null */
        public ?float $PaymentFixedPercentage=null,

        // @DataMember(Order=8)
        /** @var float|null */
        public ?float $PaymentMinPercentage=null,

        // @DataMember(Order=9)
        /** @var float|null */
        public ?float $PaymentMaxPercentage=null,

        // @DataMember(Order=10)
        /** @var float|null */
        public ?float $DiscountAmount=null,

        // @DataMember(Order=11)
        /** @var float|null */
        public ?float $DiscountPercentage=null,

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ActionsId'])) $this->ActionsId = $o['ActionsId'];
        if (isset($o['FirstPaymentOnly'])) $this->FirstPaymentOnly = $o['FirstPaymentOnly'];
        if (isset($o['MaxMonths'])) $this->MaxMonths = $o['MaxMonths'];
        if (isset($o['PaymentValue'])) $this->PaymentValue = $o['PaymentValue'];
        if (isset($o['PaymentFixedPercentage'])) $this->PaymentFixedPercentage = $o['PaymentFixedPercentage'];
        if (isset($o['PaymentMinPercentage'])) $this->PaymentMinPercentage = $o['PaymentMinPercentage'];
        if (isset($o['PaymentMaxPercentage'])) $this->PaymentMaxPercentage = $o['PaymentMaxPercentage'];
        if (isset($o['DiscountAmount'])) $this->DiscountAmount = $o['DiscountAmount'];
        if (isset($o['DiscountPercentage'])) $this->DiscountPercentage = $o['DiscountPercentage'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ActionsId)) $o['ActionsId'] = $this->ActionsId;
        if (isset($this->FirstPaymentOnly)) $o['FirstPaymentOnly'] = $this->FirstPaymentOnly;
        if (isset($this->MaxMonths)) $o['MaxMonths'] = $this->MaxMonths;
        if (isset($this->PaymentValue)) $o['PaymentValue'] = $this->PaymentValue;
        if (isset($this->PaymentFixedPercentage)) $o['PaymentFixedPercentage'] = $this->PaymentFixedPercentage;
        if (isset($this->PaymentMinPercentage)) $o['PaymentMinPercentage'] = $this->PaymentMinPercentage;
        if (isset($this->PaymentMaxPercentage)) $o['PaymentMaxPercentage'] = $this->PaymentMaxPercentage;
        if (isset($this->DiscountAmount)) $o['DiscountAmount'] = $this->DiscountAmount;
        if (isset($this->DiscountPercentage)) $o['DiscountPercentage'] = $this->DiscountPercentage;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @DataContract
class PaymentPlanActionsAdd implements JsonSerializable
{
    public function __construct(
        // @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 bool|null */
        public ?bool $FirstPaymentOnly=null,

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

        // @DataMember(Order=6)
        /** @var float|null */
        public ?float $PaymentValue=null,

        // @DataMember(Order=7)
        /** @var float|null */
        public ?float $PaymentFixedPercentage=null,

        // @DataMember(Order=8)
        /** @var float|null */
        public ?float $PaymentMinPercentage=null,

        // @DataMember(Order=9)
        /** @var float|null */
        public ?float $PaymentMaxPercentage=null,

        // @DataMember(Order=10)
        /** @var float|null */
        public ?float $DiscountAmount=null,

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

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TenantsId'])) $this->TenantsId = $o['TenantsId'];
        if (isset($o['ActionsId'])) $this->ActionsId = $o['ActionsId'];
        if (isset($o['FirstPaymentOnly'])) $this->FirstPaymentOnly = $o['FirstPaymentOnly'];
        if (isset($o['MaxMonths'])) $this->MaxMonths = $o['MaxMonths'];
        if (isset($o['PaymentValue'])) $this->PaymentValue = $o['PaymentValue'];
        if (isset($o['PaymentFixedPercentage'])) $this->PaymentFixedPercentage = $o['PaymentFixedPercentage'];
        if (isset($o['PaymentMinPercentage'])) $this->PaymentMinPercentage = $o['PaymentMinPercentage'];
        if (isset($o['PaymentMaxPercentage'])) $this->PaymentMaxPercentage = $o['PaymentMaxPercentage'];
        if (isset($o['DiscountAmount'])) $this->DiscountAmount = $o['DiscountAmount'];
        if (isset($o['DiscountPercentage'])) $this->DiscountPercentage = $o['DiscountPercentage'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TenantsId)) $o['TenantsId'] = $this->TenantsId;
        if (isset($this->ActionsId)) $o['ActionsId'] = $this->ActionsId;
        if (isset($this->FirstPaymentOnly)) $o['FirstPaymentOnly'] = $this->FirstPaymentOnly;
        if (isset($this->MaxMonths)) $o['MaxMonths'] = $this->MaxMonths;
        if (isset($this->PaymentValue)) $o['PaymentValue'] = $this->PaymentValue;
        if (isset($this->PaymentFixedPercentage)) $o['PaymentFixedPercentage'] = $this->PaymentFixedPercentage;
        if (isset($this->PaymentMinPercentage)) $o['PaymentMinPercentage'] = $this->PaymentMinPercentage;
        if (isset($this->PaymentMaxPercentage)) $o['PaymentMaxPercentage'] = $this->PaymentMaxPercentage;
        if (isset($this->DiscountAmount)) $o['DiscountAmount'] = $this->DiscountAmount;
        if (isset($this->DiscountPercentage)) $o['DiscountPercentage'] = $this->DiscountPercentage;
        return empty($o) ? new class(){} : $o;
    }
}

PHP PaymentPlanActionsAdd DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment_plan_actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TenantsId":0,"ActionsId":0,"FirstPaymentOnly":false,"MaxMonths":0,"PaymentValue":0,"PaymentFixedPercentage":0,"PaymentMinPercentage":0,"PaymentMaxPercentage":0,"DiscountAmount":0,"DiscountPercentage":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TenantsId":0,"ActionsId":0,"FirstPaymentOnly":false,"MaxMonths":0,"PaymentValue":0,"PaymentFixedPercentage":0,"PaymentMinPercentage":0,"PaymentMaxPercentage":0,"DiscountAmount":0,"DiscountPercentage":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}