digitaluapi

<back to all web services

PaymentPlanActionsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/payment_plan_actions/{Id}
import Foundation
import ServiceStack

// @DataContract
public class PaymentPlanActionsEdit : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var id:Int

    // @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 PaymentPlanActionsEditResponse : Codable
{
    // @DataMember(Order=1)
    public var id:Int

    // @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 PaymentPlanActionsEdit DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /payment_plan_actions/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	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: text/jsv
Content-Length: length

{
	Id: 0,
	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
		}
	}
}