ThirdPartyInterface Web Service

ThirdPartyInterface

Click here for a complete list of operations.

FetchTransactions

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 /api/ThirdPartyInterface.asmx HTTP/1.1
Host: app.tfn.co.za
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/FetchTransactions"

<?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>
    <FetchTransactions xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <customerNumber>string</customerNumber>
      <capturedDateAfter>dateTime</capturedDateAfter>
    </FetchTransactions>
  </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>
    <FetchTransactionsResponse xmlns="http://tempuri.org/">
      <FetchTransactionsResult>
        <TransactionSerializable>
          <TransactionID>guid</TransactionID>
          <CustomerNumber>string</CustomerNumber>
          <CustomerExternalNumber>string</CustomerExternalNumber>
          <ChildCustomerNumber>string</ChildCustomerNumber>
          <ChildCustomerExternalNumber>string</ChildCustomerExternalNumber>
          <ProductCode>string</ProductCode>
          <TransactionTypeCode>string</TransactionTypeCode>
          <TransactionDate>dateTime</TransactionDate>
          <CapturedDate>dateTime</CapturedDate>
          <SupplierName>string</SupplierName>
          <SupplierNumber>string</SupplierNumber>
          <VehicleRegistration>string</VehicleRegistration>
          <VehicleFleetNumber>string</VehicleFleetNumber>
          <Amount>decimal</Amount>
          <VAT>decimal</VAT>
          <ChildAccountAmount>decimal</ChildAccountAmount>
          <ChildAccountVAT>decimal</ChildAccountVAT>
          <Litres>decimal</Litres>
          <Odometer>decimal</Odometer>
          <UtilisedOrders>
            <TransactionOrder xsi:nil="true" />
            <TransactionOrder xsi:nil="true" />
          </UtilisedOrders>
          <TransactionReference>string</TransactionReference>
          <Identifier>string</Identifier>
          <ReversedTransaction>
            <TransactionID>guid</TransactionID>
            <IsFuel>boolean</IsFuel>
            <TransactionReference>string</TransactionReference>
          </ReversedTransaction>
          <Reversed>boolean</Reversed>
          <ReversedDate>dateTime</ReversedDate>
        </TransactionSerializable>
        <TransactionSerializable>
          <TransactionID>guid</TransactionID>
          <CustomerNumber>string</CustomerNumber>
          <CustomerExternalNumber>string</CustomerExternalNumber>
          <ChildCustomerNumber>string</ChildCustomerNumber>
          <ChildCustomerExternalNumber>string</ChildCustomerExternalNumber>
          <ProductCode>string</ProductCode>
          <TransactionTypeCode>string</TransactionTypeCode>
          <TransactionDate>dateTime</TransactionDate>
          <CapturedDate>dateTime</CapturedDate>
          <SupplierName>string</SupplierName>
          <SupplierNumber>string</SupplierNumber>
          <VehicleRegistration>string</VehicleRegistration>
          <VehicleFleetNumber>string</VehicleFleetNumber>
          <Amount>decimal</Amount>
          <VAT>decimal</VAT>
          <ChildAccountAmount>decimal</ChildAccountAmount>
          <ChildAccountVAT>decimal</ChildAccountVAT>
          <Litres>decimal</Litres>
          <Odometer>decimal</Odometer>
          <UtilisedOrders>
            <TransactionOrder xsi:nil="true" />
            <TransactionOrder xsi:nil="true" />
          </UtilisedOrders>
          <TransactionReference>string</TransactionReference>
          <Identifier>string</Identifier>
          <ReversedTransaction>
            <TransactionID>guid</TransactionID>
            <IsFuel>boolean</IsFuel>
            <TransactionReference>string</TransactionReference>
          </ReversedTransaction>
          <Reversed>boolean</Reversed>
          <ReversedDate>dateTime</ReversedDate>
        </TransactionSerializable>
      </FetchTransactionsResult>
    </FetchTransactionsResponse>
  </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 /api/ThirdPartyInterface.asmx HTTP/1.1
