wsEvents


Click here for a complete list of operations.

getBatches

Returns a collections of Batches found given Status and optionally start and end dates for search. Given just status, will return today's batches with that status. Acceptable Status are Listed by BatchStatusName in BatchStatusRef Table. Typically Closed, Open, Review or Ready

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
BatchStatus:
BeginDate:
EndDate:

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

<?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>
    <getBatches xmlns="http://www.atsol.org/wsEvents/">
      <BatchStatus>string</BatchStatus>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </getBatches>
  </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>
    <getBatchesResponse xmlns="http://www.atsol.org/wsEvents/">
      <getBatchesResult>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
        <ResultBatches>
          <cBatch>
            <ARGLAccount>string</ARGLAccount>
            <ARPseudo>string</ARPseudo>
            <BatchNumber>string</BatchNumber>
            <CashAccountCode>string</CashAccountCode>
            <CashEntity>string</CashEntity>
            <CashGLAccount>string</CashGLAccount>
            <CashPseudo>string</CashPseudo>
            <ControlCash>decimal</ControlCash>
            <ControlCount>int</ControlCount>
            <Controlled>boolean</Controlled>
            <CreatedBy>string</CreatedBy>
            <DateCreated>dateTime</DateCreated>
            <Description>string</Description>
            <DuesCycleFlag>boolean</DuesCycleFlag>
            <EffectiveDate>dateTime</EffectiveDate>
            <EventCode>string</EventCode>
            <FinancialEntityCode>string</FinancialEntityCode>
            <LastUpdated>dateTime</LastUpdated>
            <HasExportedTrans>boolean</HasExportedTrans>
            <PostingStatus>string</PostingStatus>
            <SourceSystem>string</SourceSystem>
            <TransCash>decimal</TransCash>
            <TransCount>int</TransCount>
            <UpdatedBy>string</UpdatedBy>
          </cBatch>
          <cBatch>
            <ARGLAccount>string</ARGLAccount>
            <ARPseudo>string</ARPseudo>
            <BatchNumber>string</BatchNumber>
            <CashAccountCode>string</CashAccountCode>
            <CashEntity>string</CashEntity>
            <CashGLAccount>string</CashGLAccount>
            <CashPseudo>string</CashPseudo>
            <ControlCash>decimal</ControlCash>
            <ControlCount>int</ControlCount>
            <Controlled>boolean</Controlled>
            <CreatedBy>string</CreatedBy>
            <DateCreated>dateTime</DateCreated>
            <Description>string</Description>
            <DuesCycleFlag>boolean</DuesCycleFlag>
            <EffectiveDate>dateTime</EffectiveDate>
            <EventCode>string</EventCode>
            <FinancialEntityCode>string</FinancialEntityCode>
            <LastUpdated>dateTime</LastUpdated>
            <HasExportedTrans>boolean</HasExportedTrans>
            <PostingStatus>string</PostingStatus>
            <SourceSystem>string</SourceSystem>
            <TransCash>decimal</TransCash>
            <TransCount>int</TransCount>
            <UpdatedBy>string</UpdatedBy>
          </cBatch>
        </ResultBatches>
      </getBatchesResult>
    </getBatchesResponse>
  </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>
    <getBatches xmlns="http://www.atsol.org/wsEvents/">
      <BatchStatus>string</BatchStatus>
      <BeginDate>string</BeginDate>
      <EndDate>string</EndDate>
    </getBatches>
  </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>
    <getBatchesResponse xmlns="http://www.atsol.org/wsEvents/">
      <getBatchesResult>
        <ResultCode>int</ResultCode>
        <ResultMessage>string</ResultMessage>
        <ResultBatches>
          <cBatch>
            <ARGLAccount>string</ARGLAccount>
            <ARPseudo>string</ARPseudo>
            <BatchNumber>string</BatchNumber>
            <CashAccountCode>string</CashAccountCode>
            <CashEntity>string</CashEntity>
            <CashGLAccount>string</CashGLAccount>
            <CashPseudo>string</CashPseudo>
            <ControlCash>decimal</ControlCash>
            <ControlCount>int</ControlCount>
            <Controlled>boolean</Controlled>
            <CreatedBy>string</CreatedBy>
            <DateCreated>dateTime</DateCreated>
            <Description>string</Description>
            <DuesCycleFlag>boolean</DuesCycleFlag>
            <EffectiveDate>dateTime</EffectiveDate>
            <EventCode>string</EventCode>
            <FinancialEntityCode>string</FinancialEntityCode>
            <LastUpdated>dateTime</LastUpdated>
            <HasExportedTrans>boolean</HasExportedTrans>
            <PostingStatus>string</PostingStatus>
            <SourceSystem>string</SourceSystem>
            <TransCash>decimal</TransCash>
            <TransCount>int</TransCount>
            <UpdatedBy>string</UpdatedBy>
          </cBatch>
          <cBatch>
            <ARGLAccount>string</ARGLAccount>
            <ARPseudo>string</ARPseudo>
            <BatchNumber>string</BatchNumber>
            <CashAccountCode>string</CashAccountCode>
            <CashEntity>string</CashEntity>
            <CashGLAccount>string</CashGLAccount>
            <CashPseudo>string</CashPseudo>
            <ControlCash>decimal</ControlCash>
            <ControlCount>int</ControlCount>
            <Controlled>boolean</Controlled>
            <CreatedBy>string</CreatedBy>
            <DateCreated>dateTime</DateCreated>
            <Description>string</Description>
            <DuesCycleFlag>boolean</DuesCycleFlag>
            <EffectiveDate>dateTime</EffectiveDate>
            <EventCode>string</EventCode>
            <FinancialEntityCode>string</FinancialEntityCode>
            <LastUpdated>dateTime</LastUpdated>
            <HasExportedTrans>boolean</HasExportedTrans>
            <PostingStatus>string</PostingStatus>
            <SourceSystem>string</SourceSystem>
            <TransCash>decimal</TransCash>
            <TransCount>int</TransCount>
            <UpdatedBy>string</UpdatedBy>
          </cBatch>
        </ResultBatches>
      </getBatchesResult>
    </getBatchesResponse>
  </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/getBatches?BatchStatus=string&BeginDate=string&EndDate=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"?>
