Studebaker Submetering API Services

<back to all web services

GetCollectionsSummary

The following routes are available for this service:
All Verbs/getCollectionsSummaryGet the collections summary report data

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/GetCollectionsSummary HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/csv
Content-Length: length

PropertyId,CycleId,RequestIpAddress,Token
0,0,String,String

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

History,PotentialCollection,ActualCollection
"[{monthName:String,date:0001-01-01,totalBilled:0,feesBilled:0,totalCollected:0,feesCollected:0}]","{billingCycleName:String,billingCycleId:0,invoicedServices:[{serviceName:String,invoiceCount:0,totalDollarAmount:0,averageAmount:0,averageUsage:0,unitOfMeasure:String}],invoicedFees:[{feeName:String,totalDollarAmount:0}],invoiceAdjustments:[{adjustmentName:String,invoiceCount:0,totalDollarAmount:0}],totalDollarCorporateOrExempt:0,partialExemptionsTotal:0,potentialCollection:0,totalInvoiced:0}","{collectionCycleName:String,collectionCycleId:0,totalCollections:0,collectedBySSI:0,collectedByProperty:0,collectedServices:[{name:String,amount:0}],refunds:0,rejectedPayments:0,ssiFees:[{name:String,amount:0}],totalSSIFees:0,netCollectionsDue:0,moneyCollectedUntil:String}"