digitaluapi

<back to all web services

DebtsLookup

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/debts
"use strict";
export class DebtsLookup {
    /** @param {{TenantsId?:number,CustomersId?:number,InvoiceNumber?:string,DebtDate?:string,DebtAge?:number,AmountOutstanding?:number,CapitalOutstanding?:number,InterestOutstanding?:number,FeesOutstanding?:number,LastPaidDate?:string,LastPaidAmount?:number,VulnerabilityFlag?:boolean,CurrenciesId?:number,CurrencyRatesId?:number,StatusCodesId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TenantsId;
    /** @type {number} */
    CustomersId;
    /** @type {string} */
    InvoiceNumber;
    /** @type {string} */
    DebtDate;
    /** @type {number} */
    DebtAge;
    /** @type {number} */
    AmountOutstanding;
    /** @type {?number} */
    CapitalOutstanding;
    /** @type {?number} */
    InterestOutstanding;
    /** @type {?number} */
    FeesOutstanding;
    /** @type {?string} */
    LastPaidDate;
    /** @type {?number} */
    LastPaidAmount;
    /** @type {boolean} */
    VulnerabilityFlag;
    /** @type {number} */
    CurrenciesId;
    /** @type {number} */
    CurrencyRatesId;
    /** @type {number} */
    StatusCodesId;
}

JavaScript DebtsLookup 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 /debts HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDebtsLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <DebtsLookupResponse>
    <AmountOutstanding>0</AmountOutstanding>
    <CapitalOutstanding>0</CapitalOutstanding>
    <CurrenciesId>0</CurrenciesId>
    <CurrencyRatesId>0</CurrencyRatesId>
    <CustomersId>0</CustomersId>
    <DebtAge>0</DebtAge>
    <DebtDate>0001-01-01T00:00:00</DebtDate>
    <FeesOutstanding>0</FeesOutstanding>
    <InterestOutstanding>0</InterestOutstanding>
    <InvoiceNumber>String</InvoiceNumber>
    <LastPaidAmount>0</LastPaidAmount>
    <LastPaidDate>0001-01-01T00:00:00</LastPaidDate>
    <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>
    <StatusCodesId>0</StatusCodesId>
    <TenantsId>0</TenantsId>
    <VulnerabilityFlag>false</VulnerabilityFlag>
  </DebtsLookupResponse>
</ArrayOfDebtsLookupResponse>