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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentPlanActionsAddResponse:
    tenants_id: int = 0
    actions_id: int = 0
    first_payment_only: bool = False
    max_months: int = 0
    payment_value: Optional[float] = None
    payment_fixed_percentage: Optional[float] = None
    payment_min_percentage: Optional[float] = None
    payment_max_percentage: Optional[float] = None
    discount_amount: Optional[float] = None
    discount_percentage: Optional[float] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaymentPlanActionsAdd:
    # @Validate(Validator="NotNull")
    tenants_id: int = 0

    # @Validate(Validator="NotNull")
    actions_id: int = 0

    # @Validate(Validator="NotNull")
    first_payment_only: bool = False

    # @Validate(Validator="NotNull")
    max_months: int = 0

    payment_value: Optional[float] = None
    payment_fixed_percentage: Optional[float] = None
    payment_min_percentage: Optional[float] = None
    payment_max_percentage: Optional[float] = None
    discount_amount: Optional[float] = None
    discount_percentage: Optional[float] = None

Python PaymentPlanActionsAdd DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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"}}}