Studebaker Submetering API Services

<back to all web services

GetAccountsWithCreditReport

The following routes are available for this service:
All Verbs/getAccountsWithCreditReportGet the report data for accounts with credits
Parameters:
NameParameterData TypeRequiredDescription
PropertyIdpathintYesThe property id
MovedOutOnlypathbooleanYesInclude only moved out accounts
MaximumAgeInMonthspathintNoMaximum age of last bill (defaults to 3 months)

To override the Content-type in your clients 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 /jsv/reply/GetAccountsWithCreditReport HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/jsv
Content-Length: length

{
	propertyId: 0,
	movedOutOnly: False,
	maximumAgeInMonths: 0,
	requestIpAddress: String,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	oldestLastInvoiceDate: 0001-01-01,
	data: 
	[
		{
			tenantName: String,
			residentAccount: 0,
			building: String,
			unit: String,
			balance: 0,
			accountStatus: String,
			lastInvoiceDate: 0001-01-01
		}
	]
}