Skip to content
  • There are no suggestions because the search field is empty.

CRM Organisation

URL

Verbs

Function

/CRMOrganisation

 GET

Query a list of CRM Organisations
/CRMOrganisation POST Create a CRM Organisation
/CRMOrganisation/<code> POST Update an existing CRM Organisation

/CRMOrganisation<code>

GET

Query a single CRM Organisation

Supported modifiers

Query String

Definition
Sample

Release
emailFilter Query CRM Organisations with an email address emailFilter=bob@domain.com  
modifiedSince Return CRM Organisations modified since a nominated date and time modifiedSince=2013-02-28T16:45:00  
treeName and treeBranch Return a list of CRM Organisations assigned to a nominated branch of a nominated tree treeName=Colour-AUS&treeBranch=Blue  
parentOrganisation Return a list of CRM Organisations that are direct children of a particular parent CRM Organisation parentOrganisation=1004 2020.1
convertToCustomer

When POSTing an Organisation, request it to convert and create a linked Customer

You must also include an attribute in the body called ConvertToRelationship defining the new relationship

 convertToCustomer=true  
convertToSupplier

When POSTing an Organisation, request it to convert and create a linked Supplier.

You must also include an attribute in the body called ConvertToRelationship defining the new relationship

 convertToSupplier=true  
includeCrossReferences Include the Cross References Organisations and Contacts includeCrossReferences=true 2021.2
salesPerson Return CRM Organisations assigned to the nominated Sales Person salesPerson=Sally 2021.3
salesManager Return CRM Organisations assigned to the nominated Sales Manager salesManager=Leonie 2021.3

Security Linked Menu

Menu Item
Located
Organisations CRM / Relationships

Sample XML Response

<?xml version="1.0" encoding="UTF-8"?>
<CRMOrganisation>
    <Code>1004</Code>
    <Edition>32</Edition>
    <OidString>5569.5</OidString>
    <AlertText/>
    <Alpha>HIGHLA</Alpha>
    <CreditAlertText/>
    <CustomerSinceDate>2004-01-03</CustomerSinceDate>
    <EntryTimeStamp>2004-01-03T10:28:32</EntryTimeStamp>
    <EntryUser>SUPER</EntryUser>
    <IsBusSameAsStreet>true</IsBusSameAsStreet>
    <IsCreditAllowed>true</IsCreditAllowed>
    <IsExcludeCallRoster>false</IsExcludeCallRoster>
    <IsExcludeMailList>false</IsExcludeMailList>
    <IsInvoiceReseller>false</IsInvoiceReseller>
    <IsPORequiredForSVRequest>false</IsPORequiredForSVRequest>
    <IsRefCheckAvailable>false</IsRefCheckAvailable>
    <IsReseller>false</IsReseller>
    <IsVerified>false</IsVerified>
    <ModifiedTimeStamp>2008-03-15T16:58:37</ModifiedTimeStamp>
    <ModifiedUser>SUPER</ModifiedUser>
    <AssignedTeam>Sales Team</AssignedTeam>
    <AssignedUser>Steve Simpson</AssignedUser>
    <SalesPerson>SANDSS</SalesPerson>
    <Customer>1004</Customer>
    <Relationship>CUST</Relationship>
    <Status>Active</Status>
    <Classification>02</Classification>
    <Importance>MEDIUM</Importance>
    <ParentOrganisation>1000</ParentOrganisation>
    <PrimaryContact>10014</PrimaryContact>
    <Reseller>1052</Reseller>
    <SalesManager>SCORESS</SalesManager>
    <SalesTeam>Sales Team</SalesTeam>
    <Source>MAIL</Source>
    <Territory>METRO</Territory>
    <Type>EDU</Type>
    <Name>HighLake Primary</Name>
    <Notes/>
    <NumberEmployees>0</NumberEmployees>
    <PaymentTerms>Account Customer</PaymentTerms>
    <Revenue>0.00</Revenue>
    <RefCheckNote/>
    <BusinessPostalAddress>
        <Contact>Warren Black</Contact>
        <Address1>5 Sandringham Street</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Dolls Point</Suburb>
        <Postcode>2219</Postcode>
        <State>NSW</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(02) 5698 6857</PhoneBH>
        <PhoneAH/>
        <Fax>(02) 5698 6812</Fax>
        <Email>Highlake@school.gov.com</Email>
        <Web/>
        <Mobile>0410 144 415</Mobile>
    </BusinessPostalAddress>
    <BusinessStreetAddress>
        <Contact>Warren Black</Contact>
        <Address1>5 Sandringham Street</Address1>
        <Address2/>
        <Address3/>
        <Suburb>Dolls Point</Suburb>
        <Postcode>2219</Postcode>
        <State>NSW</State>
        <Country>AUS</Country>
        <TZone>+10:00</TZone>
        <PhoneBH>(02) 5698 6857</PhoneBH>
        <PhoneAH/>
        <Fax>(02) 5698 6812</Fax>
        <Email>Highlake@school.gov.com</Email>
        <Web/>
        <Mobile>0410 144 415</Mobile>
    </BusinessStreetAddress>
    <UserDefinedFields collection='true' count='2'>
        <UserDefinedField>
            <Name>Founded Date</Name>
            <Type>Date</Type>
            <Value>2049-02-16</Value>
        </UserDefinedField>
        <UserDefinedField>
            <Name>Send Xmas Card</Name>
            <Type>Boolean</Type>
            <Value>false</Value>
        </UserDefinedField>
    </UserDefinedFields>
    <Trees collection='true' count='3'>
        <Tree>
            <Name>Customer Type-AUS</Name>
            <IsMandatory>false</IsMandatory>
            <Value>School Primary</Value>
            <Path>School Primary</Path>
            <ShortCode>PRIMARY</ShortCode>
        </Tree>
        <Tree>
            <Name>Region-AUS</Name>
            <IsMandatory>false</IsMandatory>
            <Value>New South Wales</Value>
            <Path>Australia\New South Wales</Path>
            <ShortCode>NSW</ShortCode>
        </Tree>
        <Tree>
            <Name>Supplier Type-AUS</Name>
            <IsMandatory>false</IsMandatory>
            <Value/>
            <Path/>
        </Tree>
    </Trees>
</CRMOrganisation>