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
PaymentPlanActionsAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
ActionsIdbodylongYes
FirstPaymentOnlybodyboolYes
MaxMonthsbodyintYes
PaymentValuebodydouble?No
PaymentFixedPercentagebodydouble?No
PaymentMinPercentagebodydouble?No
PaymentMaxPercentagebodydouble?No
DiscountAmountbodydouble?No
DiscountPercentagebodydouble?No
PaymentPlanActionsAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformintNo
ActionsIdformlongNo
FirstPaymentOnlyformboolNo
MaxMonthsformintNo
PaymentValueformdouble?No
PaymentFixedPercentageformdouble?No
PaymentMinPercentageformdouble?No
PaymentMaxPercentageformdouble?No
DiscountAmountformdouble?No
DiscountPercentageformdouble?No
ResponseStatusformResponseStatusNo

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.

POST /payment_plan_actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
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
}
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
		}
	}
}