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 Foundation
import ServiceStack

// @DataContract
public class PaymentPlanActionsAdd : Codable
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public var tenantsId:Int

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public var actionsId:Int

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public var firstPaymentOnly:Bool

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public var maxMonths:Int

    // @DataMember(Order=6)
    public var paymentValue:Double?

    // @DataMember(Order=7)
    public var paymentFixedPercentage:Double?

    // @DataMember(Order=8)
    public var paymentMinPercentage:Double?

    // @DataMember(Order=9)
    public var paymentMaxPercentage:Double?

    // @DataMember(Order=10)
    public var discountAmount:Double?

    // @DataMember(Order=11)
    public var discountPercentage:Double?

    required public init(){}
}

public class PaymentPlanActionsAddResponse : Codable
{
    // @DataMember(Order=2)
    public var tenantsId:Int

    // @DataMember(Order=3)
    public var actionsId:Int

    // @DataMember(Order=4)
    public var firstPaymentOnly:Bool

    // @DataMember(Order=5)
    public var maxMonths:Int

    // @DataMember(Order=6)
    public var paymentValue:Double?

    // @DataMember(Order=7)
    public var paymentFixedPercentage:Double?

    // @DataMember(Order=8)
    public var paymentMinPercentage:Double?

    // @DataMember(Order=9)
    public var paymentMaxPercentage:Double?

    // @DataMember(Order=10)
    public var discountAmount:Double?

    // @DataMember(Order=11)
    public var discountPercentage:Double?

    // @DataMember(Order=13)
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift PaymentPlanActionsAdd 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_actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentPlanActionsAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <TenantsId>0</TenantsId>
  <ActionsId>0</ActionsId>
  <FirstPaymentOnly>false</FirstPaymentOnly>
  <MaxMonths>0</MaxMonths>
  <PaymentValue>0</PaymentValue>
  <PaymentFixedPercentage>0</PaymentFixedPercentage>
  <PaymentMinPercentage>0</PaymentMinPercentage>
  <PaymentMaxPercentage>0</PaymentMaxPercentage>
  <DiscountAmount>0</DiscountAmount>
  <DiscountPercentage>0</DiscountPercentage>
</PaymentPlanActionsAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentPlanActionsAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ActionsId>0</ActionsId>
  <DiscountAmount>0</DiscountAmount>
  <DiscountPercentage>0</DiscountPercentage>
  <FirstPaymentOnly>false</FirstPaymentOnly>
  <MaxMonths>0</MaxMonths>
  <PaymentFixedPercentage>0</PaymentFixedPercentage>
  <PaymentMaxPercentage>0</PaymentMaxPercentage>
  <PaymentMinPercentage>0</PaymentMinPercentage>
  <PaymentValue>0</PaymentValue>
  <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>
  <TenantsId>0</TenantsId>
</PaymentPlanActionsAddResponse>