H2OAPIv20 Web Service

H2OAPIv20

Click here for a complete list of operations.

Charges_Search

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 /v20/Default.asmx HTTP/1.1
Host: api.myh2o.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.myh2o.com/v20/Charges_Search"

<?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>
    <Charges_Search xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <ID>int</ID>
        <ID>int</ID>
        <CustomerID>int</CustomerID>
        <CustomerID>int</CustomerID>
        <ServiceID>int</ServiceID>
        <ServiceID>int</ServiceID>
        <BillID>int</BillID>
        <BillID>int</BillID>
        <ProductID>int</ProductID>
        <ProductID>int</ProductID>
        <CustomerProductID>int</CustomerProductID>
        <CustomerProductID>int</CustomerProductID>
        <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
        <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
      </Request>
    </Charges_Search>
  </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:Body>
    <Charges_SearchResponse xmlns="http://api.myh2o.com/v20">
      <Charges_SearchResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <ID>int</ID>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <CustomerID>int</CustomerID>
            <ServiceID>int</ServiceID>
            <ServiceID>int</ServiceID>
            <BillID>int</BillID>
            <BillID>int</BillID>
            <ProductID>int</ProductID>
            <ProductID>int</ProductID>
            <CustomerProductID>int</CustomerProductID>
            <CustomerProductID>int</CustomerProductID>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
          </Request>
        </Debug>
        <Charges>
          <Charge>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <ServiceID>int</ServiceID>
            <Amount>decimal</Amount>
            <BillID>int</BillID>
            <ProductID>int</ProductID>
            <CustomerProductID>int</CustomerProductID>
            <TaxAmount>decimal</TaxAmount>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
            <Description>string</Description>
          </Charge>
          <Charge>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <ServiceID>int</ServiceID>
            <Amount>decimal</Amount>
            <BillID>int</BillID>
            <ProductID>int</ProductID>
            <CustomerProductID>int</CustomerProductID>
            <TaxAmount>decimal</TaxAmount>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
            <Description>string</Description>
          </Charge>
        </Charges>
      </Charges_SearchResult>
    </Charges_SearchResponse>
  </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 /v20/Default.asmx HTTP/1.1
Host: api.myh2o.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:Body>
    <Charges_Search xmlns="http://api.myh2o.com/v20">
      <Request>
        <Credentials>
          <Username>string</Username>
          <Password>string</Password>
          <Client>string</Client>
          <ImpersonationKey>string</ImpersonationKey>
        </Credentials>
        <Session>
          <SessionKey>string</SessionKey>
        </Session>
        <Debug>boolean</Debug>
        <ID>int</ID>
        <ID>int</ID>
        <CustomerID>int</CustomerID>
        <CustomerID>int</CustomerID>
        <ServiceID>int</ServiceID>
        <ServiceID>int</ServiceID>
        <BillID>int</BillID>
        <BillID>int</BillID>
        <ProductID>int</ProductID>
        <ProductID>int</ProductID>
        <CustomerProductID>int</CustomerProductID>
        <CustomerProductID>int</CustomerProductID>
        <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
        <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
      </Request>
    </Charges_Search>
  </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:Body>
    <Charges_SearchResponse xmlns="http://api.myh2o.com/v20">
      <Charges_SearchResult>
        <Header>
          <Success>boolean</Success>
          <Message>string</Message>
          <SessionKey>string</SessionKey>
          <Impersonated>boolean</Impersonated>
          <Error_Code>string</Error_Code>
          <Error_Description>string</Error_Description>
        </Header>
        <Debug>
          <Request>
            <Credentials>
              <Username>string</Username>
              <Password>string</Password>
              <Client>string</Client>
              <ImpersonationKey>string</ImpersonationKey>
            </Credentials>
            <Session>
              <SessionKey>string</SessionKey>
            </Session>
            <Debug>boolean</Debug>
            <ID>int</ID>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <CustomerID>int</CustomerID>
            <ServiceID>int</ServiceID>
            <ServiceID>int</ServiceID>
            <BillID>int</BillID>
            <BillID>int</BillID>
            <ProductID>int</ProductID>
            <ProductID>int</ProductID>
            <CustomerProductID>int</CustomerProductID>
            <CustomerProductID>int</CustomerProductID>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
          </Request>
        </Debug>
        <Charges>
          <Charge>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <ServiceID>int</ServiceID>
            <Amount>decimal</Amount>
            <BillID>int</BillID>
            <ProductID>int</ProductID>
            <CustomerProductID>int</CustomerProductID>
            <TaxAmount>decimal</TaxAmount>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
            <Description>string</Description>
          </Charge>
          <Charge>
            <ID>int</ID>
            <CustomerID>int</CustomerID>
            <ServiceID>int</ServiceID>
            <Amount>decimal</Amount>
            <BillID>int</BillID>
            <ProductID>int</ProductID>
            <CustomerProductID>int</CustomerProductID>
            <TaxAmount>decimal</TaxAmount>
            <AType>ADJ or FCC or LPC or MRC or NAC or NRC or OCC or PICC or PRO or TAX or Usage</AType>
            <Description>string</Description>
          </Charge>
        </Charges>
      </Charges_SearchResult>
    </Charges_SearchResponse>
  </soap12:Body>
</soap12:Envelope>