Studebaker Submetering API Services

<back to all web services

GetTenantInvoices

The following routes are available for this service:
All Verbs/getTenantInvoicesGet the invoices for a tenant
Parameters:
NameParameterData TypeRequiredDescription
TenantIdpathintYesThe id (a.k.a. account number) of the tenant
PageSizepathintYesThe maximum number of rows you wish to retrieve at any one time
CurrentPagepathintYes0-based number of the page of data required

To override the Content-type in your clients HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/GetTenantInvoices HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/csv
Content-Length: length

TenantId,PageSize,CurrentPage,RequestIpAddress,Token
0,0,0,String,String

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

Invoices
"[{invoiceDate:0001-01-01,amount:0,invoicePdfUrl:String,serviceAddress:String,dueDate:0001-01-01,tenantCanPayOnline:False,paymentServiceProvider:0,details:[{transactionDate:0001-01-01,description:String,previousReadingDate:0001-01-01,previousReading:0,currentReadingDate:0001-01-01,currentReading:0,multiplier:0,usage:0,unit:String,rate:0,amount:0,formattedTransactionDate:String,formattedCurrentReadingDate:String,formattedPreviousReadingDate:String}],recentCredits:[{refId:0,transactionDate:0001-01-01,description:String,amount:0,formattedTransactionDate:String,subOrder:0}],insertUrl:String,insertCaption:String}]"