CustomerCareService Web Service

CustomerCareService

Click here for a complete list of operations.

GetBillHistory

Returns bill history

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/CustomerCareService.asmx HTTP/1.1
Host: ua-custsvc-ihub.southerncompany.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.southernco.com/CustSvc-iHub/GetBillHistory"

<?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:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap:Header>
  <soap:Body>
    <GetBillHistory xmlns="http://ws.southernco.com/CustSvc-iHub">
      <billHistoryRequest>
        <BaseRequest xmlns="">
          <UserId>string</UserId>
          <MessageDateTime>dateTime</MessageDateTime>
          <MessageId>string</MessageId>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </BaseRequest>
        <AccountNumber xmlns="">string</AccountNumber>
        <StartYearMonth xmlns="">
          <Year>string</Year>
          <Month>string</Month>
        </StartYearMonth>
        <EndYearMonth xmlns="">
          <Year>string</Year>
          <Month>string</Month>
        </EndYearMonth>
      </billHistoryRequest>
    </GetBillHistory>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
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:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap:Header>
  <soap:Body>
    <GetBillHistoryResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <GetBillHistoryResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
        <Account xmlns="">
          <AccountNumber>string</AccountNumber>
          <AccountName>string</AccountName>
          <Premise>
            <PremiseNumber>string</PremiseNumber>
            <PrimariesBilledCount>int</PrimariesBilledCount>
            <MeterCount>int</MeterCount>
            <ServicePoints xsi:nil="true" />
            <ServicePoints xsi:nil="true" />
          </Premise>
          <Bills>
            <BillDate>date</BillDate>
            <BillDueDate>date</BillDueDate>
            <BillableFlag>boolean</BillableFlag>
            <DebitBalanceAmount>decimal</DebitBalanceAmount>
            <BillTypeCode>string</BillTypeCode>
            <DueAmount>decimal</DueAmount>
            <LastBillDate>date</LastBillDate>
            <ProductOrderNumber>string</ProductOrderNumber>
            <DeliveryMethod>string</DeliveryMethod>
            <TotalNetUsageDays>int</TotalNetUsageDays>
            <TotalNetUsageAmount>decimal</TotalNetUsageAmount>
            <DebtAmount>decimal</DebtAmount>
            <BillRelativeYearMonth xsi:nil="true" />
            <RevenueRelativeYearMonth xsi:nil="true" />
            <LocalTaxAmount>decimal</LocalTaxAmount>
            <CancelRebillFlag>boolean</CancelRebillFlag>
            <DebitDate>date</DebitDate>
            <BillSummary xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillSchedule xsi:nil="true" />
            <ReadingSource xsi:nil="true" />
            <AccumulatedBillAmount>decimal</AccumulatedBillAmount>
            <AccumulatedUseAmount>decimal</AccumulatedUseAmount>
            <InformationalFlag>boolean</InformationalFlag>
            <BillImageURL>string</BillImageURL>
            <DaysUsed>int</DaysUsed>
            <UnpaidNet>decimal</UnpaidNet>
            <TotalNet>decimal</TotalNet>
            <UnappliedExcessCredit>decimal</UnappliedExcessCredit>
            <CutOutDate>date</CutOutDate>
            <ExtensionDueDate>date</ExtensionDueDate>
            <NextBillDate>date</NextBillDate>
            <InternalMailCode>string</InternalMailCode>
            <Releases xsi:nil="true" />
            <Releases xsi:nil="true" />
          </Bills>
          <Bills>
            <BillDate>date</BillDate>
            <BillDueDate>date</BillDueDate>
            <BillableFlag>boolean</BillableFlag>
            <DebitBalanceAmount>decimal</DebitBalanceAmount>
            <BillTypeCode>string</BillTypeCode>
            <DueAmount>decimal</DueAmount>
            <LastBillDate>date</LastBillDate>
            <ProductOrderNumber>string</ProductOrderNumber>
            <DeliveryMethod>string</DeliveryMethod>
            <TotalNetUsageDays>int</TotalNetUsageDays>
            <TotalNetUsageAmount>decimal</TotalNetUsageAmount>
            <DebtAmount>decimal</DebtAmount>
            <BillRelativeYearMonth xsi:nil="true" />
            <RevenueRelativeYearMonth xsi:nil="true" />
            <LocalTaxAmount>decimal</LocalTaxAmount>
            <CancelRebillFlag>boolean</CancelRebillFlag>
            <DebitDate>date</DebitDate>
            <BillSummary xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillSchedule xsi:nil="true" />
            <ReadingSource xsi:nil="true" />
            <AccumulatedBillAmount>decimal</AccumulatedBillAmount>
            <AccumulatedUseAmount>decimal</AccumulatedUseAmount>
            <InformationalFlag>boolean</InformationalFlag>
            <BillImageURL>string</BillImageURL>
            <DaysUsed>int</DaysUsed>
            <UnpaidNet>decimal</UnpaidNet>
            <TotalNet>decimal</TotalNet>
            <UnappliedExcessCredit>decimal</UnappliedExcessCredit>
            <CutOutDate>date</CutOutDate>
            <ExtensionDueDate>date</ExtensionDueDate>
            <NextBillDate>date</NextBillDate>
            <InternalMailCode>string</InternalMailCode>
            <Releases xsi:nil="true" />
            <Releases xsi:nil="true" />
          </Bills>
          <BillSummaries>
            <PastDueAmount>string</PastDueAmount>
            <DebitSequenceNumber>int</DebitSequenceNumber>
            <BillSequenceNumber>int</BillSequenceNumber>
            <RunSequenceNumber>int</RunSequenceNumber>
            <RefundAmount>decimal</RefundAmount>
          </BillSummaries>
          <BillSummaries>
            <PastDueAmount>string</PastDueAmount>
            <DebitSequenceNumber>int</DebitSequenceNumber>
            <BillSequenceNumber>int</BillSequenceNumber>
            <RunSequenceNumber>int</RunSequenceNumber>
            <RefundAmount>decimal</RefundAmount>
          </BillSummaries>
          <ServiceAddress>
            <AddressType>string</AddressType>
            <AddressKey>string</AddressKey>
            <AddressLineCode>string</AddressLineCode>
            <PreStreetDirection>string</PreStreetDirection>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressCompressed>string</AddressCompressed>
            <StreetType>string</StreetType>
            <PostStreetDirection>string</PostStreetDirection>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryCode>string</CountryCode>
            <CountyCode>string</CountyCode>
            <CountyName>string</CountyName>
            <RuralOrUrbanCode>string</RuralOrUrbanCode>
            <AddressStatusCode>string</AddressStatusCode>
            <StartDate>date</StartDate>
            <EndDate>date</EndDate>
            <Notes>string</Notes>
          </ServiceAddress>
          <AccountSummary>
            <CompanyCode>string</CompanyCode>
            <TotalCutableAmount>decimal</TotalCutableAmount>
            <TotalNonCutableAmount>decimal</TotalNonCutableAmount>
            <TotalArrearsCutableAmount>decimal</TotalArrearsCutableAmount>
            <TotalArrearsNonCutableAmount>decimal</TotalArrearsNonCutableAmount>
          </AccountSummary>
          <OperatingCenter>
            <OpCenterCode xsi:nil="true" />
            <ReportLevel xsi:nil="true" />
            <RegionCode xsi:nil="true" />
            <DivisionCode xsi:nil="true" />
          </OperatingCenter>
          <Customer>
            <CustomerNumber>string</CustomerNumber>
          </Customer>
        </Account>
      </GetBillHistoryResult>
    </GetBillHistoryResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /webservices/CustomerCareService.asmx HTTP/1.1
