digitaluapi

<back to all web services

PaymentPlanActionsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/payment_plan_actions
"use strict";
export class PaymentPlanActionsLookup {
    /** @param {{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} */
    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 PaymentPlanActionsLookup 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.

GET /payment_plan_actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

[
	{
		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
			}
		}
	}
]