PublicAPIService


Click here for a complete list of operations.

getAndApplyUnappliedPaymentsReadyToApply

Call this at end of period to get AND apply all unapplied payments that are ready to apply. This API call combines getUnappliedPaymentsReadyToApply and applyARReceiptPayment into one call

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

<?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>
    <getAndApplyUnappliedPaymentsReadyToApply xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TimeStamp>string</TimeStamp>
    </getAndApplyUnappliedPaymentsReadyToApply>
  </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>
    <getAndApplyUnappliedPaymentsReadyToApplyResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getAndApplyUnappliedPaymentsReadyToApplyResult>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </getAndApplyUnappliedPaymentsReadyToApplyResult>
    </getAndApplyUnappliedPaymentsReadyToApplyResponse>
  </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 /PublicAPIService.asmx HTTP/1.1
Host: langcompany.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>
    <getAndApplyUnappliedPaymentsReadyToApply xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <Auth>
        <User>string</User>
        <Password>string</Password>
        <CompanyID>string</CompanyID>
        <Version>string</Version>
        <PartnerToken>string</PartnerToken>
      </Auth>
      <TimeStamp>string</TimeStamp>
    </getAndApplyUnappliedPaymentsReadyToApply>
  </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>
    <getAndApplyUnappliedPaymentsReadyToApplyResponse xmlns="http://digitalgateway.com/WebServices/PublicAPIService">
      <getAndApplyUnappliedPaymentsReadyToApplyResult>
        <Value>boolean</Value>
        <Valid>boolean</Valid>
      </getAndApplyUnappliedPaymentsReadyToApplyResult>
    </getAndApplyUnappliedPaymentsReadyToApplyResponse>
  </soap12:Body>
</soap12:Envelope>