Find here the list of actions to apply on the objects, and the data reference for this object.

What is a firm ?

A firm is a company, with a name, some administrative data, and contact info. A firm can contain several contacts.

Getting the firms list

GET /firms.xml

Returns all firms, page by page
Add a page parameter to navigate

Getting a single firm

GET /firms/#{id}.xml

Returns a single firm, identified by its id

Creating a new firm

POST /firms.xml

Creates a new firm, and returns the firm data

Updating an existing firm

PUT /firms/#{id}.xml

Updates some fields of an existing firm

Deleting an existing firm

DELETE /firms/#{id}.xml

Deletes the firm identified by its id

Object data

<firm>
<id>id of firm</id>
<name>name of firm</name>
<firm_type>type of firm (see below)</firm_type>
<project_id>id of related project</project_id>
<siren>company identification number</siren>
<tva>intra vat number</tva>
<contact_addresses>
 <contact_address>
  <address_type>type of address (see below)</address_type>
  <street_address>street address</street_address>
  <street_address2>more address</street_address2>
  <zip_code>zip code</zip_code>
  <city>city</city>
  <country>France</country>
 </contact_address>
</contact_addresses>
<contact_items>
 <contact_item>
  <type_id>type of contact_item (see below)</type_id>
  <value>tel, email, etc.</value>
 </contact_item>
</contact_items>
</firm>

Possible values of client/firm type

• client for a client

• prospect for a prospect

• supplier for a supplier

• press for a journalist

• partner for a partner

• staff for a staff member or potential member

• perso for a personal contact

• other for none of the above

Possible values of contact_item_type

• 20 for a personal address

• 21 for a professional address

• 22 for a none of above

Possible values of contact_address_type for firms

• 71 for a phone

• 72 for a fax

• 73 for an email

• 74 for web site