Reports Web Service

Reports

Click here for a complete list of operations.

GetOrderDetailReport

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 /Reports.asmx HTTP/1.1
Host: webservices.flexcommute.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.flexcommute.com/webservice/GetOrderDetailReport"

<?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>
    <Authentication xmlns="http://www.flexcommute.com/webservice/">
      <Username>string</Username>
      <Password>string</Password>
      <IdMember>long</IdMember>
      <IdImpersonatingUser>int</IdImpersonatingUser>
    </Authentication>
  </soap:Header>
  <soap:Body>
    <GetOrderDetailReport xmlns="http://www.flexcommute.com/webservice/">
      <criteria>
        <TPAID>string</TPAID>
        <TPACompanyID>string</TPACompanyID>
        <BenefitMonth>dateTime</BenefitMonth>
        <TPAEmployeeID>string</TPAEmployeeID>
        <ReferenceNumber>long</ReferenceNumber>
        <IncludeAllDetails>boolean</IncludeAllDetails>
        <IncludeShippingDetail>boolean</IncludeShippingDetail>
        <IncludePaymentDetail>boolean</IncludePaymentDetail>
        <IncludeCreditDebitDetail>boolean</IncludeCreditDebitDetail>
        <IncludeSubsidyDetail>boolean</IncludeSubsidyDetail>
        <IncludeProductDetail>boolean</IncludeProductDetail>
      </criteria>
    </GetOrderDetailReport>
  </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>
    <GetOrderDetailReportResponse xmlns="http://www.flexcommute.com/webservice/">
      <GetOrderDetailReportResult>
        <Orders>
          <OrderDetail>
            <ReferencNumber>long</ReferencNumber>
            <OrderType>string</OrderType>
            <OrderDate>dateTime</OrderDate>
            <TPAID>string</TPAID>
            <TPACompanyID>string</TPACompanyID>
            <BenefitMonth>dateTime</BenefitMonth>
            <TPAEmployeeID>string</TPAEmployeeID>
            <TPAEmployeeID2>string</TPAEmployeeID2>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Division>string</Division>
            <PONumber>string</PONumber>
            <TotalItems>int</TotalItems>
            <Subtotal>decimal</Subtotal>
            <TotalSubsidies>decimal</TotalSubsidies>
            <TotalDiscounts>decimal</TotalDiscounts>
            <TotalSurcharges>decimal</TotalSurcharges>
            <TotalCreditDebits>decimal</TotalCreditDebits>
            <OrderTotal>decimal</OrderTotal>
            <ShippingAddress xsi:nil="true" />
            <OrderPayments xsi:nil="true" />
            <OrderCreditDebits xsi:nil="true" />
            <OrderSubsidies xsi:nil="true" />
            <OrderProducts xsi:nil="true" />
          </OrderDetail>
          <OrderDetail>
            <ReferencNumber>long</ReferencNumber>
            <OrderType>string</OrderType>
            <OrderDate>dateTime</OrderDate>
            <TPAID>string</TPAID>
            <TPACompanyID>string</TPACompanyID>
            <BenefitMonth>dateTime</BenefitMonth>
            <TPAEmployeeID>string</TPAEmployeeID>
            <TPAEmployeeID2>string</TPAEmployeeID2>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Division>string</Division>
            <PONumber>string</PONumber>
            <TotalItems>int</TotalItems>
            <Subtotal>decimal</Subtotal>
            <TotalSubsidies>decimal</TotalSubsidies>
            <TotalDiscounts>decimal</TotalDiscounts>
            <TotalSurcharges>decimal</TotalSurcharges>
            <TotalCreditDebits>decimal</TotalCreditDebits>
            <OrderTotal>decimal</OrderTotal>
            <ShippingAddress xsi:nil="true" />
            <OrderPayments xsi:nil="true" />
            <OrderCreditDebits xsi:nil="true" />
            <OrderSubsidies xsi:nil="true" />
            <OrderProducts xsi:nil="true" />
          </OrderDetail>
        </Orders>
      </GetOrderDetailReportResult>
    </GetOrderDetailReportResponse>
  </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 /Reports.asmx HTTP/1.1
