digitaluapi

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 .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.

POST /payment_plan_details HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentPlanDetailsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <PaymentPlansId>0</PaymentPlansId>
  <PlannedDate>0001-01-01T00:00:00</PlannedDate>
  <PlannedAmount>0</PlannedAmount>
  <PlannedCurrenciesId>0</PlannedCurrenciesId>
  <PaymentsId>0</PaymentsId>
  <StatusCodesId>0</StatusCodesId>
</PaymentPlanDetailsAdd>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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