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

export class PaymentPlanActionsAddResponse
{
    // @DataMember(Order=2)
    public TenantsId: number;

    // @DataMember(Order=3)
    public ActionsId: number;

    // @DataMember(Order=4)
    public FirstPaymentOnly: boolean;

    // @DataMember(Order=5)
    public MaxMonths: number;

    // @DataMember(Order=6)
    public PaymentValue?: number;

    // @DataMember(Order=7)
    public PaymentFixedPercentage?: number;

    // @DataMember(Order=8)
    public PaymentMinPercentage?: number;

    // @DataMember(Order=9)
    public PaymentMaxPercentage?: number;

    // @DataMember(Order=10)
    public DiscountAmount?: number;

    // @DataMember(Order=11)
    public DiscountPercentage?: number;

    // @DataMember(Order=13)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<PaymentPlanActionsAddResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PaymentPlanActionsAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public ActionsId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public FirstPaymentOnly: boolean;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public MaxMonths: number;

    // @DataMember(Order=6)
    public PaymentValue?: number;

    // @DataMember(Order=7)
    public PaymentFixedPercentage?: number;

    // @DataMember(Order=8)
    public PaymentMinPercentage?: number;

    // @DataMember(Order=9)
    public PaymentMaxPercentage?: number;

    // @DataMember(Order=10)
    public DiscountAmount?: number;

    // @DataMember(Order=11)
    public DiscountPercentage?: number;

    public constructor(init?: Partial<PaymentPlanActionsAdd>) { (Object as any).assign(this, init); }
}

TypeScript PaymentPlanActionsAdd DTOs

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_plan_actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
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/csv
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"}}}