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}
"use strict";
export class PaymentPlanActionsEditResponse {
    /** @param {{Id?:number,TenantsId?:number,ActionsId?:number,FirstPaymentOnly?:boolean,MaxMonths?:number,PaymentValue?:number,PaymentFixedPercentage?:number,PaymentMinPercentage?:number,PaymentMaxPercentage?:number,DiscountAmount?:number,DiscountPercentage?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ActionsId;
    /** @type {boolean} */
    FirstPaymentOnly;
    /** @type {number} */
    MaxMonths;
    /** @type {?number} */
    PaymentValue;
    /** @type {?number} */
    PaymentFixedPercentage;
    /** @type {?number} */
    PaymentMinPercentage;
    /** @type {?number} */
    PaymentMaxPercentage;
    /** @type {?number} */
    DiscountAmount;
    /** @type {?number} */
    DiscountPercentage;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class PaymentPlanActionsEdit {
    /** @param {{Id?:number,TenantsId?:number,ActionsId?:number,FirstPaymentOnly?:boolean,MaxMonths?:number,PaymentValue?:number,PaymentFixedPercentage?:number,PaymentMinPercentage?:number,PaymentMaxPercentage?:number,DiscountAmount?:number,DiscountPercentage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    ActionsId;
    /** @type {boolean} */
    FirstPaymentOnly;
    /** @type {number} */
    MaxMonths;
    /** @type {?number} */
    PaymentValue;
    /** @type {?number} */
    PaymentFixedPercentage;
    /** @type {?number} */
    PaymentMinPercentage;
    /** @type {?number} */
    PaymentMaxPercentage;
    /** @type {?number} */
    DiscountAmount;
    /** @type {?number} */
    DiscountPercentage;
}

JavaScript 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
		}
	}
}