wsEvents


Click here for a complete list of operations.

getSimpleBatch

Returns a valid BatchNumber, BatchCashAccount, and PaymentCashAccount from iMIS. If the batch does not exist, this method will create it. In the getBatchDetailsObject. Parameters: batchEntity is the Financial Entity of the Batch (can be blank). batchMask is used to define the batch name. the characters YY will be replaced with the year, MM with the month, and DD as the day. batchDescription will be the description of the batch. batchCashAccount must be a valid cash account. batchEventCode is optional and will be used to separate events into separate batches. It can be blank. It will return the BatchNumber, BatchCashAccount (this is the cash account that was use to create the batch), PaymentCashAccount (this is the cash account that you should use when processing associated payments with this transaction and is based on the PaymentType and the setup in the BATCH_SETTINGS_ general lookup table. Additional information on the setup of the BATCH_SETTINGS table is in the documentation.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
batchEntity:
batchMask:
batchDescription:
batchDate:
batchCashAccount:
batchEventCode:

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 /WebServices/wsEvents.asmx HTTP/1.1
Host: demo.atsol.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.atsol.org/wsEvents/getSimpleBatch"

<?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>
    <getSimpleBatch xmlns="http://www.atsol.org/wsEvents/">
      <batchEntity>string</batchEntity>
      <batchMask>string</batchMask>
      <batchDescription>string</batchDescription>
      <batchDate>dateTime</batchDate>
      <batchCashAccount>string</batchCashAccount>
      <batchEventCode>string</batchEventCode>
    </getSimpleBatch>
  </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>
    <getSimpleBatchResponse xmlns="http://www.atsol.org/wsEvents/">
      <getSimpleBatchResult>
        <BatchNumber>string</BatchNumber>
        <BatchCashAccount>string</BatchCashAccount>
        <PaymentCashAccount>string</PaymentCashAccount>
        <ProcessorCashAccount>string</ProcessorCashAccount>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
      </getSimpleBatchResult>
    </getSimpleBatchResponse>
  </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 /WebServices/wsEvents.asmx HTTP/1.1
Host: demo.atsol.org
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>
    <getSimpleBatch xmlns="http://www.atsol.org/wsEvents/">
      <batchEntity>string</batchEntity>
      <batchMask>string</batchMask>
      <batchDescription>string</batchDescription>
      <batchDate>dateTime</batchDate>
      <batchCashAccount>string</batchCashAccount>
      <batchEventCode>string</batchEventCode>
    </getSimpleBatch>
  </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>
    <getSimpleBatchResponse xmlns="http://www.atsol.org/wsEvents/">
      <getSimpleBatchResult>
        <BatchNumber>string</BatchNumber>
        <BatchCashAccount>string</BatchCashAccount>
        <PaymentCashAccount>string</PaymentCashAccount>
        <ProcessorCashAccount>string</ProcessorCashAccount>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
      </getSimpleBatchResult>
    </getSimpleBatchResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /WebServices/wsEvents.asmx/getSimpleBatch?batchEntity=string&batchMask=string&batchDescription=string&batchDate=string&batchCashAccount=string&batchEventCode=string HTTP/1.1
Host: demo.atsol.org
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BatchObj xmlns="http://www.atsol.org/wsEvents/">
  <BatchNumber>string</BatchNumber>
  <BatchCashAccount>string</BatchCashAccount>
  <PaymentCashAccount>string</PaymentCashAccount>
  <ProcessorCashAccount>string</ProcessorCashAccount>
  <ResultCode>int</ResultCode>
  <ResultMessage>string</ResultMessage>
</BatchObj>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /WebServices/wsEvents.asmx/getSimpleBatch HTTP/1.1
Host: demo.atsol.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

batchEntity=string&batchMask=string&batchDescription=string&batchDate=string&batchCashAccount=string&batchEventCode=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BatchObj xmlns="http://www.atsol.org/wsEvents/">
  <BatchNumber>string</BatchNumber>
  <BatchCashAccount>string</BatchCashAccount>
  <PaymentCashAccount>string</PaymentCashAccount>
  <ProcessorCashAccount>string</ProcessorCashAccount>
  <ResultCode>int</ResultCode>
  <ResultMessage>string</ResultMessage>
</BatchObj>