PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addPurchaseOrderReceiptAndVoucher

This function will add a PO Receipt for the specified Purchase Order.

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

<?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>
    <addPurchaseOrderReceiptAndVoucher xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <POReceipt>
        <PONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PONumber>
        <POReceiptNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </POReceiptNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Details>
          <PurchaseOrderReceiptDetail>
            <PONumber xsi:nil="true" />
            <POReceiptNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POReceiptDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <Received>boolean</Received>
          </PurchaseOrderReceiptDetail>
          <PurchaseOrderReceiptDetail>
            <PONumber xsi:nil="true" />
            <POReceiptNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POReceiptDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <Received>boolean</Received>
          </PurchaseOrderReceiptDetail>
        </Details>
      </POReceipt>
      <POVoucher>
        <PONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PONumber>
        <POVoucherNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </POVoucherNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Type>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Type>
        <VendorInvoiceNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </VendorInvoiceNumber>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <DueDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DueDate>
        <TermDiscountDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </TermDiscountDate>
        <TermDiscountRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </TermDiscountRate>
        <Details>
          <PurchaseOrderVoucherDetail>
            <PONumber xsi:nil="true" />
            <POVoucherNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POVoucherDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <optItem xsi:nil="true" />
            <optDescription xsi:nil="true" />
            <optPurchaseGLID xsi:nil="true" />
            <optPurchaseDept xsi:nil="true" />
            <optPrice xsi:nil="true" />
            <ReceiptReceived>boolean</ReceiptReceived>
          </PurchaseOrderVoucherDetail>
          <PurchaseOrderVoucherDetail>
            <PONumber xsi:nil="true" />
            <POVoucherNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POVoucherDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <optItem xsi:nil="true" />
            <optDescription xsi:nil="true" />
            <optPurchaseGLID xsi:nil="true" />
            <optPurchaseDept xsi:nil="true" />
            <optPrice xsi:nil="true" />
            <ReceiptReceived>boolean</ReceiptReceived>
          </PurchaseOrderVoucherDetail>
        </Details>
        <AllocateDetails>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </AllocateDetails>
        <Vendor>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Vendor>
        <ExcludeItemFromTermsDisc>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ExcludeItemFromTermsDisc>
        <ExcludeFreightFromTermsDisc>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ExcludeFreightFromTermsDisc>
      </POVoucher>
    </addPurchaseOrderReceiptAndVoucher>
  </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>
    <addPurchaseOrderReceiptAndVoucherResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addPurchaseOrderReceiptAndVoucherResult>
        <Receipt>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <POReceiptNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </POReceiptNumber>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Details>
            <PurchaseOrderReceiptDetail xsi:nil="true" />
            <PurchaseOrderReceiptDetail xsi:nil="true" />
          </Details>
        </Receipt>
        <Voucher>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <POVoucherNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </POVoucherNumber>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Type>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Type>
          <VendorInvoiceNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorInvoiceNumber>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <Term>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Term>
          <DueDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </DueDate>
          <TermDiscountDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </TermDiscountDate>
          <TermDiscountRate>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </TermDiscountRate>
          <Details>
            <PurchaseOrderVoucherDetail xsi:nil="true" />
            <PurchaseOrderVoucherDetail xsi:nil="true" />
          </Details>
          <AllocateDetails>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </AllocateDetails>
          <Vendor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Vendor>
          <ExcludeItemFromTermsDisc>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </ExcludeItemFromTermsDisc>
          <ExcludeFreightFromTermsDisc>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </ExcludeFreightFromTermsDisc>
        </Voucher>
      </addPurchaseOrderReceiptAndVoucherResult>
    </addPurchaseOrderReceiptAndVoucherResponse>
  </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>
    <addPurchaseOrderReceiptAndVoucher xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <POReceipt>
        <PONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PONumber>
        <POReceiptNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </POReceiptNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Details>
          <PurchaseOrderReceiptDetail>
            <PONumber xsi:nil="true" />
            <POReceiptNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POReceiptDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <Received>boolean</Received>
          </PurchaseOrderReceiptDetail>
          <PurchaseOrderReceiptDetail>
            <PONumber xsi:nil="true" />
            <POReceiptNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POReceiptDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <Received>boolean</Received>
          </PurchaseOrderReceiptDetail>
        </Details>
      </POReceipt>
      <POVoucher>
        <PONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </PONumber>
        <POVoucherNumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </POVoucherNumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Type>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Type>
        <VendorInvoiceNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </VendorInvoiceNumber>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <Term>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Term>
        <DueDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </DueDate>
        <TermDiscountDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </TermDiscountDate>
        <TermDiscountRate>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </TermDiscountRate>
        <Details>
          <PurchaseOrderVoucherDetail>
            <PONumber xsi:nil="true" />
            <POVoucherNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POVoucherDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <optItem xsi:nil="true" />
            <optDescription xsi:nil="true" />
            <optPurchaseGLID xsi:nil="true" />
            <optPurchaseDept xsi:nil="true" />
            <optPrice xsi:nil="true" />
            <ReceiptReceived>boolean</ReceiptReceived>
          </PurchaseOrderVoucherDetail>
          <PurchaseOrderVoucherDetail>
            <PONumber xsi:nil="true" />
            <POVoucherNumber xsi:nil="true" />
            <PODetailID xsi:nil="true" />
            <Quantity xsi:nil="true" />
            <SerialNumber xsi:nil="true" />
            <POVoucherDetailID xsi:nil="true" />
            <optCost xsi:nil="true" />
            <optFreight xsi:nil="true" />
            <optDiscount xsi:nil="true" />
            <optItem xsi:nil="true" />
            <optDescription xsi:nil="true" />
            <optPurchaseGLID xsi:nil="true" />
            <optPurchaseDept xsi:nil="true" />
            <optPrice xsi:nil="true" />
            <ReceiptReceived>boolean</ReceiptReceived>
          </PurchaseOrderVoucherDetail>
        </Details>
        <AllocateDetails>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </AllocateDetails>
        <Vendor>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Vendor>
        <ExcludeItemFromTermsDisc>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ExcludeItemFromTermsDisc>
        <ExcludeFreightFromTermsDisc>
          <Value>boolean</Value>
          <Valid>boolean</Valid>
        </ExcludeFreightFromTermsDisc>
      </POVoucher>
    </addPurchaseOrderReceiptAndVoucher>
  </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>
    <addPurchaseOrderReceiptAndVoucherResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addPurchaseOrderReceiptAndVoucherResult>
        <Receipt>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <POReceiptNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </POReceiptNumber>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Details>
            <PurchaseOrderReceiptDetail xsi:nil="true" />
            <PurchaseOrderReceiptDetail xsi:nil="true" />
          </Details>
        </Receipt>
        <Voucher>
          <PONumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </PONumber>
          <POVoucherNumber>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </POVoucherNumber>
          <Date>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </Date>
          <Type>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Type>
          <VendorInvoiceNumber>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </VendorInvoiceNumber>
          <Description>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Description>
          <Term>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Term>
          <DueDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </DueDate>
          <TermDiscountDate>
            <Value>dateTime</Value>
            <ValueAsString xsi:nil="true" />
            <Valid>boolean</Valid>
          </TermDiscountDate>
          <TermDiscountRate>
            <Value>decimal</Value>
            <Valid>boolean</Valid>
          </TermDiscountRate>
          <Details>
            <PurchaseOrderVoucherDetail xsi:nil="true" />
            <PurchaseOrderVoucherDetail xsi:nil="true" />
          </Details>
          <AllocateDetails>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </AllocateDetails>
          <Vendor>
            <ID xsi:nil="true" />
            <Code xsi:nil="true" />
          </Vendor>
          <ExcludeItemFromTermsDisc>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </ExcludeItemFromTermsDisc>
          <ExcludeFreightFromTermsDisc>
            <Value>boolean</Value>
            <Valid>boolean</Valid>
          </ExcludeFreightFromTermsDisc>
        </Voucher>
      </addPurchaseOrderReceiptAndVoucherResult>
    </addPurchaseOrderReceiptAndVoucherResponse>
  </soap12:Body>
</soap12:Envelope>