<BatchSet xmlns="http://www.atsol.org/wsEvents/">
  <ResultCode>int</ResultCode>
  <ResultMessage>string</ResultMessage>
  <ResultBatches>
    <cBatch>
      <ARGLAccount>string</ARGLAccount>
      <ARPseudo>string</ARPseudo>
      <BatchNumber>string</BatchNumber>
      <CashAccountCode>string</CashAccountCode>
      <CashEntity>string</CashEntity>
      <CashGLAccount>string</CashGLAccount>
      <CashPseudo>string</CashPseudo>
      <ControlCash>decimal</ControlCash>
      <ControlCount>int</ControlCount>
      <Controlled>boolean</Controlled>
      <CreatedBy>string</CreatedBy>
      <DateCreated>dateTime</DateCreated>
      <Description>string</Description>
      <DuesCycleFlag>boolean</DuesCycleFlag>
      <EffectiveDate>dateTime</EffectiveDate>
      <EventCode>string</EventCode>
      <FinancialEntityCode>string</FinancialEntityCode>
      <LastUpdated>dateTime</LastUpdated>
      <HasExportedTrans>boolean</HasExportedTrans>
      <PostingStatus>string</PostingStatus>
      <SourceSystem>string</SourceSystem>
      <TransCash>decimal</TransCash>
      <TransCount>int</TransCount>
      <UpdatedBy>string</UpdatedBy>
    </cBatch>
    <cBatch>
      <ARGLAccount>string</ARGLAccount>
      <ARPseudo>string</ARPseudo>
      <BatchNumber>string</BatchNumber>
      <CashAccountCode>string</CashAccountCode>
      <CashEntity>string</CashEntity>
      <CashGLAccount>string</CashGLAccount>
      <CashPseudo>string</CashPseudo>
      <ControlCash>decimal</ControlCash>
      <ControlCount>int</ControlCount>
      <Controlled>boolean</Controlled>
      <CreatedBy>string</CreatedBy>
      <DateCreated>dateTime</DateCreated>
      <Description>string</Description>
      <DuesCycleFlag>boolean</DuesCycleFlag>
      <EffectiveDate>dateTime</EffectiveDate>
      <EventCode>string</EventCode>
      <FinancialEntityCode>string</FinancialEntityCode>
      <LastUpdated>dateTime</LastUpdated>
      <HasExportedTrans>boolean</HasExportedTrans>
      <PostingStatus>string</PostingStatus>
      <SourceSystem>string</SourceSystem>
      <TransCash>decimal</TransCash>
      <TransCount>int</TransCount>
      <UpdatedBy>string</UpdatedBy>
    </cBatch>
  </ResultBatches>
