digitaluapi

<back to all web services

DebtsAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/debts

export class DebtsAddResponse
{
    // @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;

    // @DataMember(Order=18)
    public ResponseStatus: ResponseStatus;

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

// @DataContract
export class DebtsAdd
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    public TenantsId: number;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    public CustomersId: number;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    public InvoiceNumber: string;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    public DebtDate: string;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    public DebtAge: number;

    // @DataMember(Order=7)
    // @Validate(Validator="NotNull")
    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)
    // @Validate(Validator="NotNull")
    public VulnerabilityFlag: boolean;

    // @DataMember(Order=14)
    // @Validate(Validator="NotNull")
    public CurrenciesId: number;

    // @DataMember(Order=15)
    // @Validate(Validator="NotNull")
    public CurrencyRatesId: number;

    // @DataMember(Order=16)
    // @Validate(Validator="NotNull")
    public StatusCodesId: number;

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

TypeScript DebtsAdd DTOs

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

HTTP + 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
		}
	}
}