POST v1/PaymentPlan/UpdatePaymentPlanInfo

Insert or Update Payment Plan Info

Request Information

URI Parameters

None.

Body Parameters

Payment Plan data

PaymentPlanDTO
NameDescriptionTypeAdditional information
PolicyQuoteID

integer

None.

PlanTypeCode

string

None.

PlanType

string

None.

DayofMonthPaymentisDue

integer

None.

DepositAmount

decimal number

None.

DownPaymentPercentage

decimal number

None.

NumberofPayments

integer

None.

NumberofMonthsBetweenPayments

integer

None.

InstallmentFee

decimal number

None.

InstallmentPercentage

decimal number

None.

AmountCollectedByAgent

decimal number

None.

MethodofPaymentCode

string

None.

MethodofPayment

string

None.

PaymentCurrencyCode

string

None.

NextTermPaymentPlanTypeCode

string

None.

NextTermPaymentPlanType

string

None.

RequiredDepositAmount

decimal number

None.

ReturnPremiumMailedCode

string

None.

ReturnPremiumPayeeCode

string

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyQuoteID": 1,
  "PlanTypeCode": "sample string 2",
  "PlanType": "sample string 3",
  "DayofMonthPaymentisDue": 1,
  "DepositAmount": 1.0,
  "DownPaymentPercentage": 1.1,
  "NumberofPayments": 1,
  "NumberofMonthsBetweenPayments": 1,
  "InstallmentFee": 1.0,
  "InstallmentPercentage": 1.1,
  "AmountCollectedByAgent": 1.0,
  "MethodofPaymentCode": "sample string 4",
  "MethodofPayment": "sample string 5",
  "PaymentCurrencyCode": "sample string 6",
  "NextTermPaymentPlanTypeCode": "sample string 7",
  "NextTermPaymentPlanType": "sample string 8",
  "RequiredDepositAmount": 1.0,
  "ReturnPremiumMailedCode": "sample string 9",
  "ReturnPremiumPayeeCode": "sample string 10"
}

application/xml, text/xml

Sample:
<PaymentPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <AmountCollectedByAgent>1</AmountCollectedByAgent>
  <DayofMonthPaymentisDue>1</DayofMonthPaymentisDue>
  <DepositAmount>1</DepositAmount>
  <DownPaymentPercentage>1.1</DownPaymentPercentage>
  <InstallmentFee>1</InstallmentFee>
  <InstallmentPercentage>1.1</InstallmentPercentage>
  <MethodofPayment>sample string 5</MethodofPayment>
  <MethodofPaymentCode>sample string 4</MethodofPaymentCode>
  <NextTermPaymentPlanType>sample string 8</NextTermPaymentPlanType>
  <NextTermPaymentPlanTypeCode>sample string 7</NextTermPaymentPlanTypeCode>
  <NumberofMonthsBetweenPayments>1</NumberofMonthsBetweenPayments>
  <NumberofPayments>1</NumberofPayments>
  <PaymentCurrencyCode>sample string 6</PaymentCurrencyCode>
  <PlanType>sample string 3</PlanType>
  <PlanTypeCode>sample string 2</PlanTypeCode>
  <PolicyQuoteID>1</PolicyQuoteID>
  <RequiredDepositAmount>1</RequiredDepositAmount>
  <ReturnPremiumMailedCode>sample string 9</ReturnPremiumMailedCode>
  <ReturnPremiumPayeeCode>sample string 10</ReturnPremiumPayeeCode>
</PaymentPlanDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PaymentPlanDTO'.

Response Information

Resource Description

ActionResultDTOOfPaymentPlanDTO
NameDescriptionTypeAdditional information
Result

PaymentPlanDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "PolicyQuoteID": 1,
    "PlanTypeCode": "sample string 2",
    "PlanType": "sample string 3",
    "DayofMonthPaymentisDue": 1,
    "DepositAmount": 1.0,
    "DownPaymentPercentage": 1.1,
    "NumberofPayments": 1,
    "NumberofMonthsBetweenPayments": 1,
    "InstallmentFee": 1.0,
    "InstallmentPercentage": 1.1,
    "AmountCollectedByAgent": 1.0,
    "MethodofPaymentCode": "sample string 4",
    "MethodofPayment": "sample string 5",
    "PaymentCurrencyCode": "sample string 6",
    "NextTermPaymentPlanTypeCode": "sample string 7",
    "NextTermPaymentPlanType": "sample string 8",
    "RequiredDepositAmount": 1.0,
    "ReturnPremiumMailedCode": "sample string 9",
    "ReturnPremiumPayeeCode": "sample string 10"
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfPaymentPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
    <d2p1:AmountCollectedByAgent>1</d2p1:AmountCollectedByAgent>
    <d2p1:DayofMonthPaymentisDue>1</d2p1:DayofMonthPaymentisDue>
    <d2p1:DepositAmount>1</d2p1:DepositAmount>
    <d2p1:DownPaymentPercentage>1.1</d2p1:DownPaymentPercentage>
    <d2p1:InstallmentFee>1</d2p1:InstallmentFee>
    <d2p1:InstallmentPercentage>1.1</d2p1:InstallmentPercentage>
    <d2p1:MethodofPayment>sample string 5</d2p1:MethodofPayment>
    <d2p1:MethodofPaymentCode>sample string 4</d2p1:MethodofPaymentCode>
    <d2p1:NextTermPaymentPlanType>sample string 8</d2p1:NextTermPaymentPlanType>
    <d2p1:NextTermPaymentPlanTypeCode>sample string 7</d2p1:NextTermPaymentPlanTypeCode>
    <d2p1:NumberofMonthsBetweenPayments>1</d2p1:NumberofMonthsBetweenPayments>
    <d2p1:NumberofPayments>1</d2p1:NumberofPayments>
    <d2p1:PaymentCurrencyCode>sample string 6</d2p1:PaymentCurrencyCode>
    <d2p1:PlanType>sample string 3</d2p1:PlanType>
    <d2p1:PlanTypeCode>sample string 2</d2p1:PlanTypeCode>
    <d2p1:PolicyQuoteID>1</d2p1:PolicyQuoteID>
    <d2p1:RequiredDepositAmount>1</d2p1:RequiredDepositAmount>
    <d2p1:ReturnPremiumMailedCode>sample string 9</d2p1:ReturnPremiumMailedCode>
    <d2p1:ReturnPremiumPayeeCode>sample string 10</d2p1:ReturnPremiumPayeeCode>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfPaymentPlanDTO>