Retrieve Organization Account

This request retrieves information about an Organization and its primary contact. Use this to get information standard and account custom field data for an organization account.

REST

Request

https://api.neoncrm.com/neonws/services/api/account/retrieveOrganizationAccount?userSessionId=[session id]&accountId=3543

Response

{
    "retrieveOrganizationAccountResponse": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2013-01-24T03:59:12.189-06:00",
        "organizationAccount": {
            "createdDateTime": "2013-01-24T03:55:38.000-06:00",
            "createdBy": "Administrator ",
            "lastModifiedDateTime": "2013-01-24T03:55:38.000-06:00",
            "lastModifiedBy": "Administrator ",
            "accountId": 3543,
            "primaryContact": {
                "contactId": 5180,
                "firstName": "kevin",
                "lastName": "lee",
                "middleName": "mid",
                "prefix": "Mr.",
                "suffix": "test",
                "salutation": "brother",
                "preferredName": "kevin",
                "phone1": 422794616,
                "phone1Type": "Home",
                "phone2": 422794617,
                "phone2Type": "Work",
                "phone3": 422794618,
                "phone3Type": "Mobile",
                "fax": 422794620,
                "dob": "1988-10-16-05:00",
                "gender": {
                    "code": "M",
                    "name": "Male"
                },
                "deceased": false,
                "addresses": {
                    "address": {
                        "addressId": 3438,
                        "isPrimaryAddress": true,
                        "isShippingAddress": false,
                        "addressType": {
                            "id": 1,
                            "name": "Home"
                        },
                        "addressLine1": "street1",
                        "city": "city",
                        "state": {
                            "code": "AL",
                            "name": "ALABAMA"
                        },
                        "county": "county",
                        "country": {
                            "id": 2,
                            "name": "Canada"
                        },
                        "zipCode": 111,
                        "zipCodeSuffix": 222,
                        "startDate": "2012-01-01-06:00",
                        "endDate": "2013-01-01-06:00"
                    }
                },
                "department": "dep",
                "title": "SoftwareEngineer"
            },
            "noSolicitation": false,
            "url": "www.z2systems.com",
            "customFieldDataList": {
                "customFieldData": {
                    "fieldId": 73,
                    "fieldOptionId": 94
                }
            },
            "source": {
                "id": 43,
                "name": "J. Starr"
            },
            "organizationName": "kliOrganizationName",
            "organizationTypes": {
                "organizationType": {
                    "id": 1,
                    "name": "Church"
                }
            }
        }
    }
}

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:retrieveorganizationaccountrequest>
             <usersessionid>T1357624094982</usersessionid>
             <accountid>5789</accountid>
          </neon:retrieveorganizationaccountrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:retrieveorganizationaccountresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsedatetime>2013-01-24T04:01:33.511-06:00</responsedatetime>
         <organizationaccount>
            <createddatetime>2013-01-24T03:55:38.000-06:00</createddatetime>
            <createdby>Administrator</createdby>
            <lastmodifieddatetime>2013-01-24T03:55:38.000-06:00</lastmodifieddatetime>
            <lastmodifiedby>Administrator</lastmodifiedby>
            <accountid>3543</accountid>
            <primarycontact>
               <contactid>5180</contactid>
               <firstname>kevin</firstname>
               <lastname>lee</lastname>
               <middlename>mid</middlename>
               <prefix>Mr.</prefix>
               <suffix>test</suffix>
               <salutation>brother</salutation>
               <preferredname>kevin</preferredname>
               <phone1>422794616</phone1>
               <phone1type>Home</phone1type>
               <phone2>422794617</phone2>
               <phone2type>Work</phone2type>
               <phone3>422794618</phone3>
               <phone3type>Mobile</phone3type>
               <fax>422794620</fax>
               <dob>1988-10-16-05:00</dob>
               <gender>
                  <code>M</code>
                  <name>Male</name>
               </gender>
               <deceased>false</deceased>
               <addresses>
                  <address>
                     <addressid>3438</addressid>
                     <isprimaryaddress>true</isprimaryaddress>
                     <isshippingaddress>false</isshippingaddress>
                     <addresstype>
                        <id>1</id>
                        <name>Home</name>
                     </addresstype>
                     <addressline1>street1</addressline1>
                     <city>city</city>
                     <state>
                        <code>AL</code>
                        <name>ALABAMA</name>
                     </state>
                     <county>county</county>
                     <country>
                        <id>2</id>
                        <name>Canada</name>
                     </country>
                     <zipcode>111</zipcode>
                     <zipcodesuffix>222</zipcodesuffix>
                     <startdate>2012-01-01-06:00</startdate>
                     <enddate>2013-01-01-06:00</enddate>
                  </address>
               </addresses>
               <department>dep</department>
               <title>SoftwareEngineer</title>
            </primarycontact>
            <nosolicitation>false</nosolicitation>
            <url>www.z2systems.com</url>
            <customfielddatalist>
               <customfielddata>
                  <fieldid>73</fieldid>
                  <fieldoptionid>94</fieldoptionid>
               </customfielddata>
            </customfielddatalist>
            <source>
               <id>43</id>
               <name>J. Starr</name>

            <organizationname>kliOrganizationName</organizationname>
            <organizationtypes>
               <organizationtype>
                  <id>1</id>
                  <name>Church</name>
               </organizationtype>
            </organizationtypes>
         </organizationaccount>
      </ns2:retrieveorganizationaccountresponse>
   </soap:body>
