H2OAPIv20


Click here for a complete list of operations.

Transactions_Create

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.rev.io
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.myh2o.com/v20/Transactions_Create"

<?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>
    <Transactions_Create 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>
        <Transaction>
          <Type>CHARGE or CREDIT</Type>
          <ID>int</ID>
          <Amount>decimal</Amount>
          <Quantity>int</Quantity>
          <Description>string</Description>
          <ProductID>int</ProductID>
          <ProductTypeID>int</ProductTypeID>
          <CustomerID>int</CustomerID>
          <LineID>int</LineID>
          <CustomerProductID>int</CustomerProductID>
          <DateStart>dateTime</DateStart>
          <DateEnd>dateTime</DateEnd>
          <TaxIncluded>boolean</TaxIncluded>
          <Prorate>boolean</Prorate>
          <AgentID>int</AgentID>
          <AgentNumber>string</AgentNumber>
          <StatementID>int</StatementID>
          <CreatedDate>dateTime</CreatedDate>
        </Transaction>
      </Request>
    </Transactions_Create>
  </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>
    <Transactions_CreateResponse xmlns="http://api.myh2o.com/v20">
      <Transactions_CreateResult>
        <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>
            <Transaction>
              <Type>CHARGE or CREDIT</Type>
              <ID>int</ID>
              <Amount>decimal</Amount>
              <Quantity>int</Quantity>
              <Description>string</Description>
              <ProductID>int</ProductID>
              <ProductTypeID>int</ProductTypeID>
              <CustomerID>int</CustomerID>
              <LineID>int</LineID>
              <CustomerProductID>int</CustomerProductID>
              <DateStart>dateTime</DateStart>
              <DateEnd>dateTime</DateEnd>
              <TaxIncluded>boolean</TaxIncluded>
              <Prorate>boolean</Prorate>
              <AgentID>int</AgentID>
              <AgentNumber>string</AgentNumber>
              <StatementID>int</StatementID>
              <CreatedDate>dateTime</CreatedDate>
            </Transaction>
          </Request>
        </Debug>
        <Transaction>
          <Type>CHARGE or CREDIT</Type>
          <ID>int</ID>
          <Amount>decimal</Amount>
          <Quantity>int</Quantity>
          <Description>string</Description>
          <ProductID>int</ProductID>
          <ProductTypeID>int</ProductTypeID>
          <CustomerID>int</CustomerID>
          <LineID>int</LineID>
          <CustomerProductID>int</CustomerProductID>
          <DateStart>dateTime</DateStart>
          <DateEnd>dateTime</DateEnd>
          <TaxIncluded>boolean</TaxIncluded>
          <Prorate>boolean</Prorate>
          <AgentID>int</AgentID>
          <AgentNumber>string</AgentNumber>
          <StatementID>int</StatementID>
          <CreatedDate>dateTime</CreatedDate>
        </Transaction>
      </Transactions_CreateResult>
    </Transactions_CreateResponse>
  </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.rev.io
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>
    <Transactions_Create 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>
        <Transaction>
          <Type>CHARGE or CREDIT</Type>
          <ID>int</ID>
          <Amount>decimal</Amount>
          <Quantity>int</Quantity>
          <Description>string</Description>
          <ProductID>int</ProductID>
          <ProductTypeID>int</ProductTypeID>
          <CustomerID>int</CustomerID>
          <LineID>int</LineID>
          <CustomerProductID>int</CustomerProductID>
          <DateStart>dateTime</DateStart>
          <DateEnd>dateTime</DateEnd>
          <TaxIncluded>boolean</TaxIncluded>
          <Prorate>boolean</Prorate>
          <AgentID>int</AgentID>
          <AgentNumber>string</AgentNumber>
          <StatementID>int</StatementID>
          <CreatedDate>dateTime</CreatedDate>
        </Transaction>
      </Request>
    </Transactions_Create>
  </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>
    <Transactions_CreateResponse xmlns="http://api.myh2o.com/v20">
      <Transactions_CreateResult>
        <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>
            <Transaction>
              <Type>CHARGE or CREDIT</Type>
              <ID>int</ID>
              <Amount>decimal</Amount>
              <Quantity>int</Quantity>
              <Description>string</Description>
              <ProductID>int</ProductID>
              <ProductTypeID>int</ProductTypeID>
              <CustomerID>int</CustomerID>
              <LineID>int</LineID>
              <CustomerProductID>int</CustomerProductID>
              <DateStart>dateTime</DateStart>
              <DateEnd>dateTime</DateEnd>
              <TaxIncluded>boolean</TaxIncluded>
              <Prorate>boolean</Prorate>
              <AgentID>int</AgentID>
              <AgentNumber>string</AgentNumber>
              <StatementID>int</StatementID>
              <CreatedDate>dateTime</CreatedDate>
            </Transaction>
          </Request>
        </Debug>
        <Transaction>
          <Type>CHARGE or CREDIT</Type>
          <ID>int</ID>
          <Amount>decimal</Amount>
          <Quantity>int</Quantity>
          <Description>string</Description>
          <ProductID>int</ProductID>
          <ProductTypeID>int</ProductTypeID>
          <CustomerID>int</CustomerID>
          <LineID>int</LineID>
          <CustomerProductID>int</CustomerProductID>
          <DateStart>dateTime</DateStart>
          <DateEnd>dateTime</DateEnd>
          <TaxIncluded>boolean</TaxIncluded>
          <Prorate>boolean</Prorate>
          <AgentID>int</AgentID>
          <AgentNumber>string</AgentNumber>
          <StatementID>int</StatementID>
          <CreatedDate>dateTime</CreatedDate>
        </Transaction>
      </Transactions_CreateResult>
    </Transactions_CreateResponse>
  </soap12:Body>
</soap12:Envelope>