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

// @DataContract
export class DebtsLookup
{
    // @DataMember(Order=2)
    public TenantsId: number;

    // @DataMember(Order=3)
    public CustomersId: number;

    // @DataMember(Order=4)
    public InvoiceNumber: string;

    // @DataMember(Order=5)
    public DebtDate: string;

    // @DataMember(Order=6)
    public DebtAge: number;

    // @DataMember(Order=7)
    public AmountOutstanding: number;

    // @DataMember(Order=8)
    public CapitalOutstanding?: number;

    // @DataMember(Order=9)
    public InterestOutstanding?: number;

    // @DataMember(Order=10)
    public FeesOutstanding?: number;

    // @DataMember(Order=11)
    public LastPaidDate?: string;

    // @DataMember(Order=12)
    public LastPaidAmount?: number;

    // @DataMember(Order=13)
    public VulnerabilityFlag: boolean;

    // @DataMember(Order=14)
    public CurrenciesId: number;

    // @DataMember(Order=15)
    public CurrencyRatesId: number;

    // @DataMember(Order=16)
    public StatusCodesId: number;

    public constructor(init?: Partial<DebtsLookup>) { (Object as any).assign(this, init); }
}

TypeScript DebtsLookup DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"TenantsId":0,"CustomersId":0,"InvoiceNumber":"String","DebtDate":"0001-01-01T00:00:00.0000000","DebtAge":0,"AmountOutstanding":0,"CapitalOutstanding":0,"InterestOutstanding":0,"FeesOutstanding":0,"LastPaidDate":"0001-01-01T00:00:00.0000000","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"}}}]