ApService


Click here for a complete list of operations.

GetPaymentSchedule

Get payment schedule for a merchant log.

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 /services/APService.asmx HTTP/1.1
Host: services.encompass-suite.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://aocsolutions.com/EncompassWebServices/GetPaymentSchedule"

<?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>
    <GetPaymentSchedule xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MerchantLogUniqueID>string</MerchantLogUniqueID>
      </request>
    </GetPaymentSchedule>
  </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>
    <GetPaymentScheduleResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <GetPaymentScheduleResult>
        <ResponseCode>Success or Failed or InvalidUserCredentials or AwaitingApproval or InvalidUserDefinedFieldname or NoPrivilege or MerchantLogNotFound or StandardFieldValidationFailed or UserDefinedFieldValidationFailed or InvalidOrganization or UnavailableAtThisTime or InsufficientCreditLimit or NotFound or InvalidProductCode</ResponseCode>
        <Description>string</Description>
        <PaymentSchedule>
          <PaymentScheduleItemResponse>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
            <ProcessedDate>dateTime</ProcessedDate>
          </PaymentScheduleItemResponse>
          <PaymentScheduleItemResponse>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
            <ProcessedDate>dateTime</ProcessedDate>
          </PaymentScheduleItemResponse>
        </PaymentSchedule>
      </GetPaymentScheduleResult>
    </GetPaymentScheduleResponse>
  </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 /services/APService.asmx HTTP/1.1
Host: services.encompass-suite.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>
    <GetPaymentSchedule xmlns="http://aocsolutions.com/EncompassWebServices/">
      <user>
        <OrgGroupLoginId>string</OrgGroupLoginId>
        <Username>string</Username>
        <Password>string</Password>
      </user>
      <request>
        <BankNumber>string</BankNumber>
        <CompanyNumber>string</CompanyNumber>
        <MerchantLogUniqueID>string</MerchantLogUniqueID>
      </request>
    </GetPaymentSchedule>
  </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>
    <GetPaymentScheduleResponse xmlns="http://aocsolutions.com/EncompassWebServices/">
      <GetPaymentScheduleResult>
        <ResponseCode>Success or Failed or InvalidUserCredentials or AwaitingApproval or InvalidUserDefinedFieldname or NoPrivilege or MerchantLogNotFound or StandardFieldValidationFailed or UserDefinedFieldValidationFailed or InvalidOrganization or UnavailableAtThisTime or InsufficientCreditLimit or NotFound or InvalidProductCode</ResponseCode>
        <Description>string</Description>
        <PaymentSchedule>
          <PaymentScheduleItemResponse>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
            <ProcessedDate>dateTime</ProcessedDate>
          </PaymentScheduleItemResponse>
          <PaymentScheduleItemResponse>
            <ActiveFromDate>dateTime</ActiveFromDate>
            <ActiveToDate>dateTime</ActiveToDate>
            <Amount>decimal</Amount>
            <CreditLimit>decimal</CreditLimit>
            <ProcessedDate>dateTime</ProcessedDate>
          </PaymentScheduleItemResponse>
        </PaymentSchedule>
      </GetPaymentScheduleResult>
    </GetPaymentScheduleResponse>
  </soap12:Body>
</soap12:Envelope>