Host: webservices.flexcommute.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>
    <Authentication xmlns="http://www.flexcommute.com/webservice/">
      <Username>string</Username>
      <Password>string</Password>
      <IdMember>long</IdMember>
      <IdImpersonatingUser>int</IdImpersonatingUser>
    </Authentication>
  </soap12:Header>
  <soap12:Body>
    <GetOrderDetailReport xmlns="http://www.flexcommute.com/webservice/">
      <criteria>
        <TPAID>string</TPAID>
        <TPACompanyID>string</TPACompanyID>
        <BenefitMonth>dateTime</BenefitMonth>
        <TPAEmployeeID>string</TPAEmployeeID>
        <ReferenceNumber>long</ReferenceNumber>
        <IncludeAllDetails>boolean</IncludeAllDetails>
        <IncludeShippingDetail>boolean</IncludeShippingDetail>
        <IncludePaymentDetail>boolean</IncludePaymentDetail>
        <IncludeCreditDebitDetail>boolean</IncludeCreditDebitDetail>
        <IncludeSubsidyDetail>boolean</IncludeSubsidyDetail>
        <IncludeProductDetail>boolean</IncludeProductDetail>
      </criteria>
    </GetOrderDetailReport>
  </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>
    <GetOrderDetailReportResponse xmlns="http://www.flexcommute.com/webservice/">
      <GetOrderDetailReportResult>
        <Orders>
          <OrderDetail>
            <ReferencNumber>long</ReferencNumber>
            <OrderType>string</OrderType>
            <OrderDate>dateTime</OrderDate>
            <TPAID>string</TPAID>
            <TPACompanyID>string</TPACompanyID>
            <BenefitMonth>dateTime</BenefitMonth>
            <TPAEmployeeID>string</TPAEmployeeID>
            <TPAEmployeeID2>string</TPAEmployeeID2>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Division>string</Division>
            <PONumber>string</PONumber>
            <TotalItems>int</TotalItems>
            <Subtotal>decimal</Subtotal>
            <TotalSubsidies>decimal</TotalSubsidies>
            <TotalDiscounts>decimal</TotalDiscounts>
            <TotalSurcharges>decimal</TotalSurcharges>
            <TotalCreditDebits>decimal</TotalCreditDebits>
            <OrderTotal>decimal</OrderTotal>
            <ShippingAddress xsi:nil="true" />
            <OrderPayments xsi:nil="true" />
            <OrderCreditDebits xsi:nil="true" />
            <OrderSubsidies xsi:nil="true" />
            <OrderProducts xsi:nil="true" />
          </OrderDetail>
          <OrderDetail>
            <ReferencNumber>long</ReferencNumber>
            <OrderType>string</OrderType>
            <OrderDate>dateTime</OrderDate>
            <TPAID>string</TPAID>
            <TPACompanyID>string</TPACompanyID>
            <BenefitMonth>dateTime</BenefitMonth>
            <TPAEmployeeID>string</TPAEmployeeID>
            <TPAEmployeeID2>string</TPAEmployeeID2>
            <FirstName>string</FirstName>
            <LastName>string</LastName>
            <Division>string</Division>
            <PONumber>string</PONumber>
            <TotalItems>int</TotalItems>
            <Subtotal>decimal</Subtotal>
            <TotalSubsidies>decimal</TotalSubsidies>
            <TotalDiscounts>decimal</TotalDiscounts>
            <TotalSurcharges>decimal</TotalSurcharges>
            <TotalCreditDebits>decimal</TotalCreditDebits>
            <OrderTotal>decimal</OrderTotal>
            <ShippingAddress xsi:nil="true" />
            <OrderPayments xsi:nil="true" />
            <OrderCreditDebits xsi:nil="true" />
            <OrderSubsidies xsi:nil="true" />
            <OrderProducts xsi:nil="true" />
          </OrderDetail>
        </Orders>
      </GetOrderDetailReportResult>
    </GetOrderDetailReportResponse>
  </soap12:Body>
</soap12:Envelope>