Host: ua-custsvc-ihub.southerncompany.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetBillHistory xmlns="http://ws.southernco.com/CustSvc-iHub">
      <billHistoryRequest>
        <BaseRequest xmlns="">
          <UserId>string</UserId>
          <MessageDateTime>dateTime</MessageDateTime>
          <MessageId>string</MessageId>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
          <NameValue>
            <Name>string</Name>
            <Value>string</Value>
          </NameValue>
        </BaseRequest>
        <AccountNumber xmlns="">string</AccountNumber>
        <StartYearMonth xmlns="">
          <Year>string</Year>
          <Month>string</Month>
        </StartYearMonth>
        <EndYearMonth xmlns="">
          <Year>string</Year>
          <Month>string</Month>
        </EndYearMonth>
      </billHistoryRequest>
    </GetBillHistory>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <ScCredentials xmlns="http://ws.southernco.com/CustSvc-iHub">
      <DirectUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </DirectUserNameToken>
      <OriginatingUserNameToken>
        <BinarySecurityToken>
          <ID>string</ID>
        </BinarySecurityToken>
      </OriginatingUserNameToken>
      <Created>string</Created>
    </ScCredentials>
  </soap12:Header>
  <soap12:Body>
    <GetBillHistoryResponse xmlns="http://ws.southernco.com/CustSvc-iHub">
      <GetBillHistoryResult>
        <BaseResponse xmlns="">
          <MessageDateTime>dateTime</MessageDateTime>
          <ResponseCode>string</ResponseCode>
          <ResponseDescription>string</ResponseDescription>
          <ErrorData>
            <ErrorCode>string</ErrorCode>
            <ErrorDescription>string</ErrorDescription>
            <NativeErrorDetail>string</NativeErrorDetail>
          </ErrorData>
        </BaseResponse>
        <Account xmlns="">
          <AccountNumber>string</AccountNumber>
          <AccountName>string</AccountName>
          <Premise>
            <PremiseNumber>string</PremiseNumber>
            <PrimariesBilledCount>int</PrimariesBilledCount>
            <MeterCount>int</MeterCount>
            <ServicePoints xsi:nil="true" />
            <ServicePoints xsi:nil="true" />
          </Premise>
          <Bills>
            <BillDate>date</BillDate>
            <BillDueDate>date</BillDueDate>
            <BillableFlag>boolean</BillableFlag>
            <DebitBalanceAmount>decimal</DebitBalanceAmount>
            <BillTypeCode>string</BillTypeCode>
            <DueAmount>decimal</DueAmount>
            <LastBillDate>date</LastBillDate>
            <ProductOrderNumber>string</ProductOrderNumber>
            <DeliveryMethod>string</DeliveryMethod>
            <TotalNetUsageDays>int</TotalNetUsageDays>
            <TotalNetUsageAmount>decimal</TotalNetUsageAmount>
            <DebtAmount>decimal</DebtAmount>
            <BillRelativeYearMonth xsi:nil="true" />
            <RevenueRelativeYearMonth xsi:nil="true" />
            <LocalTaxAmount>decimal</LocalTaxAmount>
            <CancelRebillFlag>boolean</CancelRebillFlag>
            <DebitDate>date</DebitDate>
            <BillSummary xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillSchedule xsi:nil="true" />
            <ReadingSource xsi:nil="true" />
            <AccumulatedBillAmount>decimal</AccumulatedBillAmount>
            <AccumulatedUseAmount>decimal</AccumulatedUseAmount>
            <InformationalFlag>boolean</InformationalFlag>
            <BillImageURL>string</BillImageURL>
            <DaysUsed>int</DaysUsed>
            <UnpaidNet>decimal</UnpaidNet>
            <TotalNet>decimal</TotalNet>
            <UnappliedExcessCredit>decimal</UnappliedExcessCredit>
            <CutOutDate>date</CutOutDate>
            <ExtensionDueDate>date</ExtensionDueDate>
            <NextBillDate>date</NextBillDate>
            <InternalMailCode>string</InternalMailCode>
            <Releases xsi:nil="true" />
            <Releases xsi:nil="true" />
          </Bills>
          <Bills>
            <BillDate>date</BillDate>
            <BillDueDate>date</BillDueDate>
            <BillableFlag>boolean</BillableFlag>
            <DebitBalanceAmount>decimal</DebitBalanceAmount>
            <BillTypeCode>string</BillTypeCode>
            <DueAmount>decimal</DueAmount>
            <LastBillDate>date</LastBillDate>
            <ProductOrderNumber>string</ProductOrderNumber>
            <DeliveryMethod>string</DeliveryMethod>
            <TotalNetUsageDays>int</TotalNetUsageDays>
            <TotalNetUsageAmount>decimal</TotalNetUsageAmount>
            <DebtAmount>decimal</DebtAmount>
            <BillRelativeYearMonth xsi:nil="true" />
            <RevenueRelativeYearMonth xsi:nil="true" />
            <LocalTaxAmount>decimal</LocalTaxAmount>
            <CancelRebillFlag>boolean</CancelRebillFlag>
            <DebitDate>date</DebitDate>
            <BillSummary xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillItems xsi:nil="true" />
            <BillSchedule xsi:nil="true" />
            <ReadingSource xsi:nil="true" />
            <AccumulatedBillAmount>decimal</AccumulatedBillAmount>
            <AccumulatedUseAmount>decimal</AccumulatedUseAmount>
            <InformationalFlag>boolean</InformationalFlag>
            <BillImageURL>string</BillImageURL>
            <DaysUsed>int</DaysUsed>
            <UnpaidNet>decimal</UnpaidNet>
            <TotalNet>decimal</TotalNet>
            <UnappliedExcessCredit>decimal</UnappliedExcessCredit>
            <CutOutDate>date</CutOutDate>
            <ExtensionDueDate>date</ExtensionDueDate>
            <NextBillDate>date</NextBillDate>
            <InternalMailCode>string</InternalMailCode>
            <Releases xsi:nil="true" />
            <Releases xsi:nil="true" />
          </Bills>
          <BillSummaries>
            <PastDueAmount>string</PastDueAmount>
            <DebitSequenceNumber>int</DebitSequenceNumber>
            <BillSequenceNumber>int</BillSequenceNumber>
            <RunSequenceNumber>int</RunSequenceNumber>
            <RefundAmount>decimal</RefundAmount>
          </BillSummaries>
          <BillSummaries>
            <PastDueAmount>string</PastDueAmount>
            <DebitSequenceNumber>int</DebitSequenceNumber>
            <BillSequenceNumber>int</BillSequenceNumber>
            <RunSequenceNumber>int</RunSequenceNumber>
            <RefundAmount>decimal</RefundAmount>
          </BillSummaries>
          <ServiceAddress>
            <AddressType>string</AddressType>
            <AddressKey>string</AddressKey>
            <AddressLineCode>string</AddressLineCode>
            <PreStreetDirection>string</PreStreetDirection>
            <AddressLine1>string</AddressLine1>
            <AddressLine2>string</AddressLine2>
            <AddressLine3>string</AddressLine3>
            <AddressLine4>string</AddressLine4>
            <AddressCompressed>string</AddressCompressed>
            <StreetType>string</StreetType>
            <PostStreetDirection>string</PostStreetDirection>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <CountryCode>string</CountryCode>
            <CountyCode>string</CountyCode>
            <CountyName>string</CountyName>
            <RuralOrUrbanCode>string</RuralOrUrbanCode>
            <AddressStatusCode>string</AddressStatusCode>
            <StartDate>date</StartDate>
            <EndDate>date</EndDate>
            <Notes>string</Notes>
          </ServiceAddress>
          <AccountSummary>
            <CompanyCode>string</CompanyCode>
            <TotalCutableAmount>decimal</TotalCutableAmount>
            <TotalNonCutableAmount>decimal</TotalNonCutableAmount>
            <TotalArrearsCutableAmount>decimal</TotalArrearsCutableAmount>
            <TotalArrearsNonCutableAmount>decimal</TotalArrearsNonCutableAmount>
          </AccountSummary>
          <OperatingCenter>
            <OpCenterCode xsi:nil="true" />
            <ReportLevel xsi:nil="true" />
            <RegionCode xsi:nil="true" />
            <DivisionCode xsi:nil="true" />
          </OperatingCenter>
          <Customer>
            <CustomerNumber>string</CustomerNumber>
          </Customer>
        </Account>
      </GetBillHistoryResult>
    </GetBillHistoryResponse>
  </soap12:Body>
</soap12:Envelope>