TransactionWebservice_1

TransactionWebservice_1_1

Click here for a complete list of operations.

VoucherTotals

Get the voucher totals over a certain period of time. The totals are on TerminalCode level. Type is bitwise to make combinations: 1=details, 2=subtotals, 4=grandtotals

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 /ICP.Mimas.SAL/transaction_1_1.asmx HTTP/1.1
Host: live.icpmimas.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.icpmimas.com/VoucherTotals"

<?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>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <VoucherTotals xmlns="http://www.icpmimas.com/">
      <terminalCode>string</terminalCode>
      <type>short</type>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <day>short</day>
      <week>short</week>
      <month>short</month>
      <year>int</year>
      <allStatus>boolean</allStatus>
      <pageNumber>short</pageNumber>
      <pageRows>short</pageRows>
      <sortCol>string</sortCol>
    </VoucherTotals>
  </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>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap:Header>
  <soap:Body>
    <VoucherTotalsResponse xmlns="http://www.icpmimas.com/">
      <resultCode>int</resultCode>
      <resultText>string</resultText>
      <VoucherTotals>
        <DateFrom>dateTime</DateFrom>
        <DateTo>dateTime</DateTo>
        <TotOrders>int</TotOrders>
        <TotValue>long</TotValue>
        <TotRows>int</TotRows>
        <Details>
          <VoucherDetailData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <ProviderCode>string</ProviderCode>
            <OrderId>long</OrderId>
            <Value>long</Value>
            <EmployeeCode>string</EmployeeCode>
            <ExternalRef>string</ExternalRef>
            <OrderDate>dateTime</OrderDate>
            <DeliveryDate>dateTime</DeliveryDate>
          </VoucherDetailData_1_0>
          <VoucherDetailData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <ProviderCode>string</ProviderCode>
            <OrderId>long</OrderId>
            <Value>long</Value>
            <EmployeeCode>string</EmployeeCode>
            <ExternalRef>string</ExternalRef>
            <OrderDate>dateTime</OrderDate>
            <DeliveryDate>dateTime</DeliveryDate>
          </VoucherDetailData_1_0>
        </Details>
        <SubTotals>
          <VoucherSubTotalData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherSubTotalData_1_0>
          <VoucherSubTotalData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherSubTotalData_1_0>
        </SubTotals>
        <GrandTotals>
          <VoucherGrandTotalData_1_0>
            <Status>string</Status>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherGrandTotalData_1_0>
          <VoucherGrandTotalData_1_0>
            <Status>string</Status>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherGrandTotalData_1_0>
        </GrandTotals>
      </VoucherTotals>
    </VoucherTotalsResponse>
  </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 /ICP.Mimas.SAL/transaction_1_1.asmx HTTP/1.1
Host: live.icpmimas.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>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <VoucherTotals xmlns="http://www.icpmimas.com/">
      <terminalCode>string</terminalCode>
      <type>short</type>
      <startDate>dateTime</startDate>
      <endDate>dateTime</endDate>
      <day>short</day>
      <week>short</week>
      <month>short</month>
      <year>int</year>
      <allStatus>boolean</allStatus>
      <pageNumber>short</pageNumber>
      <pageRows>short</pageRows>
      <sortCol>string</sortCol>
    </VoucherTotals>
  </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>
    <AuthenticationHeader xmlns="http://www.icpmimas.com/">
      <loginLogId>long</loginLogId>
      <icpGroupId>long</icpGroupId>
      <sessionKey>string</sessionKey>
      <validUntil>dateTime</validUntil>
      <culture>string</culture>
    </AuthenticationHeader>
  </soap12:Header>
  <soap12:Body>
    <VoucherTotalsResponse xmlns="http://www.icpmimas.com/">
      <resultCode>int</resultCode>
      <resultText>string</resultText>
      <VoucherTotals>
        <DateFrom>dateTime</DateFrom>
        <DateTo>dateTime</DateTo>
        <TotOrders>int</TotOrders>
        <TotValue>long</TotValue>
        <TotRows>int</TotRows>
        <Details>
          <VoucherDetailData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <ProviderCode>string</ProviderCode>
            <OrderId>long</OrderId>
            <Value>long</Value>
            <EmployeeCode>string</EmployeeCode>
            <ExternalRef>string</ExternalRef>
            <OrderDate>dateTime</OrderDate>
            <DeliveryDate>dateTime</DeliveryDate>
          </VoucherDetailData_1_0>
          <VoucherDetailData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <ProviderCode>string</ProviderCode>
            <OrderId>long</OrderId>
            <Value>long</Value>
            <EmployeeCode>string</EmployeeCode>
            <ExternalRef>string</ExternalRef>
            <OrderDate>dateTime</OrderDate>
            <DeliveryDate>dateTime</DeliveryDate>
          </VoucherDetailData_1_0>
        </Details>
        <SubTotals>
          <VoucherSubTotalData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherSubTotalData_1_0>
          <VoucherSubTotalData_1_0>
            <Status>string</Status>
            <ProductCode>string</ProductCode>
            <ShortName>string</ShortName>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherSubTotalData_1_0>
        </SubTotals>
        <GrandTotals>
          <VoucherGrandTotalData_1_0>
            <Status>string</Status>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherGrandTotalData_1_0>
          <VoucherGrandTotalData_1_0>
            <Status>string</Status>
            <TotOrders>int</TotOrders>
            <TotValue>long</TotValue>
          </VoucherGrandTotalData_1_0>
        </GrandTotals>
      </VoucherTotals>
    </VoucherTotalsResponse>
  </soap12:Body>
</soap12:Envelope>