digitaluapi

<back to all web services

PaymentPlanDetailsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/payment_plan_details
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 PaymentPlanDetailsAddResponse:
    payment_plans_id: int = 0
    planned_date: datetime.datetime = datetime.datetime(1, 1, 1)
    planned_amount: float = 0.0
    planned_currencies_id: int = 0
    payments_id: int = 0
    status_codes_id: int = 0
    response_status: Optional[ResponseStatus] = None


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

    # @Validate(Validator="NotNull")
    planned_date: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Validate(Validator="NotNull")
    planned_amount: float = 0.0

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

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

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

Python PaymentPlanDetailsAdd 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_details HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"PaymentPlansId":0,"PlannedDate":"0001-01-01T00:00:00.0000000","PlannedAmount":0,"PlannedCurrenciesId":0,"PaymentsId":0,"StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PaymentPlansId":0,"PlannedDate":"0001-01-01T00:00:00.0000000","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"}}}