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
DebtsAdd Parameters:
NameParameterData TypeRequiredDescription
TenantsIdbodyintYes
CustomersIdbodylongYes
InvoiceNumberbodystringYes
DebtDatebodyDateTimeYes
DebtAgebodyintYes
AmountOutstandingbodydoubleYes
CapitalOutstandingbodydouble?No
InterestOutstandingbodydouble?No
FeesOutstandingbodydouble?No
LastPaidDatebodyDateTime?No
LastPaidAmountbodydouble?No
VulnerabilityFlagbodyboolYes
CurrenciesIdbodyintYes
CurrencyRatesIdbodylongYes
StatusCodesIdbodylongYes
DebtsAddResponse Parameters:
NameParameterData TypeRequiredDescription
TenantsIdformintNo
CustomersIdformlongNo
InvoiceNumberformstringNo
DebtDateformDateTimeNo
DebtAgeformintNo
AmountOutstandingformdoubleNo
CapitalOutstandingformdouble?No
InterestOutstandingformdouble?No
FeesOutstandingformdouble?No
LastPaidDateformDateTime?No
LastPaidAmountformdouble?No
VulnerabilityFlagformboolNo
CurrenciesIdformintNo
CurrencyRatesIdformlongNo
StatusCodesIdformlongNo
ResponseStatusformResponseStatusNo

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