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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetAccountsWithCreditReport HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

<GetAccountsWithCreditReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Reports.Requests">
  <RequestIpAddress xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</RequestIpAddress>
  <Token xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Common.Requests">String</Token>
  <MaximumAgeInMonths>0</MaximumAgeInMonths>
  <MovedOutOnly>false</MovedOutOnly>
  <PropertyId>0</PropertyId>
</GetAccountsWithCreditReport>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAccountsWithCreditReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Reports.Responses">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:AccountsWithCreditReportData>
      <d2p1:AccountStatus>String</d2p1:AccountStatus>
      <d2p1:Balance>0</d2p1:Balance>
      <d2p1:Building>String</d2p1:Building>
      <d2p1:LastInvoiceDate>0001-01-01T00:00:00</d2p1:LastInvoiceDate>
      <d2p1:ResidentAccount>0</d2p1:ResidentAccount>
      <d2p1:TenantName>String</d2p1:TenantName>
      <d2p1:Unit>String</d2p1:Unit>
    </d2p1:AccountsWithCreditReportData>
  </Data>
  <OldestLastInvoiceDate>0001-01-01T00:00:00</OldestLastInvoiceDate>
</GetAccountsWithCreditReportResponse>