PublicAPIService Web Service

PublicAPIService

Click here for a complete list of operations.

addARReceipt

After adding Sales Order, call this routine to add a receipt

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: pip.sta.solutions
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://digitalgateway.com/WebServices/PublicAPIService/addARReceipt"

<?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>
    <addARReceipt xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ARReceipt>
        <Receipt>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Receipt>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <SONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SONumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PaymentMethod>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PaymentMethod>
        <PaymentReferenceNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PaymentReferenceNumber>
        <PaymentDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </PaymentDate>
        <Amount>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Amount>
        <Unapplied>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Unapplied>
        <Fee>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Fee>
        <UserID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </UserID>
        <Details>
          <ARReceiptDetail>
            <DetailID>int</DetailID>
            <Receipt xsi:nil="true" />
            <Invoice xsi:nil="true" />
            <Amount xsi:nil="true" />
            <TermDiscount xsi:nil="true" />
          </ARReceiptDetail>
          <ARReceiptDetail>
            <DetailID>int</DetailID>
            <Receipt xsi:nil="true" />
            <Invoice xsi:nil="true" />
            <Amount xsi:nil="true" />
            <TermDiscount xsi:nil="true" />
          </ARReceiptDetail>
        </Details>
      </ARReceipt>
    </addARReceipt>
  </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>
    <addARReceiptResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addARReceiptResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addARReceiptResult>
    </addARReceiptResponse>
  </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: pip.sta.solutions
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>
    <addARReceipt xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <ARReceipt>
        <Receipt>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Receipt>
        <Customer>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </Customer>
        <SONumber>
          <ID>
            <Value>int</Value>
            <Valid>boolean</Valid>
          </ID>
          <Code>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </Code>
        </SONumber>
        <Date>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </Date>
        <Description>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Description>
        <PaymentMethod>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PaymentMethod>
        <PaymentReferenceNumber>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </PaymentReferenceNumber>
        <PaymentDate>
          <Value>dateTime</Value>
          <ValueAsString>
            <Value>string</Value>
            <Valid>boolean</Valid>
          </ValueAsString>
          <Valid>boolean</Valid>
        </PaymentDate>
        <Amount>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Amount>
        <Unapplied>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Unapplied>
        <Fee>
          <Value>decimal</Value>
          <Valid>boolean</Valid>
        </Fee>
        <UserID>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </UserID>
        <Details>
          <ARReceiptDetail>
            <DetailID>int</DetailID>
            <Receipt xsi:nil="true" />
            <Invoice xsi:nil="true" />
            <Amount xsi:nil="true" />
            <TermDiscount xsi:nil="true" />
          </ARReceiptDetail>
          <ARReceiptDetail>
            <DetailID>int</DetailID>
            <Receipt xsi:nil="true" />
            <Invoice xsi:nil="true" />
            <Amount xsi:nil="true" />
            <TermDiscount xsi:nil="true" />
          </ARReceiptDetail>
        </Details>
      </ARReceipt>
    </addARReceipt>
  </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>
    <addARReceiptResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <addARReceiptResult>
        <ID>
          <Value>int</Value>
          <Valid>boolean</Valid>
        </ID>
        <Code>
          <Value>string</Value>
          <Valid>boolean</Valid>
        </Code>
      </addARReceiptResult>
    </addARReceiptResponse>
  </soap12:Body>
</soap12:Envelope>