customerMaintenance Web Service

customerMaintenance

Click here for a complete list of operations.

getCustomerBalances

Searches for AR_Balances based on CustID and CpnyID

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/customerMaintenance.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/getCustomerBalances"

<?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>
    <getCustomerBalances xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <custID>string</custID>
      <bSumMultiCpnyDB>boolean</bSumMultiCpnyDB>
    </getCustomerBalances>
  </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>
    <getCustomerBalancesResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getCustomerBalancesResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AccruedRevAgeBal00>double</AccruedRevAgeBal00>
        <AccruedRevAgeBal01>double</AccruedRevAgeBal01>
        <AccruedRevAgeBal02>double</AccruedRevAgeBal02>
        <AccruedRevAgeBal03>double</AccruedRevAgeBal03>
        <AccruedRevAgeBal04>double</AccruedRevAgeBal04>
        <AccruedRevBal>double</AccruedRevBal>
        <AgeBal00>double</AgeBal00>
        <AgeBal01>double</AgeBal01>
        <AgeBal02>double</AgeBal02>
        <AgeBal03>double</AgeBal03>
        <AgeBal04>double</AgeBal04>
        <AvgDayToPay>double</AvgDayToPay>
        <CpnyID>string</CpnyID>
        <CrLmt>double</CrLmt>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CurrBal>double</CurrBal>
        <CuryID>string</CuryID>
        <CuryPromoBal>double</CuryPromoBal>
        <CustID>string</CustID>
        <FutureBal>double</FutureBal>
        <LastActDate>dateTime</LastActDate>
        <LastAgeDate>dateTime</LastAgeDate>
        <LastFinChrgDate>dateTime</LastFinChrgDate>
        <LastInvcDate>dateTime</LastInvcDate>
        <LastStmtBal00>double</LastStmtBal00>
        <LastStmtBal01>double</LastStmtBal01>
        <LastStmtBal02>double</LastStmtBal02>
        <LastStmtBal03>double</LastStmtBal03>
        <LastStmtBal04>double</LastStmtBal04>
        <LastStmtBegBal>double</LastStmtBegBal>
        <LastStmtDate>dateTime</LastStmtDate>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <NbrInvcPaid>double</NbrInvcPaid>
        <NoteID>int</NoteID>
        <PaidInvcDays>double</PaidInvcDays>
        <PerNbr>string</PerNbr>
        <PromoBal>double</PromoBal>
        <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>
        <TotOpenOrd>double</TotOpenOrd>
        <TotPrePay>double</TotPrePay>
        <TotShipped>double</TotShipped>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </getCustomerBalancesResult>
    </getCustomerBalancesResponse>
  </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/customerMaintenance.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>
    <getCustomerBalances xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <custID>string</custID>
      <bSumMultiCpnyDB>boolean</bSumMultiCpnyDB>
    </getCustomerBalances>
  </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>
    <getCustomerBalancesResponse xmlns="http://www.catalinatechnology.com/services/ctDynamicsSL">
      <getCustomerBalancesResult>
        <errorMessage>string</errorMessage>
        <notes>string</notes>
        <resultCode>int</resultCode>
        <AccruedRevAgeBal00>double</AccruedRevAgeBal00>
        <AccruedRevAgeBal01>double</AccruedRevAgeBal01>
        <AccruedRevAgeBal02>double</AccruedRevAgeBal02>
        <AccruedRevAgeBal03>double</AccruedRevAgeBal03>
        <AccruedRevAgeBal04>double</AccruedRevAgeBal04>
        <AccruedRevBal>double</AccruedRevBal>
        <AgeBal00>double</AgeBal00>
        <AgeBal01>double</AgeBal01>
        <AgeBal02>double</AgeBal02>
        <AgeBal03>double</AgeBal03>
        <AgeBal04>double</AgeBal04>
        <AvgDayToPay>double</AvgDayToPay>
        <CpnyID>string</CpnyID>
        <CrLmt>double</CrLmt>
        <Crtd_DateTime>dateTime</Crtd_DateTime>
        <Crtd_Prog>string</Crtd_Prog>
        <Crtd_User>string</Crtd_User>
        <CurrBal>double</CurrBal>
        <CuryID>string</CuryID>
        <CuryPromoBal>double</CuryPromoBal>
        <CustID>string</CustID>
        <FutureBal>double</FutureBal>
        <LastActDate>dateTime</LastActDate>
        <LastAgeDate>dateTime</LastAgeDate>
        <LastFinChrgDate>dateTime</LastFinChrgDate>
        <LastInvcDate>dateTime</LastInvcDate>
        <LastStmtBal00>double</LastStmtBal00>
        <LastStmtBal01>double</LastStmtBal01>
        <LastStmtBal02>double</LastStmtBal02>
        <LastStmtBal03>double</LastStmtBal03>
        <LastStmtBal04>double</LastStmtBal04>
        <LastStmtBegBal>double</LastStmtBegBal>
        <LastStmtDate>dateTime</LastStmtDate>
        <LUpd_DateTime>dateTime</LUpd_DateTime>
        <LUpd_Prog>string</LUpd_Prog>
        <LUpd_User>string</LUpd_User>
        <NbrInvcPaid>double</NbrInvcPaid>
        <NoteID>int</NoteID>
        <PaidInvcDays>double</PaidInvcDays>
        <PerNbr>string</PerNbr>
        <PromoBal>double</PromoBal>
        <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>
        <TotOpenOrd>double</TotOpenOrd>
        <TotPrePay>double</TotPrePay>
        <TotShipped>double</TotShipped>
        <User1>string</User1>
        <User2>string</User2>
        <User3>double</User3>
        <User4>double</User4>
        <User5>string</User5>
        <User6>string</User6>
        <User7>dateTime</User7>
        <User8>dateTime</User8>
      </getCustomerBalancesResult>
    </getCustomerBalancesResponse>
  </soap12:Body>
</soap12:Envelope>