digitaluapi

<back to all web services

PaymentPlanActionsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/payment_plan_actions
"use strict";
export class PaymentPlanActionsLookup {
    /** @param {{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} */
    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 PaymentPlanActionsLookup 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.

GET /payment_plan_actions HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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