| Requires any of the roles: | Client, Admin, Partner |
| POST | /debts |
|---|
"use strict";
export class DebtsAddResponse {
/** @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,ResponseStatus?:ResponseStatus}} [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;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class DebtsAdd {
/** @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;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /debts HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
TenantsId: 0,
CustomersId: 0,
InvoiceNumber: String,
DebtDate: 0001-01-01,
DebtAge: 0,
AmountOutstanding: 0,
CapitalOutstanding: 0,
InterestOutstanding: 0,
FeesOutstanding: 0,
LastPaidDate: 0001-01-01,
LastPaidAmount: 0,
VulnerabilityFlag: False,
CurrenciesId: 0,
CurrencyRatesId: 0,
StatusCodesId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
TenantsId: 0,
CustomersId: 0,
InvoiceNumber: String,
DebtDate: 0001-01-01,
DebtAge: 0,
AmountOutstanding: 0,
CapitalOutstanding: 0,
InterestOutstanding: 0,
FeesOutstanding: 0,
LastPaidDate: 0001-01-01,
LastPaidAmount: 0,
VulnerabilityFlag: False,
CurrenciesId: 0,
CurrencyRatesId: 0,
StatusCodesId: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}