digitaluapi

<back to all web services

PaymentPlanDetailsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/payment_plan_details
PaymentPlanDetailsAdd Parameters:
NameParameterData TypeRequiredDescription
PaymentPlansIdbodylongYes
PlannedDatebodyDateTimeYes
PlannedAmountbodydoubleYes
PlannedCurrenciesIdbodyintYes
PaymentsIdbodylongYes
StatusCodesIdbodylongYes
PaymentPlanDetailsAddResponse Parameters:
NameParameterData TypeRequiredDescription
PaymentPlansIdformlongNo
PlannedDateformDateTimeNo
PlannedAmountformdoubleNo
PlannedCurrenciesIdformintNo
PaymentsIdformlongNo
StatusCodesIdformlongNo
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_details HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PaymentPlansId: 0,
	PlannedDate: 0001-01-01,
	PlannedAmount: 0,
	PlannedCurrenciesId: 0,
	PaymentsId: 0,
	StatusCodesId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	PaymentPlansId: 0,
	PlannedDate: 0001-01-01,
	PlannedAmount: 0,
	PlannedCurrenciesId: 0,
	PaymentsId: 0,
	StatusCodesId: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}