paymentEntry Web Service

paymentEntry

Click here for a complete list of operations.

getBatchesByBatNbr

Gets AR batches based on the passed batNbr

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 /ctapi/services/ctDynamicsSL/paymentEntry.asmx HTTP/1.1
Host: www.catalinatechnology.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.catalinatechnology.com/services/ctDynamicsSL/getBatchesByBatNbr"

<?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:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap:Header>
  <soap:Body>
    <getBatchesByBatNbr xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <batNbr>string</batNbr>
    </getBatchesByBatNbr>
  </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>
    <getBatchesByBatNbrResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getBatchesByBatNbrResult>
        <Batch>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <Acct>string</Acct>
          <AutoRev>short</AutoRev>
          <AutoRevCopy>short</AutoRevCopy>
          <BalanceType>string</BalanceType>
          <BankAcct>string</BankAcct>
          <BankSub>string</BankSub>
          <BaseCuryID>string</BaseCuryID>
          <BatNbr>string</BatNbr>
          <BatType>string</BatType>
          <clearamt>double</clearamt>
          <Cleared>short</Cleared>
          <CpnyID>string</CpnyID>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CrTot>double</CrTot>
          <CtrlTot>double</CtrlTot>
          <CuryCrTot>double</CuryCrTot>
          <CuryCtrlTot>double</CuryCtrlTot>
          <CuryDepositAmt>double</CuryDepositAmt>
          <CuryDrTot>double</CuryDrTot>
          <CuryEffDate>dateTime</CuryEffDate>
          <CuryId>string</CuryId>
          <CuryMultDiv>string</CuryMultDiv>
          <CuryRate>double</CuryRate>
          <CuryRateType>string</CuryRateType>
          <Cycle>short</Cycle>
          <DateClr>dateTime</DateClr>
          <DateEnt>dateTime</DateEnt>
          <DepositAmt>double</DepositAmt>
          <Descr>string</Descr>
          <DrTot>double</DrTot>
          <EditScrnNbr>string</EditScrnNbr>
          <GLPostOpt>string</GLPostOpt>
          <JrnlType>string</JrnlType>
          <LedgerID>string</LedgerID>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <Module>string</Module>
          <NbrCycle>short</NbrCycle>
          <NoteID>int</NoteID>
          <OrigBatNbr>string</OrigBatNbr>
          <OrigCpnyID>string</OrigCpnyID>
          <OrigScrnNbr>string</OrigScrnNbr>
          <PerEnt>string</PerEnt>
          <PerPost>string</PerPost>
          <Rlsed>short</Rlsed>
          <S4Future01>string</S4Future01>
          <S4Future02>string</S4Future02>
          <S4Future03>double</S4Future03>
          <S4Future04>double</S4Future04>
          <S4Future05>double</S4Future05>
          <S4Future06>double</S4Future06>
          <S4Future07>dateTime</S4Future07>
          <S4Future08>dateTime</S4Future08>
          <S4Future09>int</S4Future09>
          <S4Future10>int</S4Future10>
          <S4Future11>string</S4Future11>
          <S4Future12>string</S4Future12>
          <Status>string</Status>
          <Sub>string</Sub>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <VOBatNbrForPP>string</VOBatNbrForPP>
        </Batch>
        <Batch>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <Acct>string</Acct>
          <AutoRev>short</AutoRev>
          <AutoRevCopy>short</AutoRevCopy>
          <BalanceType>string</BalanceType>
          <BankAcct>string</BankAcct>
          <BankSub>string</BankSub>
          <BaseCuryID>string</BaseCuryID>
          <BatNbr>string</BatNbr>
          <BatType>string</BatType>
          <clearamt>double</clearamt>
          <Cleared>short</Cleared>
          <CpnyID>string</CpnyID>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CrTot>double</CrTot>
          <CtrlTot>double</CtrlTot>
          <CuryCrTot>double</CuryCrTot>
          <CuryCtrlTot>double</CuryCtrlTot>
          <CuryDepositAmt>double</CuryDepositAmt>
          <CuryDrTot>double</CuryDrTot>
          <CuryEffDate>dateTime</CuryEffDate>
          <CuryId>string</CuryId>
          <CuryMultDiv>string</CuryMultDiv>
          <CuryRate>double</CuryRate>
          <CuryRateType>string</CuryRateType>
          <Cycle>short</Cycle>
          <DateClr>dateTime</DateClr>
          <DateEnt>dateTime</DateEnt>
          <DepositAmt>double</DepositAmt>
          <Descr>string</Descr>
          <DrTot>double</DrTot>
          <EditScrnNbr>string</EditScrnNbr>
          <GLPostOpt>string</GLPostOpt>
          <JrnlType>string</JrnlType>
          <LedgerID>string</LedgerID>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <Module>string</Module>
          <NbrCycle>short</NbrCycle>
          <NoteID>int</NoteID>
          <OrigBatNbr>string</OrigBatNbr>
          <OrigCpnyID>string</OrigCpnyID>
          <OrigScrnNbr>string</OrigScrnNbr>
          <PerEnt>string</PerEnt>
          <PerPost>string</PerPost>
          <Rlsed>short</Rlsed>
          <S4Future01>string</S4Future01>
          <S4Future02>string</S4Future02>
          <S4Future03>double</S4Future03>
          <S4Future04>double</S4Future04>
          <S4Future05>double</S4Future05>
          <S4Future06>double</S4Future06>
          <S4Future07>dateTime</S4Future07>
          <S4Future08>dateTime</S4Future08>
          <S4Future09>int</S4Future09>
          <S4Future10>int</S4Future10>
          <S4Future11>string</S4Future11>
          <S4Future12>string</S4Future12>
          <Status>string</Status>
          <Sub>string</Sub>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <VOBatNbrForPP>string</VOBatNbrForPP>
        </Batch>
      </getBatchesByBatNbrResult>
    </getBatchesByBatNbrResponse>
  </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 /ctapi/services/ctDynamicsSL/paymentEntry.asmx HTTP/1.1
