Studebaker Submetering API Services

GetTenantInvoices

The following routes are available for this service:
All Verbs	/getTenantInvoices	Get the invoices for a tenant

Parameters:
Name	Parameter	Data Type	Required	Description
TenantId	path	int	Yes	The id (a.k.a. account number) of the tenant
PageSize	path	int	Yes	The maximum number of rows you wish to retrieve at any one time
CurrentPage	path	int	Yes	0-based number of the page of data required

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/GetTenantInvoices HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: application/xml
Content-Length: length

<GetTenantInvoices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Tenants.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>
  <CurrentPage>0</CurrentPage>
  <PageSize>0</PageSize>
  <TenantId>0</TenantId>
</GetTenantInvoices>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTenantInvoicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Tenants.Responses">
  <Invoices xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:TenantInvoice>
      <d2p1:Amount>0</d2p1:Amount>
      <d2p1:Details>
        <d2p1:TenantInvoiceDetail>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:CurrentReading>0</d2p1:CurrentReading>
          <d2p1:CurrentReadingDate>0001-01-01T00:00:00</d2p1:CurrentReadingDate>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:FormattedCurrentReadingDate>String</d2p1:FormattedCurrentReadingDate>
          <d2p1:FormattedPreviousReadingDate>String</d2p1:FormattedPreviousReadingDate>
          <d2p1:FormattedTransactionDate>String</d2p1:FormattedTransactionDate>
          <d2p1:Multiplier>0</d2p1:Multiplier>
          <d2p1:PreviousReading>0</d2p1:PreviousReading>
          <d2p1:PreviousReadingDate>0001-01-01T00:00:00</d2p1:PreviousReadingDate>
          <d2p1:Rate>0</d2p1:Rate>
          <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
          <d2p1:Unit>String</d2p1:Unit>
          <d2p1:Usage>0</d2p1:Usage>
        </d2p1:TenantInvoiceDetail>
      </d2p1:Details>
      <d2p1:DueDate>0001-01-01T00:00:00</d2p1:DueDate>
      <d2p1:InsertCaption>String</d2p1:InsertCaption>
      <d2p1:InsertUrl>String</d2p1:InsertUrl>
      <d2p1:InvoiceDate>0001-01-01T00:00:00</d2p1:InvoiceDate>
      <d2p1:InvoicePdfUrl>String</d2p1:InvoicePdfUrl>
      <d2p1:PaymentServiceProvider>0</d2p1:PaymentServiceProvider>
      <d2p1:RecentCredits>
        <d2p1:RecentCreditDetail>
          <d2p1:Amount>0</d2p1:Amount>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:FormattedTransactionDate>String</d2p1:FormattedTransactionDate>
          <d2p1:RefId>0</d2p1:RefId>
          <d2p1:SubOrder>0</d2p1:SubOrder>
          <d2p1:TransactionDate>0001-01-01T00:00:00</d2p1:TransactionDate>
        </d2p1:RecentCreditDetail>
      </d2p1:RecentCredits>
      <d2p1:ServiceAddress>String</d2p1:ServiceAddress>
      <d2p1:TenantCanPayOnline>false</d2p1:TenantCanPayOnline>
    </d2p1:TenantInvoice>
  </Invoices>
</GetTenantInvoicesResponse>