digitaluapi

<back to all web services

PaymentPlanActionsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/payment_plan_actions/{Id}
"use strict";
export class PaymentPlanActionsEditResponse {
    /** @param {{Id?:number,TenantsId?:number,ActionsId?:number,FirstPaymentOnly?:boolean,MaxMonths?:number,PaymentValue?:number,PaymentFixedPercentage?:number,PaymentMinPercentage?:number,PaymentMaxPercentage?:number,DiscountAmount?:number,DiscountPercentage?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @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;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class PaymentPlanActionsEdit {
    /** @param {{Id?:number,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} */
    Id;
    /** @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 PaymentPlanActionsEdit DTOs

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

HTTP + XML

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

PUT /payment_plan_actions/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PaymentPlanActionsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <ActionsId>0</ActionsId>
  <FirstPaymentOnly>false</FirstPaymentOnly>
  <MaxMonths>0</MaxMonths>
  <PaymentValue>0</PaymentValue>
  <PaymentFixedPercentage>0</PaymentFixedPercentage>
  <PaymentMinPercentage>0</PaymentMinPercentage>
  <PaymentMaxPercentage>0</PaymentMaxPercentage>
  <DiscountAmount>0</DiscountAmount>
  <DiscountPercentage>0</DiscountPercentage>
</PaymentPlanActionsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentPlanActionsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ActionsId>0</ActionsId>
  <DiscountAmount>0</DiscountAmount>
  <DiscountPercentage>0</DiscountPercentage>
  <FirstPaymentOnly>false</FirstPaymentOnly>
  <Id>0</Id>
  <MaxMonths>0</MaxMonths>
  <PaymentFixedPercentage>0</PaymentFixedPercentage>
  <PaymentMaxPercentage>0</PaymentMaxPercentage>
  <PaymentMinPercentage>0</PaymentMinPercentage>
  <PaymentValue>0</PaymentValue>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TenantsId>0</TenantsId>
</PaymentPlanActionsEditResponse>