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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DebtsLookup:
    tenants_id: int = 0
    customers_id: int = 0
    invoice_number: Optional[str] = None
    debt_date: datetime.datetime = datetime.datetime(1, 1, 1)
    debt_age: int = 0
    amount_outstanding: float = 0.0
    capital_outstanding: Optional[float] = None
    interest_outstanding: Optional[float] = None
    fees_outstanding: Optional[float] = None
    last_paid_date: Optional[datetime.datetime] = None
    last_paid_amount: Optional[float] = None
    vulnerability_flag: bool = False
    currencies_id: int = 0
    currency_rates_id: int = 0
    status_codes_id: int = 0

Python DebtsLookup 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.

GET /debts HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
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
			}
		}
	}
]