customers Web Service

customers

Click here for a complete list of operations.

getArAccountsAsArray

Retrieves all AR Accounts. Calls: xct_spDSLGetArAccounts

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/customers.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/getArAccountsAsArray"

<?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>
    <getArAccountsAsArray xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL" />
  </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>
    <getArAccountsAsArrayResponse xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <getArAccountsAsArrayResult>
        <ARSetup>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <AnnFinChrg>double</AnnFinChrg>
          <ArAcct>string</ArAcct>
          <ArSub>string</ArSub>
          <AutoApplyWO>short</AutoApplyWO>
          <AutoBatRpt>short</AutoBatRpt>
          <AutoNSF>short</AutoNSF>
          <AutoRef>short</AutoRef>
          <ChkAcct>string</ChkAcct>
          <ChkSub>string</ChkSub>
          <ChrgMin>short</ChrgMin>
          <CompdFinChrg>short</CompdFinChrg>
          <CreditHoldType>string</CreditHoldType>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CurrPerNbr>string</CurrPerNbr>
          <CustViewDflt>string</CustViewDflt>
          <DaysPastDue>short</DaysPastDue>
          <DecPlPrcCst>short</DecPlPrcCst>
          <DecPlQty>short</DecPlQty>
          <DfltAutoApply>short</DfltAutoApply>
          <DfltClass>string</DfltClass>
          <DfltNSFAcct>string</DfltNSFAcct>
          <DfltNSFSub>string</DfltNSFSub>
          <DfltSBWOAcct>string</DfltSBWOAcct>
          <DfltSBWOSub>string</DfltSBWOSub>
          <DfltSCWOAcct>string</DfltSCWOAcct>
          <DfltSCWOSub>string</DfltSCWOSub>
          <DfltStmtCycle>string</DfltStmtCycle>
          <DfltStmtType>string</DfltStmtType>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <DiscCpnyFromInvc>short</DiscCpnyFromInvc>
          <FinChrgAcct>string</FinChrgAcct>
          <FinChrgFirst>string</FinChrgFirst>
          <FinChrgSub>string</FinChrgSub>
          <GLPostOpt>string</GLPostOpt>
          <IncAcct>string</IncAcct>
          <IncSub>string</IncSub>
          <Init>short</Init>
          <LastBatNbr>string</LastBatNbr>
          <LastCrMemoNbr>string</LastCrMemoNbr>
          <LastDrMemoNbr>string</LastDrMemoNbr>
          <LastFinChrgRefNbr>string</LastFinChrgRefNbr>
          <LastRefNbr>string</LastRefNbr>
          <LastWORefNbr>string</LastWORefNbr>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MCuryBatRpt>short</MCuryBatRpt>
          <MinFinChrg>double</MinFinChrg>
          <Nbr0803Docs>short</Nbr0803Docs>
          <NoteId>int</NoteId>
          <NSFChrg>double</NSFChrg>
          <OverLimitAmt>double</OverLimitAmt>
          <OverLimitType>string</OverLimitType>
          <PASortDflt>string</PASortDflt>
          <PerNbr>string</PerNbr>
          <PerRetHist>short</PerRetHist>
          <PerRetStmtDtl>short</PerRetStmtDtl>
          <PerRetTran>short</PerRetTran>
          <PrePayAcct>string</PrePayAcct>
          <PrePaySub>string</PrePaySub>
          <RetAllowAcct>string</RetAllowAcct>
          <RetAllowSub>string</RetAllowSub>
          <RetAvgDay>short</RetAvgDay>
          <RfndAcct>string</RfndAcct>
          <RfndSub>string</RfndSub>
          <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>
          <S4Future13>string</S4Future13>
          <SBLimit>double</SBLimit>
          <SetupId>string</SetupId>
          <SlsTax>short</SlsTax>
          <SlsTaxDflt>string</SlsTaxDflt>
          <TranDescDflt>string</TranDescDflt>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <WarningLvlLimit>short</WarningLvlLimit>
        </ARSetup>
        <ARSetup>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <AnnFinChrg>double</AnnFinChrg>
          <ArAcct>string</ArAcct>
          <ArSub>string</ArSub>
          <AutoApplyWO>short</AutoApplyWO>
          <AutoBatRpt>short</AutoBatRpt>
          <AutoNSF>short</AutoNSF>
          <AutoRef>short</AutoRef>
          <ChkAcct>string</ChkAcct>
          <ChkSub>string</ChkSub>
          <ChrgMin>short</ChrgMin>
          <CompdFinChrg>short</CompdFinChrg>
          <CreditHoldType>string</CreditHoldType>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CurrPerNbr>string</CurrPerNbr>
          <CustViewDflt>string</CustViewDflt>
          <DaysPastDue>short</DaysPastDue>
          <DecPlPrcCst>short</DecPlPrcCst>
          <DecPlQty>short</DecPlQty>
          <DfltAutoApply>short</DfltAutoApply>
          <DfltClass>string</DfltClass>
          <DfltNSFAcct>string</DfltNSFAcct>
          <DfltNSFSub>string</DfltNSFSub>
          <DfltSBWOAcct>string</DfltSBWOAcct>
          <DfltSBWOSub>string</DfltSBWOSub>
          <DfltSCWOAcct>string</DfltSCWOAcct>
          <DfltSCWOSub>string</DfltSCWOSub>
          <DfltStmtCycle>string</DfltStmtCycle>
          <DfltStmtType>string</DfltStmtType>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <DiscCpnyFromInvc>short</DiscCpnyFromInvc>
          <FinChrgAcct>string</FinChrgAcct>
          <FinChrgFirst>string</FinChrgFirst>
          <FinChrgSub>string</FinChrgSub>
          <GLPostOpt>string</GLPostOpt>
          <IncAcct>string</IncAcct>
          <IncSub>string</IncSub>
          <Init>short</Init>
          <LastBatNbr>string</LastBatNbr>
          <LastCrMemoNbr>string</LastCrMemoNbr>
          <LastDrMemoNbr>string</LastDrMemoNbr>
          <LastFinChrgRefNbr>string</LastFinChrgRefNbr>
          <LastRefNbr>string</LastRefNbr>
          <LastWORefNbr>string</LastWORefNbr>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MCuryBatRpt>short</MCuryBatRpt>
          <MinFinChrg>double</MinFinChrg>
          <Nbr0803Docs>short</Nbr0803Docs>
          <NoteId>int</NoteId>
          <NSFChrg>double</NSFChrg>
          <OverLimitAmt>double</OverLimitAmt>
          <OverLimitType>string</OverLimitType>
          <PASortDflt>string</PASortDflt>
          <PerNbr>string</PerNbr>
          <PerRetHist>short</PerRetHist>
          <PerRetStmtDtl>short</PerRetStmtDtl>
          <PerRetTran>short</PerRetTran>
          <PrePayAcct>string</PrePayAcct>
          <PrePaySub>string</PrePaySub>
          <RetAllowAcct>string</RetAllowAcct>
          <RetAllowSub>string</RetAllowSub>
          <RetAvgDay>short</RetAvgDay>
          <RfndAcct>string</RfndAcct>
          <RfndSub>string</RfndSub>
          <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>
          <S4Future13>string</S4Future13>
          <SBLimit>double</SBLimit>
          <SetupId>string</SetupId>
          <SlsTax>short</SlsTax>
          <SlsTaxDflt>string</SlsTaxDflt>
          <TranDescDflt>string</TranDescDflt>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <WarningLvlLimit>short</WarningLvlLimit>
        </ARSetup>
      </getArAccountsAsArrayResult>
    </getArAccountsAsArrayResponse>
  </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/customers.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>
    <getArAccountsAsArray xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL" />
  </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>
    <getArAccountsAsArrayResponse xmlns="http://www.catalinaTechnology.com/services/ctDynamicsSL">
      <getArAccountsAsArrayResult>
        <ARSetup>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <AnnFinChrg>double</AnnFinChrg>
          <ArAcct>string</ArAcct>
          <ArSub>string</ArSub>
          <AutoApplyWO>short</AutoApplyWO>
          <AutoBatRpt>short</AutoBatRpt>
          <AutoNSF>short</AutoNSF>
          <AutoRef>short</AutoRef>
          <ChkAcct>string</ChkAcct>
          <ChkSub>string</ChkSub>
          <ChrgMin>short</ChrgMin>
          <CompdFinChrg>short</CompdFinChrg>
          <CreditHoldType>string</CreditHoldType>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CurrPerNbr>string</CurrPerNbr>
          <CustViewDflt>string</CustViewDflt>
          <DaysPastDue>short</DaysPastDue>
          <DecPlPrcCst>short</DecPlPrcCst>
          <DecPlQty>short</DecPlQty>
          <DfltAutoApply>short</DfltAutoApply>
          <DfltClass>string</DfltClass>
          <DfltNSFAcct>string</DfltNSFAcct>
          <DfltNSFSub>string</DfltNSFSub>
          <DfltSBWOAcct>string</DfltSBWOAcct>
          <DfltSBWOSub>string</DfltSBWOSub>
          <DfltSCWOAcct>string</DfltSCWOAcct>
          <DfltSCWOSub>string</DfltSCWOSub>
          <DfltStmtCycle>string</DfltStmtCycle>
          <DfltStmtType>string</DfltStmtType>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <DiscCpnyFromInvc>short</DiscCpnyFromInvc>
          <FinChrgAcct>string</FinChrgAcct>
          <FinChrgFirst>string</FinChrgFirst>
          <FinChrgSub>string</FinChrgSub>
          <GLPostOpt>string</GLPostOpt>
          <IncAcct>string</IncAcct>
          <IncSub>string</IncSub>
          <Init>short</Init>
          <LastBatNbr>string</LastBatNbr>
          <LastCrMemoNbr>string</LastCrMemoNbr>
          <LastDrMemoNbr>string</LastDrMemoNbr>
          <LastFinChrgRefNbr>string</LastFinChrgRefNbr>
          <LastRefNbr>string</LastRefNbr>
          <LastWORefNbr>string</LastWORefNbr>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MCuryBatRpt>short</MCuryBatRpt>
          <MinFinChrg>double</MinFinChrg>
          <Nbr0803Docs>short</Nbr0803Docs>
          <NoteId>int</NoteId>
          <NSFChrg>double</NSFChrg>
          <OverLimitAmt>double</OverLimitAmt>
          <OverLimitType>string</OverLimitType>
          <PASortDflt>string</PASortDflt>
          <PerNbr>string</PerNbr>
          <PerRetHist>short</PerRetHist>
          <PerRetStmtDtl>short</PerRetStmtDtl>
          <PerRetTran>short</PerRetTran>
          <PrePayAcct>string</PrePayAcct>
          <PrePaySub>string</PrePaySub>
          <RetAllowAcct>string</RetAllowAcct>
          <RetAllowSub>string</RetAllowSub>
          <RetAvgDay>short</RetAvgDay>
          <RfndAcct>string</RfndAcct>
          <RfndSub>string</RfndSub>
          <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>
          <S4Future13>string</S4Future13>
          <SBLimit>double</SBLimit>
          <SetupId>string</SetupId>
          <SlsTax>short</SlsTax>
          <SlsTaxDflt>string</SlsTaxDflt>
          <TranDescDflt>string</TranDescDflt>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <WarningLvlLimit>short</WarningLvlLimit>
        </ARSetup>
        <ARSetup>
          <errorMessage>string</errorMessage>
          <notes>string</notes>
          <resultCode>int</resultCode>
          <AnnFinChrg>double</AnnFinChrg>
          <ArAcct>string</ArAcct>
          <ArSub>string</ArSub>
          <AutoApplyWO>short</AutoApplyWO>
          <AutoBatRpt>short</AutoBatRpt>
          <AutoNSF>short</AutoNSF>
          <AutoRef>short</AutoRef>
          <ChkAcct>string</ChkAcct>
          <ChkSub>string</ChkSub>
          <ChrgMin>short</ChrgMin>
          <CompdFinChrg>short</CompdFinChrg>
          <CreditHoldType>string</CreditHoldType>
          <Crtd_DateTime>dateTime</Crtd_DateTime>
          <Crtd_Prog>string</Crtd_Prog>
          <Crtd_User>string</Crtd_User>
          <CurrPerNbr>string</CurrPerNbr>
          <CustViewDflt>string</CustViewDflt>
          <DaysPastDue>short</DaysPastDue>
          <DecPlPrcCst>short</DecPlPrcCst>
          <DecPlQty>short</DecPlQty>
          <DfltAutoApply>short</DfltAutoApply>
          <DfltClass>string</DfltClass>
          <DfltNSFAcct>string</DfltNSFAcct>
          <DfltNSFSub>string</DfltNSFSub>
          <DfltSBWOAcct>string</DfltSBWOAcct>
          <DfltSBWOSub>string</DfltSBWOSub>
          <DfltSCWOAcct>string</DfltSCWOAcct>
          <DfltSCWOSub>string</DfltSCWOSub>
          <DfltStmtCycle>string</DfltStmtCycle>
          <DfltStmtType>string</DfltStmtType>
          <DiscAcct>string</DiscAcct>
          <DiscSub>string</DiscSub>
          <DiscCpnyFromInvc>short</DiscCpnyFromInvc>
          <FinChrgAcct>string</FinChrgAcct>
          <FinChrgFirst>string</FinChrgFirst>
          <FinChrgSub>string</FinChrgSub>
          <GLPostOpt>string</GLPostOpt>
          <IncAcct>string</IncAcct>
          <IncSub>string</IncSub>
          <Init>short</Init>
          <LastBatNbr>string</LastBatNbr>
          <LastCrMemoNbr>string</LastCrMemoNbr>
          <LastDrMemoNbr>string</LastDrMemoNbr>
          <LastFinChrgRefNbr>string</LastFinChrgRefNbr>
          <LastRefNbr>string</LastRefNbr>
          <LastWORefNbr>string</LastWORefNbr>
          <LUpd_DateTime>dateTime</LUpd_DateTime>
          <LUpd_Prog>string</LUpd_Prog>
          <LUpd_User>string</LUpd_User>
          <MCuryBatRpt>short</MCuryBatRpt>
          <MinFinChrg>double</MinFinChrg>
          <Nbr0803Docs>short</Nbr0803Docs>
          <NoteId>int</NoteId>
          <NSFChrg>double</NSFChrg>
          <OverLimitAmt>double</OverLimitAmt>
          <OverLimitType>string</OverLimitType>
          <PASortDflt>string</PASortDflt>
          <PerNbr>string</PerNbr>
          <PerRetHist>short</PerRetHist>
          <PerRetStmtDtl>short</PerRetStmtDtl>
          <PerRetTran>short</PerRetTran>
          <PrePayAcct>string</PrePayAcct>
          <PrePaySub>string</PrePaySub>
          <RetAllowAcct>string</RetAllowAcct>
          <RetAllowSub>string</RetAllowSub>
          <RetAvgDay>short</RetAvgDay>
          <RfndAcct>string</RfndAcct>
          <RfndSub>string</RfndSub>
          <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>
          <S4Future13>string</S4Future13>
          <SBLimit>double</SBLimit>
          <SetupId>string</SetupId>
          <SlsTax>short</SlsTax>
          <SlsTaxDflt>string</SlsTaxDflt>
          <TranDescDflt>string</TranDescDflt>
          <User1>string</User1>
          <User2>string</User2>
          <User3>double</User3>
          <User4>double</User4>
          <User5>string</User5>
          <User6>string</User6>
          <User7>dateTime</User7>
          <User8>dateTime</User8>
          <WarningLvlLimit>short</WarningLvlLimit>
        </ARSetup>
      </getArAccountsAsArrayResult>
    </getArAccountsAsArrayResponse>
  </soap12:Body>
</soap12:Envelope>