Developer's center
API documentation
API sample code
API quickstart
Applications store
Registered developers
Our objects
Contact management
Contacts
Firms
Project & Time
Projects
Tasks
Timesheets
Sales management
Leads
Catalog
Proposals
Cash management
Invoices
Purchase bills
Cash deposits
Bank accounts
Team management
Staff
Salaries
Vacations
Expenses
Interviews
Documents
Notes
Files
Contracts
Doc from the web
Find here the list of actions to apply on the objects, and the data reference for this object.
What is a Staff Member ?
A staff_member is an employee, past or present, of your company.
Getting the staff members list
GET /staff_members.xml
Returns all staff members, page by page
Add a page parameter to navigate
Getting a single staff member
GET /staff_members/#{id}.xml
Returns a single staff member, identified by its id
Creating a new staff member
POST /staff_members.xml
Creates a new staff member, and returns the staff member data
Updating an existing staff member
PUT /staff_members/#{id}.xml
Updates some fields of an existing staff member
Deleting an existing staff member
DELETE /staff_members/#{id}.xml
Deletes the staff member identified by its id
Object data
<staff_member>
<id>id of this object</id>
<user_id>id of the user related to this staff_member, if any</user_id>
<civility_label_id>civility (see below)</civility_label_id>
<first_name>first name of staff</first_name>
<last_name>last name of staff</last_name>
<birth_date>date of birth</birth_date>
<birth_city>city of birth</birth_city>
<birth_country_id>France (name, not id)</birth_country_id>
<nationality_country_id>France (name, not id)</nationality_country_id>
<address>address</address>
<city>city</city>
<zip>zip</zip>
<s_security_nb>social security number</s_security_nb>
<arrival_date>date of arrival in the company</arrival_date>
<departure_date>date of departure in the company (if any)</departure_date>
<job_label>name of the job</job_label>
<job_description>description of the job (several lines)</job_description>
<rank>rank of the job</rank>
<job_level>level of the job</job_level>
<job_qualification>qualification of the job</job_qualification>
<email>contact email</email>
<comment>comment</comment>
<family_situation_id>id of family situation (see below)</family_situation_id>
<salary>raw salary perceived per year</salary>
<category>category of worker (employee, intern, etc)</category>
<time_conditions>work hours</time_conditions>
<contract_type>type of contract</contract_type>
<cdi>1 if the work contract if unlimited duration contract</cdi>
<transportation>detail of transportation gratification</transportation>
<work_contract>content of work contract</work_contract>
<doc_work_contract>1 if work contract is stored</doc_work_contract>
<doc_id>1 if copy of identification card is stored</doc_id>
<doc_social_card>1 if copy of social information is stored</doc_social_card>
<rib_bank>bank info : bank</rib_bank>
<rib_sub>bank info : bank branch</rib_sub>
<rib_account>bank info : account number</rib_account>
<rib_key>bank info : key</rib_key>
</staff_member>
Possible values of civility_label_id
17 for a Mr
18 for a Madam
19 for a Miss
Possible values of family situation
450 for bachelor
451 for married
452 for divorced
453 for widow
454 for living in community