</BatchSet>

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/getBatches HTTP/1.1
Host: demo.atsol.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

BatchStatus=string&BeginDate=string&EndDate=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<BatchSet xmlns="http://www.atsol.org/wsEvents/">
  <ResultCode>int</ResultCode>
  <ResultMessage>string</ResultMessage>
  <ResultBatches>
    <cBatch>
      <ARGLAccount>string</ARGLAccount>
      <ARPseudo>string</ARPseudo>
      <BatchNumber>string</BatchNumber>
      <CashAccountCode>string</CashAccountCode>
      <CashEntity>string</CashEntity>
      <CashGLAccount>string</CashGLAccount>
      <CashPseudo>string</CashPseudo>
      <ControlCash>decimal</ControlCash>
      <ControlCount>int</ControlCount>
      <Controlled>boolean</Controlled>
      <CreatedBy>string</CreatedBy>
      <DateCreated>dateTime</DateCreated>
      <Description>string</Description>
      <DuesCycleFlag>boolean</DuesCycleFlag>
      <EffectiveDate>dateTime</EffectiveDate>
      <EventCode>string</EventCode>
      <FinancialEntityCode>string</FinancialEntityCode>
      <LastUpdated>dateTime</LastUpdated>
      <HasExportedTrans>boolean</HasExportedTrans>
      <PostingStatus>string</PostingStatus>
      <SourceSystem>string</SourceSystem>
      <TransCash>decimal</TransCash>
      <TransCount>int</TransCount>
      <UpdatedBy>string</UpdatedBy>
    </cBatch>
    <cBatch>
      <ARGLAccount>string</ARGLAccount>
      <ARPseudo>string</ARPseudo>
      <BatchNumber>string</BatchNumber>
      <CashAccountCode>string</CashAccountCode>
      <CashEntity>string</CashEntity>
      <CashGLAccount>string</CashGLAccount>
      <CashPseudo>string</CashPseudo>
      <ControlCash>decimal</ControlCash>
      <ControlCount>int</ControlCount>
      <Controlled>boolean</Controlled>
      <CreatedBy>string</CreatedBy>
      <DateCreated>dateTime</DateCreated>
      <Description>string</Description>
      <DuesCycleFlag>boolean</DuesCycleFlag>
      <EffectiveDate>dateTime</EffectiveDate>
      <EventCode>string</EventCode>
      <FinancialEntityCode>string</FinancialEntityCode>
      <LastUpdated>dateTime</LastUpdated>
      <HasExportedTrans>boolean</HasExportedTrans>
      <PostingStatus>string</PostingStatus>
      <SourceSystem>string</SourceSystem>
      <TransCash>decimal</TransCash>
      <TransCount>int</TransCount>
      <UpdatedBy>string</UpdatedBy>
    </cBatch>
  </ResultBatches>
</BatchSet>