Organization

An object representing an organization.

Supported API Calls: Get | Add | Update | Delete

Object Properties

Property

Type

Description

ID

integer

Unique Identity of an Organization. When adding a new Organization the value must be 0.

Name

string (100)

Name of the Organization.

OldName

string (100)

When updating an Organization object, if you are updating the Name field, store the previous name in the OldName field.

Description

string (100)

Text for the Organization's comment field.

Industry

integer

ID to set the Organization's industry drop-down box. Value should be equal to an industry object's ID field.

Sector

string (100)

ID to set the Organization's sector drop-down box. Value should be equal to an sector object's ID field.

AnnualRevenue

double

Text for the Organization's Annual Revenue field. This value is optional.

NumberOfEmployee

integer

Text for the Organization's # of Employees field. This value is optional.

PriceBookId

integer

The ID of a pricebook object.

OwnerId

integer

The ID of the user who owns this object.

IsLocked

boolean

Flag to indicate this Organization is available in BlueCamroo but cannot be edited. This property is read only.

IsActive

boolean

Flag to indicate this Organization is available in BlueCamroo.

Source

integer

ID to set the Organization's Source drop-down box. Value should be equal to a Source object's ID field.

Website

string (100)

Text for the Organization's Website field.

CreatedBy

integer

ID of the internal user who created this object. Read only.

CreationDate

DateTime

Indicates when this object was created. Read only.

LastModifiedBy

integer

ID of the user who last modified the object. Read only.

LastModifiedDate

DateTime

Date the last time the object was modified. Read only.

LastActivityDate

DateTime

Date the last time the object was accessed in any way. Read only.

CustomerRole

AccountCustomerRole

The AccountCustomerRole object collects the customer status lookup value (open, on hold) and the Customer Type lookup value.

SupplierRole

AccountSupplierRole

The AccountSupplierRole object collects the supplier status lookup value (open, on hold) and the Supplier Type lookup value.

AddressList

List<Address>

An Organization object can be associated with multiple addresses. The Organization's addresses are stored as a list of Address objects.

SocialNetworkProfileList

List<SocialNetworkProfile>

An Organization object can be associated with multiple social profiles. The Organization's profiles are stored as a list of SocialNetworkProfile objects.

IsSuspended

boolean

Flag to indicate this Organization is suspended.

IsLead

boolean

Flag to indicate this object is treated as a lead in BlueCamroo.

IsCustomer

boolean

Flag to indicate this object is treated as a customer in BlueCamroo.

IsSupplier

boolean

Flag to indicate this object is treated as a supplier in BlueCamroo.

LeadAge

integer

If this organization is a lead, the number of days it has been a lead.

Get

Description

Returns the specified Organization.

URL

https://{company}.bluecamroo.com/api/account/get/{id}

HTTP Method

GET

Parameters

None

Data Return

Returns the Organization object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: OK

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Add

Description

Adds an Organization. Adds an Organization by passing an Organization object.

URL

https://{company}.bluecamroo.com/api/account/add

HTTP Method

POST

Parameters

An Organization object

Data Return

Returns the Organization object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

201: Created

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Update

Description

Pass an Organization object to replace one or more Organization details with the matching value.

URL

https://{company}.bluecamroo.com/api/account/update

HTTP Method

PUT

Parameters

An Organization object

Data Return

Returns the Organization object in the requested format (e.g., JSON or XML)

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)

Delete

Description

Deletes the Organization based on the passed ID number.

URL

https://{company}.bluecamroo.com/api/account/delete/{id}

HTTP Method

DELETE

Parameters

None

Data Return

None

HTTP Return Status Code

200: Ok

400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)

401: Not authorized (you need to log in)

403: Forbidden (you don't have permission to this resource)