PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

getSalesInvoice

Get Sales Invoice

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/getSalesInvoice"

<?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>
    <getSalesInvoice xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <InvoiceNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </InvoiceNumber>
    </getSalesInvoice>
  </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>
    <getSalesInvoiceResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getSalesInvoiceResult>
        <BillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillToNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <InvoiceNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </InvoiceNumber>
        <NumberOfAssets>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </NumberOfAssets>
        <TotalInventoryCost>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </TotalInventoryCost>
        <TotalSellingPrice>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </TotalSellingPrice>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Details>
          <SalesInvoiceDetail>
            <EquipmentNumber xsi:nil="true" />
            <Description xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <ZipCode xsi:nil="true" />
            <CustomerPONumber xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Price xsi:nil="true" />
            <Cost xsi:nil="true" />
            <ProductCode xsi:nil="true" />
            <ShipToNumber xsi:nil="true" />
            <SalesCode xsi:nil="true" />
            <Condition xsi:nil="true" />
            <Quantity xsi:nil="true" />
          </SalesInvoiceDetail>
          <SalesInvoiceDetail>
            <EquipmentNumber xsi:nil="true" />
            <Description xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <ZipCode xsi:nil="true" />
            <CustomerPONumber xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Price xsi:nil="true" />
            <Cost xsi:nil="true" />
            <ProductCode xsi:nil="true" />
            <ShipToNumber xsi:nil="true" />
            <SalesCode xsi:nil="true" />
            <Condition xsi:nil="true" />
            <Quantity xsi:nil="true" />
          </SalesInvoiceDetail>
        </Details>
      </getSalesInvoiceResult>
    </getSalesInvoiceResponse>
  </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>
    <getSalesInvoice xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <InvoiceNumber>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </InvoiceNumber>
    </getSalesInvoice>
  </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>
    <getSalesInvoiceResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getSalesInvoiceResult>
        <BillToNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </BillToNumber>
        <CustomerNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </CustomerNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <InvoiceNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </InvoiceNumber>
        <NumberOfAssets>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </NumberOfAssets>
        <TotalInventoryCost>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </TotalInventoryCost>
        <TotalSellingPrice>
          <Value>double</Value>
          <Valid>boolean</Valid>
        </TotalSellingPrice>
        <PONumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PONumber>
        <SalesRep>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SalesRep>
        <Remarks>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Remarks>
        <Details>
          <SalesInvoiceDetail>
            <EquipmentNumber xsi:nil="true" />
            <Description xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <ZipCode xsi:nil="true" />
            <CustomerPONumber xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Price xsi:nil="true" />
            <Cost xsi:nil="true" />
            <ProductCode xsi:nil="true" />
            <ShipToNumber xsi:nil="true" />
            <SalesCode xsi:nil="true" />
            <Condition xsi:nil="true" />
            <Quantity xsi:nil="true" />
          </SalesInvoiceDetail>
          <SalesInvoiceDetail>
            <EquipmentNumber xsi:nil="true" />
            <Description xsi:nil="true" />
            <Make xsi:nil="true" />
            <Model xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <Address xsi:nil="true" />
            <City xsi:nil="true" />
            <State xsi:nil="true" />
            <ZipCode xsi:nil="true" />
            <CustomerPONumber xsi:nil="true" />
            <InstallDate xsi:nil="true" />
            <Price xsi:nil="true" />
            <Cost xsi:nil="true" />
            <ProductCode xsi:nil="true" />
            <ShipToNumber xsi:nil="true" />
            <SalesCode xsi:nil="true" />
            <Condition xsi:nil="true" />
            <Quantity xsi:nil="true" />
          </SalesInvoiceDetail>
        </Details>
      </getSalesInvoiceResult>
    </getSalesInvoiceResponse>
  </soap12:Body>
</soap12:Envelope>