Studebaker Submetering API Services

GetCollectionsSummary

Get the collections summary report data

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

HTTP + SOAP11

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

POST /soap11 HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetCollectionsSummary

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetCollectionsSummary 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>
  <CycleId>0</CycleId>
  <PropertyId>0</PropertyId>
</GetCollectionsSummary>

    </soap:Body>
</soap:Envelope>

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetCollectionsSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSIAccountServices.Api.Reports.Responses">
  <ActualCollection xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:CollectedByProperty>0</d2p1:CollectedByProperty>
    <d2p1:CollectedBySSI>0</d2p1:CollectedBySSI>
    <d2p1:CollectedServices>
      <d2p1:CollectionSummaryCollectedService>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:CollectionSummaryCollectedService>
    </d2p1:CollectedServices>
    <d2p1:CollectionCycleId>0</d2p1:CollectionCycleId>
    <d2p1:CollectionCycleName>String</d2p1:CollectionCycleName>
    <d2p1:MoneyCollectedUntil>String</d2p1:MoneyCollectedUntil>
    <d2p1:NetCollectionsDue>0</d2p1:NetCollectionsDue>
    <d2p1:Refunds>0</d2p1:Refunds>
    <d2p1:RejectedPayments>0</d2p1:RejectedPayments>
    <d2p1:SSIFees>
      <d2p1:CollectionSummarySSIFee>
        <d2p1:Amount>0</d2p1:Amount>
        <d2p1:Name>String</d2p1:Name>
      </d2p1:CollectionSummarySSIFee>
    </d2p1:SSIFees>
    <d2p1:TotalCollections>0</d2p1:TotalCollections>
    <d2p1:TotalSSIFees>0</d2p1:TotalSSIFees>
  </ActualCollection>
  <History xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:CollectionSummaryHistoryItem>
      <d2p1:Date>0001-01-01T00:00:00</d2p1:Date>
      <d2p1:FeesBilled>0</d2p1:FeesBilled>
      <d2p1:FeesCollected>0</d2p1:FeesCollected>
      <d2p1:MonthName>String</d2p1:MonthName>
      <d2p1:TotalBilled>0</d2p1:TotalBilled>
      <d2p1:TotalCollected>0</d2p1:TotalCollected>
    </d2p1:CollectionSummaryHistoryItem>
  </History>
  <PotentialCollection xmlns:d2p1="http://schemas.datacontract.org/2004/07/ABS.Interfaces">
    <d2p1:BillingCycleId>0</d2p1:BillingCycleId>
    <d2p1:BillingCycleName>String</d2p1:BillingCycleName>
    <d2p1:InvoiceAdjustments>
      <d2p1:CollectionSummaryAdjustments>
        <d2p1:AdjustmentName>String</d2p1:AdjustmentName>
        <d2p1:InvoiceCount>0</d2p1:InvoiceCount>
        <d2p1:TotalDollarAmount>0</d2p1:TotalDollarAmount>
      </d2p1:CollectionSummaryAdjustments>
    </d2p1:InvoiceAdjustments>
    <d2p1:InvoicedFees>
      <d2p1:CollectionSummaryInvoicedFee>
        <d2p1:FeeName>String</d2p1:FeeName>
        <d2p1:TotalDollarAmount>0</d2p1:TotalDollarAmount>
      </d2p1:CollectionSummaryInvoicedFee>
    </d2p1:InvoicedFees>
    <d2p1:InvoicedServices>
      <d2p1:CollectionSummaryInvoicedService>
        <d2p1:AverageAmount>0</d2p1:AverageAmount>
        <d2p1:AverageUsage>0</d2p1:AverageUsage>
        <d2p1:InvoiceCount>0</d2p1:InvoiceCount>
        <d2p1:ServiceName>String</d2p1:ServiceName>
        <d2p1:TotalDollarAmount>0</d2p1:TotalDollarAmount>
        <d2p1:UnitOfMeasure>String</d2p1:UnitOfMeasure>
      </d2p1:CollectionSummaryInvoicedService>
    </d2p1:InvoicedServices>
    <d2p1:PartialExemptionsTotal>0</d2p1:PartialExemptionsTotal>
    <d2p1:PotentialCollection>0</d2p1:PotentialCollection>
    <d2p1:TotalDollarCorporateOrExempt>0</d2p1:TotalDollarCorporateOrExempt>
    <d2p1:TotalInvoiced>0</d2p1:TotalInvoiced>
  </PotentialCollection>
</GetCollectionsSummaryResponse>

    </soap:Body>
</soap:Envelope>