Host: www.catalinatechnology.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:Header>
    <ctDynamicsSLHeader xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <licenseKey>string</licenseKey>
      <licenseName>string</licenseName>
      <licenseExpiration>string</licenseExpiration>
      <softwareName>string</softwareName>
      <siteID>string</siteID>
      <siteKey>string</siteKey>
      <userName>string</userName>
      <cpnyID>string</cpnyID>
      <apiUsername>string</apiUsername>
      <apiPassword>string</apiPassword>
      <flags>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
        <nameValuePairs>
          <name>string</name>
          <value>string</value>
        </nameValuePairs>
      </flags>
    </ctDynamicsSLHeader>
  </soap12:Header>
  <soap12:Body>
    <getBatchesByBatNbr xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <batNbr>string</batNbr>
    </getBatchesByBatNbr>
  </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>
    <getBatchesByBatNbrResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getBatchesByBatNbrResult>
        <Batch>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <Acct>string</Acct>
          <AutoRev>short</AutoRev>
          <AutoRevCopy>short</AutoRevCopy>
          <BalanceType>string</BalanceType>
          <BankAcct>string</BankAcct>
          <BankSub>string</BankSub>
          <BaseCuryID>string</BaseCuryID>
          <BatNbr>string</BatNbr>
          <BatType>string</BatType>
          <clearamt>double</clearamt>
          <Cleared>short</Cleared>
          <CpnyID>string</CpnyID>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CrTot>double</CrTot>
          <CtrlTot>double</CtrlTot>
          <CuryCrTot>double</CuryCrTot>
          <CuryCtrlTot>double</CuryCtrlTot>
          <CuryDepositAmt>double</CuryDepositAmt>
          <CuryDrTot>double</CuryDrTot>
          <CuryEffDate>dateTime</CuryEffDate>
          <CuryId>string</CuryId>
          <CuryMultDiv>string</CuryMultDiv>
          <CuryRate>double</CuryRate>
          <CuryRateType>string</CuryRateType>
          <Cycle>short</Cycle>
          <DateClr>dateTime</DateClr>
          <DateEnt>dateTime</DateEnt>
          <DepositAmt>double</DepositAmt>
          <Descr>string</Descr>
          <DrTot>double</DrTot>
          <EditScrnNbr>string</EditScrnNbr>
          <GLPostOpt>string</GLPostOpt>
          <JrnlType>string</JrnlType>
          <LedgerID>string</LedgerID>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <Module>string</Module>
          <NbrCycle>short</NbrCycle>
          <NoteID>int</NoteID>
          <OrigBatNbr>string</OrigBatNbr>
          <OrigCpnyID>string</OrigCpnyID>
          <OrigScrnNbr>string</OrigScrnNbr>
          <PerEnt>string</PerEnt>
          <PerPost>string</PerPost>
          <Rlsed>short</Rlsed>
          <S4Future01>string</S4Future01>
          <S4Future02>string</S4Future02>
          <S4Future03>double</S4Future03>
          <S4Future04>double</S4Future04>
          <S4Future05>double</S4Future05>
          <S4Future06>double</S4Future06>
          <S4Future07>dateTime</S4Future07>
          <S4Future08>dateTime</S4Future08>
          <S4Future09>int</S4Future09>
          <S4Future10>int</S4Future10>
          <S4Future11>string</S4Future11>
          <S4Future12>string</S4Future12>
          <Status>string</Status>
          <Sub>string</Sub>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <VOBatNbrForPP>string</VOBatNbrForPP>
        </Batch>
        <Batch>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <Acct>string</Acct>
          <AutoRev>short</AutoRev>
          <AutoRevCopy>short</AutoRevCopy>
          <BalanceType>string</BalanceType>
          <BankAcct>string</BankAcct>
          <BankSub>string</BankSub>
          <BaseCuryID>string</BaseCuryID>
          <BatNbr>string</BatNbr>
          <BatType>string</BatType>
          <clearamt>double</clearamt>
          <Cleared>short</Cleared>
          <CpnyID>string</CpnyID>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CrTot>double</CrTot>
          <CtrlTot>double</CtrlTot>
          <CuryCrTot>double</CuryCrTot>
          <CuryCtrlTot>double</CuryCtrlTot>
          <CuryDepositAmt>double</CuryDepositAmt>
          <CuryDrTot>double</CuryDrTot>
          <CuryEffDate>dateTime</CuryEffDate>
          <CuryId>string</CuryId>
          <CuryMultDiv>string</CuryMultDiv>
          <CuryRate>double</CuryRate>
          <CuryRateType>string</CuryRateType>
          <Cycle>short</Cycle>
          <DateClr>dateTime</DateClr>
          <DateEnt>dateTime</DateEnt>
          <DepositAmt>double</DepositAmt>
          <Descr>string</Descr>
          <DrTot>double</DrTot>
          <EditScrnNbr>string</EditScrnNbr>
          <GLPostOpt>string</GLPostOpt>
          <JrnlType>string</JrnlType>
          <LedgerID>string</LedgerID>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <Module>string</Module>
          <NbrCycle>short</NbrCycle>
          <NoteID>int</NoteID>
          <OrigBatNbr>string</OrigBatNbr>
          <OrigCpnyID>string</OrigCpnyID>
          <OrigScrnNbr>string</OrigScrnNbr>
          <PerEnt>string</PerEnt>
          <PerPost>string</PerPost>
          <Rlsed>short</Rlsed>
          <S4Future01>string</S4Future01>
          <S4Future02>string</S4Future02>
          <S4Future03>double</S4Future03>
          <S4Future04>double</S4Future04>
          <S4Future05>double</S4Future05>
          <S4Future06>double</S4Future06>
          <S4Future07>dateTime</S4Future07>
          <S4Future08>dateTime</S4Future08>
          <S4Future09>int</S4Future09>
          <S4Future10>int</S4Future10>
          <S4Future11>string</S4Future11>
          <S4Future12>string</S4Future12>
          <Status>string</Status>
          <Sub>string</Sub>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <VOBatNbrForPP>string</VOBatNbrForPP>
        </Batch>
      </getBatchesByBatNbrResult>
    </getBatchesByBatNbrResponse>
  </soap12:Body>
</soap12:Envelope>