digitaluapi

<back to all web services

DebtsEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/debts/{Id}
"use strict";
export class DebtsEditResponse {
    /** @param {{Id?:number,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,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @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;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DebtsEdit {
    /** @param {{Id?:number,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} */
    Id;
    /** @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 DebtsEdit 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 /debts/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DebtsEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <TenantsId>0</TenantsId>
  <CustomersId>0</CustomersId>
  <InvoiceNumber>String</InvoiceNumber>
  <DebtDate>0001-01-01T00:00:00</DebtDate>
  <DebtAge>0</DebtAge>
  <AmountOutstanding>0</AmountOutstanding>
  <CapitalOutstanding>0</CapitalOutstanding>
  <InterestOutstanding>0</InterestOutstanding>
  <FeesOutstanding>0</FeesOutstanding>
  <LastPaidDate>0001-01-01T00:00:00</LastPaidDate>
  <LastPaidAmount>0</LastPaidAmount>
  <VulnerabilityFlag>false</VulnerabilityFlag>
  <CurrenciesId>0</CurrenciesId>
  <CurrencyRatesId>0</CurrencyRatesId>
  <StatusCodesId>0</StatusCodesId>
</DebtsEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DebtsEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <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>
  <Id>0</Id>
  <InterestOutstanding>0</InterestOutstanding>
  <InvoiceNumber>String</InvoiceNumber>
  <LastPaidAmount>0</LastPaidAmount>
  <LastPaidDate>0001-01-01T00:00:00</LastPaidDate>
  <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>
  <StatusCodesId>0</StatusCodesId>
  <TenantsId>0</TenantsId>
  <VulnerabilityFlag>false</VulnerabilityFlag>
</DebtsEditResponse>