CRM Lead
URL | Verbs | Function | Available |
---|---|---|---|
/CRMLead | GET | Query a list of CRM Leads | 2021.3 |
/CRMLead | POST | Create a new CRM Lead | 2021.3 |
/CRMLead/<code> | GET | Query a single CRM Lead | 2021.3 |
/CRMLead/<code> | POST | Update an existing CRM Lead | 2021.3 |
Supported modifiers
Query String | Definition | Sample | Released |
---|---|---|---|
modifiedSince | Return CRM Leads modified since a nominated date and time | modifiedSince=2013-02-28T16:45:00 | 2021.3 |
treeName and treeBranch | Return a list of CRM Leads assigned to a nominated branch of a nominated tree | treeName=Colour-AUS&treeBranch=Blue | 2021.3 |
status | Return a list of CRM Leads with a nominated status - Open or Closed | status=Open | 2021.3 |
leadStage | Return a list of CRM Leads at a nominated stage | stage=Prospect | 2021.3 |
Security Linked Menu
Menu Item | Located |
---|---|
Leads & Opportunities | CRM / Sales & Marketing |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<CRMLead> <Edition>15</Edition> <OidString>5586.1</OidString> <EntryTimeStamp>2008-01-03T15:10:28</EntryTimeStamp> <EntryUser>SUPER</EntryUser> <ModifiedTimeStamp>2011-10-29T10:38:49</ModifiedTimeStamp> <ModifiedUser>SUPER</ModifiedUser> <LeadNumber>1000</LeadNumber> <Description>Lisa interested in new products esp PC Solutions for the Primary schools</Description> <Summary>Lisa interested in new products</Summary> <KeyWords>Primary, PC Solution</KeyWords> <Notes/> <IsPrivate>false</IsPrivate> <IsWebAccessible>false</IsWebAccessible> <Requirements>Interested in new products that we have to offer.</Requirements> <ProposedSolution>Get Steve to offer listing of all new products that might be of use to Lisa.</ProposedSolution> <LeadStage>BEG</LeadStage> <ConfidencePercentage>0.00</ConfidencePercentage> <Discount>0.00</Discount> <PotentialRevenue>18480.70</PotentialRevenue> <EnteredPotential>18480.70</EnteredPotential> <EnteredConfidencePercent>0.00</EnteredConfidencePercent> <EnteredForecast>0.00</EnteredForecast> <PrimaryProduct>1001</PrimaryProduct> <LeadSource>WORD</LeadSource> <ReferredBy/> <LeadRating>HOT</LeadRating> <Organisation>1000</Organisation> <Territory>METRO</Territory> <SalesPerson>SAMPSS</SalesPerson> <SalesTeam>Sales Team</SalesTeam> <ObtainedDate>2008-01-04</ObtainedDate> <TenderDueDate/> <ExpectedDate>2008-04-05</ExpectedDate> <WonLostDate/> <ClosedDate/> <OpenedBy/> <ClosedBy/> <LostReason/> <AssignedUser>SUPER</AssignedUser> <AssignedTeam>Admin Team</AssignedTeam> <Reseller>1052</Reseller> <Contact>10000</Contact> <Campaign>1005</Campaign> <CampaignActivity>3</CampaignActivity> <LineItems collection='true' count='1'> <CRMLineItem> <LineType>CR</LineType> <LineNumber>1</LineNumber> <OidString>5532.1</OidString> <Edition>6</Edition> <Quantity>10.0000</Quantity> <DiscountPercentage>0.00</DiscountPercentage> <Amount>18480.70</Amount> <DiscountAmount>0.00</DiscountAmount> <TaxAmount>0.00</TaxAmount> <TaxPercentage>0.0000</TaxPercentage> <UnitPrice>1848.0700</UnitPrice> <UnitCost>0.0000</UnitCost> <Margin>0.0000</Margin> <MarginPercentage>100.0000</MarginPercentage> <StandardText/> <CRMProduct>1001</CRMProduct> <Product>1001</Product> <Description>EDU Primary School PC Solution</Description> <SubCode/> <IsHoldCost>false</IsHoldCost> <IsRevisionHoldPrice>false</IsRevisionHoldPrice> </CRMLineItem> </LineItems> <UserDefinedFields collection='true' count='0'/> <Trees collection='true' count='0'/> </CRMLead>