Host: app.tfn.co.za
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>
    <FetchTransactions xmlns="http://tempuri.org/">
      <userName>string</userName>
      <password>string</password>
      <customerNumber>string</customerNumber>
      <capturedDateAfter>dateTime</capturedDateAfter>
    </FetchTransactions>
  </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>
    <FetchTransactionsResponse xmlns="http://tempuri.org/">
      <FetchTransactionsResult>
        <TransactionSerializable>
          <TransactionID>guid</TransactionID>
          <CustomerNumber>string</CustomerNumber>
          <CustomerExternalNumber>string</CustomerExternalNumber>
          <ChildCustomerNumber>string</ChildCustomerNumber>
          <ChildCustomerExternalNumber>string</ChildCustomerExternalNumber>
          <ProductCode>string</ProductCode>
          <TransactionTypeCode>string</TransactionTypeCode>
          <TransactionDate>dateTime</TransactionDate>
          <CapturedDate>dateTime</CapturedDate>
          <SupplierName>string</SupplierName>
          <SupplierNumber>string</SupplierNumber>
          <VehicleRegistration>string</VehicleRegistration>
          <VehicleFleetNumber>string</VehicleFleetNumber>
          <Amount>decimal</Amount>
          <VAT>decimal</VAT>
          <ChildAccountAmount>decimal</ChildAccountAmount>
          <ChildAccountVAT>decimal</ChildAccountVAT>
          <Litres>decimal</Litres>
          <Odometer>decimal</Odometer>
          <UtilisedOrders>
            <TransactionOrder xsi:nil="true" />
            <TransactionOrder xsi:nil="true" />
          </UtilisedOrders>
          <TransactionReference>string</TransactionReference>
          <Identifier>string</Identifier>
          <ReversedTransaction>
            <TransactionID>guid</TransactionID>
            <IsFuel>boolean</IsFuel>
            <TransactionReference>string</TransactionReference>
          </ReversedTransaction>
          <Reversed>boolean</Reversed>
          <ReversedDate>dateTime</ReversedDate>
        </TransactionSerializable>
        <TransactionSerializable>
          <TransactionID>guid</TransactionID>
          <CustomerNumber>string</CustomerNumber>
          <CustomerExternalNumber>string</CustomerExternalNumber>
          <ChildCustomerNumber>string</ChildCustomerNumber>
          <ChildCustomerExternalNumber>string</ChildCustomerExternalNumber>
          <ProductCode>string</ProductCode>
          <TransactionTypeCode>string</TransactionTypeCode>
          <TransactionDate>dateTime</TransactionDate>
          <CapturedDate>dateTime</CapturedDate>
          <SupplierName>string</SupplierName>
          <SupplierNumber>string</SupplierNumber>
          <VehicleRegistration>string</VehicleRegistration>
          <VehicleFleetNumber>string</VehicleFleetNumber>
          <Amount>decimal</Amount>
          <VAT>decimal</VAT>
          <ChildAccountAmount>decimal</ChildAccountAmount>
          <ChildAccountVAT>decimal</ChildAccountVAT>
          <Litres>decimal</Litres>
          <Odometer>decimal</Odometer>
          <UtilisedOrders>
            <TransactionOrder xsi:nil="true" />
            <TransactionOrder xsi:nil="true" />
          </UtilisedOrders>
          <TransactionReference>string</TransactionReference>
          <Identifier>string</Identifier>
          <ReversedTransaction>
            <TransactionID>guid</TransactionID>
            <IsFuel>boolean</IsFuel>
            <TransactionReference>string</TransactionReference>
          </ReversedTransaction>
          <Reversed>boolean</Reversed>
          <ReversedDate>dateTime</ReversedDate>
        </TransactionSerializable>
      </FetchTransactionsResult>
    </FetchTransactionsResponse>
  </soap12:Body>
</soap12:Envelope>