</soap:envelope>

Request Parameters

Name Required Description
accountId Yes Account ID

Response Parameters

Name Required Description
organizationAccount.accountId Yes Account ID to be updated.
organizationAccount.organizationName Yes
organizationAccount.primaryContactAccountId Primary Contact Account ID
organizationAccount.primaryContact.contactId Contact ID to be updated. This is necessary for using the Update Individual Account method.
organizationAccount.primaryContact.firstName
organizationAccount.primaryContact.lastName
organizationAccount.primaryContact.middleName
organizationAccount.primaryContact.prefix Possible values come from the List Prefixes request.
organizationAccount.primaryContact.suffix
organizationAccount.primaryContact.preferredName
organizationAccount.primaryContact.salutation
organizationAccount.primaryContact.phone1
organizationAccount.primaryContact.phone1Type Possible values: Home, Work, Mobile
organizationAccount.primaryContact.phone2
organizationAccount.primaryContact.phone2Type Possible values: Home, Work, Mobile
organizationAccount.primaryContact.phone3
organizationAccount.primaryContact.phone3Type Possible values: Home, Work, Mobile
organizationAccount.primaryContact.fax
organizationAccount.primaryContact.dob Date format: YYYY-MM-DD
organizationAccount.primaryContact.gender.code Possible values can be retrieved using the List Genders method.
organizationAccount.primaryContact.gender.name Possible values can be retrieved using the List Genders method.
organizationAccount.primaryContact.deceased Possible values: true, false
organizationAccount.primaryContact.title
organizationAccount.primaryContact.department
organizationAccount.primaryContact.email1
organizationAccount.primaryContact.addresses.address.isPrimaryAddress Whether this address is the primary address. Possible values: true, false
organizationAccount.primaryContact.addresses.address.isShippingAddress Whether this address should be considered a shipping address. Possible values: true, false
organizationAccount.primaryContact.addresses.address.addressId
organizationAccount.primaryContact.addresses.address.addressType.id Possible values can be retrieved from the List Address Types method.
organizationAccount.primaryContact.addresses.address.addressType.name Possible values can be retrieved from the List Address Types method.
organizationAccount.primaryContact.addresses.address.addressLine1
organizationAccount.primaryContact.addresses.address.addressLine2
organizationAccount.primaryContact.addresses.address.addressLine3
organizationAccount.primaryContact.addresses.address.addressLine4
organizationAccount.primaryContact.addresses.address.city
organizationAccount.primaryContact.addresses.address.state.code Possible values can be retrieved from the List States method.
organizationAccount.primaryContact.addresses.address.state.name Possible values can be retrieved from the List States method.
organizationAccount.primaryContact.addresses.address.province Only used for countries other than US and Canada. Canadian provinces can be found in the States field.
organizationAccount.primaryContact.addresses.address.county
organizationAccount.primaryContact.addresses.address.country.id Possible values can be retrieved from the List Countries method.
organizationAccount.primaryContact.addresses.address.country.name Possible values can be retrieved from the List Countries method.
organizationAccount.primaryContact.addresses.address.zipCode
organizationAccount.primaryContact.addresses.address.zipCodeSuffix
organizationAccount.primaryContact.addresses.address.startDate Format: YYYY-MM-DD
organizationAccount.primaryContact.addresses.address.endDate Format: YYYY-MM-DD
organizationAccount.noSolicitation This corresponds to the Do Not Contact field. Possible values: true, false.
organizationAccount.url
organizationAccount.login.orgId
organizationAccount.customFieldDataList.customFieldData.fieldId Retrieve possible account custom fields from the List Custom Fields request.
organizationAccount.customFieldDataList.customFieldData.fieldValue Required if the custom field type is a text field.
organizationAccount.customFieldDataList.customFieldData.fieldOptionId Required if the custom field type is not a text field. Possible values can be retrieved from the List Custom Fields request.
organizationAccount.source.id Possible values can be retrieved from the List Sources method.
organizationAccount.source.name Possible values can be retrieved from the List Sources method.
organizationAccount.existingOrganizationId Include the Account ID of an organization account to link this individual as a company contact.
organizationAccount.organizationTypes.organizationType.id Possible values can be retrieved from the List Organization Types method.
organizationAccount.organizationTypes.organizationType.name Possible values can be retrieved from the List Organization Types method.

Error Codes

Code Text Description
10032 Organization account id is required.
10033 Organization account id is invalid.