PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getAPVoucherApplications

This function will return a list of AP Voucher Applications for a specified Voucher Number.

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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/getAPVoucherApplications"

<?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>
    <getAPVoucherApplications xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <VoucherNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </VoucherNumber>
      <TransactionType>int</TransactionType>
    </getAPVoucherApplications>
  </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>
    <getAPVoucherApplicationsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getAPVoucherApplicationsResult>
        <VoucherData>
          <VoucherNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VoucherNumber>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <VendorInvoiceNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorInvoiceNumber>
          <Total>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Total>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <PONumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PONumber>
          <ExtBatchNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ExtBatchNumber>
          <Details>
            <VoucherDetail xsi:nil="true" />
            <VoucherDetail xsi:nil="true" />
          </Details>
          <Applications>
            <VoucherApplication xsi:nil="true" />
            <VoucherApplication xsi:nil="true" />
          </Applications>
        </VoucherData>
        <VoucherData>
          <VoucherNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VoucherNumber>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <VendorInvoiceNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorInvoiceNumber>
          <Total>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Total>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <PONumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PONumber>
          <ExtBatchNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ExtBatchNumber>
          <Details>
            <VoucherDetail xsi:nil="true" />
            <VoucherDetail xsi:nil="true" />
          </Details>
          <Applications>
            <VoucherApplication xsi:nil="true" />
            <VoucherApplication xsi:nil="true" />
          </Applications>
        </VoucherData>
      </getAPVoucherApplicationsResult>
    </getAPVoucherApplicationsResponse>
  </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 /PIP/publicAPIService.asmx HTTP/1.1
Host: einfo.gfidigital.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>
    <getAPVoucherApplications xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <VoucherNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </VoucherNumber>
      <TransactionType>int</TransactionType>
    </getAPVoucherApplications>
  </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>
    <getAPVoucherApplicationsResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getAPVoucherApplicationsResult>
        <VoucherData>
          <VoucherNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VoucherNumber>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <VendorInvoiceNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorInvoiceNumber>
          <Total>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Total>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <PONumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PONumber>
          <ExtBatchNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ExtBatchNumber>
          <Details>
            <VoucherDetail xsi:nil="true" />
            <VoucherDetail xsi:nil="true" />
          </Details>
          <Applications>
            <VoucherApplication xsi:nil="true" />
            <VoucherApplication xsi:nil="true" />
          </Applications>
        </VoucherData>
        <VoucherData>
          <VoucherNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VoucherNumber>
          <VendorNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </VendorNumber>
          <VendorInvoiceNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorInvoiceNumber>
          <Total>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </Total>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <PONumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </PONumber>
          <ExtBatchNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ExtBatchNumber>
          <Details>
            <VoucherDetail xsi:nil="true" />
            <VoucherDetail xsi:nil="true" />
          </Details>
          <Applications>
            <VoucherApplication xsi:nil="true" />
            <VoucherApplication xsi:nil="true" />
          </Applications>
        </VoucherData>
      </getAPVoucherApplicationsResult>
    </getAPVoucherApplicationsResponse>
  </soap12:Body>
</soap12:Envelope>