digitaluapi

<back to all web services

PaymentPlansAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/payment_plans
PaymentPlansAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
ActionsIdbodylongYes
DatebodyDateTimeYes
MaxMonthsbodyintYes
DiscountAmountbodydoubleYes
DiscountCurrenciesIdbodyintYes
StatusCodesIdbodylongYes
PaymentPlansAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformintNo
ActionsIdformlongNo
DateformDateTimeNo
MaxMonthsformintNo
DiscountAmountformdoubleNo
DiscountCurrenciesIdformintNo
StatusCodesIdformlongNo
ResponseStatusformResponseStatusNo

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

HTTP + CSV

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

POST /payment_plans HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"TenantsId":0,"ActionsId":0,"Date":"0001-01-01T00:00:00.0000000","MaxMonths":0,"DiscountAmount":0,"DiscountCurrenciesId":0,"StatusCodesId":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"TenantsId":0,"ActionsId":0,"Date":"0001-01-01T00:00:00.0000000","MaxMonths":0,"DiscountAmount":0,"DiscountCurrenciesId":0,"StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}